Dear ImGui

Integrating the Dear ImGui C++ sample into your project requires you to perform the following steps.

1. Copy the following files from the sample project to your project:

   • The imgui folder — to the source/ folder
   • The ImGuiImpl.cpp and ImGuiImpl.h files — to the source/ folder
   • The data/imgui.basemat file — to the data/ folder
2. In Visual Studio, add all files copied to the source/ folder to your project (Project -> Add Existing Item...).

3. To display the sample menu in your application, add the following lines in the corresponding sections of source/AppSystemLogic.cpp:

   Source code (C++)

   #include <UnigineWorld.h>
   #include <UnigineControls.h>
   #include <UnigineInput.h>
   
   #include "ImGuiImpl.h"
   
   using namespace Unigine;
   
   	
   int AppSystemLogic::init()
   {
   	Unigine::Engine::get()->setBackgroundUpdate(Engine::BACKGROUND_UPDATE_RENDER_NON_MINIMIZED);
   
   	// initialize ImGui backend, set up the Engine
   	ImGuiImpl::init();
   
   	return 1;
   }
   
   int AppSystemLogic::update()
   {
   	EngineWindowPtr main_window = WindowManager::getMainWindow();
   	if (!main_window)
   	{
   		Engine::get()->quit();
   		return 1;
   	}
   
   	ImGuiImpl::newFrame();
   
   	// feel free to use ImGui API here...
   	ImGui::ShowDemoWindow();
   
   	ImGuiImpl::render();
   	return 1;
   }
   
   int AppSystemLogic::shutdown()
   {
   	ImGuiImpl::shutdown();
   
   	return 1;
   }

//#define ImDrawIdx unsigned int

#define ImDrawIdx int

When creating a release build, add the absolute and the relative path for imgui.basemat as shown below:

Integrating the Dear ImGui C# sample into your project requires you to perform the following steps.

1. Add ImGui libraries using either of the following variants:

   • Manually: copy the cimgui.dll and ImGui.NET.dll files from the sample folder to the bin/ folder of your project.
   • In Visual Studio Code, open the terminal and type dotnet add package ImGui.NET -v 1.86.0.

   • In Visual Studio, select Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution..., find ImGui.NET wrapper and install it (the sample uses version 1.86.0).

     

2. Copy the data/imgui.basemat file to the data/ folder of your project.
3. Copy the ImGuiImpl.cs file to the source/ folder of your project.

4. Add ImGuiImpl.cs to <Project_Name>.csproj in the root directory of the project:

   Source code

   <Compile Include="source\ImGuiImpl.cs" />

5. Add the ImGui.NET.dll library to the Reference in <Project_Name>.csproj and make sure to specify the HintPath:

   Source code

   <ItemGroup>
   	<Reference Include="ImGui.NET">
   		<HintPath>bin\ImGui.NET.dll</HintPath>
   	</Reference>
   </ItemGroup>

6. In <Project_Name>.csproj, add the possibility to work with Unsafe blocks:

   Source code

   <AllowUnsafeBlocks>True</AllowUnsafeBlocks>

7. In source/AppSystemLogic.cs, add the directive and the following code in the corresponding methods.

   Source code (C#)

   using ImGuiNET;
   
   	
   	public override bool Init()
   		{
   			ImGuiImpl.Init();
   			return true;
   		}
   
   		public override bool Update()
   		{
   			ImGuiImpl.NewFrame();
   
   			// feel free to use ImGui API here...
   			ImGui.ShowDemoWindow();
   
   			ImGuiImpl.Render();
   
   			return true;
   		}
   		public override bool Shutdown()
   		{
   			ImGuiImpl.Shutdown();
   			return true;
   		}

//#define ImDrawIdx unsigned int

#define ImDrawIdx int

Building the Project#