imgui

Class ImGuiWindowClass

java.lang.Object

imgui.ImGuiWindowClass

public final class ImGuiWindowClass
extends java.lang.Object

[ALPHA] Rarely used / very advanced uses only. Use with SetNextWindowClass() and DockSpace() functions. Important: the content of this class is still highly WIP and likely to change and be refactored before we stabilize Docking features. Please be mindful if using this. Provide hints: - To the platform back-end via altered viewport flags (enable/disable OS decoration, OS task bar icons, etc.) - To the platform back-end for OS level parent/child relationships of viewport. - To the docking system for various options and filtering.

Constructor Summary

Constructors

Constructor and Description
ImGuiWindowClass() This class will create a native structure.

Method Summary

Modifier and Type	Method and Description
void	destroy()
int	geClassId() User data.
boolean	getDockingAllowUnclassed() Set to true to allow windows of this class to be docked/merged with an unclassed window.
boolean	getDockingAlwaysTabBar() Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)
int	getDockNodeFlagsOverrideClear() [EXPERIMENTAL]
int	getDockNodeFlagsOverrideSet() [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)
int	getParentViewportId() Hint for the platform back-end.
void	setClassId(int classId) User data.
void	setDockingAllowUnclassed(boolean dockingAllowUnclassed) Set to true to allow windows of this class to be docked/merged with an unclassed window.
void	setDockingAlwaysTabBar(boolean dockingAlwaysTabBar) Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)
void	setDockNodeFlagsOverrideClear(int dockNodeFlagsOverrideClear) [EXPERIMENTAL]
void	setDockNodeFlagsOverrideSet(int dockNodeFlagsOverrideSet) [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)
void	setParentViewportId(int parentViewportId) Hint for the platform back-end.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImGuiWindowClass

public ImGuiWindowClass()

This class will create a native structure. Call destroy() method to manually free used memory.

Method Detail

destroy

public void destroy()

geClassId

public int geClassId()

User data. 0 = Default class (unclassed). Windows of different classes cannot be docked with each others.

setClassId

public void setClassId(int classId)

User data. 0 = Default class (unclassed). Windows of different classes cannot be docked with each others.

getParentViewportId

public int getParentViewportId()

Hint for the platform back-end. If non-zero, the platform back-end can create a parent<>child relationship between the platform windows. Not conforming back-ends are free to e.g. parent every viewport to the main viewport or not.

setParentViewportId

public void setParentViewportId(int parentViewportId)

Hint for the platform back-end. If non-zero, the platform back-end can create a parent<>child relationship between the platform windows. Not conforming back-ends are free to e.g. parent every viewport to the main viewport or not.

getDockNodeFlagsOverrideSet

public int getDockNodeFlagsOverrideSet()

[EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

setDockNodeFlagsOverrideSet

public void setDockNodeFlagsOverrideSet(int dockNodeFlagsOverrideSet)

[EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

getDockNodeFlagsOverrideClear

public int getDockNodeFlagsOverrideClear()

[EXPERIMENTAL]

setDockNodeFlagsOverrideClear

public void setDockNodeFlagsOverrideClear(int dockNodeFlagsOverrideClear)

[EXPERIMENTAL]

getDockingAlwaysTabBar

public boolean getDockingAlwaysTabBar()

Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)

setDockingAlwaysTabBar

public void setDockingAlwaysTabBar(boolean dockingAlwaysTabBar)

Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)

getDockingAllowUnclassed

public boolean getDockingAllowUnclassed()

Set to true to allow windows of this class to be docked/merged with an unclassed window.

setDockingAllowUnclassed

public void setDockingAllowUnclassed(boolean dockingAllowUnclassed)

Set to true to allow windows of this class to be docked/merged with an unclassed window.