Unigine::Input Class
| Header: | #include <UnigineInput.h> |
The Input class contains functions for simple manual handling of user inputs using a keyboard, a mouse or a gamepad.
This class represents an engine's singleton.
See Also#
- Input sample in C# Component Samples suite
Usage Examples#
The following example shows a way to move and rotate a node by using the Input class:
Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineInput.h>
#include <UnigineConsole.h>
#include <UnigineGame.h>
#include <UniginePrimitives.h>
using namespace Unigine;
using namespace Math;
NodePtr box;
float move_speed = 1.0f;
float turn_speed = 30.0f;
int AppWorldLogic::init()
{
box = Primitives::createBox(vec3_one);
return 1;
}
int AppWorldLogic::update()
{
if (Console::isActive())
return 1;
if (Input::isKeyPressed(Input::KEY_UP) || Input::isKeyPressed(Input::KEY_W))
box->translate(Vec3_forward * move_speed * Game::getIFps());
if (Input::isKeyPressed(Input::KEY_DOWN) || Input::isKeyPressed(Input::KEY_S))
box->translate(Vec3_back * move_speed * Game::getIFps());
if (Input::isKeyPressed(Input::KEY_LEFT) || Input::isKeyPressed(Input::KEY_A))
box->rotate(0.0f, 0.0f, turn_speed * Game::getIFps());
if (Input::isKeyPressed(Input::KEY_RIGHT) || Input::isKeyPressed(Input::KEY_D))
box->rotate(0.0f, 0.0f, -turn_speed * Game::getIFps());
return 1;
}The following code demonstrates how to receive an event that changed the button state to isKeyDown(), isKeyUp(). Such code can also be used for the mouse and touch buttons.
Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineInput.h>
#include <UnigineConsole.h>
using namespace Unigine;
int AppWorldLogic::update()
{
if (Input::isKeyDown(Input::KEY_T) || Input::isKeyUp(Input::KEY_T))
{
InputEventKeyboardPtr e = Input::getKeyEvent(Input::KEY_T);
Console::messageLine("%s %d time = %lld frame = %lld", Input::getKeyName(e->getKey()), e->getAction(), e->getTimestamp(), e->getFrame());
}
return 1;
}The following code illustrates receiving the immediate input — the user receives the event notification immediately after filtering:
Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineInput.h>
#include <UnigineConsole.h>
using namespace Unigine;
int AppWorldLogic::init()
{
Input::addCallback(Input::CALLBACK_IMMEDIATE_INPUT, MakeCallback(on_immediate_input));
return 1;
}The following code illustrates how the event filter works. Pressing the "W" button and mouse movements will be declined, i.e. these events won't be taken as input:
Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineInput.h>
using namespace Unigine;
int event_filter(InputEventPtr& e)
{
switch (e->getType())
{
case InputEvent::INPUT_EVENT_KEYBOARD:
{
// skip 'W' key repeat events
InputEventKeyboardPtr k = checked_ptr_cast<InputEventKeyboard>(e);
if (k->getKey() == Input::KEY_W && k->getAction() == InputEventKeyboard::ACTION_REPEAT)
return 1;
break;
}
case InputEvent::INPUT_EVENT_MOUSE_MOTION:
{
// skip all mouse motion events
return 1;
}
default: break;
}
return 0;
}
int AppWorldLogic::init()
{
Input::setEventsFilter(event_filter);
return 1;
}The following code is an example of input events creation. We'll imitate the input of the show_profiler 1 console command as if it were an event from the keyboard.
Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineInput.h>
using namespace Unigine;
enum
{
STATE_OPEN_CONSOLE = 0,
STATE_TYPING_COMMAND,
STATE_APPLY_COMMAND,
STATE_FINISH,
};
int state = STATE_OPEN_CONSOLE;
const char* command = "show_profiler 1";
int AppWorldLogic::update()
{
switch (state)
{
case STATE_OPEN_CONSOLE:
{
InputEventKeyboardPtr key = InputEventKeyboard::create();
key->setAction(InputEventKeyboard::ACTION_DOWN);
key->setKey(Input::KEY_BACK_QUOTE);
Input::sendEvent(key);
state = STATE_TYPING_COMMAND;
break;
}
case STATE_TYPING_COMMAND:
{
int size = strlen(command);
for (int i = 0; i < size; i++)
{
InputEventTextPtr text = InputEventText::create();
text->setUnicode(command[i]);
Input::sendEvent(text);
}
state = STATE_APPLY_COMMAND;
break;
}
case STATE_APPLY_COMMAND:
{
InputEventKeyboardPtr key = InputEventKeyboard::create();
key->setAction(InputEventKeyboard::ACTION_REPEAT);
key->setKey(Input::KEY_ENTER);
Input::sendEvent(key);
state = STATE_FINISH;
break;
}
default: break;
}
return 1;
}The following code demonstrates how to obtain various button names using the getKeyName(), keyToUnicode(), and getKeyLocalName() methods:
Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineInput.h>
#include <UnigineConsole.h>
using namespace Unigine;
int AppWorldLogic::init()
{
Console::setOnscreen(true);
return 1;
}
int AppWorldLogic::update()
{
auto print_info = [](const char* state, Input::KEY key)
{
unsigned int unicode = Input::keyToUnicode(key);
Console::message("%s: (key='%s', unicode='%s', local_name='%s') ",
state,
Input::getKeyName(key),
String::unicodeToUtf8(unicode).get(),
Input::getKeyLocalName(key));
};
print_info("Up", Input::KEY_W);
print_info("Jump", Input::KEY_SPACE);
print_info("Run", Input::KEY_RIGHT_SHIFT);
Console::message("\n");
return 1;
}Input Class
Enums
MOUSE_HANDLE#
MOUSE_BUTTON#
MODIFIER#
KEY#
CALLBACK_INDEX#
DEVICE_TYPE#
GAMEPAD_BUTTON#
Buttons of the gamepad.GAMEPAD_AXIS#
JOYSTICK_POV#
POV (Point-of-View) switch or DPad states.Members
Math::ivec2 getMousePosition ( ) const#
Returns a vector containing the global coordinates of the mouse cursor. In case of a mouse button event, the cursor position at the moment of the processed event is returned. In case of no such event, the mouse position at the beginning of the frame is returned. To get the cursor position during another type of event, get this event (for example getKeyEvent()) and get the cursor position stored inside it.Return value
Global coordinates of the cursor.Math::ivec2 getMouseDeltaPosition ( ) #
Returns a vector containing screen position change of the mouse pointer along the X and Y axes — the difference between the values in the previous and the current frames.Return value
Float mouse pointer position delta.int getMouseWheel ( ) const#
Returns the current mouse scroll value. Negative values correspond to scrolling downwards; positive values correspond to scrolling upwards; the value is zero when the mouse wheel is not scrolled.Return value
Mouse scroll value in the [-1;1] range.int getMouseWheelHorizontal ( ) const#
Returns the current horizontal mouse scroll value.Return value
Horizontal mouse scroll value in the [-1;1] range.void setMouseGrab ( bool grab ) #
Sets the value indicating if the mouse pointer is bound to the application window.Arguments
- bool grab - 1 if the mouse cannot leave the application window; otherwise, 0.
bool isMouseGrab ( ) const#
Returns the value indicating if the mouse pointer is bound to the application window.Return value
true if the mouse cannot leave the application window; otherwise, false.int getNumGamePads ( ) const#
Returns the total number of all gamepads.Return value
Number of all gamepads.Ptr<InputGamePad> getGamePad ( int num ) const#
Returns a gamepad of the given index.Arguments
- int num - Gamepad index.
Return value
InputGamepad object.int getNumJoysticks ( ) const#
Returns the total number of all joysticks.Return value
Number of all joysticks.Ptr<InputJoystick> getJoystick ( int num ) const#
Returns a joystick with the given index.Arguments
- int num - Joystick index.
Return value
InputJoystick object.bool isKeyPressed ( Input::KEY key ) const#
Returns a value indicating if the given key is pressed. Check this value to perform continuous actions.Source code (C++)
if (Input::isKeyPressed(Input::KEY_ENTER)) {
Log::message("the Enter key is held down\n");
}Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
true if the key is pressed; otherwise, false.bool isKeyDown ( Input::KEY key ) const#
Returns a value indicating if the given key was pressed during the current frame. Check this value to perform one-time actions on pressing a key.Source code (C++)
if (Input::isKeyDown(Input::KEY_SPACE)) {
Log::message("the Space key was pressed\n");
}Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
1 during the first frame when the key was pressed, 0 for the following ones until it is released and pressed again.bool isKeyUp ( Input::KEY key ) const#
Returns a value indicating if the given key was released during the current frame. Check this value to perform one-time actions on releasing a key.Source code (C++)
if (Input::isKeyUp(Input::KEY_F)) {
Log::message("the F key was released\n");
}Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
true during the first frame when the key was released; otherwise, false.bool isMouseButtonPressed ( Input::MOUSE_BUTTON button ) const#
Returns a value indicating if the given mouse button is pressed. Check this value to perform continuous actions.Source code (C++)
if (Input::isMouseButtonPressed(Input::MOUSE_BUTTON_LEFT)) {
Log::message("the left mouse button is held down\n");
}Arguments
- Input::MOUSE_BUTTON button - One of the preset MOUSE_BUTTON_ codes.
Return value
1 if the mouse button is pressed; otherwise, 0.bool isMouseButtonDown ( Input::MOUSE_BUTTON button ) const#
Returns a value indicating if the given mouse button was pressed during the current frame. Check this value to perform one-time actions on pressing a mouse button.Source code (C++)
if (Input::isMouseButtonDown(Input::MOUSE_BUTTON_LEFT)) {
Log::message("the left mouse button was pressed\n");
}Arguments
- Input::MOUSE_BUTTON button - One of the preset MOUSE_BUTTON_ codes.
Return value
1 during the first frame when the mouse button was released; otherwise, 0.bool isMouseButtonUp ( Input::MOUSE_BUTTON button ) const#
Returns a value indicating if the given mouse button was released during the current frame. Check this value to perform one-time actions on releasing a mouse button.Source code (C++)
if (Input::isMouseButtonUp(Input::MOUSE_BUTTON_LEFT)) {
Log::message("the left mouse button was released\n");
}Arguments
- Input::MOUSE_BUTTON button - One of the preset MOUSE_BUTTON_ codes.
Return value
1 during the first frame when the mouse button was released; otherwise, 0.void setMouseHandle ( Input::MOUSE_HANDLE handle ) #
Sets the mouse behavior mode.Arguments
- Input::MOUSE_HANDLE handle - Mouse behavior mode, one of the MOUSE_HANDLE_* values.
Input::MOUSE_HANDLE getMouseHandle ( ) const#
Returns the mouse behavior mode.Return value
Mouse behavior mode, one of the MOUSE_HANDLE_* values.bool isTouchPressed ( int index ) const#
Returns a value indicating if the touchscreen is pressed by the finger.Arguments
- int index - Touch input index.
Return value
true if the touchscreen is pressed; otherwise, false.bool isTouchDown ( int index ) const#
Returns a value indicating if the given touch was pressed during the current frame.Arguments
- int index - Touch input index.
Return value
true if the touchscreen is pressed during the current frame; otherwise, false.bool isTouchUp ( int index ) const#
Returns a value indicating if the given touch was released.Arguments
- int index - Touch input index.
Return value
true during the first frame when the touch was released; otherwise, false.Math::ivec2 getTouchPosition ( int index ) const#
Returns a vector containing integer values of touch position.Arguments
- int index - Touch input index.
Return value
The touch position.Math::ivec2 getTouchDelta ( int index ) const#
Returns a vector containing screen position change of the touch along the X and Y axes — the difference between the values in the previous and the current frames.Arguments
- int index - Touch input index.
Return value
The touch position delta.Ptr<InputEventTouch> getTouchEvent ( int index ) #
Returns the action cast to the touch event.Arguments
- int index - Touch input index.
Return value
Touch input event.int getTouchEvents ( int index, Vector<Ptr<InputEventTouch>> & events ) #
Returns the actions cast to the touch event.Arguments
- int index - Touch input index.
- Vector<Ptr<InputEventTouch>> & events - The buffer with touch input events.
Return value
Number of touch input events.Ptr<InputEventKeyboard> getKeyEvent ( Input::KEY key ) #
Returns the currently processed keyboard input event.Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
Keyboard input event, or nullptr if there are no events for the specified key in the current frame.int getKeyEvents ( Input::KEY key, Vector<Ptr<InputEventKeyboard>> & events ) #
Returns the buffer with events for the specified key.Arguments
- Input::KEY key - One of the preset KEY_ codes.
- Vector<Ptr<InputEventKeyboard>> & events - The buffer with input events.
const char * getKeyName ( Input::KEY key ) const#
Returns the specified key name.Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
Key name.Input::KEY getKeyByName ( const char * name ) const#
Returns the key by its name.Arguments
- const char * name - Key name.
Return value
One of the preset KEY_ codes.Ptr<InputEventMouseButton> getMouseButtonEvent ( Input::MOUSE_BUTTON button ) #
Returns the mouse motion input event for the specified button.Arguments
- Input::MOUSE_BUTTON button - One of the preset MOUSE_BUTTON_ codes.
Return value
Mouse motion input event.const char * getMouseButtonName ( Input::MOUSE_BUTTON button ) const#
Returns the mouse button name.Arguments
- Input::MOUSE_BUTTON button - One of the preset MOUSE_BUTTON_ codes.
Return value
Mouse button name.Input::MOUSE_BUTTON getMouseButtonByName ( const char * name ) const#
Returns the mouse button by its name.Arguments
- const char * name - Mouse button name.
Return value
One of the preset MOUSE_BUTTON_ codes.int getEventsBuffer ( int frame, Vector<Ptr<InputEvent>> & events ) const#
Returns the buffer with the input events for the specified frame.Arguments
- int frame - Number of frame for which the buffer of input events is to be obtained. Input events are stored for the last 60 frames. 0 is the current frame, 1 is the previous frame, etc.
- Vector<Ptr<InputEvent>> & events - The buffer with input events.
void sendEvent ( const Ptr<InputEvent> & e ) #
Creates a user event and dispatches it to the Engine.Arguments
- const Ptr<InputEvent> & e - Input event.
void setEventsFilter ( int (*)(const Ptr<InputEvent> &) func ) #
Sets a callback function to be executed on receiving input events. This input event filter enables you to reject certain input events for the Engine and get necessary information on all input events.Arguments
- int (*)(const Ptr<InputEvent> &) func - Input event callback.
bool isModifierEnabled ( Input::MODIFIER modifier ) const#
Returns the value indicating if the specified modifier is enabled.Arguments
- Input::MODIFIER modifier - One of the preset MODIFIER_ codes.
Return value
true if the modifier is enabled; otherwise, false.unsigned int keyToUnicode ( Input::KEY key ) const#
Returns the specified key transformed to unicode.Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
Unicode symbol.Input::KEY unicodeToKey ( unsigned int unicode ) const#
Returns the specified key transformed to unicode.Arguments
- unsigned int unicode - Unicode symbol.
Return value
One of the preset KEY_ codes.Math::ivec2 getMouseDeltaRaw ( ) const#
Returns the physical change in the absolute mouse position (not the screen cursor).Return value
The change in the absolute mouse position, dots per inch.bool isEmptyClipboard ( ) const#
Returns a value indicating if the clipboard is empty.Return value
true if the clipboard is empty; otherwise, false.void setClipboard ( const char * clipboard ) #
Updates the contents of the system clipboard.Arguments
- const char * clipboard - Contents to set.
const char * getClipboard ( ) const#
Retrieves the contents of the system clipboard.Return value
Contents of the system clipboard.void setMouseCursorHide ( bool hide ) #
Sets a value indicating if the mouse cursor should be hidden. Can be used, for example, to hide mouse cursor for a certain element.Notice
This method hides the cursor only for one frame. So, you should call it each frame if a longer period is required.
Arguments
- bool hide - true to hide the mouse cursor for a single frame, false - to show it.
bool isMouseCursorHide ( ) const#
Returns a value indicating if the mouse cursor is hidden in the current frame.Return value
true if mouse cursor is hidden in the current frame, false - to show it.void setMouseCursorSystem ( bool system ) #
Sets a value indicating if the OS mouse pointer should be displayed.Arguments
- bool system - true to display the OS mouse pointer; otherwise, false.
bool isMouseCursorSystem ( ) const#
Returns a value indicating if the OS mouse pointer is displayed.Return value
true if the OS mouse pointer is displayed; otherwise, false.void setMouseCursorNeedUpdate ( bool update ) #
Sets a value indicating that some changes were made to the cursor (e.g., it was shown, hidden, changed to system, etc.) and it has to be updated. Suppose the cursor was modified, for example, by the Interface plugin. After closing the plugin's window the cursor shall not return to its previous state because SDL doesn't even know about the changes. You can use this flag to signalize, that mouse cursor must be updated.Arguments
- bool update - true to signalize that the mouse cursor has to be updated; otherwise, false.
bool isMouseCursorNeedUpdate ( ) const#
Returns a value indicating that changes were made to the cursor (e.g., it was shown, hidden, changed to system, etc.) and it has to be updated. Suppose the cursor was modified, for example, by the Interface plugin. After closing the plugin's window the cursor shall not return to its previous state because SDL doesn't even know about the changes. You can use this flag to signalize, that mouse cursor must be updated.Return value
true if the mouse cursor has to be updated; otherwise, false.void setMouseCursorSkinCustom ( const Ptr<Image> & image ) #
Sets a custom image to be used for the mouse cursor.Arguments
- const Ptr<Image> & image - Image containing pointer shapes to be set for the mouse cursor (e.g., select, move, resize, etc.).
void setMouseCursorSkinSystem ( ) #
Sets the current OS cursor skin (pointer shapes like select, move, resize, etc.).void setMouseCursorSkinDefault ( ) #
Sets the default Engine cursor skin (pointer shapes like select, move, resize, etc.).void setMouseCursorCustom ( const Ptr<Image> & image, int x = 0, int y = 0 ) #
Sets a custom image for the OS mouse cursor. The image must be of the square size and RGBA8 format.Source code (C++)
// create an instance of the Image class
ImagePtr cursor = Image::create("textures/my_cursor.png");
// set the image as the mouse cursor
Input::setMouseCursorCustom(cursor);
// show the OS mouse pointer
Input::setMouseCursorSystem(1);Arguments
- const Ptr<Image> & image - Cursor image to be set.
- int x - X coordinate of the cursor's hot spot.
- int y - Y coordinate of the cursor's hot spot.
void clearMouseCursorCustom ( ) #
Clears the custom mouse cursor set via the setMouseCursorCustom() method.void updateMouseCursor ( ) #
Updates the mouse cursor. This method should be called after making changes to the mouse cursor to apply them all together. After calling this method the cursor shall be updated in the next frame.const char * getKeyLocalName ( Input::KEY key ) const#
Returns the name for the specified key taken from the currently selected keyboard layout.Notice
The returned value is affected by the modifier such as Shift.
Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
Localized name for the specified key.int getMouseButtonEvents ( Input::MOUSE_BUTTON button, Vector<Ptr<InputEventMouseButton>> & events ) #
Returns the number of input events for the specified mouse button and puts the events to the specified output buffer.Arguments
- Input::MOUSE_BUTTON button - One of the preset MOUSE_BUTTON_ codes.
- Vector<Ptr<InputEventMouseButton>> & events - Buffer with input events.
Return value
Number of input events for the specified mouse button.Math::ivec2 getForceMousePosition ( ) #
Returns the absolute mouse position obtained from the OS.Return value
The absolute mouse position.bool isKeyText ( Input::KEY key ) const#
Returns a value indicating if the given key has a corresponding printable symbol (current Num Lock state is taken into account). For example, pressing 2 on the numpad with Num Lock enabled produces "2", while with disabled Num Lock the same key acts as a down arrow. Keys like Esc, PrintScreen, BackSpace do not produce any printable symbol at all.Arguments
- Input::KEY key - One of the preset KEY_ codes.
Return value
true if the key value is a symbol; otherwise, false.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase1< Input::MOUSE_BUTTON > * func ) #
Adds a callback of the specified type for mouse button events. Callback functions can be used to determine actions to be performed when various input events occur. Here is an example of tracking mouse button events via callbacks:Source code (C++)
void button_clicked(Input::MOUSE_BUTTON button)
{
// actions to be performed ...
}
// somewhere in the code
// setting our callback function on clicking a mouse button
Input::addCallback(Input::CALLBACK_MOUSE_DOWN, MakeCallback(button_clicked));Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase1< Input::MOUSE_BUTTON > * func - Callback function pointer. The callback signature should be as follows: Source code (C++)button - mouse button.
void callback_function_name(Input::MOUSE_BUTTON button);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase2< int, int > * func ) #
Adds a callback of the specified type for the mouse motion event. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase2< int, int > * func - Callback function pointer. The callback signature should be as follows: Source code (C++)(x, y) - mouse coordinates delta.
void callback_function_name(int x, int y);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase1< Input::KEY > * func ) #
Adds a callback of the specified type for keyboard events. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase1< Input::KEY > * func - Callback function pointer. The callback signature should be as follows: Source code (C++)key - keyboard key code.
void callback_function_name(Input::KEY key);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase1< unsigned int > * func ) #
Adds a callback of the specified type for a unicode key or a touch event. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase1< unsigned int > * func - Callback function pointer. The callback signature should be as follows: Source code (C++)code - unicode value displayed for the key or touch index (depending on the callback type).
void callback_function_name(unsigned int code);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase1< Ptr <InputEvent> > * func ) #
Adds a callback of the specified type. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase1< Ptr <InputEvent> > * func - Callback function pointer. The callback signature should be as follows: Source code (C++)event - input event.
void callback_function_name(InputEventPtr event);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase2< unsigned int, Input::GAMEPAD_BUTTON> * func ) #
Adds a callback of the specified type for a gamepad button event. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase2< unsigned int, Input::GAMEPAD_BUTTON> * func - Callback function pointer. The callback signature should be as follows: Source code (C++)index - gamepad index. button - gamepad button index.
void callback_function_name(unsigned int index, Input::GAMEPAD_BUTTON button);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase2< unsigned int, Input::GAMEPAD_AXIS> * func ) #
Adds a callback of the specified type for a gamepad axis event. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase2< unsigned int, Input::GAMEPAD_AXIS> * func - Callback function pointer. The callback signature should be as follows: Source code (C++)index - gamepad index. axis - gamepad axis index.
void callback_function_name(unsigned int index, Input::GAMEPAD_AXIS axis);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.void * addCallback ( CALLBACK_INDEX callback, Unigine::CallbackBase2< unsigned int, int> * func ) #
Adds a callback of the specified type for an action event. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the following:
-
Unigine::CallbackBase2< unsigned int, int> * func - Callback function pointer. The callback signature should be as follows: Source code (C++)index - device index. action - action index.
void callback_function_name(unsigned int index, int action);
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.bool removeCallback ( CALLBACK_INDEX callback, void * id ) #
Removes the specified callback from the list of callbacks of the specified type. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the CALLBACK_* variables.
- void * id - Callback ID obtained when adding it.
Return value
true if the callback with the given ID was removed successfully; otherwise false.void clearCallbacks ( CALLBACK_INDEX callback ) #
Clears all added callbacks of the specified type. Callback functions can be used to determine actions to be performed when various input events occur.Arguments
- CALLBACK_INDEX callback - Callback type. One of the CALLBACK_* variables.
const char * getModifierName ( Input::MODIFIER modifier ) const#
Returns the name of the key modifier by its scancode.Arguments
- Input::MODIFIER modifier - Scancode of the modifier.
Return value
Key name of the modifier.Input::MODIFIER getModifierByName ( const char * name ) const#
Returns the scancode of the key modifier by its name.Arguments
- const char * name - Key name of the modifier.
Return value
Scancode of the modifier.Last update:
13.04.2023
Помогите сделать статью лучше
Была ли эта статья полезной?
(или выберите слово/фразу и нажмите Ctrl+Enter