AnimationPlayer Class Reference

Use the Animation Player to play back an animation timeline that you set using the TimelineProperty property in that Animation Player. More...

Inheritance diagram for AnimationPlayer:

Static Public Member Functions
static ObjectRef< AnimationPlayer >	create (Domain domain, String name)
	Creates animation player. More...

Static Public Attributes
static final Metaclass	metaclass
	The Metaclass for the class. More...
Static Public Attributes inherited from NodeComponent
static final Metaclass	metaclass
	The Metaclass for the class. More...
Static Public Attributes inherited from KanziObject
static final Metaclass	metaclass = new AbstractMetaclass("Kanzi.Object")
	The Metaclass for the class.

Additional Inherited Members
Public Member Functions inherited from NodeComponent
void	close ()
	Close the object, and release native resources.
String	getName ()
	Gets the value of NameProperty. More...
Node	getNode ()
	Returns the node the node component is attached to or null if node component is not attached to a node. More...
NodeComponentState	getState ()
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
boolean	isAttached ()
	Indicates whether node component is attached to a node. More...
boolean	isAttaching ()
	Indicates whether node component is in the process of attaching to a node. More...
boolean	isAttachingOrAttached ()
	Indicates whether node component is in the process of attaching to a node or already attached. More...
boolean	isDetached ()
	Indicates whether node component is detached from any node. More...
boolean	isDetaching ()
	Indicates whether node component currently detaching from the node. More...
boolean	isDetachingOrDetached ()
	Indicates whether node component is in the process of detaching from the node or already detached. More...
void	setName (String value)
	Sets the value of NameProperty. More...
Public Member Functions inherited from KanziObject
boolean	equals (Object object)
Domain	getDomain ()
	Returns the domain the object belongs to. More...
Metaclass	getDynamicMetaclass ()
	Returns the metaclass of the dynamic type of the object. More...
long	getNative ()
	Gets a pointer to the backing C++ instance. More...
TDataType	getOptionalProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. More...
TDataType	getProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type. More...
int	hashCode ()
boolean	hasValue (PropertyType< TDataType > propertyType)
	Evaluates whether there are any inputs into the property value. More...
boolean	isStale ()
	Test if the object is stale i.e. More...
void	removeLocalValue (PropertyType< TDataType > propertyType)
	Removes the local value associated with the property. More...
void	setProperty (PropertyType< TDataType > propertyType, TDataType value)
	Sets the local value of a property type. More...
ObjectRef< TType >	tryCreateObjectRef (Class< TType > clazz)
	Tries to create an owning ObjectRef instance to this KanziObject. More...
Public Attributes inherited from NodeComponentMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.NodeComponent")
	Metaclass for NodeComponent.
DynamicPropertyType< String >	NameProperty
	Name. More...
Public Attributes inherited from AnimationPlayerMetadata
DynamicPropertyType< Boolean >	AutoplayEnabledProperty
	Specifies whether animation player should start playback of its timeline automatically when it is attached to the node. More...
DynamicMessageType< AnimationPlayerMetadata.CompletedMessageArguments >	CompletedMessage
	Occurs when an Animation Player completes animation playback. More...
DynamicPropertyType< Float >	DurationScaleProperty
	Specifies how much duration of the timeline is scaled during its playback. More...
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.AnimationPlayer")
	Metaclass for AnimationPlayer.
DynamicMessageType< AnimationPlayerMetadata.PauseMessageArguments >	PauseMessage
	Instructs an Animation Player to pause animation playback. More...
DynamicPropertyType< KzuTimeLineEntryPlaybackMode >	PlaybackModeProperty
	Specifies the mode of timeline playback (normal, reverse, pingpong). More...
DynamicMessageType< AnimationPlayerMetadata.PlayMessageArguments >	PlayMessage
	Instructs an Animation Player to start animation playback with new parameters. More...
DynamicPropertyType< Boolean >	RelativePlaybackProperty
	Specifies whether animations are played in relative manner by adding animated value to target property value instead of replacing the property value. More...
DynamicPropertyType< Integer >	RepeatCountProperty
	Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats). More...
DynamicPropertyType< Boolean >	RestoreOriginalValuesAfterPlaybackProperty
	Specifies whether animated properties return to their initial values after playback of the timeline ends. More...
DynamicMessageType< AnimationPlayerMetadata.ResumeMessageArguments >	ResumeMessage
	Instructs an Animation Player to resume animation playback if it is paused or to start the playback if it is stopped. More...
DynamicMessageType< AnimationPlayerMetadata.StartedMessageArguments >	StartedMessage
	Occurs when an Animation Player starts animation playback. More...
DynamicMessageType< AnimationPlayerMetadata.StopMessageArguments >	StopMessage
	Instructs an Animation Player to stop animation playback. More...
DynamicMessageType< AnimationPlayerMetadata.StoppedMessageArguments >	StoppedMessage
	Occurs when an Animation Player stops animation playback. More...
DynamicPropertyType< Resource >	TimelineProperty
	The target animation timeline. More...
Protected Member Functions inherited from NodeComponent
	NodeComponent (Domain domain, long handle, Metaclass metaclass)
	Wraps a given native Node Component. More...
void	attachOverride ()
	Called when the Trigger is attached to a node.
void	detachOverride ()
	Called when a Trigger is detached from a Node.
void	initialize ()
	Initializes the Node Component.
void	removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token)
	Removes message handler added via NodeComponent#addNodeComponentMessageHandler function. More...
Static Protected Member Functions inherited from NodeComponent
static< Derived extends NodeComponent > ObjectRef< Derived >	createDerived (Domain domain, String name, Metaclass metaclass)
	Creates a derived class instance. More...

Detailed Description

Use the Animation Player to play back an animation timeline that you set using the TimelineProperty property in that Animation Player.

Kanzi resolves paths to animated nodes relative to the node where you attach an Animation Player.

Member Function Documentation

static ObjectRef<AnimationPlayer> create ( Domain  domain, String  name  )

static

Creates animation player.

Parameters

domain	Domain.
name	Name of animation player.

Returns

animation player.

Member Data Documentation

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.AnimationPlayerMetadata.metaclass

The Metaclass for the class.