Unigine::AnimationModifierVec2 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.
        

In This Article:

Header:	#include <UnigineAnimation.h>
Inherits from:	AnimationModifier

功能列表:

Name	说明/描述 View: Sort by:
AnimationModifierVec2	Creates the animation modifier to animate the specified parameter.
getDefaultValue	Returns the current default value of all modifier elements.
setCurveX	Setter and Getter for curve storing the values used by the modifier for the X axis.
getCurveX
setCurveY	Setter and Getter for curve storing the values used by the modifier for the Y axis.
getCurveY
isUniformTime	Returns the current value showing if the modifier values are changed uniformly along the timeline.
copy	Copies all data from the specified source animation modifier.
getValueByTime	Returns the value of the modifier at the specified time.
getValueByNormalizedTime	Returns the normalized value of the modifier at the specified time.
addValue	Adds the value to the modifier at the specified time.
updateUniformTime	Changes the value that defines if the modifier values are changed uniformly along the timeline.

AnimationModifierVec2 Class

Members

Math::Vec2 getDefaultValue() const#

Returns the current default value of all modifier elements.

Return value

Current default value of all modifier elements.

void setCurveX ( const Ptr<AnimationCurveScalar>& x ) #

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

Arguments

const Ptr<AnimationCurveScalar>& x - The curve storing the values used by the modifier for the X axis.

Ptr<AnimationCurveScalar> 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 ( const Ptr<AnimationCurveScalar>& y ) #

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

Arguments

const Ptr<AnimationCurveScalar>& y - The curve storing the values used by the modifier for the Y axis.

Ptr<AnimationCurveScalar> 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.

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.

AnimationModifierVec2 ( AnimParams::PARAM param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

AnimParams::PARAM param - Parameter to be animated by the modifier.

AnimationModifierVec2 ( AnimParams::PARAM param, int param_index ) #

Creates the animation modifier to animate the specified parameter.

Arguments

AnimParams::PARAM param - Parameter to be animated by the modifier.
int param_index - Index of the parameter.

AnimationModifierVec2 ( AnimParams::PARAM param, const char * param_name ) #

Creates the animation modifier to animate the specified parameter.

Arguments

AnimParams::PARAM param - Parameter to be animated by the modifier.
const char * param_name - Name of the parameter.

AnimationModifierVec2 ( const char * param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

const char * param - Parameter to be animated by the modifier.

AnimationModifierVec2 ( const char * param, int param_index ) #

Creates the animation modifier to animate the specified parameter.

Arguments

const char * param - Parameter to be animated by the modifier.
int param_index - Index of the parameter.

AnimationModifierVec2 ( const char * param, const char * param_name ) #

Creates the animation modifier to animate the specified parameter.

Arguments

const char * param - Parameter to be animated by the modifier.
const char * param_name - Name of the parameter.

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

Copies all data from the specified source animation modifier.

Arguments

const Ptr<AnimationModifierVec2> & modifier - Source animation modifier.

Math::Vec2 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::Vec2 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 addValue ( float time, const Math::Vec2 & value, AnimationCurve::KEY_TYPE type = Enum.AnimationCurve.KEY_TYPE.LINEAR ) #

Adds the value to the modifier at the specified time.

Arguments

float time - Time of the key on the timeline, in seconds.
const Math::Vec2 & 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: 2024-04-19

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)