Unigine.Plugins.SpiderVision.MasksData Class

MasksData Class

Properties

bool Enabled#

int NumMasks#

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

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


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

// ... actions to be performed

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

Members

void Clear ( ) #

int AddMask ( ) #

Return value

void RemoveMask ( int index ) #

Arguments

• int index - Mask index.

void SetMaskName ( int mask, string name ) #

Arguments

• int mask - Mask index.
• string name - Mask name.

string GetMaskName ( int mask ) #

Arguments

• int mask - Mask index.

Return value

void SetMaskEnabled ( int mask, bool enabled ) #

Arguments

• int mask - Mask index.
• bool enabled - true to enable rendering of the mask, false to disable it.

bool IsMaskEnabled ( int mask ) #

Arguments

• int mask - Mask index.

Return value

void SetMaskSmoothStep ( int mask, int smooth_step ) #

Arguments

• int mask - Mask index.
• int smooth_step - Smoothing value, the number of additional points to be inserted between the control points of the mask.

int GetMaskSmoothStep ( int mask ) #

Arguments

• int mask - Mask index.

Return value

int AddPoint ( int mask ) #

Arguments

• int mask - Mask index.

Return value

int AddPoint ( int mask, int insert_index ) #

Arguments

• int mask - Mask index.
• int insert_index - Point index.

Return value

void RemovePoint ( int mask, int index ) #

Arguments

• int mask - Mask index.
• int index - Point index.

int GetNumPoints ( int mask ) #

Arguments

• int mask - Mask index.

Return value

void SetPoint ( int mask, int index, vec2 point ) #

Arguments

• int mask - Mask index.
• int index - Point index.
• vec2 point - Point coordinates.

vec2 GetPoint ( int mask, int index ) #

Arguments

• int mask - Mask index.
• int index - Point index.

Return value

void SetPointHandleLeft ( int mask, int index, vec2 point ) #

Arguments

• int mask - Mask index.
• int index - Point index.
• vec2 point - Coordinates of left control handle point.

vec2 GetHandleLeft ( int mask, int index ) #

Arguments

• int mask - Mask index.
• int index - Point index.

Return value

void SetPointHandleRight ( int mask, int index, vec2 point ) #

Arguments

• int mask - Mask index.
• int index - Point index.
• vec2 point - Coordinates of right control handle point.

vec2 GetHandleRight ( int mask, int index ) #

Arguments

• int mask - Mask index.
• int index - Point index.

Return value

void SetPointSmoothType ( int mask, int index, ViewportData.POINT_SMOOTH_TYPE type ) #

Arguments

• int mask - Mask index.
• int index - Point index.
• ViewportData.POINT_SMOOTH_TYPE type - Type of the line curving behavior in the point.

ViewportData.POINT_SMOOTH_TYPE GetPointSmoothType ( int mask, int index ) #

Arguments

• int mask - Mask index.
• int index - Point index.

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.