Unigine.Curve2d Class

Curve2d Class

Enums

REPEAT_MODE#

Properties

int Hash#

int NumKeys#

Curve2d.REPEAT_MODE RepeatModeStart#

Curve2d.REPEAT_MODE RepeatModeEnd#

Members

Curve2d ( ) #

Curve2d ( Curve2d curve ) #

Arguments

• Curve2d curve - Source curve.

void Clear ( ) #

void Copy ( Curve2d curve ) #

Arguments

• Curve2d curve - Source curve.

int AddKey ( vec2 point ) #

Arguments

• vec2 point - Coordinates of the new key point to be added.

Return value

int AddKey ( vec2 point, vec2 left_tangent, vec2 right_tangent ) #

Arguments

• vec2 point - Coordinates of the new key point to be added.
• vec2 left_tangent - Coordinates of the left tangent at the key point.
• vec2 right_tangent - Coordinates of the right tangent at the key point.

Return value

void RemoveKey ( int index ) #

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, vec2 point ) #

Arguments

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

void SortKeys ( ) #

void SetKeyPoint ( int index, vec2 point ) #

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.
• vec2 point - New coordinates to be set for the specified point.

void SetKeyLeftTangent ( int index, vec2 point ) #

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.
• vec2 point - New coordinates of the left tangent at the specified key point to be set.

void SetKeyRightTangent ( int index, vec2 point ) #

Arguments

• int index - Key point number, in the range from 0 to the total number of key points in the curve.
• vec2 point - New coordinates of the right tangent at the specified key point to be set.

vec2 GetKeyPoint ( int index ) #

Arguments

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

Return value

vec2 GetKeyLeftTangent ( int index ) #

Arguments

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

Return value

vec2 GetKeyRightTangent ( int index ) #

Arguments

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

Return value

bool SaveState ( Stream stream ) #

Example using saveState() and restoreState() methods:

// initialize a node and set its state
Curve2d curve = new Curve2d();
curve.AddKey(new vec2(1, 0));
curve.AddKey(new vec2(2, 1));
curve.AddKey(new vec2(4, 3));

// save state
Blob blob_state = new Blob();
curve.SaveState(blob_state);

// change the node state
curve.RemoveKey(1);

// restore state
blob_state.SeekSet(0);	// returning the carriage to the start of the blob
curve.RestoreState(blob_state);

Arguments

• Stream stream - Stream to which the curve data will be saved.

Return value

bool RestoreState ( Stream stream ) #

Example using saveState() and restoreState() methods:

// initialize a node and set its state
Curve2d curve = new Curve2d();
curve.AddKey(new vec2(1, 0));
curve.AddKey(new vec2(2, 1));
curve.AddKey(new vec2(4, 3));

// save state
Blob blob_state = new Blob();
curve.SaveState(blob_state);

// change the node state
curve.RemoveKey(1);

// restore state
blob_state.SeekSet(0);	// returning the carriage to the start of the blob
curve.RestoreState(blob_state);

Arguments

• Stream stream - Stream in which the saved curve parameter data is stored.

Return value

bool Save ( Xml xml ) #

Arguments

• Xml xml - Xml class instance to which the curve data will be saved.

Return value

bool Load ( Xml xml ) #

Arguments

• Xml xml - Xml class instance in which the curve data is stored.

Return value

IntPtr AddChangedCallback ( ChangedDelegate func ) #

void changed_callback_function_name();

You can set a callback function as follows:

AddChangedCallback(() => changed_callback_function_name());

Example: Setting a changed callback function for a curve:

class SomeClass
{
	// curve for which a changed callback function is to be set
	Unigine.Curve2d curve;

	/*...*/

	// callback function
	private void on_change()
	{
		// insert your code handling curve changing here
	}

	private void RegisterCallback()
	{
		// setting the on_change() function to handle curve changing
		curve.AddChangedCallback(() => on_change());
	}
	
	/*...*/
}

Arguments

• ChangedDelegate func - Callback function with the following signature: void ChangedDelegate()

Return value

bool RemoveChangedCallback ( IntPtr id ) #

Arguments

• IntPtr id - Changed callback ID obtained when adding it.

Return value

void ClearChangedCallbacks ( ) #

float Evaluate ( float time ) #

Arguments

• float time - The time within the curve you want to evaluate (horizontal axis in the curve graph).

Return value