Kanzi  3.9.2
Java API
AnimationPlayerMetadata Interface Reference

Metadata definitions for AnimationPlayer. More...

Inheritance diagram for AnimationPlayerMetadata:
[legend]

Classes

interface  CompletedMessageArguments
 Metadata definitions for CompletedMessageArguments. More...
 
interface  PauseMessageArguments
 Metadata definitions for PauseMessageArguments. More...
 
interface  PlayMessageArguments
 Metadata definitions for PlayMessageArguments. More...
 
interface  ResumeMessageArguments
 Metadata definitions for ResumeMessageArguments. More...
 
interface  StartedMessageArguments
 Metadata definitions for StartedMessageArguments. More...
 
interface  StopMessageArguments
 Metadata definitions for StopMessageArguments. More...
 
interface  StoppedMessageArguments
 Metadata definitions for StoppedMessageArguments. More...
 

Public Attributes

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...
 

Detailed Description

Metadata definitions for AnimationPlayer.

Member Data Documentation

◆ AutoplayEnabledProperty

DynamicPropertyType<Boolean> AutoplayEnabledProperty
Initial value:
=
new DynamicPropertyType<>("AnimationPlayer.AutoplayEnabled", Boolean.class)

Specifies whether animation player should start playback of its timeline automatically when it is attached to the node.

◆ CompletedMessage

AbstractMessageType CompletedMessage
Initial value:
=
new AbstractMessageType("Message.AnimationPlayer.Completed")

Occurs when animation player completes animation playback.

◆ DurationScaleProperty

DynamicPropertyType<Float> DurationScaleProperty
Initial value:
=
new DynamicPropertyType<>("AnimationPlayer.DurationScale", Float.class)

Specifies how much duration of the timeline is scaled during its playback.

◆ PlaybackModeProperty

DynamicPropertyType<Integer> PlaybackModeProperty
Initial value:
=
new DynamicPropertyType<>("AnimationPlayer.PlaybackMode", Integer.class)

Specifies the mode of timeline playback (normal, reverse, pingpong).

◆ RelativePlaybackProperty

DynamicPropertyType<Boolean> RelativePlaybackProperty
Initial value:
=
new DynamicPropertyType<>("AnimationPlayer.RelativePlayback", Boolean.class)

Specifies whether animations are played in relative manner by adding animated value to target property value instead of replacing the property value.

◆ RepeatCountProperty

DynamicPropertyType<Integer> RepeatCountProperty
Initial value:
=
new DynamicPropertyType<>("AnimationPlayer.RepeatCount", Integer.class)

Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats).

◆ RestoreOriginalValuesAfterPlaybackProperty

DynamicPropertyType<Boolean> RestoreOriginalValuesAfterPlaybackProperty
Initial value:
=
new DynamicPropertyType<>(
"AnimationPlayer.RestoreOriginalValuesAfterPlayback", Boolean.class)

Specifies whether animated properties return to their initial values after playback of the timeline ends.

◆ TimelineProperty

DynamicPropertyType<Resource> TimelineProperty
Initial value:
=
new DynamicPropertyType<>("AnimationPlayer.Timeline", Resource.class)

The target animation timeline.