AnimationModifierDouble 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.
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits from: | AnimationModifier |
AnimationModifierDouble Class
Members
getDefaultValue() const#
Returns the current default value of all modifier elements.
Return value
Current default value of all modifier elements.void setCurve ( AnimationCurveDouble curve ) #
Sets a new curve storing the values used by the modifier.
Arguments
- AnimationCurveDouble curve - The curve storing the values used by the modifier.
AnimationCurveDouble getCurve() const#
Returns the current curve storing the values used by the modifier.
Return value
Current curve storing the values used by the modifier.int isUniformTime() const#
Returns the current value showing if the modifier values are changed uniformly along the timeline.
Return value
Current value showing if the modifier values are changed uniformly along the timeline.AnimationModifierDouble ( int param ) #
Creates the animation modifier to animate the specified parameter.Arguments
- int param - Parameter to be animated by the modifier.
AnimationModifierDouble ( int param, int param_index ) #
Creates the animation modifier to animate the specified parameter.Arguments
- int param - Parameter to be animated by the modifier.
- int param_index - Index of the parameter.
AnimationModifierDouble ( int param, string param_name ) #
Creates the animation modifier to animate the specified parameter.Arguments
- int param - Parameter to be animated by the modifier.
- string param_name - Name of the parameter.
AnimationModifierDouble ( string param ) #
Creates the animation modifier to animate the specified parameter.Arguments
- string param - Parameter to be animated by the modifier.
AnimationModifierDouble ( string param, int param_index ) #
Creates the animation modifier to animate the specified parameter.Arguments
- string param - Parameter to be animated by the modifier.
- int param_index - Index of the parameter.
AnimationModifierDouble ( string param, string param_name ) #
Creates the animation modifier to animate the specified parameter.Arguments
- string param - Parameter to be animated by the modifier.
- string param_name - Name of the parameter.
void copy ( AnimationModifierDouble modifier ) #
Copies all data from the specified source animation modifier.Arguments
- AnimationModifierDouble modifier - Source animation modifier.
double 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.double 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, double value, int 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.
- double value - The modifier value at the specified time.
- int type - Interpolation type set for the key, one of the ANIMATION_CURVE_KEY_TYPE_* values.
void updateUniformTime ( int enabled, int 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
- int enabled - The current value.
- int force_update - The target value.
The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2023-11-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)