poret/UnrealImGui
1
0
Fork 0
mirror of https://github.com/kevinporetti/UnrealImGui.git synced 2025-01-18 16:30:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated project status and documentation.

Browse Source
This commit is contained in:
Sebastian 2019-08-08 19:05:00 +01:00
parent 9e5975c9bb
commit 05d7c5c48b
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.md
View File

@ -6,6 +6,8 @@ Change History
-------------- --------------
Version: 1.17 (2019/04) Version: 1.17 (2019/04)
- Added experimental support for touch input.
- Integrated fixes allowing to build this as an engine plugin:
- Added support for sharing with game mouse input. - Added support for sharing with game mouse input.
- Refactorization of input handling, with changes in SImGuiWidget and compatibility breaking changes in UImGuiInputHandler. - Refactorization of input handling, with changes in SImGuiWidget and compatibility breaking changes in UImGuiInputHandler.

13
README.md
View File

@ -9,7 +9,7 @@ Dear ImGui is an immediate-mode graphical user interface library that is very li
Status Status
------ ------
Version: 1.17 WIP Version: 1.17
ImGui version: 1.65 ImGui version: 1.65
@ -166,11 +166,9 @@ ImGui::Image(TextureHandle, Size);
Right after the start ImGui will work in render-only mode. To interact with it, you need to activate input mode either by changing `Input Enabled` [property](#properties) from code, using `ImGui.ToggleInput` [command](#console-commands) or with a [keyboard shortcut](#keyboard-shortcuts). Right after the start ImGui will work in render-only mode. To interact with it, you need to activate input mode either by changing `Input Enabled` [property](#properties) from code, using `ImGui.ToggleInput` [command](#console-commands) or with a [keyboard shortcut](#keyboard-shortcuts).
In input mode, ImGui will consume all input events. The reason behind the input mode and its default behaviour is a separation between debug and game inputs to prevent accidental changes in both layers.
#### Sharing input #### Sharing input
It is possible to modify rules to share keyboard or gamepad inputs. It is possible to enable input sharing features to pass keyboard, gamepad or mouse events to the game. Note, that the original design assumed that plugin should consume all input to isolate debug from game. While sharing keyboard or gamepad is pretty straightforward and works by passing input events to the viewport, mouse sharing works in a bit different way. Since the ImGui widget overlays the whole viewport, widget needs to switch hit visibility and update position in the background. It might be possible to generate a custom collision geometry matching ImGui and simplifying working with mouse and touch inputs, but I don't plan to work on this right now.
The default behaviour can be configured in [input settings](#input) and changed during runtime by modifying `Keyboard Input Shared`, `Gamepad Input Shared` and `Mouse Input Shared` [properties](#properties) or `ImGui.ToggleKeyboardInputSharing`, `ImGui.ToggleGamepadInputSharing` and `ImGui.ToggleMouseInputSharing` [commands](#console-commands). The default behaviour can be configured in [input settings](#input) and changed during runtime by modifying `Keyboard Input Shared`, `Gamepad Input Shared` and `Mouse Input Shared` [properties](#properties) or `ImGui.ToggleKeyboardInputSharing`, `ImGui.ToggleGamepadInputSharing` and `ImGui.ToggleMouseInputSharing` [commands](#console-commands).
@ -203,6 +201,7 @@ ImGui module has a set of properties that allow to modify its behaviour:
- `Gamepad Navigation` - Whether ImGui [gamepad navigation feature](#keyboard-and-gamepad-navigation) is enabled. - `Gamepad Navigation` - Whether ImGui [gamepad navigation feature](#keyboard-and-gamepad-navigation) is enabled.
- `Keyboard Input Shared` - Whether keyboard input should be [shared with the game](#sharing-input). Default behaviour can be configured in [input settings](#input). - `Keyboard Input Shared` - Whether keyboard input should be [shared with the game](#sharing-input). Default behaviour can be configured in [input settings](#input).
- `Gamepad Input Shared` - Whether gamepad input should be [shared with the game](#sharing-input). Default behaviour can be configured in [input settings](#input). - `Gamepad Input Shared` - Whether gamepad input should be [shared with the game](#sharing-input). Default behaviour can be configured in [input settings](#input).
- `Mouse Input Shared` - Whether mouse input should be [shared with the game](#sharing-input). Default behaviour can be configured in [input settings](#input).
- `Show Demo` - Whether to show ImGui demo. - `Show Demo` - Whether to show ImGui demo.
All properties can be changed by corresponding [console commands](#console-commands) or from code. All properties can be changed by corresponding [console commands](#console-commands) or from code.
@ -220,6 +219,7 @@ FImGuiModule::Get().GetProperties();
- `ImGui.ToggleGamepadNavigation` - Toggle ImGui gamepad navigation. - `ImGui.ToggleGamepadNavigation` - Toggle ImGui gamepad navigation.
- `ImGui.ToggleKeyboardInputSharing` - Toggle ImGui keyboard input sharing. - `ImGui.ToggleKeyboardInputSharing` - Toggle ImGui keyboard input sharing.
- `ImGui.ToggleGamepadInputSharing` - Toggle ImGui gamepad input sharing. - `ImGui.ToggleGamepadInputSharing` - Toggle ImGui gamepad input sharing.
- `ImGui.ToggleMouseInputSharing` - Toggle ImGui mouse input sharing.
- `ImGui.ToggleDemo` - Toggle ImGui demo. - `ImGui.ToggleDemo` - Toggle ImGui demo.
### Console debug variables ### Console debug variables
@ -238,8 +238,9 @@ Plugin settings can be found in *Project Settings/Plugins/ImGui* panel. Right no
>*If you decide to implement an own handler, please keep in mind that I'm thinking about replacing it.* >*If you decide to implement an own handler, please keep in mind that I'm thinking about replacing it.*
##### Input ##### Input
- `Share Keyboard Input` - Whether by default, ImGui should [shared with game](#sharing-input) keyboard input. - `Share Keyboard Input` - Whether by default, ImGui should [share with game](#sharing-input) keyboard input.
- `Share Gamepad Input` - Whether by default, ImGui should [shared with game](#sharing-input) gamepad input. - `Share Gamepad Input` - Whether by default, ImGui should [share with game](#sharing-input) gamepad input.
- `Share Mouse Input` - Whether by default, ImGui should [share with game](#sharing-input) mouse input.
- `Use Software Cursor` - Whether ImGui should draw its own cursor in place of the hardware one. - `Use Software Cursor` - Whether ImGui should draw its own cursor in place of the hardware one.
##### Keyboard shortcuts ##### Keyboard shortcuts