1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H__
5 * Copyright (c) 2014 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/internal/common/owner-container.h>
23 #include <dali/internal/event/animation/key-frames-impl.h>
24 #include <dali/internal/event/animation/path-impl.h>
25 #include <dali/internal/update/nodes/node.h>
26 #include <dali/internal/update/common/property-base.h>
27 #include <dali/public-api/animation/alpha-function.h>
28 #include <dali/public-api/animation/animation.h>
29 #include <dali/public-api/animation/time-period.h>
30 #include <dali/public-api/common/constants.h>
31 #include <dali/public-api/common/dali-common.h>
32 #include <dali/public-api/math/quaternion.h>
33 #include <dali/public-api/math/radian.h>
41 typedef Dali::Animation::Interpolation Interpolation;
43 struct AnimatorFunctionBase;
50 typedef OwnerContainer< AnimatorBase* > AnimatorContainer;
52 typedef AnimatorContainer::Iterator AnimatorIter;
53 typedef AnimatorContainer::ConstIterator AnimatorConstIter;
56 * An abstract base class for Animators, which can be added to scene graph animations.
57 * Each animator changes a single property of an object in the scene graph.
63 typedef float (*AlphaFunc)(float progress); ///< Definition of an alpha function
69 : mDurationSeconds(1.0f),
70 mInitialDelaySeconds(0.0f),
71 mAlphaFunction(AlphaFunction::DEFAULT),
72 mDisconnectAction(Dali::Animation::BakeFinal),
81 virtual ~AnimatorBase()
86 * Set the duration of the animator.
87 * @pre durationSeconds must be zero or greater; zero is useful when animating boolean values.
88 * @param [in] seconds Duration in seconds.
90 void SetDuration(float seconds)
92 DALI_ASSERT_DEBUG(seconds >= 0.0f);
94 mDurationSeconds = seconds;
98 * Retrieve the duration of the animator.
99 * @return The duration in seconds.
103 return mDurationSeconds;
107 * Set the delay before the animator should take effect.
108 * The default is zero i.e. no delay.
109 * @param [in] seconds The delay in seconds.
111 void SetInitialDelay(float seconds)
113 mInitialDelaySeconds = seconds;
117 * Retrieve the initial delay of the animator.
118 * @return The delay in seconds.
120 float GetInitialDelay()
122 return mInitialDelaySeconds;
126 * Set the alpha function for an animator.
127 * @param [in] alphaFunc The alpha function to apply to the animation progress.
129 void SetAlphaFunction(const AlphaFunction& alphaFunction)
131 mAlphaFunction = alphaFunction;
135 * Retrieve the alpha function of an animator.
136 * @return The function.
138 AlphaFunction GetAlphaFunction() const
140 return mAlphaFunction;
144 * Applies the alpha function to the specified progress
145 * @param[in] Current progress
146 * @return The progress after the alpha function has been aplied
148 float ApplyAlphaFunction( float progress ) const
150 float result = progress;
152 AlphaFunction::Mode alphaFunctionMode( mAlphaFunction.GetMode() );
153 if( alphaFunctionMode == AlphaFunction::BUILTIN_FUNCTION )
155 switch(mAlphaFunction.GetBuiltinFunction())
157 case AlphaFunction::DEFAULT:
158 case AlphaFunction::LINEAR:
162 case AlphaFunction::REVERSE:
164 result = 1.0f-progress;
167 case AlphaFunction::EASE_IN_SQUARE:
169 result = progress * progress;
172 case AlphaFunction::EASE_OUT_SQUARE:
174 result = 1.0f - (1.0f-progress) * (1.0f-progress);
177 case AlphaFunction::EASE_IN:
179 result = progress * progress * progress;
182 case AlphaFunction::EASE_OUT:
184 result = (progress-1.0f) * (progress-1.0f) * (progress-1.0f) + 1.0f;
187 case AlphaFunction::EASE_IN_OUT:
189 result = progress*progress*(3.0f-2.0f*progress);
192 case AlphaFunction::EASE_IN_SINE:
194 result = -1.0f * cosf(progress * Math::PI_2) + 1.0f;
197 case AlphaFunction::EASE_OUT_SINE:
199 result = sinf(progress * Math::PI_2);
202 case AlphaFunction::EASE_IN_OUT_SINE:
204 result = -0.5f * (cosf(Math::PI * progress) - 1.0f);
207 case AlphaFunction::BOUNCE:
209 result = sinf(progress * Math::PI);
212 case AlphaFunction::SIN:
214 result = 0.5f - cosf(progress * 2.0f * Math::PI) * 0.5f;
217 case AlphaFunction::EASE_OUT_BACK:
219 const float sqrt2 = 1.70158f;
221 result = 1.0f + progress * progress * ( ( sqrt2 + 1.0f ) * progress + sqrt2 );
224 case AlphaFunction::COUNT:
230 else if( alphaFunctionMode == AlphaFunction::CUSTOM_FUNCTION )
232 AlphaFunctionPrototype customFunction = mAlphaFunction.GetCustomFunction();
235 result = customFunction(progress);
240 //If progress is very close to 0 or very close to 1 we don't need to evaluate the curve as the result will
241 //be almost 0 or almost 1 respectively
242 if( ( progress > Math::MACHINE_EPSILON_1 ) && ((1.0f - progress) > Math::MACHINE_EPSILON_1) )
244 Dali::Vector4 controlPoints = mAlphaFunction.GetBezierControlPoints();
246 static const float tolerance = 0.001f; //10 iteration max
248 //Perform a binary search on the curve
249 float lowerBound(0.0f);
250 float upperBound(1.0f);
251 float currentT(0.5f);
252 float currentX = EvaluateCubicBezier( controlPoints.x, controlPoints.z, currentT);
253 while( fabs( progress - currentX ) > tolerance )
255 if( progress > currentX )
257 lowerBound = currentT;
261 upperBound = currentT;
263 currentT = (upperBound+lowerBound)*0.5f;
264 currentX = EvaluateCubicBezier( controlPoints.x, controlPoints.z, currentT);
266 result = EvaluateCubicBezier( controlPoints.y, controlPoints.w, currentT);
274 * Whether to bake the animation if attached property owner is disconnected.
275 * Property is only baked if the animator is active.
276 * @param [in] action The disconnect action.
278 void SetDisconnectAction( Dali::Animation::EndAction action )
280 mDisconnectAction = action;
284 * Retrieve the disconnect action of an animator.
285 * @return The disconnect action.
287 Dali::Animation::EndAction GetDisconnectAction() const
289 return mDisconnectAction;
293 * Whether the animator is active or not.
294 * @param [in] active The new active state.
295 * @post When the animator becomes active, it applies the disconnect-action if the property owner is then disconnected.
296 * @note When the property owner is disconnected, the active state is set to false.
298 void SetActive( bool active )
304 * Retrieve whether the animator has been set to active or not.
305 * @return The active state.
307 bool GetActive() const
313 * Retrive wheter the animator's target object is valid and on the stage.
314 * @return The enabled state.
316 bool IsEnabled() const
321 * Returns wheter the target object of the animator is still valid
322 * or has been destroyed.
323 * @return True if animator is orphan, false otherwise *
324 * @note The SceneGraph::Animation will delete any orphan animator in its Update method.
326 virtual bool Orphan() = 0;
329 * Update the scene object attached to the animator.
330 * @param[in] bufferIndex The buffer to animate.
331 * @param[in] progress A value from 0 to 1, where 0 is the start of the animation, and 1 is the end point.
332 * @param[in] bake Bake.
334 virtual void Update(BufferIndex bufferIndex, float progress, bool bake) = 0;
339 * Helper function to evaluate a cubic bezier curve assuming first point is at 0.0 and last point is at 1.0
340 * @param[in] p0 First control point of the bezier curve
341 * @param[in] p1 Second control point of the bezier curve
342 * @param[in] t A floating point value between 0.0 and 1.0
343 * @return Value of the curve at progress t
345 inline float EvaluateCubicBezier( float p0, float p1, float t ) const
348 return 3.0f*(1.0f-t)*(1.0f-t)*t*p0 + 3.0f*(1.0f-t)*tSquare*p1 + tSquare*t;
351 float mDurationSeconds;
352 float mInitialDelaySeconds;
354 AlphaFunction mAlphaFunction;
356 Dali::Animation::EndAction mDisconnectAction; ///< EndAction to apply when target object gets disconnected from the stage.
357 bool mActive:1; ///< Animator is "active" while it's running.
358 bool mEnabled:1; ///< Animator is "enabled" while its target object is valid and on the stage.
362 * An animator for a specific property type PropertyType.
364 template < typename PropertyType, typename PropertyAccessorType >
365 class Animator : public AnimatorBase, public PropertyOwner::Observer
370 * Construct a new property animator.
371 * @param[in] property The animatable property; only valid while the Animator is attached.
372 * @param[in] animatorFunction The function used to animate the property.
373 * @param[in] alphaFunction The alpha function to apply.
374 * @param[in] timePeriod The time period of this animation.
375 * @return A newly allocated animator.
377 static AnimatorBase* New( const PropertyOwner& propertyOwner,
378 const PropertyBase& property,
379 AnimatorFunctionBase* animatorFunction,
380 AlphaFunction alphaFunction,
381 const TimePeriod& timePeriod )
383 typedef Animator< PropertyType, PropertyAccessorType > AnimatorType;
385 // The property was const in the actor-thread, but animators are used in the scene-graph thread.
386 AnimatorType* animator = new AnimatorType( const_cast<PropertyOwner*>( &propertyOwner ),
387 const_cast<PropertyBase*>( &property ),
390 animator->SetAlphaFunction( alphaFunction );
391 animator->SetInitialDelay( timePeriod.delaySeconds );
392 animator->SetDuration( timePeriod.durationSeconds );
398 * Virtual destructor.
404 mPropertyOwner->RemoveObserver(*this);
407 if( mAnimatorFunction )
409 delete mAnimatorFunction;
414 * Called when mPropertyOwner is connected to the scene graph.
416 virtual void PropertyOwnerConnected( PropertyOwner& owner )
422 * Called when mPropertyOwner is disconnected from the scene graph.
424 virtual void PropertyOwnerDisconnected( BufferIndex bufferIndex, PropertyOwner& owner )
426 // If we are active, then bake the value if required
427 if ( mActive && mDisconnectAction != Dali::Animation::Discard )
429 // Bake to target-value if BakeFinal, otherwise bake current value
430 Update( bufferIndex, ( mDisconnectAction == Dali::Animation::Bake ? mCurrentProgress : 1.0f ), true );
438 * Called shortly before mPropertyOwner is destroyed
440 virtual void PropertyOwnerDestroyed( PropertyOwner& owner )
442 mPropertyOwner = NULL;
443 mPropertyAccessor.Reset();
450 virtual void Update( BufferIndex bufferIndex, float progress, bool bake )
452 float alpha = ApplyAlphaFunction(progress);
454 const PropertyType& current = mPropertyAccessor.Get( bufferIndex );
456 const PropertyType result = (*mAnimatorFunction)( alpha, current );
459 mPropertyAccessor.Bake( bufferIndex, result );
463 mPropertyAccessor.Set( bufferIndex, result );
466 mCurrentProgress = progress;
472 virtual bool Orphan()
474 return (mPropertyOwner == NULL);
480 * Private constructor; see also Animator::New().
482 Animator( PropertyOwner* propertyOwner,
483 PropertyBase* property,
484 AnimatorFunctionBase* animatorFunction )
485 : mPropertyOwner( propertyOwner ),
486 mPropertyAccessor( property ),
487 mAnimatorFunction( animatorFunction ),
488 mCurrentProgress( 0.0f )
490 mPropertyOwner->AddObserver(*this);
494 Animator( const Animator& );
497 Animator& operator=( const Animator& );
501 PropertyOwner* mPropertyOwner;
502 PropertyAccessorType mPropertyAccessor;
504 AnimatorFunctionBase* mAnimatorFunction;
505 float mCurrentProgress;
508 } // namespace SceneGraph
511 * AnimatorFunction base class.
512 * All update functions must inherit from AnimatorFunctionBase and overload the appropiate "()" operator
514 struct AnimatorFunctionBase
519 AnimatorFunctionBase(){}
522 * Virtual destructor (Intended as base class)
524 virtual ~AnimatorFunctionBase(){}
526 ///Stub "()" operators.
527 virtual bool operator()(float progress, const bool& property)
532 virtual float operator()(float progress, const int& property)
537 virtual float operator()(float progress, const unsigned int& property)
542 virtual float operator()(float progress, const float& property)
547 virtual Vector2 operator()(float progress, const Vector2& property)
552 virtual Vector3 operator()(float progress, const Vector3& property)
557 virtual Vector4 operator()(float progress, const Vector4& property)
562 virtual Quaternion operator()(float progress, const Quaternion& property)
570 struct AnimateByInteger : public AnimatorFunctionBase
572 AnimateByInteger(const int& relativeValue)
573 : mRelative(relativeValue)
577 float operator()(float alpha, const int& property)
579 return int(property + mRelative * alpha + 0.5f );
585 struct AnimateToInteger : public AnimatorFunctionBase
587 AnimateToInteger(const int& targetValue)
588 : mTarget(targetValue)
592 float operator()(float alpha, const int& property)
594 return int(property + ((mTarget - property) * alpha) + 0.5f);
600 struct AnimateByFloat : public AnimatorFunctionBase
602 AnimateByFloat(const float& relativeValue)
603 : mRelative(relativeValue)
607 float operator()(float alpha, const float& property)
609 return float(property + mRelative * alpha);
615 struct AnimateToFloat : public AnimatorFunctionBase
617 AnimateToFloat(const float& targetValue)
618 : mTarget(targetValue)
622 float operator()(float alpha, const float& property)
624 return float(property + ((mTarget - property) * alpha));
630 struct AnimateByVector2 : public AnimatorFunctionBase
632 AnimateByVector2(const Vector2& relativeValue)
633 : mRelative(relativeValue)
637 Vector2 operator()(float alpha, const Vector2& property)
639 return Vector2(property + mRelative * alpha);
645 struct AnimateToVector2 : public AnimatorFunctionBase
647 AnimateToVector2(const Vector2& targetValue)
648 : mTarget(targetValue)
652 Vector2 operator()(float alpha, const Vector2& property)
654 return Vector2(property + ((mTarget - property) * alpha));
660 struct AnimateByVector3 : public AnimatorFunctionBase
662 AnimateByVector3(const Vector3& relativeValue)
663 : mRelative(relativeValue)
667 Vector3 operator()(float alpha, const Vector3& property)
669 return Vector3(property + mRelative * alpha);
675 struct AnimateToVector3 : public AnimatorFunctionBase
677 AnimateToVector3(const Vector3& targetValue)
678 : mTarget(targetValue)
682 Vector3 operator()(float alpha, const Vector3& property)
684 return Vector3(property + ((mTarget - property) * alpha));
690 struct AnimateByVector4 : public AnimatorFunctionBase
692 AnimateByVector4(const Vector4& relativeValue)
693 : mRelative(relativeValue)
697 Vector4 operator()(float alpha, const Vector4& property)
699 return Vector4(property + mRelative * alpha);
705 struct AnimateToVector4 : public AnimatorFunctionBase
707 AnimateToVector4(const Vector4& targetValue)
708 : mTarget(targetValue)
712 Vector4 operator()(float alpha, const Vector4& property)
714 return Vector4(property + ((mTarget - property) * alpha));
720 struct AnimateByOpacity : public AnimatorFunctionBase
722 AnimateByOpacity(const float& relativeValue)
723 : mRelative(relativeValue)
727 Vector4 operator()(float alpha, const Vector4& property)
729 Vector4 result(property);
730 result.a += mRelative * alpha;
738 struct AnimateToOpacity : public AnimatorFunctionBase
740 AnimateToOpacity(const float& targetValue)
741 : mTarget(targetValue)
745 Vector4 operator()(float alpha, const Vector4& property)
747 Vector4 result(property);
748 result.a = property.a + ((mTarget - property.a) * alpha);
756 struct AnimateByBoolean : public AnimatorFunctionBase
758 AnimateByBoolean(bool relativeValue)
759 : mRelative(relativeValue)
763 bool operator()(float alpha, const bool& property)
765 // Alpha is not useful here, just keeping to the same template as other update functors
766 return bool(alpha >= 1.0f ? (property || mRelative) : property);
772 struct AnimateToBoolean : public AnimatorFunctionBase
774 AnimateToBoolean(bool targetValue)
775 : mTarget(targetValue)
779 bool operator()(float alpha, const bool& property)
781 // Alpha is not useful here, just keeping to the same template as other update functors
782 return bool(alpha >= 1.0f ? mTarget : property);
788 struct RotateByAngleAxis : public AnimatorFunctionBase
790 RotateByAngleAxis(const Radian& angleRadians, const Vector3& axis)
791 : mAngleRadians( angleRadians ),
792 mAxis(axis.x, axis.y, axis.z)
796 Quaternion operator()(float alpha, const Quaternion& rotation)
800 return rotation * Quaternion(mAngleRadians * alpha, mAxis);
806 Radian mAngleRadians;
810 struct RotateToQuaternion : public AnimatorFunctionBase
812 RotateToQuaternion(const Quaternion& targetValue)
813 : mTarget(targetValue)
817 Quaternion operator()(float alpha, const Quaternion& rotation)
819 return Quaternion::Slerp(rotation, mTarget, alpha);
826 struct KeyFrameBooleanFunctor : public AnimatorFunctionBase
828 KeyFrameBooleanFunctor(KeyFrameBooleanPtr keyFrames)
829 : mKeyFrames(keyFrames)
833 bool operator()(float progress, const bool& property)
835 if(mKeyFrames->IsActive(progress))
837 return mKeyFrames->GetValue(progress, Dali::Animation::Linear);
842 KeyFrameBooleanPtr mKeyFrames;
845 struct KeyFrameIntegerFunctor : public AnimatorFunctionBase
847 KeyFrameIntegerFunctor(KeyFrameIntegerPtr keyFrames, Interpolation interpolation)
848 : mKeyFrames(keyFrames),mInterpolation(interpolation)
852 float operator()(float progress, const int& property)
854 if(mKeyFrames->IsActive(progress))
856 return mKeyFrames->GetValue(progress, mInterpolation);
861 KeyFrameIntegerPtr mKeyFrames;
862 Interpolation mInterpolation;
865 struct KeyFrameNumberFunctor : public AnimatorFunctionBase
867 KeyFrameNumberFunctor(KeyFrameNumberPtr keyFrames, Interpolation interpolation)
868 : mKeyFrames(keyFrames),mInterpolation(interpolation)
872 float operator()(float progress, const float& property)
874 if(mKeyFrames->IsActive(progress))
876 return mKeyFrames->GetValue(progress, mInterpolation);
881 KeyFrameNumberPtr mKeyFrames;
882 Interpolation mInterpolation;
885 struct KeyFrameVector2Functor : public AnimatorFunctionBase
887 KeyFrameVector2Functor(KeyFrameVector2Ptr keyFrames, Interpolation interpolation)
888 : mKeyFrames(keyFrames),mInterpolation(interpolation)
892 Vector2 operator()(float progress, const Vector2& property)
894 if(mKeyFrames->IsActive(progress))
896 return mKeyFrames->GetValue(progress, mInterpolation);
901 KeyFrameVector2Ptr mKeyFrames;
902 Interpolation mInterpolation;
906 struct KeyFrameVector3Functor : public AnimatorFunctionBase
908 KeyFrameVector3Functor(KeyFrameVector3Ptr keyFrames, Interpolation interpolation)
909 : mKeyFrames(keyFrames),mInterpolation(interpolation)
913 Vector3 operator()(float progress, const Vector3& property)
915 if(mKeyFrames->IsActive(progress))
917 return mKeyFrames->GetValue(progress, mInterpolation);
922 KeyFrameVector3Ptr mKeyFrames;
923 Interpolation mInterpolation;
926 struct KeyFrameVector4Functor : public AnimatorFunctionBase
928 KeyFrameVector4Functor(KeyFrameVector4Ptr keyFrames, Interpolation interpolation)
929 : mKeyFrames(keyFrames),mInterpolation(interpolation)
933 Vector4 operator()(float progress, const Vector4& property)
935 if(mKeyFrames->IsActive(progress))
937 return mKeyFrames->GetValue(progress, mInterpolation);
942 KeyFrameVector4Ptr mKeyFrames;
943 Interpolation mInterpolation;
946 struct KeyFrameQuaternionFunctor : public AnimatorFunctionBase
948 KeyFrameQuaternionFunctor(KeyFrameQuaternionPtr keyFrames)
949 : mKeyFrames(keyFrames)
953 Quaternion operator()(float progress, const Quaternion& property)
955 if(mKeyFrames->IsActive(progress))
957 return mKeyFrames->GetValue(progress, Dali::Animation::Linear);
962 KeyFrameQuaternionPtr mKeyFrames;
965 struct PathPositionFunctor : public AnimatorFunctionBase
967 PathPositionFunctor( PathPtr path )
972 Vector3 operator()(float progress, const Vector3& property)
974 return mPath->SamplePosition(progress );
980 struct PathRotationFunctor : public AnimatorFunctionBase
982 PathRotationFunctor( PathPtr path, const Vector3& forward )
986 mForward.Normalize();
989 Quaternion operator()(float progress, const Quaternion& property)
991 Vector3 tangent( mPath->SampleTangent(progress) );
992 return Quaternion( mForward, tangent );
1000 } // namespace Internal
1004 #endif // __DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H__