Unigine::AnimationCurveString Class

AnimationCurveString Class

Members

const char * getDefaultKeyValue() const#

Return value

Current default value of all keys in the curve.

getNumKeys() const#

Return value

Current total number of key points in the curve.

getMinTime() const#

Return value

Current point of the whole animation timeline where this curve starts being applied, in units.

getMaxTime() const#

Return value

Current point of the whole animation timeline up to which this curve is applied, in units.

---

AnimationCurveString ( ) #

Constructor. Creates a new animation curve instance containing string values.

void copy ( const Ptr<AnimationCurveString> & curve ) #

Copies all data (key points and tangents) from the specified source curve.

Arguments

• const Ptr<AnimationCurveString> & curve - Source curve.

int addKey ( float time, const char * value ) #

Adds a new key point with the specified value at the specified point of the timeline to the curve.

Arguments

• float time - Time of the key on the timeline, in seconds.
• const char * value - The string value of the key.

Return value

Index of the added key point.

void removeKey ( int index ) #

Removes the key point with the specified index from the curve.

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.

int moveKey ( int index, float new_time ) #

Moves the key point with the specified number to a new time position (preserving the tangents). The index of key point will be updated automatically. This method can be used to implement dragging of keys on the curve.

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.
• float new_time - Time of the key on the timeline, in seconds.

Return value

New index of the key.

float getKeyTime ( int index ) const#

Returns the current time of the key point with the specified index.

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.

Return value

The time of the specified key point on the timeline, in seconds.

void setKeyValue ( int index, const char * value ) #

Sets the value for the specified key on the curve.

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.
• const char * value - The string value of the key.

const char * getKeyValue ( int index ) const#

Returns the current value for the specified key on the curve.

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.

Return value

The string value of the key.

void clear ( ) #

Clears the curve removing all key points and tangents.

const char * getValueByTime ( float time ) #

Returns the key value at the specified key point of the curve.

Arguments

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

Return value

The string value of the key.

const char * getValueByNormalizedTime ( float time ) #

Returns the key value using the normalized time value of the key.

Arguments

• float time - The normalized time value of the key.

Return value

The string value of the key.

void save ( const Ptr<Blob> & blob ) const#

Saves the curve data to a blob.

Arguments

• const Ptr<Blob> & blob - Blob to which the curve data will be saved.

void load ( const Ptr<Blob> & blob ) #

Loads the curve data from the blob.

Arguments

• const Ptr<Blob> & blob - Blob storing the curve data.