Unigine::AnimationModifierBool Class

AnimationModifierBool Class

Members

void setCurve ( const Ptr<AnimationCurveBool>& curve ) #

Arguments

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

Ptr<AnimationCurveBool> getCurve() const#

Return value

Current curve storing the values used by the modifier.

---

AnimationModifierBool ( AnimParams::PARAM param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

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

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

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

AnimationModifierBool ( const char * param ) #

Creates the animation modifier to animate the specified parameter.

Arguments

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

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

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

Copies all data from the specified source animation modifier.

Arguments

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

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

bool 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, bool 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.
• bool value - The modifier value at the specified time.
• AnimationCurve::KEY_TYPE type - Interpolation type set for the key, one of the KEY_TYPE_* values.

bool getDefaultValue ( ) const#

Returns the default value for all modifier elements.

Return value

Default value for all modifier elements.