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) 2021 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 // EXTERNAL INCLUDES
  22 #include <memory>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/event/animation/key-frame-channel.h>
  26 #include <dali/public-api/animation/alpha-function.h>
  27 #include <dali/public-api/animation/key-frames.h>
  28 #include <dali/public-api/common/vector-wrapper.h>
  29 #include <dali/public-api/object/base-object.h>
  30
  31 namespace Dali
  32 {
  33 namespace Internal
  34 {
  35 class KeyFrameSpec;
  36 class KeyFrames;
  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 private:
  48   /**
  49    * Create a specialization from the given type, and store it to the mSpec
  50    * member variable
  51    */
  52   void CreateKeyFramesSpec(Property::Type type);
  53
  54 public:
  55   /**
  56    * Get the type of this key frame.
  57    * An empty key frame will return Property::NONE, wheras an initialised
  58    * key frame object will return the type of it's first element.
  59    * @return the Property::Type of the key frame values
  60    */
  61   Property::Type GetType() const;
  62
  63   /**
  64    * Add a key frame. The first key frame to be added denotes the type
  65    * of all subsequent key frames. If a value with a different type is
  66    * added, it will throw a run time assert.
  67    * @param[in] time The time (between 0 and 1)
  68    * @param[in] value The value of the keyframe at the given time
  69    * @param[in] alpha An alpha function to blend between this key frame and the
  70    * next key frame.
  71    */
  72   void Add(float time, const Property::Value& value, AlphaFunction alpha);
  73
  74   /**
  75    * Return the key frames without specialization. The GetSpecialization methods
  76    * below will convert to the specialized objects.
  77    */
  78   KeyFrameSpec* GetKeyFramesBase() const;
  79
  80   /**
  81    * Return the value of the last key frame.
  82    */
  83   Dali::Property::Value GetLastKeyFrameValue() const;
  84
  85 private:
  86   Dali::Property::Type          mType{Property::NONE}; // Type of the specialization
  87   std::unique_ptr<KeyFrameSpec> mKeyFrames;            // Pointer to the specialized key frame object
  88 };
  89
  90 /**
  91  * This is the base class for the individual template specializations, allowing a ptr to be
  92  * stored in the handle object above.
  93  */
  94 class KeyFrameSpec
  95 {
  96 public:
  97   virtual ~KeyFrameSpec() = default;
  98
  99   virtual std::size_t GetNumberOfKeyFrames() const = 0;
 100
 101   /**
 102    * Get the key frame value as a Property::Value.
 103    * @param[in] index The index of the key frame to fetch
 104    * @param[out] value The value of the given key frame
 105    */
 106   virtual void GetKeyFrameAsValue(std::size_t index, Property::Value& value) = 0;
 107 };
 108
 109 /**
 110  * The base template class for each key frame specialization.
 111  */
 112 template<typename V>
 113 class KeyFrameBaseSpec : public KeyFrameSpec
 114 {
 115   KeyFrameChannel<V> mChannel; // The key frame channel
 116
 117 public:
 118   /**
 119    * Add a key frame to the channel. Key frames should be added
 120    * in time order (this method does not sort the vector by time)
 121    * @param[in] t - progress
 122    * @param[in] v - value
 123    * @param[in] alpha - Alpha function for blending to the next keyframe
 124    */
 125   void AddKeyFrame(float t, V v, AlphaFunction alpha)
 126   {
 127     mChannel.mValues.push_back({t, v});
 128   }
 129
 130   /**
 131    * Get the number of key frames
 132    * @return Channel size
 133    */
 134   std::size_t GetNumberOfKeyFrames() const override
 135   {
 136     return mChannel.mValues.size();
 137   }
 138
 139   /**
 140    * Get a key frame.
 141    * @param[in] index The index of the key frame to fetch
 142    * @param[out] time The progress of the given key frame
 143    * @param[out] value The value of the given key frame
 144    */
 145   void GetKeyFrame(unsigned int index, float& time, V& value) const
 146   {
 147     DALI_ASSERT_ALWAYS(index < mChannel.mValues.size() && "KeyFrame index is out of bounds");
 148     const auto& element = mChannel.mValues[index];
 149     time                = element.mProgress;
 150     value               = element.mValue;
 151   }
 152
 153   /**
 154    * @copydoc KeyFrameSpec::GetKeyFrameAsValue()
 155    */
 156   void GetKeyFrameAsValue(std::size_t index, Property::Value& value) override
 157   {
 158     value = mChannel.mValues[index].mValue;
 159   }
 160
 161   /**
 162    * Return whether the progress is valid for the range of keyframes. (The first
 163    * keyframe doesn't have to start at 0, and the last doesn't have to end at 1.0)
 164    * @param[in] progress The progress to test
 165    * @return True if the progress is valid for this object
 166    */
 167   bool IsActive(float progress) const
 168   {
 169     return mChannel.IsActive(progress);
 170   }
 171
 172   /**
 173    * Return an interpolated value for the given progress.
 174    * @param[in] progress The progress to test
 175    * @return The interpolated value
 176    */
 177   V GetValue(float progress, Dali::Animation::Interpolation interpolation) const
 178   {
 179     return mChannel.GetValue(progress, interpolation);
 180   }
 181 };
 182
 183 using KeyFrameNumber     = KeyFrameBaseSpec<float>;
 184 using KeyFrameBoolean    = KeyFrameBaseSpec<bool>;
 185 using KeyFrameInteger    = KeyFrameBaseSpec<int>;
 186 using KeyFrameVector2    = KeyFrameBaseSpec<Vector2>;
 187 using KeyFrameVector3    = KeyFrameBaseSpec<Vector3>;
 188 using KeyFrameVector4    = KeyFrameBaseSpec<Vector4>;
 189 using KeyFrameQuaternion = KeyFrameBaseSpec<Quaternion>;
 190
 191 template<typename DeriveClass>
 192 auto GetSpecialization(const Internal::KeyFrames& keyFrames)
 193 {
 194   return static_cast<DeriveClass>(keyFrames.GetKeyFramesBase());
 195 }
 196
 197 } // namespace Internal
 198
 199 // Get impl of handle
 200 inline Internal::KeyFrames& GetImplementation(Dali::KeyFrames& keyFrames)
 201 {
 202   DALI_ASSERT_ALWAYS(keyFrames && "KeyFrames handle is empty");
 203   Dali::RefObject& object = keyFrames.GetBaseObject();
 204   return static_cast<Internal::KeyFrames&>(object);
 205 }
 206
 207 inline const Internal::KeyFrames& GetImplementation(const Dali::KeyFrames& keyFrames)
 208 {
 209   DALI_ASSERT_ALWAYS(keyFrames && "KeyFrames handle is empty");
 210   const Dali::RefObject& object = keyFrames.GetBaseObject();
 211   return static_cast<const Internal::KeyFrames&>(object);
 212 }
 213
 214 } // namespace Dali
 215
 216 #endif // DALI_INTERNAL_KEY_FRAMES_H