Merge lp:~nick-dedekind/nux/remove-animation-on-tick into lp:nux

[Nick Dedekind]

Added support for removal of animations during tick.

= Problem description =

Nux animation framework does not support deleting an animation during a tick cycle.
This is required for chaining animations for LP: #1060948

= The fix =

Do not tick items which have been marked for removal in the animation controller

= Test coverage =

Unit test for removal of animation during tick.

[Brandon Schaefer (brandontschaefer)]

Looks good to me.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/nux-mbs-autolanding/77/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/nux-mbs-autolanding/./build=panda-pbuilder,distribution=quantal,flavor=armhf/77/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/nux-mbs-autolanding/./build=pbuilder,distribution=quantal,flavor=amd64/77/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/nux-mbs-autolanding/./build=pbuilder,distribution=quantal,flavor=i386/77/console

review: Needs Fixing (continuous-integration)

[Francis Ginther (fginther)]

Re-approving. I updated the job to use a better test and result collection hook script, but I used the wrong one. The job should be configured to use the correct one now. I'll monitor this MP in case there is another failure.

=== modified file 'NuxCore/AnimationController.cpp'
--- NuxCore/AnimationController.cpp	2012-11-05 21:31:06 +0000
+++ NuxCore/AnimationController.cpp	2012-11-25 22:22:21 +0000
@@ -115,7 +115,12 @@
       for (Animations::iterator i = animations_.begin(),
              end = animations_.end(); i != end; ++i)
       {
-        (*i)->Advance(ms_since_last_tick);
+        // only if it isn't pending.
+        if (do_not_tick_.empty() ||
+            do_not_tick_.find((*i)) == do_not_tick_.end())
+        {
+          (*i)->Advance(ms_since_last_tick);
+        }
       }
 
       ticking_ = false;
@@ -129,6 +134,7 @@
           Remove(i->first);
       }
       pending_.clear();
+      do_not_tick_.clear();
     }
 
   long long last_tick_;
@@ -137,6 +143,9 @@
   typedef std::vector<std::pair<Animation*, bool>> AnimationActions;
   AnimationActions pending_;
   bool ticking_;
+
+  typedef std::set<Animation*> DoNotTickActions;
+  DoNotTickActions do_not_tick_;
 };
 
 na::AnimationController::AnimationController(na::TickSource& tick_source)
@@ -173,6 +182,7 @@
   if (pimpl->ticking_)
   {
     pimpl->pending_.push_back(std::make_pair(animation, false));
+    pimpl->do_not_tick_.insert(animation);
   }
   else
   {

=== modified file 'tests/gtest-nuxcore-animation.cpp'
--- tests/gtest-nuxcore-animation.cpp	2012-11-09 01:49:53 +0000
+++ tests/gtest-nuxcore-animation.cpp	2012-11-25 22:22:21 +0000
@@ -158,6 +158,34 @@
   ASSERT_FALSE(controller.HasRunningAnimations());
 }
 
+TEST(TestAnimationController, RemoveValueInTick)
+{
+  na::TickSource source;
+  na::AnimationController controller(source);
+
+  std::shared_ptr<na::AnimateValue<int>> animation1(new na::AnimateValue<int>(0,100,1000));
+  std::shared_ptr<na::AnimateValue<int>> animation2(new na::AnimateValue<int>(0,100,1000));
+
+  int i = 0;
+  animation1->updated.connect([&](int)
+  {
+    if (++i == 2)
+    {
+      animation2.reset();
+    }
+  });
+
+  animation1->Start();
+  animation2->Start();
+  source.tick.emit(10);
+
+  ASSERT_THAT(animation1->CurrentState(), Eq(na::Animation::Running));
+  ASSERT_TRUE(animation2.get() == nullptr);
+
+  animation1.reset();
+  animation2.reset();
+}
+
 TEST(TestAnimation, TestInitialState)
 {
   MockAnimation animation;