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
- const Ptr<AnimationModifierInfo> & info - Description of an animation modifier.
void removeInfo ( const Ptr<AnimationModifierInfo> & info ) #
Removes the specified animation modifier description from the mask.Arguments
- const Ptr<AnimationModifierInfo> & info - Description of an animation modifier to be removed.
bool containsInfo ( const Ptr<AnimationModifierInfo> & info ) const#
Returns a value indicating if the mask contains the specified animation modifier description.Arguments
- const Ptr<AnimationModifierInfo> & info - Description of an animation modifier to be checked.
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:
2023-11-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)