Unigine.Curve2d Class

Curve2d Class

Enums

REPEAT_MODE#

Properties

int Hash#

int NumKeys#

Curve2d.REPEAT_MODE RepeatModeStart#

Curve2d.REPEAT_MODE RepeatModeEnd#

Event EventChanged#

// implement the Changed event handler
void changed_event_handler()
{
	Log.Message("\Handling Changed event\n");
}

//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an EventConnections instance
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections changed_event_connections = new EventConnections();


// link to this instance when subscribing to an event (subscription to various events can be linked)
publisher.EventChanged.Connect(changed_event_connections, changed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
publisher.EventChanged.Connect(changed_event_connections, () => { 
		Log.Message("Handling Changed event lambda\n");
		}
	);

// later all of these linked subscriptions can be removed with a single line
changed_event_connections.DisconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the Changed event with a handler function
publisher.EventChanged.Connect(changed_event_handler);


// remove subscription to the Changed event later by the handler function
publisher.EventChanged.Disconnect(changed_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////

// define a connection to be used to unsubscribe later
EventConnection changed_event_connection;

// subscribe to the Changed event with a lambda handler function and keeping the connection
changed_event_connection = publisher.EventChanged.Connect(() => { 
		Log.Message("Handling Changed event lambda\n");
	}
);

// ...

// you can temporarily disable a particular event connection 
changed_event_connection.Enabled = false;

// ... perform certain actions

// and enable it back when necessary
changed_event_connection.Enabled = true;

// ...

// remove the subscription later using the saved connection
changed_event_connection.Disconnect();

//////////////////////////////////////////////////////////////////////////////
//   4. Ignoring Changed events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
publisher.EventChanged.Enabled = false;

// ... actions to be performed

// and enable it back when necessary
publisher.EventChanged.Enabled = true;

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 - New coordinates of the key point.

Return value

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 ( Json json ) #

Arguments

• Json json - Json class instance to which the curve data will be saved.

Return value

bool Load ( Json json ) #

Arguments

• Json json - Json class instance in which the curve 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

float Evaluate ( float time ) #

Arguments

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

Return value