This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
VR Development
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::InputEvent Class

Header: #include <UnigineInput.h>

This class handles input event information.

InputEvent Class

Enums

TYPE#

NameDescription
INPUT_EVENT = 0Basic type. Cannot be created.
INPUT_EVENT_MOUSE_BUTTON = 1Mouse button has been clicked.
INPUT_EVENT_MOUSE_WHEEL = 2Mouse wheel has been moved.
INPUT_EVENT_MOUSE_MOTION = 3Mouse has been moved.
INPUT_EVENT_KEYBOARD = 4Keyboard button has been pressed.
INPUT_EVENT_TEXT = 5Text has been entered.
INPUT_EVENT_TOUCH = 6Touch device has been touched.
INPUT_EVENT_JOY_DEVICE = 7Joystick has been connected or disconnected.
INPUT_EVENT_JOY_BUTTON = 8Joystick button has been pressed.
INPUT_EVENT_JOY_AXIS_MOTION = 9Joystick axis has been moved.
INPUT_EVENT_JOY_POV_MOTION = 10Joystick POV hat has been moved.
INPUT_EVENT_PAD_DEVICE = 11Game pad has been connected or disconnected.
INPUT_EVENT_PAD_BUTTON = 12Game pad button has been pressed.
INPUT_EVENT_PAD_AXIS_MOTION = 13Game pad axis has been moved.
INPUT_EVENT_PAD_TOUCH_MOTION = 14Touch panel has been touched.
INPUT_EVENT_VR_DEVICE = 15
INPUT_EVENT_VR_BUTTON = 16
INPUT_EVENT_VR_BUTTON_TOUCH = 17
INPUT_EVENT_VR_AXIS_MOTION = 18
INPUT_EVENT_SYSTEM = 19System event has occurred (keyboard layout or input language has changed).
NUM_INPUT_EVENTS = 20Counter of input events.

Members


InputEvent::TYPE getType ( ) const#

Returns the type of the input event.

Return value

Type of the input event, one of the TYPE.INPUT_EVENT values.

const char * getTypeName ( ) const#

Returns the name of the input event type.

Return value

The name of the input event type.

void setTimestamp ( unsigned int timestamp ) #

Sets the timestamp of the event.

Arguments

  • unsigned int timestamp - The timestamp of the event, in milliseconds.

unsigned int getTimestamp ( ) const#

Returns the timestamp of the event.

Return value

The timestamp of the event, in milliseconds.

void setMousePosition ( const Math::ivec2 & pos ) #

Sets the mouse position for the event.

Arguments

  • const Math::ivec2 & pos - The position of the mouse.

Math::ivec2 getMousePosition ( ) const#

Returns the mouse position for the event.

Return value

The position of the mouse.

unsigned long long getFrame ( ) const#

Returns the engine frame during which the event has been sent from proxy to Input.
Last update: 2023-12-19
Build: ()