dali/internal/event/animation/animation-playlist.h

   1 #ifndef __DALI_INTERNAL_ANIMATION_PLAYLIST_H__
   2 #define __DALI_INTERNAL_ANIMATION_PLAYLIST_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/animation/animation.h>
  23 #include <dali/public-api/common/set-wrapper.h>
  24 #include <dali/internal/event/common/complete-notification-interface.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal
  30 {
  31
  32 class Animation;
  33
  34 /**
  35  * AnimationPlaylist provides notifications to applications when animations are finished.
  36  * It reference-counts playing animations, to allow "fire and forget" behaviour.
  37  */
  38 class AnimationPlaylist : public CompleteNotificationInterface
  39 {
  40 public:
  41
  42   /**
  43    * Create an AnimationPlaylist.
  44    * @return A newly allocated animation playlist.
  45    */
  46   static AnimationPlaylist* New();
  47
  48   /**
  49    * Virtual destructor.
  50    */
  51   virtual ~AnimationPlaylist();
  52
  53   /**
  54    * Called when an animation is constructed.
  55    */
  56   void AnimationCreated( Animation& animation );
  57
  58   /**
  59    * Called when an animation is destroyed.
  60    */
  61   void AnimationDestroyed( Animation& animation );
  62
  63   /**
  64    * Called when an animation is playing.
  65    * @post The animation will be referenced by AnimationPlaylist, until the "Finished" signal is emitted.
  66    */
  67   void OnPlay( Animation& animation );
  68
  69   /**
  70    * Called when an animation is cleared.
  71    * @post The animation will no longer be referenced by AnimationPlaylist.
  72    */
  73   void OnClear( Animation& animation );
  74
  75 private:
  76
  77   /**
  78    * Create an AnimationPlaylist.
  79    */
  80   AnimationPlaylist();
  81
  82   // Undefined
  83   AnimationPlaylist(const AnimationPlaylist&);
  84
  85   // Undefined
  86   AnimationPlaylist& operator=(const AnimationPlaylist& rhs);
  87
  88 private: // from CompleteNotificationInterface
  89
  90   /**
  91    * @copydoc CompleteNotificationInterface::NotifyCompleted()
  92    */
  93   virtual void NotifyCompleted();
  94
  95 private:
  96
  97   std::set< Animation* > mAnimations; ///< All existing animations (not referenced)
  98   std::set< Dali::Animation > mPlaylist; ///< The currently playing animations (reference counted)
  99
 100 };
 101
 102 } // namespace Internal
 103
 104 } // namespace Dali
 105
 106 #endif // __DALI_INTERNAL_NOTIFICATION_MANAGER_H__
 107