Kanzi  3.9.6
Java API
AnimationPlayerMetadata Interface Reference

Metadata definitions for AnimationPlayer. More...

Inheritance diagram for AnimationPlayerMetadata:
[legend]

Classes

class  CompletedMessageArguments
 Metadata definitions for CompletedMessageArguments. More...
 
class  PauseMessageArguments
 Metadata definitions for PauseMessageArguments. More...
 
class  PlayMessageArguments
 Metadata definitions for PlayMessageArguments. More...
 
class  ResumeMessageArguments
 Metadata definitions for ResumeMessageArguments. More...
 
class  StartedMessageArguments
 Metadata definitions for StartedMessageArguments. More...
 
class  StopMessageArguments
 Metadata definitions for StopMessageArguments. More...
 
class  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...
 
DynamicMessageType< AnimationPlayerMetadata.CompletedMessageArguments > 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.
 
DynamicMessageType< AnimationPlayerMetadata.PauseMessageArguments > PauseMessage
 Instructs animation player to pause animation playback. More...
 
DynamicPropertyType< Integer > PlaybackModeProperty
 Specifies the mode of timeline playback (normal, reverse, pingpong). More...
 
DynamicMessageType< AnimationPlayerMetadata.PlayMessageArguments > PlayMessage
 Instructs 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 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 animation player starts animation playback. More...
 
DynamicMessageType< AnimationPlayerMetadata.StopMessageArguments > StopMessage
 Instructs animation player to stop animation playback. More...
 
DynamicMessageType< AnimationPlayerMetadata.StoppedMessageArguments > StoppedMessage
 Occurs when animation player stops animation playback. More...
 
DynamicPropertyType< ResourceTimelineProperty
 The target animation timeline. More...
 
- Public Attributes inherited from NodeComponentMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NodeComponent")
 Metaclass for NodeComponent.
 
DynamicPropertyType< String > NameProperty
 Name. 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

DynamicMessageType<AnimationPlayerMetadata.CompletedMessageArguments> CompletedMessage
Initial value:
=
new DynamicMessageType<>("Message.AnimationPlayer.Completed",
AnimationPlayerMetadata.CompletedMessageArguments.class)

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.

◆ PauseMessage

DynamicMessageType<AnimationPlayerMetadata.PauseMessageArguments> PauseMessage
Initial value:
=
new DynamicMessageType<>(
"Message.AnimationPlayer.Pause", AnimationPlayerMetadata.PauseMessageArguments.class)

Instructs animation player to pause animation playback.

◆ PlaybackModeProperty

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

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

◆ PlayMessage

DynamicMessageType<AnimationPlayerMetadata.PlayMessageArguments> PlayMessage
Initial value:
=
new DynamicMessageType<>(
"Message.AnimationPlayer.Play", AnimationPlayerMetadata.PlayMessageArguments.class)

Instructs animation player to start animation playback with new parameters.

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

◆ ResumeMessage

DynamicMessageType<AnimationPlayerMetadata.ResumeMessageArguments> ResumeMessage
Initial value:
=
new DynamicMessageType<>(
"Message.AnimationPlayer.Resume", AnimationPlayerMetadata.ResumeMessageArguments.class)

Instructs animation player to resume animation playback if it is paused or to start the playback if it is stopped.

◆ StartedMessage

DynamicMessageType<AnimationPlayerMetadata.StartedMessageArguments> StartedMessage
Initial value:
=
new DynamicMessageType<>("Message.AnimationPlayer.Started",
AnimationPlayerMetadata.StartedMessageArguments.class)

Occurs when animation player starts animation playback.

◆ StopMessage

DynamicMessageType<AnimationPlayerMetadata.StopMessageArguments> StopMessage
Initial value:
=
new DynamicMessageType<>(
"Message.AnimationPlayer.Stop", AnimationPlayerMetadata.StopMessageArguments.class)

Instructs animation player to stop animation playback.

◆ StoppedMessage

DynamicMessageType<AnimationPlayerMetadata.StoppedMessageArguments> StoppedMessage
Initial value:
=
new DynamicMessageType<>("Message.AnimationPlayer.Stopped",
AnimationPlayerMetadata.StoppedMessageArguments.class)

Occurs when animation player stops animation playback.

◆ TimelineProperty

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

The target animation timeline.