Class ImGuiManager

The ImGui integration service.

Inheritance
object
IdentifiableObject
DependencyObject
AttachableObject
SceneManager
ImGuiManager
Implements
Inherited Members
Namespace: Evergine.UI
Assembly: Evergine.ImGui.dll
Syntax
public class ImGuiManager : SceneManager, IDependencyObject

Constructors

ImGuiManager()

Initializes a new instance of the ImGuiManager class.

Declaration
public ImGuiManager()

Properties

CustomFonts

Gets or sets an CustomFont array indicating custom fonts to load.

Declaration
public CustomFont[] CustomFonts { get; set; }
Property Value
Type Description
CustomFont[]

ImGuizmoEnabled

Gets or sets a value indicating whether the Imguizmo extension is enabled.

Declaration
public bool ImGuizmoEnabled { get; set; }
Property Value
Type Description
bool

ImNodesEnabled

Gets or sets a value indicating whether the Imnodes extension is enabled.

Declaration
public bool ImNodesEnabled { get; set; }
Property Value
Type Description
bool

ImPlotEnabled

Gets or sets a value indicating whether the Implot extension is enabled.

Declaration
public bool ImPlotEnabled { get; set; }
Property Value
Type Description
bool

MergeCustomFonts

Gets or sets a value indicating whether to merge custom fonts into the default font atlas.

Declaration
public bool MergeCustomFonts { get; set; }
Property Value
Type Description
bool

RenderingCamera

Gets or sets the rendering camera.

Declaration
public Camera RenderingCamera { get; set; }
Property Value
Type Description
Camera

RequiresExplicitRenderingCamera

Gets or sets a value indicating whether this manager requires an explicit rendering camera. When true, the manager will not fall back to ActiveCamera3D.

Declaration
public bool RequiresExplicitRenderingCamera { get; set; }
Property Value
Type Description
bool

Methods

CreateImGuiBinding(Texture)

Gets or creates a new ImGui texture binding.

Declaration
public ImTextureRef CreateImGuiBinding(Texture texture)
Parameters
Type Name Description
Texture texture

The texture to bind.
Returns
Type Description
ImTextureRef

The binding pointer.

Destroy()

Destroys this object.

Declaration
public override void Destroy()
Overrides

ExistsFont(CustomFont)

Checks if the specified custom font exists in the assets directory.

Declaration
protected virtual bool ExistsFont(CustomFont customFont)
Parameters
Type Name Description
CustomFont customFont

The custom font to check.
Returns
Type Description
bool

True if the font exists, otherwise false.

GetFontPath(CustomFont)

Constructs the full file system path to the specified custom font asset.

Declaration
protected virtual string GetFontPath(CustomFont customFont)
Parameters
Type Name Description
CustomFont customFont

The custom font for which to retrieve the file system path. Cannot be null.
Returns
Type Description
string

A string containing the full file system path to the custom font asset.

OnActivated()

Invoked when the object is activated once it is attached.

Declaration
protected override void OnActivated()
Overrides

OnAttached()

Invoked when the object is attached to the system.

Declaration
protected override bool OnAttached()
Returns
Type Description
bool

True if everything is OK.
Overrides

OnDeactivated()

Invoked when the object is deactivated.

Declaration
protected override void OnDeactivated()
Overrides

RemoveImGuiBinding(Texture)

Removes an ImGui texture binding.

Declaration
public void RemoveImGuiBinding(Texture texture)
Parameters
Type Name Description
Texture texture

The texture to remove from the binding list.

Start()

Invoked to start the object.

Declaration
protected override void Start()
Overrides

TrySetCurrentContext()

Sets this manager ImGui context as current.

Declaration
public bool TrySetCurrentContext()
Returns
Type Description
bool

True if the context was set; otherwise false.

Implements

Extension Methods