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