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
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::AnimationModifierQuat 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>
Inherits from: AnimationModifier

AnimationModifierQuat Class

Enums

MODE#

NameDescription
MODE_QUAT = 0Rotation value is obtained from AnimationCurveQuat.
MODE_ANGLES_XYZ = 1Three AnimationCurveFloat curves are used for each angle, and their data are used to compose a quaternion with the {X, Y, Z} order of coordinates.
MODE_ANGLES_ZYX = 2Three AnimationCurveFloat curves are used for each angle, and their data are used to compose a quaternion with the {Z, Y, X} order of coordinates.

Members

AnimationModifierQuat::MODE getMode() const#

Returns the current mode of obtaining the rotation data.

Return value

Current mode of obtaining the rotation data.

Math::quat getDefaultValue() const#

Returns the current default value of all modifier elements.

Return value

Current default value of all modifier elements.

void setQuatCurve ( Ptr<AnimationCurveQuat> curve ) #

Sets a new curve storing the values used by the modifier.

Arguments


Ptr<AnimationCurveQuat> getQuatCurve() const#

Returns the current curve storing the values used by the modifier.

Return value

Current curve storing the values used by the modifier.

void setCurveX ( Ptr<AnimationCurveFloat> x ) #

Sets a new curve storing the values used by the modifier for the X axis.

Arguments


Ptr<AnimationCurveFloat> getCurveX() const#

Returns the current curve storing the values used by the modifier for the X axis.

Return value

Current curve storing the values used by the modifier for the X axis.

void setCurveY ( Ptr<AnimationCurveFloat> y ) #

Sets a new curve storing the values used by the modifier for the Y axis.

Arguments


Ptr<AnimationCurveFloat> getCurveY() const#

Returns the current curve storing the values used by the modifier for the Y axis.

Return value

Current curve storing the values used by the modifier for the Y axis.

void setCurveZ ( Ptr<AnimationCurveFloat> z ) #

Sets a new curve storing the values used by the modifier for the Z axis.

Arguments


Ptr<AnimationCurveFloat> getCurveZ() const#

Returns the current curve storing the values used by the modifier for the Z axis.

Return value

Current curve storing the values used by the modifier for the Z axis.

bool isUniformTime() const#

Returns the current value showing if the modifier values are changed uniformly along the timeline.

Return value

true if value showing if the modifier values are changed uniformly along the timeline. is enabled; otherwise false.

AnimationModifierQuat ( AnimationModifierQuat::MODE mode, AnimParams::PARAM param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

  • AnimationModifierQuat::MODE mode - The mode of obtaining the rotation data.
  • AnimParams::PARAM param - Parameter to be animated by the modifier.

AnimationModifierQuat ( AnimationModifierQuat::MODE mode, AnimParams::PARAM param, int param_index ) #

Creates the animation modifier to animate the specified parameter.

Arguments

  • AnimationModifierQuat::MODE mode - The mode of obtaining the rotation data.
  • AnimParams::PARAM param - Parameter to be animated by the modifier.
  • int param_index - Index of the parameter.

AnimationModifierQuat ( AnimationModifierQuat::MODE mode, AnimParams::PARAM param, const char * param_name ) #

Creates the animation modifier to animate the specified parameter.

Arguments

  • AnimationModifierQuat::MODE mode - The mode of obtaining the rotation data.
  • AnimParams::PARAM param - Parameter to be animated by the modifier.
  • const char * param_name - Name of the parameter.

AnimationModifierQuat ( AnimationModifierQuat::MODE mode, const char * param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

  • AnimationModifierQuat::MODE mode - The mode of obtaining the rotation data.
  • const char * param - Parameter to be animated by the modifier.

AnimationModifierQuat ( AnimationModifierQuat::MODE mode, const char * param, int param_index ) #

Creates the animation modifier to animate the specified parameter.

Arguments

  • AnimationModifierQuat::MODE mode - The mode of obtaining the rotation data.
  • const char * param - Parameter to be animated by the modifier.
  • int param_index - Index of the parameter.

AnimationModifierQuat ( AnimationModifierQuat::MODE mode, const char * param, const char * param_name ) #

Creates the animation modifier to animate the specified parameter.

Arguments

  • AnimationModifierQuat::MODE mode - The mode of obtaining the rotation data.
  • const char * param - Parameter to be animated by the modifier.
  • const char * param_name - Name of the parameter.

void copy ( const Ptr<AnimationModifierQuat> & modifier ) #

Copies all data from the specified source animation modifier.

Arguments

  • const Ptr<AnimationModifierQuat> & modifier - Source animation modifier.

Math::quat getValueByTime ( float time ) #

Returns the value of the modifier at the specified time.

Arguments

  • float time - Time of the key on the timeline, in seconds.

Return value

The modifier value at the specified time.

Math::quat getValueByNormalizedTime ( float normalized_time ) #

Returns the normalized value of the modifier at the specified time.

Arguments

  • float normalized_time - The normalized time value.

Return value

The modifier value at the specified time.

void addQuatValue ( float time, const Math::quat & value ) #

Adds the quaternion value to the modifier at the specified time.

Arguments

  • float time - Time of the key on the timeline, in seconds.
  • const Math::quat & value - The modifier value at the specified time.

void addAnglesValue ( float time, const Math::vec3 & value, AnimationCurve::KEY_TYPE type = Enum.AnimationCurve.KEY_TYPE.LINEAR ) #

Adds the angles value to the modifier at the specified time.

Arguments

  • float time - Time of the key on the timeline, in seconds.
  • const Math::vec3 & value - The modifier value at the specified time.
  • AnimationCurve::KEY_TYPE type - Interpolation type set for the key, one of the KEY_TYPE_* values.

void updateUniformTime ( bool enabled, bool force_update = false ) #

Changes the value that defines if the modifier values are changed uniformly along the timeline. Enabling the uniform time allows avoiding such cases as speeding up or slowing down due to the curve shape.

Arguments

  • bool enabled - The current value.
  • bool force_update - The target value.
Last update: 2023-11-16
Build: ()