This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
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
Double Precision Coordinates
API
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::AnimationMask Class

Warning
The functionality described here is EXPERIMENTAL and is not recommended for production use. Future releases may bring significant changes to API and features. Backward compatibility of the final production-ready version is not guaranteed.
Header: #include <UnigineAnimation.h>

This class enables you to manage animation masks. A mask is a set of objects and modifiers operated by a track.

AnimationMask Class

Members

bool isEmpty() const#

Returns the current value indicating if the mask is empty.

Return value

true if the mask is empty; otherwise false.

getNumModifiers() const#

Returns the current number of modifiers that belong to the mask.

Return value

Current number of modifiers that belong to the mask.

AnimationMask ( ) #

Constructor. Creates an empty AnimationMask with default parameters.

void addInfo ( const Ptr<AnimationModifierInfo> & info ) #

Adds a new animation modifier description to the mask.

Arguments

void removeInfo ( const Ptr<AnimationModifierInfo> & info ) #

Removes the specified animation modifier description from the mask.

Arguments

bool containsInfo ( const Ptr<AnimationModifierInfo> & info ) const#

Returns a value indicating if the mask contains the specified animation modifier description.

Arguments

Return value

true if the mask contains the specified animation modifier description; otherwise, false.

Ptr<AnimationModifierInfo> getInfoByIndex ( int index ) const#

Returns a description of the animation modifier with the specified index.

Arguments

  • int index - Animation modifier description index.

Return value

Description of an animation modifier with the specified index.
Last update: 2024-04-19
Build: ()