Unigine::Controls Class

Interface for controls handling.

To use this class, include the UnigineControls.h file.

Unigine::Controls Class

Members

---

virtual ~Controls ()

Virtual destructor.

static Ptr< Controls > get ()

Returns a pointer to the Controls.

Return value

Pointer to the Controls.

static Ptr< Controls > create ()

Controls constructor.

Return value

Pointer to the created controls.

virtual void grab () =0

Sets the "owner" flag to 1 for the pointer. The Controls should not be handled by the engine after this function is called.

virtual void release () =0

Sets the "owner" flag to 0 for the pointer. The Controls should be handled by the engine after this function is called.

virtual int isOwner () const =0

Returns the "owner" flag. If the pointer is the owner, on its deletion the object also will be deleted. Use grab() and release() functions to change ownership.

Return value

The "owner" flag.

virtual void setMouseDX (float dx) const =0

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

Arguments

• float dx - Change of the X coordinate.

virtual void setMouseDY (float dy) const =0

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

Arguments

• float dy - Change of the Y coordinate.

virtual float getMouseDX () const =0

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

Return value

Change of the X coordinate.

virtual float getMouseDY () const =0

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

Return value

Change of the Y coordinate.

virtual void setState (int state, int value) const =0

Updates the state of a given control (i.e. sets the 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.

virtual int getState (int state) const =0

Returns the state of a given control.

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.

virtual int clearState (int state) const =0

Returns a control state and clears it to 0 (control is not pressed).

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.

---

Unigine::Controls::anonymous_5 Enumeration