ImGuiSamples Plugin

The ImGuiSamples Plugin demonstrates how to integrate the Dear ImGui library with UnigineEditor, and how to use the Editor's API to build advanced custom tools (create new buttons, menus, widgets and more) for various development tasks. The sample is also available on the Add-On Store as ImGuiSamples Plugin.

The plugin adds a custom window to the UnigineEditor with three tabs, each showcasing a different sample:

This sample demonstrates how to use the Editor's Undo/Redo system via the API, work with hotkeys, and implement custom visualization, using spline editing.

When Edit Mode is enabled, the spline editor becomes active. Available actions (remappable via Windows → Settings → Hotkeys):

• LMB - Select a point
• Shift + LMB - Add/remove a point or append to the spline
• Del - Remove selected point
• F - Focus camera on the selected point
• Ctrl + Z - Undo
• Ctrl + Y - Redo.

This sample demonstrates how to use the Editor and Engine widgets in immediate mode (ImGui-like style) using the EditorImmediate class. It's simple to use, but has a number of limitations. Best for prototypes and simple tools.

In the sample, four connected points form a polygon at the center of the world. Click Edit Mode to:

• Display manipulators for each point
• Move points using the manipulators
• Use the F key to focus the camera on the polygon.

The current position of each point (X, Y, Z) is updated each frame in the widget at the top-left corner of the viewport.

This sample shows how to work with C++ components inside the Editor.

• Click Initialize the ComponentSystem to register and activate the NodeRotation component (a property written in C++).
• Assign the component to any node. It starts rotating immediately.
• Control rotation speed using three sliders for X, Y, Z axes.

• UNIGINE SDK Browser (latest version)
• UNIGINE SDK Community or Engineering edition (Sim upgrade supported)
• Visual Studio 2022 (recommended)

To get started with the ImGuiSamples Plugin:

1. Clone or download the sample.

2. Open SDK Browser and make sure you have the latest version.

3. Add the sample project to SDK Browser:

   • Go to the My Projects tab.

   • Click Add Existing, select the .project file from the cloned folder (matching your OS - *_win_*/*_lin_*, edition, precision), and click Import Project.

     

4. Repair the project:

   • After importing, you'll see a Repair warning - this is expected, as only essential files are stored in the Git repository. SDK Browser will restore the rest.

• Click Repair and then Configure Project.

5. Install required dependencies:

   • The plugin uses the Qt 6.5.3 framework (UnigineEditor extensions require Qt). Install Qt 6.5.3 and make it discoverable by CMake. CMakeLists.txt searches for it in this order:
     • %UNIGINE_QTALLROOT%\v6.5.3 (environment variable UNIGINE_QTALLROOT), then
     • %UNIGINE_3RDPARTY_DIR%\Qt-All\v6.5.3 (environment variable UNIGINE_3RDPARTY_DIR), then
     • the CMake package search path (a system Qt 6.5.3, or pass -DCMAKE_PREFIX_PATH=<path-to-Qt-6.5.3>).
   • Set one of those environment variables to your Qt location (so that <value>\v6.5.3 exists), or pass -DCMAKE_PREFIX_PATH when configuring. Restart your IDE or system after changing environment variables.

6. Open the project in your IDE:

   • Launch the recommended Visual Studio 2022 (other C++ IDE with CMake support can be used as well).
   • Open the folder: source/plugins/Unigine/ImGuiSamples.
   • Confirm CMakeLists.txt is highlighted in bold (ready to build).

- set(UNIGINE_DOUBLE False CACHE BOOL "Double coords")
+ set(UNIGINE_DOUBLE True CACHE BOOL "Double coords")

7. Build and start the Editor:
   • Open Editor on your project's card in SDK Browser.
   • Plugin loads automatically from: your_project/bin/plugins/Unigine/ImGuiSamples.

If the plugin fails to run:

• Double-check all setup steps above to ensure nothing was skipped.
• Check that UNIGINE_DOUBLE in CMakeLists.txt matches the current build type (double/float).
• Ensure the correct .project file is used for your platform and SDK edition.
• Verify your SDK version is not older than the project's specified version.
• If CMake issues occur in Visual Studio, right-click the project and select: Delete Cache and Reconfigure and then Build again.