1 #ifndef DALI_TOOLKIT_INTERNAL_TRANSITION_BASE_H
2 #define DALI_TOOLKIT_INTERNAL_TRANSITION_BASE_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/controls/control.h>
23 #include <dali-toolkit/public-api/transition/transition-base.h>
24 #include <dali-toolkit/public-api/transition/transition-set.h>
27 #include <dali/public-api/animation/animation.h>
28 #include <dali/public-api/object/base-object.h>
29 #include <dali/public-api/object/property-map.h>
37 using TransitionBasePtr = IntrusivePtr<TransitionBase>;
39 class TransitionBase : public BaseObject
43 * @brief Create a new TransitionBase object.
44 * @return A smart-pointer to the newly allocated TransitionBase.
46 static TransitionBasePtr New();
49 * @copydoc Dali::Toolkit::TransitionBase::SetTimePeriod()
51 void SetTimePeriod(const Dali::TimePeriod& timePeriod);
54 * @copydoc Dali::Toolkit::TransitionBase::GetTimePeriod()
56 Dali::TimePeriod GetTimePeriod() const;
59 * @copydoc Dali::Toolkit::TransitionBase::SetAlphaFunction()
61 void SetAlphaFunction(AlphaFunction alphaFunction)
63 mAlphaFunction = alphaFunction;
67 * @copydoc Dali::Toolkit::TransitionBase::GetAlphaFunction()
69 AlphaFunction GetAlphaFunction() const
71 return mAlphaFunction;
75 * @copydoc Dali::Toolkit::TransitionBase::TransitionWithChild()
77 void TransitionWithChild(bool transitionWithChild);
80 * @brief Run processes those are required done before size/position negotiation.
81 * @param[in] animation animation for the transition
83 void PreProcess(Dali::Animation animation);
86 * @brief Make property animation for Transition
91 * Emit the Finished signal
93 void TransitionFinished();
96 * @brief Set this transition is appearing transition or not.
97 * @param[in] appearingTransition True if this transition is appearing transition.
99 void SetAppearingTransition(bool appearingTransition)
101 mIsAppearingTransition = appearingTransition;
107 * @brief Set property map which will be used as a animation start properties.
108 * @param[in] propertyMap propertyMap that will be used as a start value of transition.
110 void SetStartPropertyMap(const Property::Map& propertyMap)
112 mStartPropertyMap = propertyMap;
116 * @brief Set property map which will be used as a animation finish properties.
117 * @param[in] propertyMap propertyMap that will be used as a finish value of transition.
119 void SetFinishPropertyMap(const Property::Map& propertyMap)
121 mFinishPropertyMap = propertyMap;
125 * @brief Retrieve animation.
127 Dali::Animation GetAnimation()
133 * @brief Set target which will be transition.
134 * @param[in] target control that will be transition.
136 void SetTarget(Dali::Toolkit::Control target)
142 * @brief Gets world transform of input Actor.
143 * @param[in] actor actor for get world transform.
145 Matrix GetWorldTransform(Dali::Actor actor);
148 * @brief Gets world color of input Actor.
149 * @param[in] actor actor for get world color.
151 Vector4 GetWorldColor(Dali::Actor actor);
154 * @brief Returns whether this transition will be applied to children of target or not.
156 bool IsTransitionWithChild() const
158 return mTransitionWithChild;
162 * @brief Returns whether this transition is appearing transition or not
164 bool IsAppearingTransition() const
166 return mIsAppearingTransition;
170 * @brief Set whether this transition is a transition from a Control to another Control or effect to appearing or disappearing.
171 * @param[in] pairTransition True if this transition is appearing transition.
173 void SetPairTransition(bool pairTransition)
175 mIsPairTransition = pairTransition;
179 * @brief Returns whether this transition is a transition from a Control to another Control or effect to appearing or disappearing.
181 bool IsPairTransition() const
183 return mIsPairTransition;
188 * Construct a new TransitionBase.
193 * Second-phase constructor.
200 ~TransitionBase() = default;
204 TransitionBase(const TransitionBase&);
207 TransitionBase& operator=(const TransitionBase& rhs);
211 * @brief Makes property animation for transition.
216 * @brief Adds a property on an animation between sourceValue and destimationValue.
217 * @param[in] target target control to be animated.
218 * @param[in] index property index for animation.
219 * @param[in] sourceValue source value of animation.
220 * @param[in] destinationValue destination value of animation.
222 void AnimateBetween(Dali::Toolkit::Control target, Property::Index index, Property::Value sourceValue, Property::Value destinationValue);
225 * @brief Copy target to make clone for the child Actors
230 * @brief Make pair of Property::Map to be used for transition animation.
231 * Set the pair of Property::Map by using SetStartPropertyMap() and SetFinishPropertyMap(),
232 * then the properties of mTarget will be animated between them during transition duration.
233 * If the transition requires the information of world transform, let them be in this method.
234 * World transform and World color can be retrieved by using GetWorldTransform() and GetWorldColor() methods.
235 * And If it is needed to add additional custom animation than use GetAnimation() and add them.
237 * @note Do not set any properties in this methods.
239 virtual void OnPlay()
244 * @brief If the transition is needed to do something after the transition is finished, let them be in this method.
246 virtual void OnFinished()
251 Dali::Toolkit::Control mTarget; ///< Target that will be animated.
252 Dali::Actor mCopiedActor; ///< Copied View that will replace mTarget during transition
253 Dali::Animation mAnimation; ///< Property animations for the transition of mTarget
254 AlphaFunction mAlphaFunction; ///< Alpha function that will applied for the property animation
255 Property::Map mStartPropertyMap; ///< Start properties to be animated. (world transform)
256 Property::Map mFinishPropertyMap; ///< Finish properties to be animated. (world transform)
257 Property::Map mOriginalPropertyMap; ///< Original properties of mTarget to be used to restore after the transition is finished.
258 Dali::TimePeriod mTimePeriod; ///< TimePeriod of transition
259 bool mTransitionWithChild; ///< True, if mTarget transition is inherit to its child Actors.
260 ///< If this is false, the child Actors are moved to the child of mCopiedActor that will have original properties of target Actor during Transition.
261 bool mMoveTargetChildren; ///< Flag, if mTransitionWithChild is false and mTarget has children than True.
262 bool mIsAppearingTransition; ///< True, if this transition is appearing transition.
263 bool mIsPairTransition; ///< True, if this transition is started from a Control to another Control.
266 } // namespace Internal
268 // Helpers for public-api forwarding methods
270 inline Internal::TransitionBase& GetImplementation(Dali::Toolkit::TransitionBase& animation)
272 DALI_ASSERT_ALWAYS(animation && "TransitionBase handle is empty");
274 BaseObject& handle = animation.GetBaseObject();
276 return static_cast<Internal::TransitionBase&>(handle);
279 inline const Internal::TransitionBase& GetImplementation(const Dali::Toolkit::TransitionBase& animation)
281 DALI_ASSERT_ALWAYS(animation && "TransitionBase handle is empty");
283 const BaseObject& handle = animation.GetBaseObject();
285 return static_cast<const Internal::TransitionBase&>(handle);
288 } // namespace Toolkit
292 #endif // DALI_TOOLKIT_INTERNAL_TRANSITION_BASE_H