This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
VR Development
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::NodeAnimationPlayback Class

Header: #include <UnigineNodes.h>
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

bool isPlaying() const#

Returns the current value indicating if the playback is currently being played.

Return value

true if the playback is currently being played; otherwise false.

void setTime ( float time ) #

Sets a new playback start time, in seconds.

Arguments

  • float time - The playback start time, in seconds.

float getTime() const#

Returns the current playback start time, in seconds.

Return value

Current playback start time, in seconds.

void setLoop ( bool loop ) #

Sets a new value indicating if the playback is looped.

Arguments

  • bool loop - Set true to enable the playback is looped; false - to disable it.

bool isLoop() const#

Returns the current value indicating if the playback is looped.

Return value

true if the playback is looped; otherwise false.

void 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 ( const UGUID & guid ) #

Sets a new GUID of the .utrack file.

Arguments

  • const UGUID & guid - The GUID of the .utrack file.

const UGUID & getTrackFileGUID() const#

Returns the current GUID of the .utrack file.

Return value

Current GUID of the .utrack file.

void setTrackPath ( const char * path ) #

Sets a new path to the .utrack file.

Arguments

  • const char * 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 ( bool enable ) #

Sets a new value indicating if the playback is started on enabling the node.

Arguments

  • bool enable - Set true to enable the playback is resumed on enabling the node; false - to disable it.

bool isPlayOnEnable() const#

Returns the current value indicating if the playback is started on enabling the node.

Return value

true if the playback is resumed on enabling the node; otherwise false.

void setRestartOnEnable ( bool enable ) #

Sets a new value indicating if the playback is restarted on enabling the node.

Arguments

  • bool enable - Set true to enable the playback is restarted on enabling the node; false - to disable it.

bool isRestartOnEnable() const#

Returns the current value indicating if the playback is restarted on enabling the node.

Return value

true if the playback is restarted on enabling the node; otherwise false.

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.
Last update: 2023-11-29
Build: ()