Unigine.Plugins.SpiderVision.WarpGridData Class

WarpGridData Class

Enums

VIEWPORT_FLIP_TYPE#

WARP_HANDLE_ROLE#

Properties

bool Enabled#

int NumRows#

int NumColumns#

int WarpPointsCount#

WarpGridData.VIEWPORT_FLIP_TYPE CanvasFlipMask#

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)
WarpGridData.EventChanged.Connect(changed_event_connections, changed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
WarpGridData.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
WarpGridData.EventChanged.Connect(changed_event_handler);


// remove subscription to the Changed event later by the handler function
WarpGridData.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 = WarpGridData.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
WarpGridData.EventChanged.Enabled = false;

// ... actions to be performed

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

Members

void SetGridSize ( int row, int column ) #

Arguments

• int row - Number of grid rows.
• int column - Number of grid columns.

void SetPoint ( int x, int y, vec2 point ) #

Arguments

• int x - Position of the warping control point in the row, starting from 0 on the left.
• int y - Position of the warping control point in the column, starting from 0 at the bottom.
• vec2 point - Screen-space coordinates of the point.

void SetPoint ( int index, vec2 point ) #

Arguments

• int index - Warping control point index. The point with the 0 index is in the bottom left corner with the progression going upwards, and then to the next column bottom point.
• vec2 point - Screen-space coordinates of the point.

vec2 GetPoint ( int x, int y ) #

Arguments

• int x - Position of the warping control point in the row, starting from 0 on the left.
• int y - Position of the warping control point in the column, starting from 0 at the bottom.

Return value

vec2 GetPoint ( int index ) #

Arguments

• int index - Warping control point index. The point with the 0 index is in the bottom left corner with the progression going upwards, and then to the next column bottom point.

Return value

void SetPointHandle ( int x, int y, WarpGridData.WARP_HANDLE_ROLE type, vec2 point ) #

Arguments

• int x - Position of the warping control point in the row, starting from 0 on the left.
• int y - Position of the warping control point in the column, starting from 0 at the bottom.
• WarpGridData.WARP_HANDLE_ROLE type - Type of control handle of the warping control point.
• vec2 point - Screen-space coordinates of the point.

void SetPointHandle ( int index, WarpGridData.WARP_HANDLE_ROLE type, vec2 point ) #

Arguments

• int index - Warping control point index. The point with the 0 index is in the bottom left corner with the progression going upwards, and then to the next column bottom point.
• WarpGridData.WARP_HANDLE_ROLE type - Type of control handle of the warping control point.
• vec2 point - Screen-space coordinates of the point.

vec2 GetPointHandle ( int x, int y, WarpGridData.WARP_HANDLE_ROLE type ) #

Arguments

• int x - Position of the warping control point in the row, starting from 0 on the left.
• int y - Position of the warping control point in the column, starting from 0 at the bottom.
• WarpGridData.WARP_HANDLE_ROLE type - Type of control handle of the warping control point.

Return value

vec2 GetPointHandle ( int index, WarpGridData.WARP_HANDLE_ROLE type ) #

Arguments

• int index - Warping control point index. The point with the 0 index is in the bottom left corner with the progression going upwards, and then to the next column bottom point.
• WarpGridData.WARP_HANDLE_ROLE type - Type of control handle of the warping control point.

Return value

void SetPointHandleSmoothType ( int x, int y, ViewportData.POINT_SMOOTH_TYPE smooth_type ) #

Arguments

• int x - Position of the warping control point in the row, starting from 0 on the left.
• int y - Position of the warping control point in the column, starting from 0 at the bottom.
• ViewportData.POINT_SMOOTH_TYPE smooth_type - The type of line curving for the handle point.

void SetPointHandleSmoothType ( int index, ViewportData.POINT_SMOOTH_TYPE smooth_type ) #

Arguments

• int index - Warping control point index. The point with the 0 index is in the bottom left corner with the progression going upwards, and then to the next column bottom point.
• ViewportData.POINT_SMOOTH_TYPE smooth_type - The type of line curving for the handle point.

ViewportData.POINT_SMOOTH_TYPE GetPointHandleSmoothType ( int x, int y ) #

Arguments

• int x - Position of the warping control point in the row, starting from 0 on the left.
• int y - Position of the warping control point in the column, starting from 0 at the bottom.

Return value

ViewportData.POINT_SMOOTH_TYPE GetPointHandleSmoothType ( int index ) #

Arguments

• int index - Warping control point index. The point with the 0 index is in the bottom left corner with the progression going upwards, and then to the next column bottom point.

Return value

void SaveXml ( Xml xml ) #

Arguments

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

bool RestoreXml ( Xml xml ) #

Arguments

• Xml xml - Xml class instance the data from which is to be loaded.

Return value

void Save ( Stream stream ) #

Arguments

• Stream stream - Stream to which the data is to be written.

void Restore ( Stream stream ) #

Arguments

• Stream stream - Stream the data from which is to be loaded.