Module animation_player
Modules§
Structs§
- AUTOPLAY_
ENABLED_ PROPERTY - Specifies whether animation player should start playback of its timeline automatically when it is attached to the node.
- Animation
Player - 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.
- COMPLETED
- Occurs when an Animation Player completes animation playback.
- Completed
Message Arguments - DURATION_
SCALE_ PROPERTY - Specifies how much duration of the timeline is scaled during its playback.
- INode
Component Base - NAME_
PROPERTY - Name
- Node
Component - NodeComponent is the base class for all node components. Node component is an isolated piece of logic which can be attached to any node in order to add additional functionality to it. Examples of node component could be Trigger which performs specific actions when certain conditions are met or AnimationPlayer which animates specific properties of the node it is attached to and its child nodes.
- Node
Component Message Arguments - Node
Component Source Message Arguments - PAUSE
- Instructs an Animation Player to pause animation playback.
- PLAY
- Instructs an Animation Player to start animation playback with new parameters.
- PLAYBACK_
MODE_ PROPERTY - Specifies the mode of timeline playback (normal, reverse, pingpong).
- Pause
Message Arguments - Play
Message Arguments - RELATIVE_
PLAYBACK_ PROPERTY - Specifies whether animations are played in relative manner by adding animated value to target property value instead of replacing the property value.
- REPEAT_
COUNT_ PROPERTY - Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats).
- RESTORE_
ORIGINAL_ VALUES_ AFTER_ PLAYBACK_ PROPERTY - Specifies whether animated properties return to their initial values after playback of the timeline ends.
- RESUME
- Instructs an Animation Player to resume animation playback if it is paused or to start the playback if it is stopped.
- Resume
Message Arguments - STARTED
- Occurs when an Animation Player starts animation playback.
- STOP
- Instructs an Animation Player to stop animation playback.
- STOPPED
- Occurs when an Animation Player stops animation playback.
- Started
Message Arguments - Stop
Message Arguments - Stopped
Message Arguments - TIMELINE_
PROPERTY - The target animation timeline.
Enums§
- Node
Component State - Legacy version of enum “kanzi.NodeComponent.State”. State indicating if component is attached to a node, detached from any node or in process of attaching/detaching.