dali/internal/event/animation/key-frames-impl.h

   1 #ifndef __DALI_INTERNAL_KEY_FRAMES_H__
   2 #define __DALI_INTERNAL_KEY_FRAMES_H__
   3
   4 /*
   5  * Copyright (c) 2016 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/common/vector-wrapper.h>
  23 #include <dali/public-api/animation/key-frames.h>
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/animation/alpha-function.h>
  26 #include <dali/internal/event/animation/progress-value.h>
  27 #include <dali/internal/event/animation/key-frame-channel.h>
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33 class KeyFrameSpec;
  34 class KeyFrames;
  35 typedef IntrusivePtr<KeyFrames> KeyFramesPtr;
  36
  37
  38 /**
  39  * KeyFrames class is responsible for creating and building a specialized KeyFrame class
  40  * from the Property::Value type used in Add.
  41  */
  42 class KeyFrames : public BaseObject
  43 {
  44 public:
  45   static KeyFrames* New();
  46
  47   /**
  48    * Instantiate an empty KeyFrames object
  49    */
  50   KeyFrames();
  51
  52 protected:
  53   virtual ~KeyFrames();
  54
  55 private:
  56   /**
  57    * Don't allow copy constructor
  58    */
  59   KeyFrames(const KeyFrames& rhs);
  60
  61   /**
  62    * Don't allow copy operator
  63    */
  64   KeyFrames& operator=(const KeyFrames& rhs);
  65
  66   /**
  67    * Create a specialization from the given type, and store it to the mSpec
  68    * member variable
  69    */
  70   void CreateKeyFramesSpec(Property::Type type);
  71
  72 public:
  73   /**
  74    * Get the type of this key frame.
  75    * An empty key frame will return Property::NONE, wheras an initialised
  76    * key frame object will return the type of it's first element.
  77    * @return the Property::Type of the key frame values
  78    */
  79   Property::Type GetType() const;
  80
  81   /**
  82    * Add a key frame. The first key frame to be added denotes the type
  83    * of all subsequent key frames. If a value with a different type is
  84    * added, it will throw a run time assert.
  85    * @param[in] time The time (between 0 and 1)
  86    * @param[in] value The value of the keyframe at the given time
  87    * @param[in] alpha An alpha function to blend between this key frame and the
  88    * next key frame.
  89    */
  90   void Add(float time, Property::Value value, AlphaFunction alpha);
  91
  92   /**
  93    * Return the key frames without specialization. The GetSpecialization methods
  94    * below will convert to the specialized objects.
  95    */
  96   KeyFrameSpec* GetKeyFramesBase() const;
  97
  98 private:
  99   Dali::Property::Type mType; // Type of the specialization
 100   IntrusivePtr<KeyFrameSpec> mKeyFrames;   // Pointer to the specialized key frame object
 101 };
 102
 103
 104 /**
 105  * This is the base class for the individual template specializations, allowing a ptr to be
 106  * stored in the handle object above. It inherits from RefObject to allow smart pointers
 107  * to be used for the specializations. Note that the derived template class below
 108  * allows for a copy constructor so that the specialization object can be cloned before
 109  * being passed to the scene-graph for animation.
 110  */
 111 class KeyFrameSpec : public RefObject
 112 {
 113 public:
 114
 115   KeyFrameSpec() {}
 116
 117   virtual unsigned int GetNumberOfKeyFrames() const = 0;
 118
 119 protected:
 120
 121   /**
 122    * A reference counted object may only be deleted by calling Unreference()
 123    */
 124   virtual ~KeyFrameSpec() {}
 125 };
 126
 127
 128 /**
 129  * The base template class for each key frame specialization. It stores a vector of
 130  * ProgressValue pairs in mPVs, and uses the existing interface for KeyFrameChannel
 131  * to point at this vector.
 132  */
 133 template<typename V>
 134 class KeyFrameBaseSpec : public KeyFrameSpec
 135 {
 136 private:
 137   typedef ProgressValue<V> PV;
 138   typedef std::vector<PV> PVContainer;
 139
 140   PVContainer                    mPVs;       // The ProgressValue pairs
 141   KeyFrameChannel<V>*            mKeyFrames; // The key frame interpolator
 142
 143 public:
 144   static KeyFrameBaseSpec<V>* New()
 145   {
 146     return new KeyFrameBaseSpec<V>();
 147   }
 148
 149   static KeyFrameBaseSpec<V>* Clone(const KeyFrameBaseSpec<V>& keyFrames)
 150   {
 151     return new KeyFrameBaseSpec<V>(keyFrames);
 152   }
 153
 154   /**
 155    * Constructor
 156    */
 157   KeyFrameBaseSpec<V>()
 158   {
 159     mKeyFrames = new KeyFrameChannel<V>(KeyFrameChannelBase::Translate, mPVs);
 160   }
 161
 162 protected:
 163   /**
 164    * Copy Constructor
 165    * Allow cloning of this object
 166    */
 167   KeyFrameBaseSpec<V>(const KeyFrameBaseSpec<V>& keyFrames)
 168   : mPVs(keyFrames.mPVs)
 169   {
 170     mKeyFrames = new KeyFrameChannel<V>(KeyFrameChannelBase::Translate, mPVs);
 171   }
 172
 173   KeyFrameBaseSpec<V>& operator=( const KeyFrameBaseSpec<V>& keyFrames )
 174   {
 175     if( this != &keyFrames )
 176     {
 177       mPVs.clear();
 178       mPVs = keyFrames.mPVs;
 179       delete mKeyFrames;
 180       mKeyFrames = new KeyFrameChannel<V>(KeyFrameChannelBase::Translate, mPVs);
 181     }
 182     return *this;
 183   }
 184
 185   /**
 186    * Destructor. Ensure progress value pairs are cleared down
 187    */
 188   virtual ~KeyFrameBaseSpec<V>()
 189   {
 190     delete mKeyFrames;
 191     mPVs.clear();
 192   }
 193
 194 public:
 195   /**
 196    * Add a key frame to the progress value vector. Key frames should be added
 197    * in time order (this method does not sort the vector by time)
 198    * @param[in] t - progress
 199    * @param[in] v - value
 200    * @param[in] alpha - Alpha function for blending to the next keyframe
 201    */
 202   void AddKeyFrame(float t, V v, AlphaFunction alpha)
 203   {
 204     mPVs.push_back(PV(t, v));
 205   }
 206
 207   /**
 208    * Get the number of key frames
 209    * @return The size of the progress value vector
 210    */
 211   virtual unsigned int GetNumberOfKeyFrames() const
 212   {
 213     return mPVs.size();
 214   }
 215
 216   /**
 217    * Get a key frame.
 218    * @param[in] index The index of the key frame to fetch
 219    * @param[out] time The progress of the given key frame
 220    * @param[out] value The value of the given key frame
 221    */
 222   virtual void GetKeyFrame(unsigned int index, float& time, V& value) const
 223   {
 224     DALI_ASSERT_ALWAYS( index < mPVs.size() && "KeyFrame index is out of bounds" );
 225     time  = mPVs[index].mProgress;
 226     value = mPVs[index].mValue;
 227   }
 228
 229   /**
 230    * Return whether the progress is valid for the range of keyframes. (The first
 231    * keyframe doesn't have to start at 0, and the last doesn't have to end at 1.0)
 232    * @param[in] progress The progress to test
 233    * @return True if the progress is valid for this object
 234    */
 235   bool IsActive(float progress) const
 236   {
 237     return mKeyFrames->IsActive(progress);
 238   }
 239
 240   /**
 241    * Return an interpolated value for the given progress.
 242    * @param[in] progress The progress to test
 243    * @return The interpolated value
 244    */
 245   V GetValue(float progress, Dali::Animation::Interpolation interpolation) const
 246   {
 247     return mKeyFrames->GetValue(progress, interpolation);
 248   }
 249 };
 250
 251 typedef KeyFrameBaseSpec<float>          KeyFrameNumber;
 252 typedef KeyFrameBaseSpec<bool>           KeyFrameBoolean;
 253 typedef KeyFrameBaseSpec<int>            KeyFrameInteger;
 254 typedef KeyFrameBaseSpec<Vector2>        KeyFrameVector2;
 255 typedef KeyFrameBaseSpec<Vector3>        KeyFrameVector3;
 256 typedef KeyFrameBaseSpec<Vector4>        KeyFrameVector4;
 257 typedef KeyFrameBaseSpec<Quaternion>     KeyFrameQuaternion;
 258
 259 typedef IntrusivePtr<KeyFrameBoolean>         KeyFrameBooleanPtr;
 260 typedef IntrusivePtr<KeyFrameNumber>          KeyFrameNumberPtr;
 261 typedef IntrusivePtr<KeyFrameInteger>         KeyFrameIntegerPtr;
 262 typedef IntrusivePtr<KeyFrameVector2>         KeyFrameVector2Ptr;
 263 typedef IntrusivePtr<KeyFrameVector3>         KeyFrameVector3Ptr;
 264 typedef IntrusivePtr<KeyFrameVector4>         KeyFrameVector4Ptr;
 265 typedef IntrusivePtr<KeyFrameQuaternion>      KeyFrameQuaternionPtr;
 266
 267
 268 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameBoolean*& keyFrameSpec)
 269 {
 270   keyFrameSpec = static_cast<Internal::KeyFrameBoolean*>(keyFrames.GetKeyFramesBase());
 271 }
 272
 273 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameBoolean*& keyFrameSpec)
 274 {
 275   keyFrameSpec = static_cast<const Internal::KeyFrameBoolean*>(keyFrames.GetKeyFramesBase());
 276 }
 277
 278 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameNumber*& keyFrameSpec)
 279 {
 280   keyFrameSpec = static_cast<Internal::KeyFrameNumber*>(keyFrames.GetKeyFramesBase());
 281 }
 282
 283 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameNumber*& keyFrameSpec)
 284 {
 285   keyFrameSpec = static_cast<const Internal::KeyFrameNumber*>(keyFrames.GetKeyFramesBase());
 286 }
 287
 288 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameInteger*& keyFrameSpec)
 289 {
 290   keyFrameSpec = static_cast<Internal::KeyFrameInteger*>(keyFrames.GetKeyFramesBase());
 291 }
 292
 293 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameInteger*& keyFrameSpec)
 294 {
 295   keyFrameSpec = static_cast<const Internal::KeyFrameInteger*>(keyFrames.GetKeyFramesBase());
 296 }
 297
 298 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameVector2*& keyFrameSpec)
 299 {
 300   keyFrameSpec = static_cast<Internal::KeyFrameVector2*>(keyFrames.GetKeyFramesBase());
 301 }
 302
 303 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameVector2*& keyFrameSpec)
 304 {
 305   keyFrameSpec = static_cast<const Internal::KeyFrameVector2*>(keyFrames.GetKeyFramesBase());
 306 }
 307
 308 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameVector3*& keyFrameSpec)
 309 {
 310   keyFrameSpec = static_cast<Internal::KeyFrameVector3*>(keyFrames.GetKeyFramesBase());
 311 }
 312
 313 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameVector3*& keyFrameSpec)
 314 {
 315   keyFrameSpec = static_cast<const Internal::KeyFrameVector3*>(keyFrames.GetKeyFramesBase());
 316 }
 317
 318 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameVector4*& keyFrameSpec)
 319 {
 320   keyFrameSpec = static_cast<Internal::KeyFrameVector4*>(keyFrames.GetKeyFramesBase());
 321 }
 322
 323 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameVector4*& keyFrameSpec)
 324 {
 325   keyFrameSpec = static_cast<const Internal::KeyFrameVector4*>(keyFrames.GetKeyFramesBase());
 326 }
 327
 328 inline void GetSpecialization(Internal::KeyFrames& keyFrames, Internal::KeyFrameQuaternion*& keyFrameSpec)
 329 {
 330   keyFrameSpec = static_cast<Internal::KeyFrameQuaternion*>(keyFrames.GetKeyFramesBase());
 331 }
 332
 333 inline void GetSpecialization(const Internal::KeyFrames& keyFrames, const Internal::KeyFrameQuaternion*& keyFrameSpec)
 334 {
 335   keyFrameSpec = static_cast<const Internal::KeyFrameQuaternion*>(keyFrames.GetKeyFramesBase());
 336 }
 337
 338 } // Internal
 339
 340
 341 // Get impl of handle
 342 inline Internal::KeyFrames& GetImplementation(Dali::KeyFrames& keyFrames)
 343 {
 344   DALI_ASSERT_ALWAYS( keyFrames && "KeyFrames handle is empty" );
 345   Dali::RefObject& object = keyFrames.GetBaseObject();
 346   return static_cast<Internal::KeyFrames&>(object);
 347 }
 348
 349 inline const Internal::KeyFrames& GetImplementation(const Dali::KeyFrames& keyFrames)
 350 {
 351   DALI_ASSERT_ALWAYS( keyFrames && "KeyFrames handle is empty" );
 352   const Dali::RefObject& object = keyFrames.GetBaseObject();
 353   return static_cast<const Internal::KeyFrames&>(object);
 354 }
 355
 356
 357 } // Dali
 358
 359 #endif //__DALI_INTERNAL_KEY_FRAMES_H__