X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Finternal%2Fupdate%2Fanimation%2Fscene-graph-animator.h;h=cbf0842ad713b758ae12f07d7bd8f1fedddf952a;hb=55827866fcb8c7ee47581ac4335a3390472090e8;hp=b8da716b87f3eaf6dc78b489a044881e80180cca;hpb=7ee7b82e5ab4c99f36bf3c70ba5ebdc436bf4dce;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/internal/update/animation/scene-graph-animator.h b/dali/internal/update/animation/scene-graph-animator.h old mode 100644 new mode 100755 index b8da716..cbf0842 --- a/dali/internal/update/animation/scene-graph-animator.h +++ b/dali/internal/update/animation/scene-graph-animator.h @@ -1,8 +1,8 @@ -#ifndef __DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H__ -#define __DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H__ +#ifndef DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H +#define DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H /* - * Copyright (c) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,12 +18,10 @@ * */ +// EXTERNAL INCLUDES +#include + // INTERNAL INCLUDES -#include -#include -#include -#include -#include #include #include #include @@ -31,6 +29,11 @@ #include #include #include +#include +#include +#include +#include +#include #include #include @@ -40,29 +43,74 @@ namespace Dali namespace Internal { -typedef Dali::Animation::Interpolation Interpolation; - -struct AnimatorFunctionBase; +using Interpolation = Dali::Animation::Interpolation; -namespace SceneGraph +/** + * AnimatorFunction base class. + * Needs to be declared first so AnimatorBase knows about it's destructor + * All update functions must inherit from AnimatorFunctionBase and overload the appropiate "()" operator + */ +struct AnimatorFunctionBase { + /** + * Constructor + */ + AnimatorFunctionBase() {} + + /* + * Virtual destructor (Intended as base class) + */ + virtual ~AnimatorFunctionBase() {} + + ///Stub "()" operators. + virtual bool operator()(float progress, const bool& property) + { + return property; + } + + virtual float operator()(float progress, const int32_t& property) + { + return static_cast( property ); + } + + virtual float operator()(float progress, const float& property) + { + return property; + } + + virtual Vector2 operator()(float progress, const Vector2& property) + { + return property; + } -class AnimatorBase; + virtual Vector3 operator()(float progress, const Vector3& property) + { + return property; + } -typedef OwnerContainer< AnimatorBase* > AnimatorContainer; + virtual Vector4 operator()(float progress, const Vector4& property) + { + return property; + } + + virtual Quaternion operator()(float progress, const Quaternion& property) + { + return property; + } +}; -typedef AnimatorContainer::Iterator AnimatorIter; -typedef AnimatorContainer::ConstIterator AnimatorConstIter; +namespace SceneGraph +{ /** * An abstract base class for Animators, which can be added to scene graph animations. * Each animator changes a single property of an object in the scene graph. */ -class AnimatorBase +class AnimatorBase : public PropertyOwner::Observer { public: - typedef float (*AlphaFunc)(float progress); ///< Definition of an alpha function + using AlphaFunc = float (*)(float progress); ///< Definition of an alpha function /** * Observer to determine when the animator is no longer present @@ -86,17 +134,23 @@ public: /** * Constructor. */ - AnimatorBase() - : mLifecycleObserver(nullptr), - mDurationSeconds(1.0f), - mIntervalDelaySeconds(0.0f), - mSpeedFactor(1.0f), - mLoopCount(1), - mAlphaFunction(AlphaFunction::DEFAULT), - mDisconnectAction(Dali::Animation::BakeFinal), - mActive(false), - mEnabled(true), - mConnectedToSceneGraph(false), + AnimatorBase( PropertyOwner* propertyOwner, + AnimatorFunctionBase* animatorFunction, + AlphaFunction alphaFunction, + const TimePeriod& timePeriod ) + : mLifecycleObserver( nullptr ), + mPropertyOwner( propertyOwner ), + mAnimatorFunction( animatorFunction ), + mDurationSeconds( timePeriod.durationSeconds ), + mIntervalDelaySeconds( timePeriod.delaySeconds ), + mSpeedFactor( 1.0f ), + mCurrentProgress( 0.f ), + mLoopCount( 1 ), + mAlphaFunction( alphaFunction ), + mDisconnectAction( Dali::Animation::BakeFinal ), + mAnimationPlaying( false ), + mEnabled( true ), + mConnectedToSceneGraph( false ), mAutoReverseEnabled( false ) { } @@ -106,6 +160,11 @@ public: */ virtual ~AnimatorBase() { + delete mAnimatorFunction; + if (mPropertyOwner && mConnectedToSceneGraph) + { + mPropertyOwner->RemoveObserver(*this); + } if( mLifecycleObserver != nullptr ) { mLifecycleObserver->ObjectDestroyed(); @@ -122,10 +181,48 @@ public: mLifecycleObserver = nullptr; } +private: // From PropertyOwner::Observer + + /** + * @copydoc PropertyOwner::Observer::PropertyOwnerConnected( PropertyOwner& owner ) + */ + void PropertyOwnerConnected( PropertyOwner& owner ) override final + { + mEnabled = true; + } + + /** + * @copydoc PropertyOwner::Observer::PropertyOwnerDisconnected( BufferIndex bufferIndex, PropertyOwner& owner ) + */ + void PropertyOwnerDisconnected( BufferIndex bufferIndex, PropertyOwner& owner ) override final + { + // If we are active, then bake the value if required + if ( mAnimationPlaying && mDisconnectAction != Dali::Animation::Discard ) + { + // Bake to target-value if BakeFinal, otherwise bake current value + Update( bufferIndex, ( mDisconnectAction == Dali::Animation::Bake ? mCurrentProgress : 1.0f ), true ); + } + + mEnabled = false; + } + + /** + * @copydoc PropertyOwner::Observer::PropertyOwnerDestroyed( PropertyOwner& owner ) + */ + void PropertyOwnerDestroyed( PropertyOwner& owner ) override final + { + mPropertyOwner = nullptr; + } + +public: /** * Called when Animator is added to the scene-graph in update-thread. */ - virtual void ConnectToSceneGraph() = 0; + void ConnectToSceneGraph() + { + mConnectedToSceneGraph = true; + mPropertyOwner->AddObserver(*this); + } /** * Set the duration of the animator. @@ -153,7 +250,7 @@ public: mSpeedFactor = factor; } - void SetLoopCount(int loopCount) + void SetLoopCount(int32_t loopCount) { mLoopCount = loopCount; } @@ -329,7 +426,7 @@ public: float upperBound(1.0f); float currentT(0.5f); float currentX = EvaluateCubicBezier( controlPoints.x, controlPoints.z, currentT); - while( fabs( progress - currentX ) > tolerance ) + while( fabsf( progress - currentX ) > tolerance ) { if( progress > currentX ) { @@ -376,20 +473,11 @@ public: */ void SetActive( bool active ) { - mActive = active; + mAnimationPlaying = active; } /** - * Retrieve whether the animator has been set to active or not. - * @return The active state. - */ - bool GetActive() const - { - return mActive; - } - - /** - * Retrive wheter the animator's target object is valid and on the stage. + * Whether the animator's target object is valid and on the stage. * @return The enabled state. */ bool IsEnabled() const @@ -412,7 +500,10 @@ public: * @return True if animator is orphan, false otherwise * * @note The SceneGraph::Animation will delete any orphan animator in its Update method. */ - virtual bool Orphan() = 0; + bool Orphan() + { + return (mPropertyOwner == nullptr); + } /** * Update the scene object attached to the animator. @@ -420,7 +511,34 @@ public: * @param[in] progress A value from 0 to 1, where 0 is the start of the animation, and 1 is the end point. * @param[in] bake Bake. */ - virtual void Update(BufferIndex bufferIndex, float progress, bool bake) = 0; + void Update( BufferIndex bufferIndex, float progress, bool bake ) + { + if( mLoopCount >= 0 ) + { + // Update the progress value + progress = SetProgress( progress ); + } + + if( mPropertyOwner ) + { + mPropertyOwner->SetPropertyDirty( true ); + } + + float alpha = ApplyAlphaFunction( progress ); + + // PropertyType specific part + DoUpdate( bufferIndex, bake, alpha ); + + mCurrentProgress = progress; + } + + /** + * Type specific part of the animator + * @param bufferIndex index to use + * @param bake whether to bake or not + * @param alpha value from alpha based on progress + */ + virtual void DoUpdate( BufferIndex bufferIndex, bool bake, float alpha ) = 0; protected: @@ -438,16 +556,19 @@ protected: } LifecycleObserver* mLifecycleObserver; + PropertyOwner* mPropertyOwner; + AnimatorFunctionBase* mAnimatorFunction; float mDurationSeconds; float mIntervalDelaySeconds; float mSpeedFactor; + float mCurrentProgress; - int mLoopCount; + int32_t mLoopCount; AlphaFunction mAlphaFunction; Dali::Animation::EndAction mDisconnectAction; ///< EndAction to apply when target object gets disconnected from the stage. - bool mActive:1; ///< Animator is "active" while it's running. + bool mAnimationPlaying:1; ///< whether disconnect has been applied while it's running. bool mEnabled:1; ///< Animator is "enabled" while its target object is valid and on the stage. bool mConnectedToSceneGraph:1; ///< True if ConnectToSceneGraph() has been called in update-thread. bool mAutoReverseEnabled:1; @@ -457,7 +578,7 @@ protected: * An animator for a specific property type PropertyType. */ template < typename PropertyType, typename PropertyAccessorType > -class Animator : public AnimatorBase, public PropertyOwner::Observer +class Animator : public AnimatorBase { public: @@ -475,18 +596,12 @@ public: AlphaFunction alphaFunction, const TimePeriod& timePeriod ) { - typedef Animator< PropertyType, PropertyAccessorType > AnimatorType; - // The property was const in the actor-thread, but animators are used in the scene-graph thread. - AnimatorType* animator = new AnimatorType( const_cast( &propertyOwner ), - const_cast( &property ), - animatorFunction ); - - animator->SetAlphaFunction( alphaFunction ); - animator->SetIntervalDelay( timePeriod.delaySeconds ); - animator->SetDuration( timePeriod.durationSeconds ); - - return animator; + return new Animator( const_cast( &propertyOwner ), + const_cast( &property ), + animatorFunction, + alphaFunction, + timePeriod ); } /** @@ -494,71 +609,18 @@ public: */ virtual ~Animator() { - if (mPropertyOwner && mConnectedToSceneGraph) - { - mPropertyOwner->RemoveObserver(*this); - } - - delete mAnimatorFunction; } /** - * Called when Animator is added to the scene-graph in update-thread. + * @copydoc AnimatorBase::DoUpdate( BufferIndex bufferIndex, bool bake, float alpha ) */ - virtual void ConnectToSceneGraph() + virtual void DoUpdate( BufferIndex bufferIndex, bool bake, float alpha ) override final { - mConnectedToSceneGraph = true; - mPropertyOwner->AddObserver(*this); - } - - /** - * Called when mPropertyOwner is connected to the scene graph. - */ - virtual void PropertyOwnerConnected( PropertyOwner& owner ) - { - mEnabled = true; - } - - /** - * Called when mPropertyOwner is disconnected from the scene graph. - */ - virtual void PropertyOwnerDisconnected( BufferIndex bufferIndex, PropertyOwner& owner ) - { - // If we are active, then bake the value if required - if ( mActive && mDisconnectAction != Dali::Animation::Discard ) - { - // Bake to target-value if BakeFinal, otherwise bake current value - Update( bufferIndex, ( mDisconnectAction == Dali::Animation::Bake ? mCurrentProgress : 1.0f ), true ); - } - - mActive = false; - mEnabled = false; - } - - /** - * Called shortly before mPropertyOwner is destroyed - */ - virtual void PropertyOwnerDestroyed( PropertyOwner& owner ) - { - mPropertyOwner = NULL; - } - - /** - * From AnimatorBase. - */ - virtual void Update( BufferIndex bufferIndex, float progress, bool bake ) - { - if( mLoopCount >= 0 ) - { - // Update the progress value - progress = SetProgress( progress ); - } - - float alpha = ApplyAlphaFunction( progress ); - const PropertyType& current = mPropertyAccessor.Get( bufferIndex ); - const PropertyType result = (*mAnimatorFunction)( alpha, current ); + // need to cast the return value in case property is integer + const PropertyType result = static_cast( (*mAnimatorFunction)( alpha, current ) ); + if ( bake ) { mPropertyAccessor.Bake( bufferIndex, result ); @@ -567,16 +629,6 @@ public: { mPropertyAccessor.Set( bufferIndex, result ); } - - mCurrentProgress = progress; - } - - /** - * From AnimatorBase. - */ - virtual bool Orphan() - { - return (mPropertyOwner == NULL); } private: @@ -586,11 +638,11 @@ private: */ Animator( PropertyOwner* propertyOwner, PropertyBase* property, - AnimatorFunctionBase* animatorFunction ) - : mPropertyOwner( propertyOwner ), - mPropertyAccessor( property ), - mAnimatorFunction( animatorFunction ), - mCurrentProgress( 0.0f ) + AnimatorFunctionBase* animatorFunction, + AlphaFunction alphaFunction, + const TimePeriod& timePeriod ) + : AnimatorBase( propertyOwner, animatorFunction, alphaFunction, timePeriod ), + mPropertyAccessor( property ) { // WARNING - this object is created in the event-thread // The scene-graph mPropertyOwner object cannot be observed here @@ -604,11 +656,8 @@ private: protected: - PropertyOwner* mPropertyOwner; PropertyAccessorType mPropertyAccessor; - AnimatorFunctionBase* mAnimatorFunction; - float mCurrentProgress; }; @@ -616,8 +665,8 @@ protected: /** * An animator for a specific property type PropertyType. */ -template -class AnimatorTransformProperty : public AnimatorBase, public PropertyOwner::Observer +template +class AnimatorTransformProperty : public AnimatorBase { public: @@ -637,15 +686,11 @@ public: { // The property was const in the actor-thread, but animators are used in the scene-graph thread. - AnimatorTransformProperty* animator = new AnimatorTransformProperty( const_cast( &propertyOwner ), - const_cast( &property ), - animatorFunction ); - - animator->SetAlphaFunction( alphaFunction ); - animator->SetIntervalDelay( timePeriod.delaySeconds ); - animator->SetDuration( timePeriod.durationSeconds ); - - return animator; + return new AnimatorTransformProperty( const_cast( &propertyOwner ), + const_cast( &property ), + animatorFunction, + alphaFunction, + timePeriod ); } /** @@ -653,72 +698,17 @@ public: */ virtual ~AnimatorTransformProperty() { - if (mPropertyOwner && mConnectedToSceneGraph) - { - mPropertyOwner->RemoveObserver(*this); - } - - delete mAnimatorFunction; - } - - /** - * Called when Animator is added to the scene-graph in update-thread. - */ - virtual void ConnectToSceneGraph() - { - mConnectedToSceneGraph = true; - mPropertyOwner->AddObserver(*this); } /** - * Called when mPropertyOwner is connected to the scene graph. + * @copydoc AnimatorBase::DoUpdate( BufferIndex bufferIndex, bool bake, float alpha ) */ - virtual void PropertyOwnerConnected( PropertyOwner& owner ) + virtual void DoUpdate( BufferIndex bufferIndex, bool bake, float alpha ) override final { - mEnabled = true; - } - - /** - * Called when mPropertyOwner is disconnected from the scene graph. - */ - virtual void PropertyOwnerDisconnected( BufferIndex bufferIndex, PropertyOwner& owner ) - { - // If we are active, then bake the value if required - if ( mActive && mDisconnectAction != Dali::Animation::Discard ) - { - // Bake to target-value if BakeFinal, otherwise bake current value - Update( bufferIndex, ( mDisconnectAction == Dali::Animation::Bake ? mCurrentProgress : 1.0f ), true ); - } - - mActive = false; - mEnabled = false; - } - - /** - * Called shortly before mPropertyOwner is destroyed - */ - virtual void PropertyOwnerDestroyed( PropertyOwner& owner ) - { - mPropertyOwner = NULL; - } - - /** - * From AnimatorBase. - */ - virtual void Update( BufferIndex bufferIndex, float progress, bool bake ) - { - if( mLoopCount >= 0 ) - { - // Update the progress value - progress = SetProgress( progress ); - } - - float alpha = ApplyAlphaFunction( progress ); - - const T& current = mPropertyAccessor.Get( bufferIndex ); - - const T result = (*mAnimatorFunction)( alpha, current ); + const PropertyType& current = mPropertyAccessor.Get( bufferIndex ); + // need to cast the return value in case property is integer + const PropertyType result = static_cast( (*mAnimatorFunction)( alpha, current ) ); if ( bake ) { @@ -728,16 +718,6 @@ public: { mPropertyAccessor.Set( bufferIndex, result ); } - - mCurrentProgress = progress; - } - - /** - * From AnimatorBase. - */ - virtual bool Orphan() - { - return (mPropertyOwner == NULL); } private: @@ -747,91 +727,29 @@ private: */ AnimatorTransformProperty( PropertyOwner* propertyOwner, PropertyBase* property, - AnimatorFunctionBase* animatorFunction ) - : mPropertyOwner( propertyOwner ), - mPropertyAccessor( property ), - mAnimatorFunction( animatorFunction ), - mCurrentProgress( 0.0f ) + AnimatorFunctionBase* animatorFunction, + AlphaFunction alphaFunction, + const TimePeriod& timePeriod ) + : AnimatorBase( propertyOwner, animatorFunction, alphaFunction, timePeriod ), + mPropertyAccessor( property ) { // WARNING - this object is created in the event-thread // The scene-graph mPropertyOwner object cannot be observed here } // Undefined - AnimatorTransformProperty( const AnimatorTransformProperty& ); - - // Undefined - AnimatorTransformProperty& operator=( const AnimatorTransformProperty& ); + AnimatorTransformProperty() = delete; + AnimatorTransformProperty( const AnimatorTransformProperty& ) = delete; + AnimatorTransformProperty& operator=( const AnimatorTransformProperty& ) = delete; protected: - PropertyOwner* mPropertyOwner; PropertyAccessorType mPropertyAccessor; - AnimatorFunctionBase* mAnimatorFunction; - float mCurrentProgress; }; } // namespace SceneGraph -/* - * AnimatorFunction base class. - * All update functions must inherit from AnimatorFunctionBase and overload the appropiate "()" operator - */ -struct AnimatorFunctionBase -{ - /** - * Constructor - */ - AnimatorFunctionBase(){} - - /* - * Virtual destructor (Intended as base class) - */ - virtual ~AnimatorFunctionBase(){} - - ///Stub "()" operators. - virtual bool operator()(float progress, const bool& property) - { - return property; - } - - virtual float operator()(float progress, const int& property) - { - return property; - } - - virtual float operator()(float progress, const unsigned int& property) - { - return property; - } - - virtual float operator()(float progress, const float& property) - { - return property; - } - - virtual Vector2 operator()(float progress, const Vector2& property) - { - return property; - } - - virtual Vector3 operator()(float progress, const Vector3& property) - { - return property; - } - - virtual Vector4 operator()(float progress, const Vector4& property) - { - return property; - } - - virtual Quaternion operator()(float progress, const Quaternion& property) - { - return property; - } -}; - // Update functions struct AnimateByInteger : public AnimatorFunctionBase @@ -842,12 +760,13 @@ struct AnimateByInteger : public AnimatorFunctionBase } using AnimatorFunctionBase::operator(); - float operator()(float alpha, const int& property) + float operator()(float alpha, const int32_t& property) { - return int(property + mRelative * alpha + 0.5f ); + // integers need to be correctly rounded + return roundf(static_cast( property ) + static_cast( mRelative ) * alpha ); } - int mRelative; + int32_t mRelative; }; struct AnimateToInteger : public AnimatorFunctionBase @@ -858,12 +777,13 @@ struct AnimateToInteger : public AnimatorFunctionBase } using AnimatorFunctionBase::operator(); - float operator()(float alpha, const int& property) + float operator()(float alpha, const int32_t& property) { - return int(property + ((mTarget - property) * alpha) + 0.5f); + // integers need to be correctly rounded + return roundf(static_cast( property ) + (static_cast(mTarget - property) * alpha) ); } - int mTarget; + int32_t mTarget; }; struct AnimateByFloat : public AnimatorFunctionBase @@ -1134,13 +1054,13 @@ struct KeyFrameIntegerFunctor : public AnimatorFunctionBase } using AnimatorFunctionBase::operator(); - float operator()(float progress, const int& property) + float operator()(float progress, const int32_t& property) { if(mKeyFrames->IsActive(progress)) { - return mKeyFrames->GetValue(progress, mInterpolation); + return static_cast( mKeyFrames->GetValue(progress, mInterpolation) ); } - return property; + return static_cast( property ); } KeyFrameIntegerPtr mKeyFrames; @@ -1301,4 +1221,4 @@ struct PathRotationFunctor : public AnimatorFunctionBase } // namespace Dali -#endif // __DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H__ +#endif // DALI_INTERNAL_SCENE_GRAPH_ANIMATOR_H