Merge pull request #962 from justarandomguyintheinternet/master

Added back ImGui Input functions
maximegmd · Sep 12, 2024 · d3693f2 · d3693f2
2 parents 5549f67 + caa0ce5
commit d3693f2
Show file tree

Hide file tree

Showing 3 changed files with 191 additions and 0 deletions.
diff --git a/src/imgui_impl/win32.cpp b/src/imgui_impl/win32.cpp
@@ -92,12 +92,19 @@ bool ImGui_ImplWin32_Init(HWND ahWnd)
     io.KeyMap[ImGuiKey_Enter] = VK_RETURN;
     io.KeyMap[ImGuiKey_Escape] = VK_ESCAPE;
     io.KeyMap[ImGuiKey_KeyPadEnter] = VK_RETURN;
+    io.KeyMap[ImGuiKey_LeftCtrl] = VK_CONTROL;
+    io.KeyMap[ImGuiKey_LeftShift] = VK_SHIFT;
     io.KeyMap[ImGuiKey_A] = 'A';
     io.KeyMap[ImGuiKey_C] = 'C';
     io.KeyMap[ImGuiKey_V] = 'V';
     io.KeyMap[ImGuiKey_X] = 'X';
     io.KeyMap[ImGuiKey_Y] = 'Y';
     io.KeyMap[ImGuiKey_Z] = 'Z';
+    io.KeyMap[ImGuiKey_G] = 'G';
+    io.KeyMap[ImGuiKey_S] = 'S';
+    io.KeyMap[ImGuiKey_D] = 'D';
+    io.KeyMap[ImGuiKey_R] = 'R';
+    io.KeyMap[ImGuiKey_H] = 'H';
 
     return true;
 }

diff --git a/src/sol_imgui/README.md b/src/sol_imgui/README.md
@@ -1424,14 +1424,76 @@ selected, activated = ImGui.MenuItem("Label", "ALT+F4", selected, true)
   color_u32 = ImGui.ColorConvertFloat4ToU32({0.4, 0.2, 0, 1})
 ```
 
+## Inputs Utilities: Keyboard
+```lua
+  -- ImGui.GetKeyIndex(...)
+  -- Parameters: ImGuiKey (key)
+  -- Returns: int (index)
+  index = ImGui.GetKeyIndex(ImGuiKey.Tab)
+
+  -- ImGui.IsKeyDown(...)
+  -- Parameters: int (key_index)
+  -- Returns: bool (down)
+  down = ImGui.IsKeyDown(0)
+
+  -- ImGui.IsKeyPressed(...)
+  -- Parameters: int (key_index), bool (repeat) [O]
+  -- Returns: bool (pressed)
+  -- Overloads
+  pressed = ImGui.IsKeyPressed(0)
+  pressed = ImGui.IsKeyPressed(0, true)
+
+  -- ImGui.IsKeyReleased(...)
+  -- Parameters: int (key_index)
+  -- Returns: bool (released)
+  released = ImGui.IsKeyReleased(0)
+
+  -- ImGui.GetKeyPressedAmount(...)
+  -- Parameters: int (key_index), float (repeat_delay), float (rate)
+  -- Returns: int (pressed_amount)  
+  pressed_amount = ImGui.GetKeyPressedAmount(0, 0.5, 5)
+
+  -- ImGui.CaptureKeyboardFromApp(...)
+  -- Parameters: bool (want_capture_keyboard_value) [O]
+  -- Overloads
+  ImGui.CaptureKeyboardFromApp()
+  ImGui.CaptureKeyboardFromApp(false)
+```
+
 ## Inputs Utilities: Mouse
 ```lua
+  -- ImGui.IsMouseDown(...)
+  -- Parameters: ImGuiMouseButton (button)
+  -- Returns: bool (down)
+  down = ImGui.IsMouseDown(ImGuiMouseButton.Right)
+
+  -- ImGui.IsMouseClicked(...)
+  -- Parameters: ImGuiMouseButton (button), bool (repeat) [O]
+  -- Returns: bool (clicked)
+  -- Overloads
+  clicked = ImGui.IsMouseClicked(ImGuiMouseButton.Right)
+  clicked = ImGui.IsMouseClicked(ImGuiMouseButton.Right, false)
+
+  -- ImGui.IsMouseReleased(...)
+  -- Parameters: ImGuiMouseButton (button)
+  -- Returns: bool (released)
+  released = ImGui.IsMouseReleased(ImGuiMouseButton.Right)
+
+  -- ImGui.IsMouseDoubleClicked(...)
+  -- Parameters: ImGuiMouseButton (button)
+  -- Returns: bool (double_clicked)
+  double_clicked = ImGui.IsMouseDoubleClicked(ImGuiMouseButton.Right)
+
   -- ImGui.IsMouseHoveringRect(...)
   -- Parameters: float (min_x), float (min_y), float(max_x), float(max_y), bool (clip) [O]
   -- Returns: bool (hovered)
   hovered = ImGui.IsMouseHoveringRect(0, 0, 100, 100)
   hovered = ImGui.IsMouseHoveringRect(0, 0, 100, 100, true)
 
+  -- ImGui.IsAnyMouseDown()
+  -- Returns: bool (any_mouse_down)
+  any_mouse_down = ImGui.IsAnyMouseDown()
+
   -- ImGui.GetMousePos()
   -- Returns: float (x), float (y)
   x, y = ImGui.GetMousePos()
@@ -1460,6 +1522,20 @@ selected, activated = ImGui.MenuItem("Label", "ALT+F4", selected, true)
   -- Overloads
   ImGui.ResetMouseDragDelta()
   ImGui.ResetMouseDragDelta(ImGuiMouseButton.Middle)
+
+  -- ImGui.GetMouseCursor()
+  -- Returns: ImGuiMouseCursor (cursor)
+  cursor = ImGui.GetMouseCursor()
+
+  -- ImGui.SetMouseCursor(...)
+  -- Parameters: ImGuiMouseCursor (cursor_type)
+  ImGui.SetMouseCursor(ImGuiMouseCursor.Hand)
+
+  -- ImGui.CaptureMouseFromApp()
+  -- Parameters: bool (want_capture_mouse_value) [O]
+  -- Overloads
+  ImGui.CaptureMouseFromApp()
+  ImGui.CaptureMouseFromApp(true)
 ```
 
 ## Clipboard Utilities

diff --git a/src/sol_imgui/sol_imgui.h b/src/sol_imgui/sol_imgui.h
@@ -2600,7 +2600,63 @@ inline std::tuple<float, float, float> ColorConvertHSVtoRGB(float h, float s, fl
     return std::make_tuple(r, g, b);
 }
 
+// Inputs Utilities: Keyboard
+inline int GetKeyIndex(int imgui_key)
+{
+    return ImGui::GetKeyIndex(static_cast<ImGuiKey>(imgui_key));
+}
+inline bool IsKeyDown(int user_key_index)
+{
+    return ImGui::IsKeyDown(user_key_index);
+}
+inline bool IsKeyPressed(int user_key_index)
+{
+    return ImGui::IsKeyPressed(user_key_index);
+}
+inline bool IsKeyPressed(int user_key_index, bool repeat)
+{
+    return ImGui::IsKeyPressed(user_key_index, repeat);
+}
+inline bool IsKeyReleased(int user_key_index)
+{
+    return ImGui::IsKeyReleased(user_key_index);
+}
+inline int GetKeyPressedAmount(int key_index, float repeat_delay, float rate)
+{
+    return ImGui::GetKeyPressedAmount(key_index, repeat_delay, rate);
+}
+inline void CaptureKeyboardFromApp()
+{
+    ImGui::CaptureKeyboardFromApp();
+}
+inline void CaptureKeyboardFromApp(bool want_capture_keyboard_value)
+{
+    ImGui::CaptureKeyboardFromApp(want_capture_keyboard_value);
+}
+
 // Inputs Utilities: Mouse
+
+inline bool IsMouseDown(int button)
+{
+    return ImGui::IsMouseDown(static_cast<ImGuiMouseButton>(button));
+}
+inline bool IsMouseClicked(int button)
+{
+    return ImGui::IsMouseClicked(static_cast<ImGuiMouseButton>(button));
+}
+inline bool IsMouseClicked(int button, bool repeat)
+{
+    return ImGui::IsMouseClicked(static_cast<ImGuiMouseButton>(button), repeat);
+}
+inline bool IsMouseReleased(int button)
+{
+    return ImGui::IsMouseReleased(static_cast<ImGuiMouseButton>(button));
+}
+inline bool IsMouseDoubleClicked(int button)
+{
+    return ImGui::IsMouseDoubleClicked(static_cast<ImGuiMouseButton>(button));
+}
+
 inline bool IsMouseHoveringRect(float min_x, float min_y, float max_x, float max_y)
 {
     return ImGui::IsMouseHoveringRect({min_x, min_y}, {max_x, max_y});
@@ -2609,6 +2665,10 @@ inline bool IsMouseHoveringRect(float min_x, float min_y, float max_x, float max
 {
     return ImGui::IsMouseHoveringRect({min_x, min_y}, {max_x, max_y}, clip);
 }
+inline bool IsAnyMouseDown()
+{
+    return ImGui::IsAnyMouseDown();
+}
 inline std::tuple<float, float> GetMousePos()
 {
     const auto vec2{ImGui::GetMousePos()};
@@ -2650,6 +2710,22 @@ inline void ResetMouseDragDelta(int button)
 {
     ImGui::ResetMouseDragDelta(static_cast<ImGuiMouseButton>(button));
 }
+inline int GetMouseCursor()
+{
+    return ImGui::GetMouseCursor();
+}
+inline void SetMouseCursor(int cursor_type)
+{
+    ImGui::SetMouseCursor(static_cast<ImGuiMouseCursor>(cursor_type));
+}
+inline void CaptureMouseFromApp()
+{
+    ImGui::CaptureMouseFromApp();
+}
+inline void CaptureMouseFromApp(bool want_capture_mouse_value)
+{
+    ImGui::CaptureMouseFromApp(want_capture_mouse_value);
+}
 
 // Clipboard Utilities
 inline std::string GetClipboardText()
@@ -3048,6 +3124,22 @@ inline void InitEnums(sol::table luaGlobals)
     luaGlobals.new_enum("ImGuiMouseButton", "Left", ImGuiMouseButton_Left, "Right", ImGuiMouseButton_Right, "Middle", ImGuiMouseButton_Middle, "COUNT", ImGuiMouseButton_COUNT);
 #pragma endregion MouseButton
 
+#pragma region Key
+    luaGlobals.new_enum(
+        "ImGuiKey", "Tab", ImGuiKey_Tab, "LeftArrow", ImGuiKey_LeftArrow, "RightArrow", ImGuiKey_RightArrow, "UpArrow", ImGuiKey_UpArrow, "DownArrow", ImGuiKey_DownArrow, "PageUp",
+        ImGuiKey_PageUp, "PageDown", ImGuiKey_PageDown, "Home", ImGuiKey_Home, "End", ImGuiKey_End, "Insert", ImGuiKey_Insert, "Delete", ImGuiKey_Delete, "Backspace",
+        ImGuiKey_Backspace, "Space", ImGuiKey_Space, "Enter", ImGuiKey_Enter, "Escape", ImGuiKey_Escape, "KeyPadEnter", ImGuiKey_KeyPadEnter, "A", ImGuiKey_A, "C", ImGuiKey_C, "V",
+        ImGuiKey_V, "X", ImGuiKey_X, "Y", ImGuiKey_Y, "Z", ImGuiKey_Z, "COUNT", ImGuiKey_COUNT, "LeftCtrl", ImGuiKey_LeftCtrl, "LeftShift", ImGuiKey_LeftShift, "G", ImGuiKey_G,
+        "S", ImGuiKey_S, "D", ImGuiKey_D, "R", ImGuiKey_R, "H", ImGuiKey_H);
+#pragma endregion Key
+
+#pragma region MouseCursor
+    luaGlobals.new_enum(
+        "ImGuiMouseCursor", "None", ImGuiMouseCursor_None, "Arrow", ImGuiMouseCursor_Arrow, "TextInput", ImGuiMouseCursor_TextInput, "ResizeAll", ImGuiMouseCursor_ResizeAll,
+        "ResizeNS", ImGuiMouseCursor_ResizeNS, "ResizeEW", ImGuiMouseCursor_ResizeEW, "ResizeNESW", ImGuiMouseCursor_ResizeNESW, "ResizeNWSE", ImGuiMouseCursor_ResizeNWSE, "Hand",
+        ImGuiMouseCursor_Hand, "NotAllowed", ImGuiMouseCursor_NotAllowed, "COUNT", ImGuiMouseCursor_COUNT);
+#pragma endregion MouseCursor
+
 #pragma region ImDrawCorner Flags
     luaGlobals.new_enum(
         "ImDrawCornerFlags", "None", ImDrawCornerFlags_None, "TopLeft", ImDrawCornerFlags_TopLeft, "TopRight", ImDrawCornerFlags_TopRight, "BotLeft", ImDrawCornerFlags_BotLeft,
@@ -3684,10 +3776,23 @@ inline void InitBindings(sol::state& lua, sol::table luaGlobals)
     ImGui.set_function("ColorConvertHSVtoRGB", ColorConvertHSVtoRGB);
 #pragma endregion Color Utilities
 
+#pragma region Inputs Utilities: Keyboard
+    ImGui.set_function("GetKeyIndex", GetKeyIndex);
+    ImGui.set_function("IsKeyDown", IsKeyDown);
+    ImGui.set_function("IsKeyPressed", sol::overload(sol::resolve<bool(int)>(IsKeyPressed), sol::resolve<bool(int, bool)>(IsKeyPressed)));
+    ImGui.set_function("IsKeyReleased", IsKeyReleased);
+    ImGui.set_function("CaptureKeyboardFromApp", sol::overload(sol::resolve<void()>(CaptureKeyboardFromApp), sol::resolve<void(bool)>(CaptureKeyboardFromApp)));
+#pragma endregion Inputs Utilities : Keyboard
+
 #pragma region Inputs Utilities : Mouse
+    ImGui.set_function("IsMouseDown", IsMouseDown);
+    ImGui.set_function("IsMouseClicked", sol::overload(sol::resolve<bool(int)>(IsMouseClicked), sol::resolve<bool(int, bool)>(IsMouseClicked)));
+    ImGui.set_function("IsMouseReleased", IsMouseReleased);
+    ImGui.set_function("IsMouseDoubleClicked", IsMouseDoubleClicked);
     ImGui.set_function(
         "IsMouseHoveringRect",
         sol::overload(sol::resolve<bool(float, float, float, float)>(IsMouseHoveringRect), sol::resolve<bool(float, float, float, float, bool)>(IsMouseHoveringRect)));
+    ImGui.set_function("IsAnyMouseDown", IsAnyMouseDown);
     ImGui.set_function("GetMousePos", GetMousePos);
     ImGui.set_function("GetMousePosOnOpeningCurrentPopup", GetMousePosOnOpeningCurrentPopup);
     ImGui.set_function("IsMouseDragging", sol::overload(sol::resolve<bool(int)>(IsMouseDragging), sol::resolve<bool(int, float)>(IsMouseDragging)));
@@ -3696,6 +3801,9 @@ inline void InitBindings(sol::state& lua, sol::table luaGlobals)
                                  sol::resolve<std::tuple<float, float>()>(GetMouseDragDelta), sol::resolve<std::tuple<float, float>(int)>(GetMouseDragDelta),
                                  sol::resolve<std::tuple<float, float>(int, float)>(GetMouseDragDelta)));
     ImGui.set_function("ResetMouseDragDelta", sol::overload(sol::resolve<void()>(ResetMouseDragDelta), sol::resolve<void(int)>(ResetMouseDragDelta)));
+    ImGui.set_function("GetMouseCursor", GetMouseCursor);
+    ImGui.set_function("SetMouseCursor", SetMouseCursor);
+    ImGui.set_function("CaptureMouseFromApp", sol::overload(sol::resolve<void()>(CaptureMouseFromApp), sol::resolve<void(bool)>(CaptureMouseFromApp)));
 #pragma endregion Inputs Utilities : Mouse
 
 #pragma region Clipboard Utilities