Unigine::Controls Class

Header:

#include <UnigineControls.h>

Handles input from the user (keyboard, mouse, joystick or gamepad). It can be used instead of the default engine.controls in one of the two possible ways:

Methods:

Name	Description View: Sort by:
*create*	Creates a smart pointer to Controls.
setMouseDX	Updates a screen position change of the mouse pointer along the X axis.
getMouseDX	Returns a screen position change of the mouse pointer along the X axis during the previous frame.
setMouseDY	Updates a screen position change of the mouse pointer along the Y axis.
getMouseDY	Returns a screen position change of the mouse pointer along the Y axis during the previous frame.
getType	Returns the type of input controls.
getTypeName	Returns a type name of input controls.
setState	Toggles the state of the given control on or off.
getState	Returns the state of a given control (pressed or unpressed).
clearState	Returns a control state and clears it to 0 (not pressed).
saveState	Saves controls settings into the stream.
restoreState	Restores controls settings from the stream.

Controls Class

Enums

TYPE#

Name	Description
CONTROLS_APP = 0	A ControlsApp instance.
CONTROLS_DUMMY = 1	ControlsDummy instance.
CONTROLS_SIX_AXIS = 2	Sixaxis controller as the input device.
CONTROLS_X_PAD360 = 3	XBox 360 game pad as the input device.
CONTROLS_JOYSTICK = 4	Joystick as the input device.

Members

static ControlsPtr create ( int type ) #

Creates a smart pointer to Controls.

Arguments

int type - Type of the controls to be created.

void setMouseDX ( float mousedx ) #

Updates a screen position change of the mouse pointer along the X axis.

Arguments

float mousedx - Change of the X coordinate.

float getMouseDX ( ) #

Returns a screen position change of the mouse pointer along the X axis during the previous frame.

Return value

Change of the X coordinate.

void setMouseDY ( float mousedy ) #

Updates a screen position change of the mouse pointer along the Y axis.

Arguments

float mousedy - Change of the Y coordinate.

float getMouseDY ( ) #

Returns a screen position change of the mouse pointer along the Y axis during the previous frame.

Return value

Change of the Y coordinate.

void setState ( int state, int value ) #

Toggles the state of the given control on or off.

Arguments

int state - Control state number to update. Possible values are in range [STATE_FORWARD;NUM_STATES]. For full list of available controls see Unigine::Controls:: Enumeration at the end of the article.
int value - State value: positive value to "press" the control; 0 to release it.

int getState ( int state ) #

Returns the state of a given control (pressed or unpressed).

Arguments

int state - Control state number. Possible values are in range [STATE_FORWARD;NUM_STATES]. For full list of available controls see Unigine::Controls:: Enumeration at the end of the article.

Return value

1 if the control is pressed; otherwise, 0.

int getType ( ) #

Returns the type of input controls.

Return value

Controls type (one of CONTROLS_* variables):

const char * getTypeName ( ) #

Returns a type name of input controls.

Return value

Type name.

int clearState ( int state ) #

Returns a control state and clears it to 0 (not pressed). This function allows to handle control only once even if it is kept pressed over several frames.

Arguments

int state - Control state number. Possible values are in range [STATE_FORWARD;NUM_STATES]. For full list of available controls see Unigine::Controls:: Enumeration at the end of the article.

Return value

Returns the state of the given control: 1 if the control is pressed; otherwise,0.

bool saveState ( const Ptr<Stream> & stream ) #

Saves controls settings into the stream.

Example using saveState() and restoreState() methods:

Source code (C++)

// Get the instance of default engine controls and set its state
controls = Engine::getControls();
controls->setMouseDX(5.0f);

// save state
BlobPtr blob_state = Blob::create();
controls->saveState(blob_state);

// change state
controls->setMouseDX(1.0f);

// restore state
blob_state->seekSet(0);				// returning the carriage to the start of the blob
controls->restoreState(blob_state);

Arguments

const Ptr<Stream> & stream - Stream smart pointer.

Return value

true if the controls settings are saved successfully; otherwise, false.

bool restoreState ( const Ptr<Stream> & stream ) #

Restores controls settings from the stream.

Example using saveState() and restoreState() methods:

Source code (C++)

// Get the instance of default engine controls and set its state
controls = Engine::getControls();
controls->setMouseDX(5.0f);

// save state
BlobPtr blob_state = Blob::create();
controls->saveState(blob_state);

// change state
controls->setMouseDX(1.0f);

// restore state
blob_state->seekSet(0);				// returning the carriage to the start of the blob
controls->restoreState(blob_state);

Arguments

const Ptr<Stream> & stream - Stream smart pointer.

Return value

true if the controls settings are restored successfully; otherwise, false.

Last update: 2021-04-09

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::Controls Class

See Also#

Methods:

Controls Class

Enums

TYPE#

Members

static ControlsPtr create ( int type ) #

Arguments

void setMouseDX ( float mousedx ) #

Arguments

float getMouseDX ( ) #

Return value

void setMouseDY ( float mousedy ) #

Arguments

float getMouseDY ( ) #

Return value

void setState ( int state, int value ) #

Arguments

int getState ( int state ) #

Arguments

Return value

int getType ( ) #

Return value

const char * getTypeName ( ) #

Return value

int clearState ( int state ) #

Arguments

Return value

bool saveState ( const Ptr<Stream> & stream ) #

Arguments

Return value

bool restoreState ( const Ptr<Stream> & stream ) #

Arguments

Return value