Unigine::AnimationModifierFloat Class

AnimationModifierFloat Class

Members

getDefaultValue() const#

Return value

Current default value of all modifier elements.

void setCurve ( Ptr<AnimationCurveFloat> & curve ) #

Arguments

• Ptr<AnimationCurveFloat> & curve - The curve storing the values used by the modifier.

Ptr<AnimationCurveFloat> & getCurve() const#

Return value

Current curve storing the values used by the modifier.

bool isUniformTime() const#

Return value

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

---

AnimationModifierFloat ( AnimParams::PARAM param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

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

AnimationModifierFloat ( 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.

AnimationModifierFloat ( 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.

AnimationModifierFloat ( const char * param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

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

AnimationModifierFloat ( 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.

AnimationModifierFloat ( 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<AnimationModifierFloat> & modifier ) #

Copies all data from the specified source animation modifier.

Arguments

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

float 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.

float 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, float 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.
• float 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.