NodeAnimationPlayback Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits from: | Node |
This class is used to play animation tracks (.utrack). It enables you to clone animated objects in the hierarchy, as well as to convert prepared animations and objects into NodeReferences. Each AnimationPlayback node adds overrides for its internal playback to animation objects (animation tracks are not copied).
NodeAnimationPlayback Class
Members
int isPlaying() const#
Returns the current value indicating if the playback is currently being played.
Return value
Current the playback is currently being playedvoid setLoop ( int loop ) #
Sets a new value indicating if the playback is looped.
Arguments
- int loop - The the playback is looped
int isLoop() const#
Returns the current value indicating if the playback is looped.
Return value
Current the playback is loopedvoid setSpeed ( float speed ) #
Sets a new speed factor for the animation playback. This parameter enables you to control how fast the particular playback should be played giving you more flexibility and control (for example, you can use it for slow-motion effect).
Arguments
- float speed - The playback speed factor (the value of 2 means that the track is played 2 times faster, while 0.5f will slow it down 2 times).
float getSpeed() const#
Returns the current speed factor for the animation playback. This parameter enables you to control how fast the particular playback should be played giving you more flexibility and control (for example, you can use it for slow-motion effect).
Return value
Current playback speed factor (the value of 2 means that the track is played 2 times faster, while 0.5f will slow it down 2 times).void setTrackFileGUID ( UGUID guid ) #
Sets a new GUID of the .utrack file.
Arguments
- UGUID guid - The GUID of the .utrack file.
UGUID getTrackFileGUID() const#
Returns the current GUID of the .utrack file.
Return value
Current GUID of the .utrack file.void setTrackPath ( string path ) #
Sets a new path to the .utrack file.
Arguments
- string path - The path to the .utrack file.
const char * getTrackPath() const#
Returns the current path to the .utrack file.
Return value
Current path to the .utrack file.void setPlayOnEnable ( int enable ) #
Sets a new value indicating if the playback is started on enabling the node.
Arguments
- int enable - The the playback is resumed on enabling the node
int isPlayOnEnable() const#
Returns the current value indicating if the playback is started on enabling the node.
Return value
Current the playback is resumed on enabling the nodevoid setRestartOnEnable ( int enable ) #
Sets a new value indicating if the playback is restarted on enabling the node.
Arguments
- int enable - The the playback is restarted on enabling the node
int isRestartOnEnable() const#
Returns the current value indicating if the playback is restarted on enabling the node.
Return value
Current the playback is restarted on enabling the nodevoid setTimeFrom ( float from ) #
Sets a new playback start time, in seconds.
Arguments
- float from - The playback start time, in seconds.
float getTimeFrom() const#
Returns the current playback start time, in seconds.
Return value
Current playback start time, in seconds.void setTimeTo ( float to ) #
Sets a new playback end time, in seconds.
Arguments
- float to - The playback end time, in seconds.
float getTimeTo() const#
Returns the current playback end time, in seconds.
Return value
Current playback end time, in seconds.static NodeAnimationPlayback ( ) #
Constructor. Creates an instance of the class with default parameters.static int type ( ) #
Returns the type of the node.Return value
NodeAnimationPlayback type identifier.void play ( ) #
Plays the animation playback either from the start or from the moment when the playback was paused (see pause()).void pause ( ) #
Pauses the animation playback, so the playback can be resumed from this moment upon calling play().void stop ( ) #
Stops the animation playback.void setTime ( float time, float from = -1.0f, float to = -1.0f ) #
Sets the current playback time, and optional from and to limits.Arguments
- float time - Current playback time to be set, in seconds.
- float from - Start time to be set, in seconds.
- float to - End time to be set, in seconds.
float getTime ( ) #
Returns the current playback time, in seconds.Return value
Current playback time, in seconds.The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)