Generates input events for the world, after filtering by the UI. More...
#include <input_world_dispatcher.hpp>
Public Member Functions | |
| world_dispatcher ()=default | |
| Default constructor. More... | |
| world_dispatcher (const world_dispatcher &)=delete | |
| world_dispatcher (world_dispatcher &&)=delete | |
| world_dispatcher & | operator= (const world_dispatcher &)=delete |
| world_dispatcher & | operator= (world_dispatcher &&)=delete |
Public Attributes | |
| utils::signal< void(const mouse_moved_data &)> | on_mouse_moved |
| Signal triggered when the mouse moves. More... | |
| utils::signal< void(const mouse_wheel_data &)> | on_mouse_wheel |
| Signal triggered when the mouse wheel is moved. More... | |
| utils::signal< void(const mouse_pressed_data &)> | on_mouse_pressed |
| Signal triggered when a mouse button is pressed. More... | |
| utils::signal< void(const mouse_released_data &)> | on_mouse_released |
| Signal triggered when a mouse button is released. More... | |
| utils::signal< void(const mouse_double_clicked_data &)> | on_mouse_double_clicked |
| Signal triggered when a mouse button is double clicked. More... | |
| utils::signal< void(const mouse_drag_start_data &)> | on_mouse_drag_start |
| Signal triggered when the mouse starts a drag operation. More... | |
| utils::signal< void(const mouse_drag_stop_data &)> | on_mouse_drag_stop |
| Signal triggered when the mouse ends a drag operation. More... | |
| utils::signal< void(const key_pressed_data &)> | on_key_pressed |
| Signal triggered when a keyboard key is pressed. More... | |
| utils::signal< void(const key_pressed_repeat_data &)> | on_key_pressed_repeat |
| Signal triggered when a keyboard key is long-pressed and repeats. More... | |
| utils::signal< void(const key_released_data &)> | on_key_released |
| Signal triggered when a keyboard key is released. More... | |
| utils::signal< void(const text_entered_data &)> | on_text_entered |
| Signal triggered when text is entered. More... | |
Detailed Description
Generates input events for the world, after filtering by the UI.
The implementation is responsible for generating the following events:
- on_mouse_moved
- on_mouse_wheel
- on_mouse_pressed
- on_mouse_released
- on_mouse_double_clicked
- on_mouse_drag_start
- on_mouse_drag_stop
- on_key_pressed
- on_key_pressed_repeat
- on_key_released
- on_text_entered
These events will only trigger if not captured by any UI element, and are therefore suitable for "world" input (i.e., input for the game elements rendered below the UI). These events are triggered by gui::root, which takes care of filtering global inputs from the input::dispatcher.
Definition at line 32 of file input_world_dispatcher.hpp.
Constructor & Destructor Documentation
◆ world_dispatcher() [1/3]
|
default |
Default constructor.
◆ world_dispatcher() [2/3]
|
delete |
◆ world_dispatcher() [3/3]
|
delete |
Member Function Documentation
◆ operator=() [1/2]
|
delete |
◆ operator=() [2/2]
|
delete |
Member Data Documentation
◆ on_key_pressed
|
inherited |
Signal triggered when a keyboard key is pressed.
Definition at line 125 of file input_signals.hpp.
◆ on_key_pressed_repeat
|
inherited |
Signal triggered when a keyboard key is long-pressed and repeats.
Definition at line 130 of file input_signals.hpp.
◆ on_key_released
|
inherited |
Signal triggered when a keyboard key is released.
Definition at line 135 of file input_signals.hpp.
◆ on_mouse_double_clicked
|
inherited |
Signal triggered when a mouse button is double clicked.
Definition at line 110 of file input_signals.hpp.
◆ on_mouse_drag_start
|
inherited |
Signal triggered when the mouse starts a drag operation.
Definition at line 115 of file input_signals.hpp.
◆ on_mouse_drag_stop
|
inherited |
Signal triggered when the mouse ends a drag operation.
Definition at line 120 of file input_signals.hpp.
◆ on_mouse_moved
|
inherited |
Signal triggered when the mouse moves.
Definition at line 90 of file input_signals.hpp.
◆ on_mouse_pressed
|
inherited |
Signal triggered when a mouse button is pressed.
Definition at line 100 of file input_signals.hpp.
◆ on_mouse_released
|
inherited |
Signal triggered when a mouse button is released.
Definition at line 105 of file input_signals.hpp.
◆ on_mouse_wheel
|
inherited |
Signal triggered when the mouse wheel is moved.
Definition at line 95 of file input_signals.hpp.
◆ on_text_entered
|
inherited |
Signal triggered when text is entered.
- Note
- The event will trigger repeatedly if more than one character is generated.
Definition at line 141 of file input_signals.hpp.
The documentation for this class was generated from the following file:
- /home/runner/work/lxgui/lxgui/include/lxgui/input_world_dispatcher.hpp
