Append Stopped animation notify list at Update Animation time

[platform/core/uifw/dali-core.git] / dali / internal / update / animation / scene-graph-animation.h

diff --git a/dali/internal/update/animation/scene-graph-animation.h b/dali/internal/update/animation/scene-graph-animation.h
index 7c2be77..869fe2f 100644 (file)
--- a/dali/internal/update/animation/scene-graph-animation.h
+++ b/dali/internal/update/animation/scene-graph-animation.h
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_SCENE_GRAPH_ANIMATION_H
 
 /*
- * Copyright (c) 2023 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2024 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 #include <dali/internal/common/buffer-index.h>
 #include <dali/internal/common/message.h>
 #include <dali/internal/event/common/event-thread-services.h>
+#include <dali/internal/event/common/notifier-interface.h>
 #include <dali/internal/update/animation/scene-graph-animator.h>
 
 namespace Dali
@@ -37,7 +38,7 @@ namespace SceneGraph
  * managers "update" phase. An animation is a container of Animator objects; the actual setting
  * of object values is done by the animators.
  */
-class Animation
+class Animation : public NotifierInterface
 {
 public:
   using EndAction = Dali::Animation::EndAction;
@@ -231,6 +232,12 @@ public:
   bool Stop(BufferIndex bufferIndex);
 
   /**
+   * Clear the animator. It will stop animation, clear all animators, and make this animation never played before.
+   * @param[in] bufferIndex The buffer to update when mEndAction == Bake.
+   */
+  void ClearAnimator(BufferIndex bufferIndex);
+
+  /**
    * Called shortly before the animation is destroyed.
    * @param[in] bufferIndex The buffer to update when mEndAction == Bake.
    */
@@ -295,11 +302,11 @@ public:
    * @pre The animation is playing or paused.
    * @param[in] bufferIndex The buffer to update.
    * @param[in] elapsedSeconds The time elapsed since the previous frame.
-   * @param[out] looped True if the animation looped
+   * @param[out] stopped True if the animation stopped this loop
    * @param[out] finished True if the animation has finished.
    * @param[out] progressReached True if progress marker reached
    */
-  void Update(BufferIndex bufferIndex, float elapsedSeconds, bool& looped, bool& finished, bool& progressReached);
+  void Update(BufferIndex bufferIndex, float elapsedSeconds, bool& stopped, bool& finished, bool& progressReached);
 
   static uint32_t GetMemoryPoolCapacity();
 
@@ -365,6 +372,7 @@ protected:
   bool mAnimatorSortRequired;          // Flag to whether we need to sort animator or not.
   bool mIsActive[2];                   // Flag to indicate whether the animation is active in the current frame (which is double buffered)
   bool mIsFirstLoop;
+  bool mIsStopped; // Flag to whether this animation call stoped by user at this frame.
 };
 
 }; // namespace SceneGraph
@@ -488,6 +496,7 @@ inline void PlayAnimationMessage(EventThreadServices& eventThreadServices, const
   // Construct message in the message queue memory; note that delete should not be called on the return value
   new(slot) LocalType(&animation, &Animation::Play);
 }
+
 inline void PlayAnimationFromMessage(EventThreadServices& eventThreadServices, const Animation& animation, float progress)
 {
   using LocalType = MessageValue1<Animation, float>;