Class Animation

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

API Level:

3

Animation can be used to animate the properties of any number of objects, typically view.
If the "Finished" event 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 animation handle to be stored.
The overall animation time is superseded by the values given in the animation time used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.
If any of the individual calls to those functions exceeds the overall animation time (Duration), then the overall animation time is automatically extended.

public class Animation : BaseHandle, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable

Inheritance

Object

Tizen.NUI.Binding.BindableObject

Tizen.NUI.Binding.Element

BaseHandle

Animation

Implements

INotifyPropertyChanged

IDisposable

Constructors

Animation()

Creates an initialized animation.
The animation will not loop.
The default end action is "Cancel".
The default alpha function is linear.

Declaration

public Animation()

API Level: 3

Animation(Int32)

Creates an initialized animation.
The animation will not loop.
The default end action is "Cancel".
The default alpha function is linear.

Declaration

public Animation(int durationMilliSeconds)

Parameters

Type	Name	Description
Int32	durationMilliSeconds	The duration in milliseconds.

Remarks

DurationmSeconds must be greater than zero.

API Level: 3

Properties

CurrentLoop

Gets the current loop count.
A value 0 indicating the current loop count when looping.

Declaration

public int CurrentLoop { get; }

Property Value

Type	Description
Int32

API Level: 3

CurrentProgress

Gets or sets the progress of the animation.
The animation will play (or continue playing) from this point.
The progress must be in the 0-1 interval or in the play range interval if defined
otherwise, it will be ignored.

Declaration

public float CurrentProgress { get; set; }

Property Value

Type	Description
Single

API Level: 3

DefaultAlphaFunction

Gets or sets the default alpha function for the animation.

Declaration

public AlphaFunction DefaultAlphaFunction { get; set; }

Property Value

Type	Description
AlphaFunction

API Level: 3

DestValue

Gets or sets the destination value for each property of the animation.

Declaration

public string[] DestValue { get; set; }

Property Value

Type	Description
String[]

DisconnectAction

Gets or sets the disconnect action.
If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed.
The default action is cancel.

Declaration

public Animation.EndActions DisconnectAction { get; set; }

Property Value

Type	Description
Animation.EndActions

API Level: 3

Duration

Gets or sets the duration in milliseconds of the animation.

Declaration

public int Duration { get; set; }

Property Value

Type	Description
Int32

API Level: 3

EndAction

Gets or sets the end action of the animation.
This action is performed when the animation ends or if it is stopped.
The default end action is cancel.

Declaration

public Animation.EndActions EndAction { get; set; }

Property Value

Type	Description
Animation.EndActions

API Level: 3

EndTime

Gets or sets the end time for each property of the animation.

Declaration

public int[] EndTime { get; set; }

Property Value

Type	Description
Int32[]

LoopCount

Set: Enables looping for a specified number of repeats. A zero is the same as Looping = true; i.e., repeat forever.
This property resets the looping value and should not be used with the Looping property.
Setting this parameter does not cause the animation to Play().
Get: Gets the loop count. A zero is the same as Looping = true; i.e., repeat forever.
The loop count is initially 1 for play once.

Declaration

public int LoopCount { get; set; }

Property Value

Type	Description
Int32

API Level: 3

Looping

Gets or sets the status of whether the animation will loop.
This property resets the loop count and should not be used with the LoopCount property.
Setting this parameter does not cause the animation to Play().

Declaration

public bool Looping { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

PlayRange

Gets or sets the playing range.
Animation will play between the values specified. Both values (range.x and range.y ) should be between 0-1, otherwise they will be ignored. If the range provided is not in proper order (minimum, maximum ), it will be reordered.

Declaration

public RelativeVector2 PlayRange { get; set; }

Property Value

Type	Description
RelativeVector2

API Level: 3

ProgressNotification

Gets or sets the progress notification marker which triggers the ProgressReachedSignal.
Percentage of animation progress should be greater than 0 and less than 1, for example, 0.3 for 30%
One notification can be set on each animation.

Declaration

public float ProgressNotification { get; set; }

Property Value

Type	Description
Single

API Level: 3

Properties

Gets or sets the properties of the animation.

Declaration

public string[] Properties { get; set; }

Property Value

Type	Description
String[]

SpeedFactor

Gets or sets specificifications of a speed factor for the animation.
The speed factor is a multiplier of the normal velocity of the animation.
Values between [0, 1] will slow down the animation and values above one will speed up the animation.
It is also possible to specify a negative multiplier to play the animation in reverse.

Declaration

public float SpeedFactor { get; set; }

Property Value

Type	Description
Single

API Level: 3

StartTime

Gets or sets the start time for each property of the animation.

Declaration

public int[] StartTime { get; set; }

Property Value

Type	Description
Int32[]

State

Queries the state of the animation.

Declaration

public Animation.States State { get; }

Property Value

Type	Description
Animation.States

API Level: 3

Methods

AnimateBetween(View, String, KeyFrames, Int32, Int32, Animation.Interpolation, AlphaFunction)

Animates a property between keyframes.

Declaration

public void AnimateBetween(View target, string property, KeyFrames keyFrames, int startTime, int endTime, Animation.Interpolation interpolation = Animation.Interpolation.Linear, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	target	The target object to animate
String	property	The target property to animate
KeyFrames	keyFrames	The set of time/value pairs between which to animate
Int32	startTime	The start time of animation in milliseconds.
Int32	endTime	The end time of animation in milliseconds.
Animation.Interpolation	interpolation	The method used to interpolate between values.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimateBetween(View, String, KeyFrames, Animation.Interpolation, AlphaFunction)

Animates a property between keyframes.

Declaration

public void AnimateBetween(View target, string property, KeyFrames keyFrames, Animation.Interpolation interpolation = Animation.Interpolation.Linear, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	target	The target object to animate.
String	property	The target property to animate.
KeyFrames	keyFrames	The set of time or value pairs between which to animate.
Animation.Interpolation	interpolation	The method used to interpolate between values.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimateBy(View, String, Object, Int32, Int32, AlphaFunction)

Animates a property value by a relative amount.

Declaration

public void AnimateBy(View target, string property, object relativeValue, int startTime, int endTime, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	target	The target object to animate.
String	property	The target property to animate.
Object	relativeValue	The property value will change by this amount.
Int32	startTime	The start time of the animation.
Int32	endTime	The end time of the animation.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimateBy(View, String, Object, AlphaFunction)

Animates a property value by a relative amount.

Declaration

public void AnimateBy(View target, string property, object relativeValue, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	target	The target object to animate.
String	property	The target property to animate.
Object	relativeValue	The property value will change by this amount.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimatePath(View, Path, Vector3, Int32, Int32, AlphaFunction)

Animates the view's position and orientation through a predefined path.
The view will rotate to orient the supplied forward vector with the path's tangent.
If forward is the zero vector then no rotation will happen.

Declaration

public void AnimatePath(View view, Path path, Vector3 forward, int startTime, int endTime, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	view	The view to animate.
Path	path	It defines position and orientation.
Vector3	forward	The vector (in local space coordinate system) will be oriented with the path's tangent direction.
Int32	startTime	The start time of the animation.
Int32	endTime	The end time of the animation.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimatePath(View, Path, Vector3, AlphaFunction)

Animates the view's position and orientation through a predefined path.
The view will rotate to orient the supplied forward vector with the path's tangent.
If forward is the zero vector then no rotation will happen.

Declaration

public void AnimatePath(View view, Path path, Vector3 forward, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	view	The view to animate.
Path	path	It defines position and orientation.
Vector3	forward	The vector (in local space coordinate system) will be oriented with the path's tangent direction.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimateTo(View, String, Object, Int32, Int32, AlphaFunction)

Animates a property to a destination value.

Declaration

public void AnimateTo(View target, string property, object destinationValue, int startTime, int endTime, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	target	The target object to animate.
String	property	The target property to animate.
Object	destinationValue	The destination value.
Int32	startTime	The start time of the animation.
Int32	endTime	The end time of the animation.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

AnimateTo(View, String, Object, AlphaFunction)

Animates a property to a destination value.

Declaration

public void AnimateTo(View target, string property, object destinationValue, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
View	target	The target object to animate.
String	property	The target property to animate.
Object	destinationValue	The destination value.
AlphaFunction	alphaFunction	The alpha function to apply.

API Level: 3

Clear()

Clears the animation.
This disconnects any objects that were being animated, effectively stopping the animation.

Declaration

public void Clear()

API Level: 3

Dispose(DisposeTypes)

To make animation instance be disposed.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type

Overrides

BaseHandle.Dispose(DisposeTypes)

API Level: 3

DownCast(BaseHandle)

Downcasts a handle to animation handle.
If handle points to an animation object, the downcast produces a valid handle.
If not, the returned handle is left uninitialized.

Declaration

public static Animation DownCast(BaseHandle handle)

Parameters

Type	Name	Description
BaseHandle	handle	Handle to an object.

Returns

Type	Description
Animation	Handle to an animation object or an uninitialized handle.

API Level: 3

Pause()

Pauses the animation.

Declaration

public void Pause()

API Level: 3

Play()

Plays the animation.

Declaration

public void Play()

API Level: 3

PlayAfter(Int32)

Plays the animation after a given delay time.
The delay time is not included in the looping time.
When the delay time is a negative value, it would treat as play immediately.

Declaration

public void PlayAfter(int delayMilliseconds)

Parameters

Type	Name	Description
Int32	delayMilliseconds	The delay time.

API Level: 4

PlayAnimateTo(View)

Animates one or more properties to a destination value.

Declaration

public void PlayAnimateTo(View target)

Parameters

Type	Name	Description
View	target	The target object to animate.

PlayFrom(Single)

Plays the animation from a given point.
The progress must be in the 0-1 interval or in the play range interval if defined, otherwise, it will be ignored.

Declaration

public void PlayFrom(float progress)

Parameters

Type	Name	Description
Single	progress	A value between [0,1], or between the play range if specified, from where the animation should start playing.

API Level: 3

ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)

Declaration

protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)

Parameters

Type	Name	Description
Tizen.System.Runtime.InteropServices.HandleRef	swigCPtr

Overrides

Tizen.NUI.BaseHandle.ReleaseSwigCPtr(Tizen.System.Runtime.InteropServices.HandleRef)

Stop()

Stops the animation.

Declaration

public void Stop()

API Level: 3

Stop(Animation.EndActions)

Stops the animation.

Declaration

public void Stop(Animation.EndActions action = Animation.EndActions.Cancel)

Parameters

Type	Name	Description
Animation.EndActions	action	The end action can be set.

API Level: 3

Events

Finished

Declaration

public event EventHandler Finished

Event Type

Type	Description
EventHandler

API Level: 3

ProgressReached

Declaration

public event EventHandler ProgressReached

Event Type

Type	Description
EventHandler

API Level: 3

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable