OptionalisInternalConstructor: booleanA list of all currently active dockable windows on the key window.
A set of flags that customize the behavior of the key window.
The key window flags.
Sets the height of the window in points.
Sets the height of the window in pixels.
Gets the icon for the window.
Gets the icon for the window.
Determines if the key window's tab is visible.
Determines whether the window has been destroyed or not.
Checks whether the window currently has keyboard focus.
Gets the key window which owns this window.
Returns the X position of the window in screen coordinates in points.
Specifies the local shortcut context. This context will be automatically disabled whenever the user switches focus from the context.
Retrieves the owning container.
Gets the window of the owning container. The owning container is window that serves as the host for one or multiple key windows.
Gets the parent EditorWindow.
Gets the RenderWindow associated with this EditorWindow.
Specifies the global shortcut context. This context will be always enabled as long as the window is active.
Determines the size of the keu window.
Sets the stylesheet for this window's UI surface.
Sets the stylesheet for this window's UI surface.
Gets the primary tool bar element.
Returns the X position of the window in screen coordinates in points.
Get the local undo redo of the key window.
Sets the width of the window in points.
Sets the width of the window in pixels.
StaticcurrentThe currently active key window. Usually this value is null, but can be set to the current window inside an Update call or when calling an event callback for menu or toolbar items.
Centers the window within it's parent window.
Clear the undo/redo history.
Virtual
Closes the key window.
Virtual
Creates the default layout for a key window.
ProtectedcreateCreates a new EditorWindow for usage on this KeyWindow. If the window was already opened before, the window won't be made visible.
The type of the editor window to be created.
The newly created editor window.
Creates the KeyWindowTutorial instance for the key window.
The KeyWindowTutorial instance or null if the key window does not support tutorials.
This method is called after the onInitialize method, so all buttons and elements should already be created that are required for the tutorial. If the key window requires dynamic resolution of references for the tutorial, the KeyWindowTutorial must be subclasses and the onResolveTutorialElement method must be overridden.
ProtecteddetermineVirtual
Determines whether the key window is read-only or not.
ProtecteddidVirtual
A method called internally after the last action is redone.
ProtecteddidVirtual
A method called internally after the last action is undone.
Docks the specified window to the key window. If the window does not exist yet, a new instance will be created.
Type of window to dock.
Optionallocation: EnumValue<DockLocation>
The dock location.
Optionalreference: DockableEditorWindow
The reference window. The location will determine how and where the new window will be docked.
OptionalrelativeSize: number
The relative size of the new window. Setting it to 0.5, causes dockwindows to be splitted equally.
Instance of the docked window.
ProtecteddockDocks a new EditorWindow into the given location.
The type of the editor window to be docked.
The relative location to dock the window to, relative to reference.
The reference window. Used to determine the meaning location.
OptionalrelativeSize: number
The relative size of the docked window. Setting it to 0.5, causes both the first and second window to have the same size.
The editor window instance of the given type.
Sets the given window type as locked. Disables undocking or docking
of other windows on the same space. Will also hide the tab bar and the window title.
ProtectedfreezeFreezes the dockable editor window of type windowType.
The type of the window to freeze.
Attempts to get a previously opened DockableEditorWindow.
Instance of the open window or null, if it does not exist yet.
Gets the current dockable window layout.
The dockable editor window layout.
ProtectedgetGets an existing EditorWindow for usage on this KeyWindow.
The type of the editor window to be retrieved or created.
The editor window instance of the given type.
ProtectedinvalidateInvalidates the window title.
Virtual
Gets whether this KeyWindow should display the User List control on the main menu title bar.
Virtual
Gets whether this KeyWindow should use the main toolbar style.
Virtual
Loads the key window state to the one represented by state.
The state object, as returned by SaveState().
Locks the window to prevent it from closing.
ProtectedonVirtual
Method to override to implement destruction of custom windows. Called by the engine before the window is destroyed.
ProtectedonVirtual
Method to override to implement custom behavior of a window, called by the engine once per frame.
ProtectedonVirtual
Method to override to implement custom behavior of a window, called by the engine once per frame,
once all the windows had their onEditorUpdate() method called.
Virtual
Method to override to implement initialization of custom windows. Called by the engine after window creation.
Virtual
Triggered whenever the window's screen dpi changes.
Virtual
Triggered whenever the window gains or loses focus.
True if focus was gained, false otherwise.
Virtual
Triggered whenever the window size changes.
New width of the window in pixels.
New height of the window in pixels.
Opens a DockableEditorWindow.
Instance of the open window.
ProtectedopenOpens a new EditorWindow for usage on this KeyWindow. If the window is already opened, it will be focused instead.
The type of the editor window to be created.
The newly opened editor window.
Brings the key window to the top.
Virtual
Determines if the key window must be recreated when the specified module is being reloaded. This is an important task to do if the key window edits classes from the module that is being reloaded. In that case, the key window must be recreated - otherwise, it references outdated classes which results in undefined behavior that can destabilize the application.
The following are possible modules:
The fully qualified name of the module to be reloaded.
Executes the last command on the redo stack (last command we called undo on), re-applying its operation.
Resets the key window layout to the default.
Virtual
Saves the current key window state. This state can be persisted to disk or saved in memory and later restored by calling LoadState().
An object that represents the KeyWindow saved state.
Virtual
Sets a predefined dockable editor window layout.
The layout to be set.
Defines the window maximum width and height in points.
Defines the window minimum width and height in points.
The minimum width of the window in points.
The minimum height of the window in points.
Moves the window on the desktop. Coordinates are in screen space using points.
Moves the window on the desktop. Coordinates are in screen space using pixels.
Resizes the window using a width and height in points.
Resizes the window using a width and height in pixels.
Toggles an existing toolbar button into an on or off state which changes the visuals of the button.
Name of the existing button to toggle.
True to toggle on, false to toggle off.
Executes the last command on the undo stack, undoing its operations.
Unlocks the window to allow to be closed by the user.
Toggles an existing toolbar button into an on or off state which changes the visuals of the button.
Name of the existing button to toggle.
Updates the toggle state of all main toolbar buttons in the toolbar.
ProtectedwillVirtual
A method called internally before the last action is redone.
ProtectedwillVirtual
A method called internally before the last action is undone.
Protected StaticopenInternal method used by the managed side to open a newly created KeyWindow object instance.
The key window instance.
Staticopen
The KeyWindow implements a primary window that acts as a container to which content gets added to in the RSX editor. Each key window must have a very well defined semantic, for instance the SceneKeyWindow allows the user view and edit a scene whereas.
A key window by default is empty and only hosts a dockable content area. Content gets added by adding DockableEditorWindow to the dock area of the key window.
Key Windows can be joined together into a KeyWindowContainerWindow with tabs and can also be undocked. Once a key window gets undock, it will get its own container window.