class
DockableEditorWindow
Single window in the editor, that may be dragged, docked and can share space with multiple other windows by using tabs.
Unlike other editor windows, dockable editor windows can never exist on its own, it must always be docked to a parent tab group.
Public
Constructors
DockableEditorWindow
*********************************************************************
Methods
~DockableEditorWindow
GetName
Gets a unique name for this window.
This name will be used for referencing the window by other systems.
GetDisplayName
Gets the display name for the window.
This is what editor users will see in the window title bar.
GetDefaultSize
Returns the width/height of the window when initially created, in physical pixel units.
GetBounds
Returns the bounds of the window in physical pixels, relative to its parent tab group.
SetHasFocus
Makes the window in or out focus.
Window can only be made in focus if it is active.
HasFocus
Checks if the window has focus (usually means user clicked on it last).
SetActive
Makes the window active in its tab group.
This means the windows tab is active and the window is visible.
IsActive
Checks is the window the currently active window in its tab group.
This means the window's tab is active or the window is the only one in its container.
GetParentWindow
Gets the parent editor key window this window is docked in.
Can be null (for example when window is in the process of dragging and not visible).
GetParentTabGroup
Returns the parent window tab group.
Can be null (for example when window is in the process of dragging and not visible).
GetPosition
GetSize
GetDPIScale
Returns currently set DPI scale.
Scale of 1.0 corresponds to 96 DPI. physical pixel = logical pixel * DPI scale logical pixel = physical pixel / DPI ccale;
GetContent
Returns the GUI panel at the root of the window.
You should all your own GUI elements as children of this element.
ScreenToWindowPosition
Converts screen coordinates to coordinates relative to the window's GUI content panel.
WindowToScreenPosition
Converts coordinates relative to the window's GUI content panel to screen coordinates.
Close
Closes and destroys the window.
staticGetRttiStatic
Fields
OnParentTabGroupChanged
Triggered whenever window parent tab group changes.
Internal
Methods
SetSize
Size of the window.
SetPosition
Top-left corner of the window in screen space.
GetRenderWindow
Returns the render window that this editor window is being rendered to.
GetGUICamera
Returns the camera used for rendering the window GUI contents.
GetGUIWidget
Returns the GUI widget used for displaying GUI contents in the window.
NotifyTabGroupChanged
Changes the parent tab group of the window (e.g. when docking the window elsewhere).
Parent can be null (for example when window is in the process of being dragged and not visible).
SetHasFocusInternal
Sets or removes focus for this window.
DisableInternal
Disables the window making its GUI contents not visible.
The window remains docked in its container.
EnableInternal
Enables the window making its previously hidden GUI contents visible.
Protected
Constructors
DockableEditorWindow
Methods
DoOnMoved
Triggered whenever window position changes.
DoOnResized
Triggered whenever window size changes.
DoOnParentChanged
Triggered whenever window parent container changes.
GetParentWidget
Returns the parent GUI widget.
Before calling this you must ensure the window has a container parent otherwise this method will fail.