fix(animation): don't trigger <done> when clearing animation

Previously we did not properly separate completion from clearing an
animation; we would not properly be able to distinguish both,
effectively always triggering the animation <done> effect, also when
clearing a scope (i.e. because it was terminated).

This change moves the control over individual animations to the
animation service, and applies <done> only when the animation completes
normally.

Author: nikku

lib/animation/Animation.js

@@ -139,7 +139,7 @@ Animation.prototype.createAnimation = function(connection, scope, done = noop) {
   const tokenGfx = this._createTokenGfx(group, scope);
 
   const animation = new TokenAnimation(tokenGfx, connection.waypoints, this._randomize, () => {
-    this._animations.delete(animation);
+    this._clearAnimation(animation);
 
     done();
   });
@@ -181,11 +181,17 @@ Animation.prototype.getAnimationSpeed = function() {
 Animation.prototype.clearAnimations = function(scope) {
   this.each(animation => {
     if (!scope || animation.scope === scope) {
-      animation.remove();
+      this._clearAnimation(animation);
     }
   });
 };
 
+Animation.prototype._clearAnimation = function(animation) {
+  animation.remove();
+
+  this._animations.delete(animation);
+};
+
 Animation.prototype._createTokenGfx = function(group, scope) {
   const parent = svgCreate(this._getTokenSVG(scope).trim());
 
@@ -320,7 +326,7 @@ TokenAnimation.prototype.tick = function(tElapsed) {
 
   // completed
   if (!part) {
-    return this.remove();
+    return this.completed();
   }
 
   const segmentTime = t - part.startTime;
@@ -405,12 +411,14 @@ TokenAnimation.prototype.hide = function() {
   svgAttr(this.gfx, 'display', 'none');
 };
 
+TokenAnimation.prototype.completed = function() {
+  this.done();
+};
+
 TokenAnimation.prototype.remove = function() {
   this.pause();
 
   svgRemove(this.gfx);
-
-  this.done();
 };
 
 TokenAnimation.prototype.setSpeed = function(speed) {