Window
Defined in : <DataMorph/window.h>
class dm::Window;This class represents a Window, which is a frame which can be drawn on.
Overview
Window is meant to be inherited from by the plugin developer. It is responsible for rendering a named frame which can be customized using ImGui. Note that there’s no need to call ImGui::Begin and ImGui::End. The function that must be overriden is OnRender. In its core, this class is actually just a C++ wrapper around the internal C API.
Namespace : dm
Inherits from : dm::abi::IWindow
Members
| Constructors and assignments | |
|---|---|
| (constructor) | Constructs the Window object |
| Getters | |
|---|---|
GetNumID | Returns the numerical ID of the window |
GetDisplayName | Returns the displayed window name |
GetInternalName | Returns the internal ImGui identifier |
GetFullName | Returns the full ImGui-formatted name |
IsFocused | Returns whether the window is focused |
IsOpen | Returns whether the window is open |
IsHidden | Returns whether the window is hidden |
HasCloseButton | Returns whether the close button is shown |
GetDFlags | Returns the ImGui docking flags |
GetWFlags | Returns the ImGui window flags |
GetDockNode | Returns a dock node ID |
GetDockSpaceID | Returns the main dockspace ID |
| Setters & State control | |
|---|---|
SetName | Sets the window display name |
SetInternalName | Sets the internal window name |
SetOpen | Sets the open state |
SetHidden | Sets the hidden state |
SetShowCloseButton | Sets the close button visibility |
SetDFlags | Sets the docking flags |
SetWFlags | Sets the window flags |
| Window control | |
|---|---|
Open | Opens the window |
Close | Closes the window |
Show | Shows the window |
Hide | Hides the window |
Update | Updates and renders the window |
| Docking | |
|---|---|
Dock | Docks a window into this dock space |
AddDockNode | Adds a dock node to the dock space |
| Inherited overriden methods | |
|---|---|
IWindow::OnAttach | Called when the window is attached |
IWindow::OnDetach | Called when the window is detached |
IWindow::OnPreRender | Called before rendering |
IWindow::OnPostRender | Called after rendering |
IWindow::OnMenuBar | Renders the menu bar |
IWindow::InitDockSpace | Initializes the dock space |
IWindow::OnPreDockUpdate | Called before dock update |
IWindow::OnPostDockUpdate | Called after dock update |
| Inherited abstract methods | |
|---|---|
IWindow::OnRender | Renders the window content |