ImGuiSamples Plugin

The ImGuiSamples Plugin demonstrates how to integrate the Dear ImGui library with UnigineEditor, as well as how to use the Editor's API to build advanced custom tools for various development tasks. With this plugin, you can create new buttons, menus, widgets and more - all directly inside the UnigineEditor.

This sample is available on the Add-On Store as ImGuiSamplesPlugin and covers multiple basic cases encountered by users when making their own Editor plugins. Alternatively, the sample can be downloaded from GitHub.

The plugin adds a custom window to the UnigineEditor, which contains three separate tabs - each showcasing a different sample:

Spline Editor#

Editor (Immediate Mode)#

Components#

Running the ImGuiSamples Plugin requires you to perform the following steps:

1. Create a new project. Open the SDK Browser, go to the My Projects tab and click the Create New button. If you want to use the plugin in an existing project, you can skip Steps 1 and 2 and proceed to Step 3.

2. In the window that opens, adjust the project configuration (API+IDE, SDK, build, precision, etc.) and click Create New Project.

   Notice

   While the ImGuiSamples Plugin is implemented in C++, it does not necessarily require a CPP-based project to work - you can use it in C#(.NET) or C++(CMake)-based projects as well.

3. After the new project is created, it will appear in the My Projects tab. Click Open Editor under the created project to open it in the UnigineEditor.

   

4. Download the ImGuiSamples Plugin add-on from Add-On Store at https://store.unigine.com/ and add it to the project by dragging the *.upackage into the project data/ folder in the Asset Browser. In the Import Package window that opens, click Force Import Dependencies in the bottom-left corner, then the Import Package button, and wait until the add-on contents are imported.

   

5. Restart the Editor. After that, you can run the plugin via: Windows -> Plugin-ImGuiSamples in the Editor's menu.

   

You can modify this plugin - for example, by adding your own UI elements or creating new tools - but this requires you to rebuild it. To make changes to your plugin, follow the steps below:

1. Install Required Dependencies.

   • The plugin uses the Qt framework. Make sure you have Qt 5.12.3 installed and that the corresponding QT environment variable is correctly set.

     Qt will be located using the QTROOT environment variable. You can set it, for example, as follows: click Start, type Environment Variables, and open Edit the system environment variables. In the System Environment Variables dialog, click New (or Edit, if it already exists) and set:

     • Variable name: QTROOT
     • Value: full path to your Qt installation (e.g., C:\Qt\5.12.3\msvc2017_64)

       

     • Restart your IDE or system to apply the changes.
2. Open the plugin project in your IDE.
   • Launch the recommended Visual Studio 2022 (other C++ IDE with CMake support can be used as well).
   • Load your project: source/plugins/Unigine/ImGuiSamples - the root folder of CMakeLists.txt. If everything is set up correctly, the CMakeLists.txt file will be highlighted in bold in the Solution Explorer window, indicating that the project is ready to build.
   Warning

   By default, the project uses single precision (float). If you need double precision, open the CMakeLists.txt file and change the following line:

   Source code

   set(UNIGINE_DOUBLE False CACHE BOOL "Double coords")

   to

   Source code

   set(UNIGINE_DOUBLE True CACHE BOOL "Double coords")

3. Build the plugin, and start the Editor to check your changes (e.g. click Open Editor on your project's card in SDK Browser).

   The plugin will be loaded automatically as it's already built and located in your_project\bin\plugins\Unigine\ImGuiSamples.

   To use this plugin in another UNIGINE project, copy the ImGuiSamples folder into the same path in the target project: your_other_project\bin\plugins\Unigine\ImGuiSamples. Make sure the target project uses the same SDK version, same build configuration (Debug or Release), and same precision (float or double) as the original project.

If you're still having trouble running the application, revisit the steps above to ensure nothing was skipped. Check that the CMake variable UNIGINE_DOUBLE in CMakeLists.txt matches the current build type (double/float). If you encounter CMake issues in Visual Studio, try rebuilding the project by right-clicking on it in the Visual Studio 2022, selecting Delete Cache and Reconfigure and then Build again.