Kanzi  3.9.2
Java API
AnimationPlayer Class Reference

Controls animation playback. More...

Inheritance diagram for AnimationPlayer:
[legend]

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...
 
boolean isStale ()
 Test if the object is stale i.e. 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...
 
AbstractMessageType CompletedMessage
 Occurs when 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.
 
AbstractMessageType PauseMessage = new AbstractMessageType("Message.AnimationPlayer.Pause")
 Instructs animation player to pause animation playback.
 
DynamicPropertyType< Integer > PlaybackModeProperty
 Specifies the mode of timeline playback (normal, reverse, pingpong). More...
 
AbstractMessageType PlayMessage = new AbstractMessageType("Message.AnimationPlayer.Play")
 Instructs animation player to start animation playback with new parameters.
 
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...
 
AbstractMessageType ResumeMessage = new AbstractMessageType("Message.AnimationPlayer.Resume")
 Instructs animation player to resume animation playback if it is paused or to start the playback if it is stopped.
 
AbstractMessageType StartedMessage = new AbstractMessageType("Message.AnimationPlayer.Started")
 Occurs when animation player starts animation playback.
 
AbstractMessageType StopMessage = new AbstractMessageType("Message.AnimationPlayer.Stop")
 Instructs animation player to stop animation playback.
 
AbstractMessageType StoppedMessage = new AbstractMessageType("Message.AnimationPlayer.Stopped")
 Occurs when animation player stops animation playback.
 
DynamicPropertyType< ResourceTimelineProperty
 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...
 
Node.MessageSubscriptionToken addNodeComponentMessageHandler (MessageType messageType, Node.MessageSubscriptionFunction messageHandlerFunction)
 Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...
 
void attachOverride ()
 Called when the Trigger is attached to a node.
 
void detachOverride ()
 Called when a Trigger is detached from a Node.
 
void dispatchMessage (MessageType messageType, MessageArguments arguments)
 Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...
 
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

Controls animation playback.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static