Dali::Animation can be used to animate the properties of any number of objects, typically Actors. More...

Inheritance diagram for Dali::Animation:

Public Types
enum	EndAction
	Enumeration for what to do when the animation ends, is stopped, or is destroyed. More...
enum	Interpolation
	Enumeration for what interpolation method to use on key-frame animations. More...
enum	State
	Enumeration for what state the animation is in. More...
enum	LoopingMode
	Enumeration for what looping mode is in. More...
typedef Signal< void(Animation &) >	AnimationSignalType
	Animation finished signal type.
typedef Any	AnyFunction
	Interpolation function.
Public Member Functions
	Animation ()
	Creates an uninitialized Animation; this can be initialized with Animation::New().
	~Animation ()
	Destructor.
	Animation (const Animation &handle)
	This copy constructor is required for (smart) pointer semantics.
Animation &	operator= (const Animation &rhs)
	This assignment operator is required for (smart) pointer semantics.
void	SetDuration (float seconds)
	Sets the duration of an animation.
float	GetDuration () const
	Retrieves the duration of an animation.
void	SetLooping (bool looping)
	Sets whether the animation will loop.
void	SetLoopCount (int count)
	Enables looping for 'count' repeats.
int	GetLoopCount ()
	Gets the loop count.
int	GetCurrentLoop ()
	Gets the current loop count.
bool	IsLooping () const
	Queries whether the animation will loop.
void	SetEndAction (EndAction action)
	Sets the end action of the animation.
EndAction	GetEndAction () const
	Returns the end action of the animation.
void	SetDisconnectAction (EndAction disconnectAction)
	Sets the disconnect action.
EndAction	GetDisconnectAction () const
	Returns the disconnect action.
void	SetDefaultAlphaFunction (AlphaFunction alpha)
	Sets the default alpha function for an animation.
AlphaFunction	GetDefaultAlphaFunction () const
	Retrieves the default alpha function for an animation.
void	SetCurrentProgress (float progress)
	Sets the progress of the animation.
float	GetCurrentProgress ()
	Retrieves the current progress of the animation.
void	SetSpeedFactor (float factor)
	Specifies a speed factor for the animation.
float	GetSpeedFactor () const
	Retrieves the speed factor of the animation.
void	SetPlayRange (const Vector2 &range)
	Sets the playing range.
Vector2	GetPlayRange () const
	Gets the playing range.
void	Play ()
	Play the animation.
void	PlayFrom (float progress)
	Plays the animation from a given point.
void	PlayAfter (float delaySeconds)
	Play the animation after a given delay time.
void	Pause ()
	Pauses the animation.
State	GetState () const
	Queries the state of the animation.
void	Stop ()
	Stops the animation.
void	Clear ()
	Clears the animation.
void	SetLoopingMode (LoopingMode loopingMode)
	Sets the looping mode.
LoopingMode	GetLoopingMode () const
	Gets one of the current looping mode.
AnimationSignalType &	FinishedSignal ()
	Connects to this signal to be notified when an Animation's animations have finished.
void	AnimateBy (Property target, Property::Value relativeValue)
	Animates a property value by a relative amount.
void	AnimateBy (Property target, Property::Value relativeValue, AlphaFunction alpha)
	Animates a property value by a relative amount.
void	AnimateBy (Property target, Property::Value relativeValue, TimePeriod period)
	Animates a property value by a relative amount.
void	AnimateBy (Property target, Property::Value relativeValue, AlphaFunction alpha, TimePeriod period)
	Animates a property value by a relative amount.
void	AnimateTo (Property target, Property::Value destinationValue)
	Animates a property to a destination value.
void	AnimateTo (Property target, Property::Value destinationValue, AlphaFunction alpha)
	Animates a property to a destination value.
void	AnimateTo (Property target, Property::Value destinationValue, TimePeriod period)
	Animates a property to a destination value.
void	AnimateTo (Property target, Property::Value destinationValue, AlphaFunction alpha, TimePeriod period)
	Animates a property to a destination value.
void	AnimateBetween (Property target, KeyFrames &keyFrames)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, Interpolation interpolation)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, AlphaFunction alpha)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, AlphaFunction alpha, Interpolation interpolation)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, TimePeriod period)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, TimePeriod period, Interpolation interpolation)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, AlphaFunction alpha, TimePeriod period)
	Animates a property between keyframes.
void	AnimateBetween (Property target, KeyFrames &keyFrames, AlphaFunction alpha, TimePeriod period, Interpolation interpolation)
	Animates a property between keyframes.
void	Animate (Actor actor, Path path, const Vector3 &forward)
	Animates an actor's position and orientation through a predefined path.
void	Animate (Actor actor, Path path, const Vector3 &forward, AlphaFunction alpha)
	Animates an actor's position and orientation through a predefined path.
void	Animate (Actor actor, Path path, const Vector3 &forward, TimePeriod period)
	Animates an actor's position and orientation through a predefined path.
void	Animate (Actor actor, Path path, const Vector3 &forward, AlphaFunction alpha, TimePeriod period)
	Animates an actor's position and orientation through a predefined path.
void	Show (Actor actor, float delaySeconds)
	Shows an actor during the animation.
void	Hide (Actor actor, float delaySeconds)
	Hides an actor during the animation.
Static Public Member Functions
static Animation	New (float durationSeconds)
	Creates an initialized Animation.
static Animation	DownCast (BaseHandle handle)
	Downcasts a handle to Animation handle.

Detailed Description

Dali::Animation can be used to animate the properties of any number of objects, typically Actors.

An example animation setup is shown below:

 struct MyProgram
 {
   Actor mActor; // The object we wish to animate
   Animation mAnimation; // Keep this to control the animation
 }

 // ...To play the animation

 mAnimation = Animation::New(3.0f); // duration 3 seconds
 mAnimation.AnimateTo(Property(mActor, Actor::Property::POSITION), Vector3(10.0f, 50.0f, 0.0f));
 mAnimation.Play();

Dali::Animation supports "fire and forget" behaviour i.e. an animation continues to play if the handle is discarded. Note that in the following example, the "Finish" signal will be emitted:

 void ExampleCallback( Animation& source )
 {
   std::cout << "Animation has finished" << std::endl;
 }

 void ExampleAnimation( Actor actor )
 {
   Animation animation = Animation::New(2.0f); // duration 2 seconds
   animation.AnimateTo(Property(actor, Actor::Property::POSITION), 10.0f, 50.0f, 0.0f);
   animation.FinishedSignal().Connect( ExampleCallback );
   animation.Play();
 } // At this point the animation handle has gone out of scope

 Actor actor = Actor::New();
 Stage::GetCurrent().Add( actor );

 // Fire animation and forget about it
 ExampleAnimation( actor );

 // However the animation will continue, and "Animation has finished" will be printed after 2 seconds.

If the "Finish" signal is connected to a member function of an object, it must be disconnected before the object is destroyed. This is typically done in the object destructor, and requires either the Dali::Connection object or Dali::Animation handle to be stored.

The overall animation time is superseded by the values given in the TimePeriod structure used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and Animate() methods. If any of the individual calls to those functions exceeds the overall animation time, then the overall animation time is automatically extended.

Using AnimateTo and AnimateBy for the same property of the same Actor will yield undefined behaviour especially if the TimePeriod overlaps.

After calling Animation::Play(), Handle::GetProperty will return the target value of the animated property.

Signals | Signal Name | Method | |--------------|--------------------------| | finished | FinishedSignal() |

Actions | Action Name | Animation method called | |--------------|--------------------------| | play | Play() | | stop | Stop() | | pause | Pause() |

Since:: 2.4, DALi version 1.0.0

Member Typedef Documentation

typedef Signal< void (Animation&) > Dali::Animation::AnimationSignalType

Animation finished signal type.

Since:: 2.4, DALi version 1.0.0

typedef Any Dali::Animation::AnyFunction

Interpolation function.

Since:: 2.4, DALi version 1.0.0

Member Enumeration Documentation

enum Dali::Animation::EndAction

Enumeration for what to do when the animation ends, is stopped, or is destroyed.

Since:: 2.4, DALi version 1.0.0

Enumerator:

Bake

When the animation ends, the animated property values are saved.

Since:: 2.4, DALi version 1.0.0

Discard

When the animation ends, the animated property values are forgotten.

Since:: 2.4, DALi version 1.0.0

BakeFinal

If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Bake.

Since:: 2.4, DALi version 1.0.0

enum Dali::Animation::Interpolation

Enumeration for what interpolation method to use on key-frame animations.

Since:: 2.4, DALi version 1.0.0

Enumerator:

Linear

Values in between key frames are interpolated using a linear polynomial. (Default)

Since:: 2.4, DALi version 1.0.0

Cubic

Values in between key frames are interpolated using a cubic polynomial.

Since:: 2.4, DALi version 1.0.0

enum Dali::Animation::LoopingMode

Enumeration for what looping mode is in.

Since:: 4.0, DALi version 1.2.60

Enumerator:

RESTART

When the animation arrives at the end in looping mode, the animation restarts from the beginning.

Since:: 4.0, DALi version 1.2.60

AUTO_REVERSE

When the animation arrives at the end in looping mode, the animation reverses direction and runs backwards again.

Since:: 4.0, DALi version 1.2.60

enum Dali::Animation::State

Enumeration for what state the animation is in.

Note: Calling Reset() on this class will NOT reset the animation. It will call BaseHandle::Reset() which drops the object handle.

Since:: 3.0, DALi version 1.1.21

Enumerator:

STOPPED

Animation has stopped.

Since:: 3.0, DALi version 1.1.21

PLAYING

The animation is playing.

Since:: 3.0, DALi version 1.1.21

PAUSED

The animation is paused.

Since:: 3.0, DALi version 1.1.21

Constructor & Destructor Documentation

Dali::Animation::Animation ( )

Creates an uninitialized Animation; this can be initialized with Animation::New().

Calling member functions with an uninitialized Animation handle is not allowed.

Since:: 2.4, DALi version 1.0.0

Dali::Animation::~Animation ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:: 2.4, DALi version 1.0.0

Dali::Animation::Animation ( const Animation & handle )

This copy constructor is required for (smart) pointer semantics.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in] handle A reference to the copied handle

Member Function Documentation

void Dali::Animation::Animate	(	Actor	actor,
		Path	path,
		const Vector3 &	forward
	)

Animates an actor's position and orientation through a predefined path.

The actor will rotate to orient the supplied forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in]	actor	The actor to animate
[in]	path	The path. It defines position and orientation
[in]	forward	The vector (in local space coordinate system) that will be oriented with the path's tangent direction

void Dali::Animation::Animate	(	Actor	actor,
		Path	path,
		const Vector3 &	forward,
		AlphaFunction	alpha
	)

Animates an actor's position and orientation through a predefined path.

The actor will rotate to orient the supplied forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in]	actor	The actor to animate
[in]	path	The path. It defines position and orientation
[in]	forward	The vector (in local space coordinate system) that will be oriented with the path's tangent direction
[in]	alpha	The alpha function to apply

void Dali::Animation::Animate	(	Actor	actor,
		Path	path,
		const Vector3 &	forward,
		TimePeriod	period
	)

Animates an actor's position and orientation through a predefined path.

The actor will rotate to orient the supplied forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in]	actor	The actor to animate
[in]	path	The path. It defines position and orientation
[in]	forward	The vector (in local space coordinate system) that will be oriented with the path's tangent direction
[in]	period	The effect will occur during this time period

void Dali::Animation::Animate	(	Actor	actor,
		Path	path,
		const Vector3 &	forward,
		AlphaFunction	alpha,
		TimePeriod	period
	)

Animates an actor's position and orientation through a predefined path.

The actor will rotate to orient the supplied forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in]	actor	The actor to animate
[in]	path	The path. It defines position and orientation
[in]	forward	The vector (in local space coordinate system) that will be oriented with the path's tangent direction
[in]	alpha	The alpha function to apply
[in]	period	The effect will occur during this time period

void Dali::Animation::AnimateBetween	(	Property	target,
		KeyFrames &	keyFrames
	)