Unigine::Plugins::SpiderVision::CalibrationGridData Class

CalibrationGridData Class

Enums

CALIBRATION_GRID_TYPE#

Members

void setVisible ( bool visible ) #

Arguments

• bool visible - Set true to enable rendering of the calibration grid; false - to disable it.

bool isVisible() const#

Return value

void setDistance ( float distance ) #

Arguments

• float distance - The distance from the viewpoint to the grid.

float getDistance() const#

Return value

void setType ( CalibrationGridData::CALIBRATION_GRID_TYPE type ) #

Arguments

• CalibrationGridData::CALIBRATION_GRID_TYPE type - The type of the calibration pattern.

CalibrationGridData::CALIBRATION_GRID_TYPE getType() const#

Return value

void setSphereCut ( bool cut ) #

Arguments

• bool cut - Set true to enable Sphere Cut option; false - to disable it.

bool isSphereCut() const#

Return value

void setLinesVerticalStep ( float step ) #

Arguments

• float step - The distance between major vertical lines.

float getLinesVerticalStep() const#

Return value

void setLinesHorizontalStep ( float step ) #

Arguments

• float step - The distance between major horizontal lines.

float getLinesHorizontalStep() const#

Return value

void setLinesVerticalMinorCount ( int count ) #

Arguments

• int count - The number of secondary lines between the two neighboring major vertical lines.

int getLinesVerticalMinorCount() const#

Return value

void setLinesHorizontalMinorCount ( int count ) #

Arguments

• int count - The number of secondary lines between the two neighboring major horizontal lines.

int getLinesHorizontalMinorCount() const#

Return value

void setTextEnabled ( bool enabled ) #

Arguments

• bool enabled - Set true to enable text rendering on the calibration grid; false - to disable it.

bool isTextEnabled() const#

Return value

void setTextFontSize ( int size ) #

Arguments

• int size - The size of the text displayed on the calibration grid.

int getTextFontSize() const#

Return value

void setLineHighlightEnabled ( bool enabled ) #

Arguments

• bool enabled - Set true to enable highlighting of one horizontal and one vertical line; false - to disable it.

bool isLineHighlightEnabled() const#

Return value

void setLineHightlightHorizontalIndex ( int index ) #

Arguments

• int index - The index of the horizontal highlight.

int getLineHightlightHorizontalIndex() const#

Return value

void setLineHightlightVerticalIndex ( int index ) #

Arguments

• int index - The index of the vertical highlight.

int getLineHightlightVerticalIndex() const#

Return value

void setTransformYaw ( float yaw ) #

Arguments

• float yaw - The yaw angle, in degrees.

float getTransformYaw() const#

Return value

void setTransformPitch ( float pitch ) #

Arguments

• float pitch - The pitch angle, in degrees.

float getTransformPitch() const#

Return value

void setTransformRoll ( float roll ) #

Arguments

• float roll - The roll angle, in degrees.

float getTransformRoll() const#

Return value

static Event<> getEventChanged() const#

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


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

// create an instance of the EventConnections class
EventConnections changed_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
CalibrationGridData::getEventChanged().connect(changed_event_connections, changed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
CalibrationGridData::getEventChanged().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection changed_event_connection;

// subscribe to the Changed event with a handler function keeping the connection
CalibrationGridData::getEventChanged().connect(changed_event_connection, changed_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
changed_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
changed_event_connection.setEnabled(true);

// ...

// remove subscription to the Changed event via the connection
changed_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Changed event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling Changed event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
CalibrationGridData::getEventChanged().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;


//////////////////////////////////////////////////////////////////////////////
//   4. Subscribe to an event saving a particular connection ID
//   and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////
// instance of the EventConnections class to manage event connections
EventConnections e_connections;

// define a particular connection ID to be used to unsubscribe later
EventConnectionId changed_handler_id;

// subscribe to the Changed event with a lambda handler function and keeping connection ID
changed_handler_id = CalibrationGridData::getEventChanged().connect(e_connections, []() { 
		Log::message("\Handling Changed event (lambda).\n");
	}
);

// remove the subscription later using the ID
CalibrationGridData::getEventChanged().disconnect(changed_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   5. Ignoring all Changed events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
CalibrationGridData::getEventChanged().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
CalibrationGridData::getEventChanged().setEnabled(true);

Return value

void setBackgroundColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The background color of the calibration grid.

Math::vec4 getBackgroundColor() const#

Return value

void setHighlightedColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the highlighted line.

Math::vec4 getHighlightedColor() const#

Return value

void setHorizontalMinorLinesColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the minor horizontal lines in the calibration grid.

Math::vec4 getHorizontalMinorLinesColor() const#

Return value

void setHorizontalMajorLinesColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the major horizontal lines in the calibration grid.

Math::vec4 getHorizontalMajorLinesColor() const#

Return value

void setVerticalMinorLinesColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the minor vertical lines in the calibration grid.

Math::vec4 getVerticalMinorLinesColor() const#

Return value

void setVerticalMajorLinesColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the major vertical lines in the calibration grid.

Math::vec4 getVerticalMajorLinesColor() const#

Return value

void setAxesColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the central axes in the calibration grid.

Math::vec4 getAxesColor() const#

Return value

void setTextColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The color of the text in the calibration grid.

Math::vec4 getTextColor() const#

Return value

void save ( const Ptr<Stream> & stream ) #

Arguments

• const Ptr<Stream> & stream - Stream to which the data is to be written.

void restore ( const Ptr<Stream> & stream ) #

Arguments

• const Ptr<Stream> & stream - Stream the data from which is to be loaded.