Use input struct for events and added was_dragged to on_mouse_released

Author: cschreib

examples/common/examples_common.cpp

@@ -195,9 +195,9 @@ void examples_setup_gui(gui::manager& manager) {
     //    Usage: manager.get_input_dispatcher().get_source().
 
     input::world_dispatcher& world_input_dispatcher = manager.get_world_input_dispatcher();
-    world_input_dispatcher.on_key_pressed.connect([&](input::key key_code) {
+    world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
         // Process keyboard inputs for the game...
-        switch (key_code) {
+        switch (args.key) {
         case input::key::k_p: gui::out << manager.print_ui() << std::endl; break;
         case input::key::k_c: manager.get_root().toggle_caching(); break;
         case input::key::k_r: manager.reload_ui(); break;
@@ -213,8 +213,7 @@ void examples_setup_gui(gui::manager& manager) {
         }
     });
 
-    world_input_dispatcher.on_mouse_pressed.connect(
-        [&](input::mouse_button button_code, const gui::vector2f& mouse_pos) {
-            // Process mouse inputs for the game...
-        });
+    world_input_dispatcher.on_mouse_released.connect([&](const input::mouse_released_data& args) {
+        // Process mouse inputs for the game...
+    });
 }

examples/opengl-sdl-emscripten/main.cpp

@@ -174,8 +174,8 @@ int main(int argc, char* argv[]) {
         // Register a callback on Escape to terminate the program.
         // Doing it this way, we only react to keyboard input that is not captured by the GUI.
         input::world_dispatcher& world_input_dispatcher = manager->get_world_input_dispatcher();
-        world_input_dispatcher.on_key_pressed.connect([&](input::key key_id) {
-            if (key_id == input::key::k_escape)
+        world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
+            if (args.key == input::key::k_escape)
                 emscripten_cancel_main_loop();
         });
 

examples/opengl-sdl/main.cpp

@@ -117,8 +117,8 @@ int main(int argc, char* argv[]) {
 
         // Register a callback on Escape to terminate the program.
         // Doing it this way, we only react to keyboard input that is not captured by the GUI.
-        world_input_dispatcher.on_key_pressed.connect([&](input::key key_id) {
-            if (key_id == input::key::k_escape)
+        world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
+            if (args.key == input::key::k_escape)
                 running = false;
         });
 

examples/opengl-sfml/main.cpp

@@ -70,8 +70,8 @@ int main(int argc, char* argv[]) {
 
         // Register a callback on Escape to terminate the program.
         // Doing it this way, we only react to keyboard input that is not captured by the GUI.
-        world_input_dispatcher.on_key_pressed.connect([&](input::key key_id) {
-            if (key_id == input::key::k_escape)
+        world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
+            if (args.key == input::key::k_escape)
                 running = false;
         });
 

examples/sdl-emscripten/main.cpp

@@ -149,8 +149,8 @@ int main(int argc, char* argv[]) {
         // Register a callback on Escape to terminate the program.
         // Doing it this way, we only react to keyboard input that is not captured by the GUI.
         input::world_dispatcher& world_input_dispatcher = manager->get_world_input_dispatcher();
-        world_input_dispatcher.on_key_pressed.connect([&](input::key key_id) {
-            if (key_id == input::key::k_escape)
+        world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
+            if (args.key == input::key::k_escape)
                 emscripten_cancel_main_loop();
         });
 

examples/sdl/main.cpp

@@ -88,8 +88,8 @@ int main(int argc, char* argv[]) {
 
         // Register a callback on Escape to terminate the program.
         // Doing it this way, we only react to keyboard input that is not captured by the GUI.
-        world_input_dispatcher.on_key_pressed.connect([&](input::key key_id) {
-            if (key_id == input::key::k_escape)
+        world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
+            if (args.key == input::key::k_escape)
                 running = false;
         });
 

examples/sfml/main.cpp

@@ -54,8 +54,8 @@ int main(int argc, char* argv[]) {
 
         // Register a callback on Escape to terminate the program.
         // Doing it this way, we only react to keyboard input that is not captured by the GUI.
-        world_input_dispatcher.on_key_pressed.connect([&](input::key key_id) {
-            if (key_id == input::key::k_escape)
+        world_input_dispatcher.on_key_pressed.connect([&](const input::key_pressed_data& args) {
+            if (args.key == input::key::k_escape)
                 running = false;
         });
 

include/lxgui/gui_frame.hpp

@@ -191,7 +191,9 @@ using script_list_view = script_signal::slot_list_view;
  * last call to `OnMouseMove` (or since the last position before the mouse
  * entered this frame), and the mouse X and Y position.
  * - `OnMouseUp`: Similar to `OnMouseDown`, but triggered when the mouse button
- * is released.
+ * is released. This event provides one extra argument compared to `OnMouseDown`:
+ * a boolean flag indicating whether the mouse was released after a drag
+ * operation (true) or not (false).
  * - `OnMouseWheel`: Triggered when the mouse wheel is moved and this frame is
  * the topmost mouse-wheel-enabled frame under the mouse pointer. This event
  * provides three arguments to the registered callback. The first is a number

include/lxgui/gui_root.hpp

@@ -7,6 +7,7 @@
 #include "lxgui/gui_key_binder.hpp"
 #include "lxgui/gui_registry.hpp"
 #include "lxgui/gui_vector2.hpp"
+#include "lxgui/input_signals.hpp"
 #include "lxgui/lxgui.hpp"
 #include "lxgui/utils_observer.hpp"
 #include "lxgui/utils_signal.hpp"
@@ -295,16 +296,17 @@ class root :
     set_hovered_frame_(utils::observer_ptr<frame> obj, const vector2f& mouse_pos = vector2f::zero);
 
     void on_window_resized_(const vector2ui& dimensions);
-    void on_mouse_moved_(const vector2f& movement, const vector2f& mouse_pos);
-    void on_mouse_wheel_(float wheel_scroll, const vector2f& mouse_pos);
-    void on_drag_start_(input::mouse_button button_id, const vector2f& mouse_pos);
-    void on_drag_stop_(input::mouse_button button_id, const vector2f& mouse_pos);
-    void on_text_entered_(std::uint32_t c);
-    void on_key_state_changed_(input::key key, bool is_down, bool is_repeat);
-    void on_mouse_button_state_changed_(
+    bool on_mouse_moved_(const input::mouse_moved_data& args);
+    bool on_mouse_wheel_(const input::mouse_wheel_data& args);
+    bool on_drag_start_(const input::mouse_drag_start_data& args);
+    bool on_drag_stop_(const input::mouse_drag_stop_data& args);
+    bool on_text_entered_(const input::text_entered_data& args);
+    bool on_key_state_changed_(input::key key, bool is_down, bool is_repeat);
+    bool on_mouse_button_state_changed_(
         input::mouse_button button_id,
         bool                is_down,
         bool                is_double_click,
+        bool                was_dragged,
         const vector2f&     mouse_pos);
 
     manager&                 manager_;

include/lxgui/input_signals.hpp

@@ -7,6 +7,71 @@
 
 namespace lxgui::input {
 
+/// Data for on_mouse_moved signal
+struct mouse_moved_data {
+    gui::vector2f motion; /// Mouse motion that generated this event, in points
+    gui::vector2f position; /// Mouse position, in points
+};
+
+/// Data for on_mouse_wheel signal
+struct mouse_wheel_data {
+    float         motion; /// Mouse wheel motion that generated this event
+    gui::vector2f position; /// Mouse position, in points
+};
+
+/// Data for on_mouse_pressed signal
+struct mouse_pressed_data {
+    input::mouse_button button; /// Mouse button that generated this event
+    gui::vector2f       position; /// Mouse position, in points
+};
+
+/// Data for on_mouse_released signal
+struct mouse_released_data {
+    input::mouse_button button; /// Mouse button that generated this event
+    gui::vector2f       position; /// Mouse position, in points
+    bool                was_dragged; /// Was mouse dragged before release?
+};
+
+/// Data for on_mouse_double_clicked signal
+struct mouse_double_clicked_data {
+    input::mouse_button button; /// Mouse button that generated this event
+    gui::vector2f       position; /// Mouse position, in points
+};
+
+/// Data for on_mouse_drag_start signal
+struct mouse_drag_start_data {
+    input::mouse_button button; /// Mouse button that generated this event (if more than one, only
+                                /// the first pressed)
+    gui::vector2f position; /// Mouse position, in points
+};
+
+/// Data for on_mouse_drag_stop signal
+struct mouse_drag_stop_data {
+    input::mouse_button button; /// Mouse button that generated this event (if more than one, only
+                                /// the first pressed)
+    gui::vector2f position; /// Mouse position, in points
+};
+
+/// Data for on_key_pressed signal
+struct key_pressed_data {
+    input::key key; /// Keyboard key that generated this event
+};
+
+/// Data for on_key_pressed_repeat signal
+struct key_pressed_repeat_data {
+    input::key key; /// Keyboard key that generated this event
+};
+
+/// Data for on_key_released signal
+struct key_released_data {
+    input::key key; /// Keyboard key that generated this event
+};
+
+/// Data for on_text_entered signal
+struct text_entered_data {
+    std::uint32_t character; /// Unicode UTF-32 code point of the typed character
+};
+
 /// Stores signals for input events.
 class signals {
 public:
@@ -21,88 +86,59 @@ class signals {
 
     /**
      * \brief Signal triggered when the mouse moves
-     * \details Arguments:
-     *  - mouse motion that generated this event, in points
-     *  - mouse position, in points
      */
-    utils::signal<void(const gui::vector2f&, const gui::vector2f&)> on_mouse_moved;
+    utils::signal<void(const mouse_moved_data&)> on_mouse_moved;
 
     /**
      * \brief Signal triggered when the mouse wheel is moved
-     * \details Arguments:
-     *  - mouse wheel motion that generated this event
-     *  - mouse position, in points
      */
-    utils::signal<void(float, const gui::vector2f&)> on_mouse_wheel;
+    utils::signal<void(const mouse_wheel_data&)> on_mouse_wheel;
 
     /**
      * \brief Signal triggered when a mouse button is pressed
-     * \details Arguments:
-     *  - mouse button that generated this event
-     *  - mouse position, in points
      */
-    utils::signal<void(input::mouse_button, const gui::vector2f&)> on_mouse_pressed;
+    utils::signal<void(const mouse_pressed_data&)> on_mouse_pressed;
 
     /**
      * \brief Signal triggered when a mouse button is released
-     * \details Arguments:
-     *  - mouse button that generated this event
-     *  - mouse position, in points
      */
-    utils::signal<void(input::mouse_button, const gui::vector2f&)> on_mouse_released;
+    utils::signal<void(const mouse_released_data&)> on_mouse_released;
 
     /**
      * \brief Signal triggered when a mouse button is double clicked
-     * \details Arguments:
-     *  - mouse button that generated this event
-     *  - mouse position, in points
      */
-    utils::signal<void(input::mouse_button, const gui::vector2f&)> on_mouse_double_clicked;
+    utils::signal<void(const mouse_double_clicked_data&)> on_mouse_double_clicked;
 
     /**
      * \brief Signal triggered when the mouse starts a drag operation
-     * \details Arguments:
-     *  - mouse button that is pressed (if more than one, only the first pressed)
-     *  - mouse position, in points
      */
-    utils::signal<void(input::mouse_button, const gui::vector2f&)> on_mouse_drag_start;
+    utils::signal<void(const mouse_drag_start_data&)> on_mouse_drag_start;
 
     /**
      * \brief Signal triggered when the mouse ends a drag operation
-     * \details Arguments:
-     *  - mouse button that was pressed (if more than one, only the first pressed)
-     *  - mouse position, in points
      */
-    utils::signal<void(input::mouse_button, const gui::vector2f&)> on_mouse_drag_stop;
+    utils::signal<void(const mouse_drag_stop_data&)> on_mouse_drag_stop;
 
     /**
      * \brief Signal triggered when a keyboard key is pressed
-     * \details Arguments:
-     *  - keyboard key that generated this event
      */
-    utils::signal<void(input::key)> on_key_pressed;
+    utils::signal<void(const key_pressed_data&)> on_key_pressed;
 
     /**
      * \brief Signal triggered when a keyboard key is long-pressed and repeats
-     * \details Arguments:
-     *  - keyboard key that generated this event
      */
-    utils::signal<void(input::key)> on_key_pressed_repeat;
+    utils::signal<void(const key_pressed_repeat_data&)> on_key_pressed_repeat;
 
     /**
      * \brief Signal triggered when a keyboard key is released
-     * \details Arguments:
-     *  - keyboard key that generated this event
      */
-    utils::signal<void(input::key)> on_key_released;
+    utils::signal<void(const key_released_data&)> on_key_released;
 
     /**
      * \brief Signal triggered when text is entered
-     * \details Arguments:
-     *  - Unicode UTF-32 code point of the typed character
      * \note The event will trigger repeatedly if more than one character is generated.
      */
-    utils::signal<void(std::uint32_t)> on_text_entered;
+    utils::signal<void(const text_entered_data&)> on_text_entered;
 };
 
 } // namespace lxgui::input

src/gui_frame_glues.cpp

@@ -150,7 +150,9 @@
  * last call to `OnMouseMove` (or since the last position before the mouse
  * entered this frame), and the mouse X and Y position.
  * - `OnMouseUp`: Similar to `OnMouseDown`, but triggered when the mouse button
- * is released.
+ * is released. This event provides one extra argument compared to `OnMouseDown`:
+ * a boolean flag indicating whether the mouse was released after a drag
+ * operation (true) or not (false).
  * - `OnMouseWheel`: Triggered when the mouse wheel is moved and this frame is
  * the topmost mouse-wheel-enabled frame under the mouse pointer. This event
  * provides three arguments to the registered callback. The first is a number