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).
getStateByName	Returns the state of a given control (pressed or unpressed) by the control state name.
getStateName	Returns the name of a given control state as a string.
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.

Variables:

Name	Description
NUM_STATES = 32	The total number of controls states.
STATE_FORWARD = 0	A state in which the player moves forwards.
STATE_BACKWARD = 1	A state in which the player moves backwards.
STATE_MOVE_LEFT = 2	A state in which the player moves left.
STATE_MOVE_RIGHT = 3	A state in which the player moves right.
STATE_TURN_UP = 4	A state, in which the player turns upward.
STATE_TURN_DOWN = 5	A state in which the player turns downward.
STATE_TURN_LEFT = 6	A state in which the player turns left.
STATE_TURN_RIGHT = 7	A state in which the player turns right.
STATE_CROUCH = 8	A state in which the player crouches or squats.
STATE_JUMP = 9	A state in which the player jumps.
STATE_RUN = 10	A state in which the player runs.
STATE_USE = 11	A state in which the player utilizes some object.
STATE_FIRE = 12	A state in which the player fires their weapon.
STATE_SAVE = 13	A state in which the world is being saved.
STATE_RESTORE = 14	A state in which the world is being restored.
STATE_SCREENSHOT = 15	A state in which a screenshot is being taken.
STATE_AUX_0 = 16	Auxiliary state (unreserved) It can be mapped to any control state, if necessary (see the example).
STATE_AUX_1 = 17	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_2 = 18	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_3 = 19	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_4 = 20	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_5 = 21	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_6 = 22	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_7 = 23	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_8 = 24	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_9 = 25	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_A = 26	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_B = 27	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_C = 28	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_D = 29	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_E = 30	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
STATE_AUX_F = 31	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).

Controls Class

Enums

TYPE#

Name	Description
CONTROLS_APP = 0	ControlsApp instance.
CONTROLS_DUMMY = 1	ControlsDummy instance.
CONTROLS_GAMEPAD = 2	Gamepad controller (e.g., XBox 360, Sixaxis, etc.) as the input device.
CONTROLS_JOYSTICK = 3	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 ( ) const#

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 ( ) const#

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 ) const#

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 getStateByName ( const char * name ) const#

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

Arguments

const char * name - Name of the control state. 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.

const char * getStateName ( int state ) const#

Returns the name of a given control state as a string.

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

Name of the control state.

Controls::TYPE getType ( ) const#

Returns the type of input controls.

Return value

Controls type (one of CONTROLS_* variables):

const char * getTypeName ( ) const#

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 ) const#

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: 2022-10-10

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:

Variables:

Controls Class

Enums

TYPE#

Members

static ControlsPtr create ( int type ) #

Arguments

void setMouseDX ( float mousedx ) #

Arguments

float getMouseDX ( ) const#

Return value

void setMouseDY ( float mousedy ) #

Arguments

float getMouseDY ( ) const#

Return value

void setState ( int state, int value ) #

Arguments

int getState ( int state ) const#

Arguments

Return value

int getStateByName ( const char * name ) const#

Arguments

Return value

const char * getStateName ( int state ) const#

Arguments

Return value

Controls::TYPE getType ( ) const#

Return value

const char * getTypeName ( ) const#

Return value

int clearState ( int state ) #

Arguments

Return value

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

Arguments

Return value

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

Arguments

Return value