Class KeyWindowBaseAbstract

Main class for defining a new Key Window. A Key Window is the main container to which content gets added to in the RSX editor. Each key window must have a very well defined semantic, for instance the Scene Key Window allows the user view and edit a scene.

Key Windows can be joined together into a single window with tabs and can also be undocked to have their own free window.

Hierarchy (view full)

Constructors

constructor

Properties

Accessors

dpiScale flags getMaximumSize getMinimumSize height heightInPixels icon iconHandle isActive isDestroyed isFocused keyWindow left localShortcutContext owningContainerWindow parentWindow position renderWindow shortcutContext size toolBar top ui undoRedo width widthInPixels windowTitle

Methods

center clearUndoRedoHistory close createDefaultLayout didRedo didUndo getDockableLayout isUserListControlSupported isUsingMainToolBarStyle lockKeyWindow onActiveChanged onCloseRequested onDestroy onEditorUpdate onEditorUpdateLate onInitialize onWindowDPIChanged onWindowFocusChanged onWindowResized raise redo resetLayout screenToWindowPosition setDockableLayout setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels undo unlockKeyWindow willRedo willUndo windowToScreenPosition

Events

onResize onMove onClose onFocusChangedInternal

Constructors

Protectedconstructor

Accessors

dpiScale

  • get dpiScale(): number

  • Returns the DPI scale factor.

    Returns number

    Note

    The DPI scale is in relation to a 1x base resolution of 75 DPI.

flags

getMaximumSize

getMinimumSize

height

  • get height(): number

  • Sets the height of the window in points.

    Returns number

  • set height(value): void

  • Parameters

    • value: number

    Returns void

heightInPixels

  • get heightInPixels(): number

  • Sets the height of the window in pixels.

    Returns number

  • set heightInPixels(value): void

  • Parameters

    • value: number

    Returns void

icon

  • get icon(): Image

  • Gets the icon for the window.

    Returns Image

  • set icon(value): void

  • Gets the icon for the window.

    Parameters

    Returns void

iconHandle

isActive

  • get isActive(): boolean

  • Determines if the key window's tab is visible.

    Returns boolean

  • set isActive(value): void

  • Parameters

    • value: boolean

    Returns void

isDestroyed

  • get isDestroyed(): boolean

  • Determines whether the window has been destroyed or not.

    Returns boolean

isFocused

  • get isFocused(): boolean

  • Checks whether the window currently has keyboard focus.

    Returns boolean

  • set isFocused(value): void

  • Parameters

    • value: boolean

    Returns void

keyWindow

  • get keyWindow(): KeyWindowBase

  • Gets the key window which owns this window.

    Returns KeyWindowBase

left

  • get left(): number

  • Returns the X position of the window in screen coordinates in points.

    Returns number

localShortcutContext

  • get localShortcutContext(): ShortcutContext

  • Specifies the local shortcut context. This context will be automatically disabled whenever the user switches focus from the context.

    Returns ShortcutContext

owningContainerWindow

  • get owningContainerWindow(): EditorWindow

  • Gets the window of the owning container. The owning container is window that serves as the host for one or multiple key windows.

    Returns EditorWindow

parentWindow

position

  • get position(): Immutable<Vector2>

  • Determines the position in which the key window is, in screen coordinates.

    Returns Immutable<Vector2>

renderWindow

  • get renderWindow(): RenderWindow

  • Gets the RenderWindow associated with this EditorWindow.

    Returns RenderWindow

shortcutContext

  • get shortcutContext(): ShortcutContext

  • Specifies the global shortcut context. This context will be always enabled as long as the window is active.

    Returns ShortcutContext

size

toolBar

  • get toolBar(): UIToolBar

  • Gets the primary tool bar element.

    Returns UIToolBar

top

  • get top(): number

  • Returns the X position of the window in screen coordinates in points.

    Returns number

ui

undoRedo

  • get undoRedo(): UndoRedo

  • Get the local undo redo of the key window.

    Returns UndoRedo

width

  • get width(): number

  • Sets the width of the window in points.

    Returns number

  • set width(value): void

  • Parameters

    • value: number

    Returns void

widthInPixels

  • get widthInPixels(): number

  • Sets the width of the window in pixels.

    Returns number

  • set widthInPixels(value): void

  • Parameters

    • value: number

    Returns void

windowTitle

  • get windowTitle(): I18N

  • Determines the human name to display on the window title or it's tab.

    Returns I18N

    A string that contains a human readable name for the key window.

  • set windowTitle(value): void

  • Parameters

    Returns void

Methods

center

  • center(): void

  • Centers the window within it's parent window.

    Returns void

clearUndoRedoHistory

  • clearUndoRedoHistory(): void

  • Clear the undo/redo history.

    Returns void

close

  • close(): void
  • Virtual

    Closes the key window.

    Returns void

createDefaultLayout

  • createDefaultLayout(): void
  • Virtual

    Creates the default layout for a key window.

    Returns void

ProtecteddidRedo

  • didRedo(): void
  • Virtual

    A method called internally after the last action is redone.

    Returns void

ProtecteddidUndo

  • didUndo(): void
  • Virtual

    A method called internally after the last action is undone.

    Returns void

getDockableLayout

isUserListControlSupported

  • isUserListControlSupported(): boolean
  • Virtual

    Gets whether this KeyWindow should display the User List control on the main menu title bar.

    Returns boolean

isUsingMainToolBarStyle

  • isUsingMainToolBarStyle(): boolean
  • Virtual

    Gets whether this KeyWindow should use the main toolbar style.

    Returns boolean

lockKeyWindow

  • lockKeyWindow(): void

  • Locks the window to prevent it from closing.

    Returns void

onActiveChanged

  • onActiveChanged(isActive): void

  • Parameters

    • isActive: boolean

    Returns void

onCloseRequested

  • onCloseRequested(): boolean

  • Returns boolean

ProtectedonDestroy

  • onDestroy(): void
  • Virtual

    Method to override to implement destruction of custom windows. Called by the engine before the window is destroyed.

    Returns void

ProtectedonEditorUpdate

  • onEditorUpdate(): void
  • Virtual

    Method to override to implement custom behavior of a window, called by the engine once per frame.

    Returns void

ProtectedonEditorUpdateLate

  • onEditorUpdateLate(): void
  • Virtual

    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.

    Returns void

onInitialize

  • onInitialize(options): void
  • Virtual

    Method to override to implement initialization of custom windows. Called by the engine after window creation.

    Parameters

    • options: any

    Returns void

onWindowDPIChanged

onWindowFocusChanged

  • onWindowFocusChanged(inFocus): void
  • Virtual

    Triggered whenever the window gains or loses focus.

    Parameters

    • inFocus: boolean

      True if focus was gained, false otherwise.

    Returns void

onWindowResized

  • onWindowResized(width, height): void
  • Virtual

    Triggered whenever the window size changes.

    Parameters

    • width: number

      New width of the window in pixels.

    • height: number

      New height of the window in pixels.

    Returns void

raise

  • raise(): void

  • Brings the key window to the top.

    Returns void

redo

  • redo(): void

  • Executes the last command on the redo stack (last command we called undo on), re-applying its operation.

    Returns void

resetLayout

  • resetLayout(): void

  • Resets the key window layout to the default.

    Returns void

screenToWindowPosition

setDockableLayout

  • setDockableLayout(layout): void
  • Virtual

    Sets a predefined dockable editor window layout.

    Parameters

    Returns void

    Note

    This will override any existing windows on the current layout.

setMaximumSize

  • setMaximumSize(maxWidth, maxHeight): void

  • Defines the window maximum width and height in points.

    Parameters

    • maxWidth: number
    • maxHeight: number

    Returns void

setMinimumSize

  • setMinimumSize(minWidth, minHeight): void

  • Defines the window minimum width and height in points.

    Parameters

    • minWidth: number

      The minimum width of the window in points.

    • minHeight: number

      The minimum height of the window in points.

    Returns void

setPosition

  • setPosition(x, y): void

  • Moves the window on the desktop. Coordinates are in screen space using points.

    Parameters

    • x: number
    • y: number

    Returns void

setPositionInPixels

  • setPositionInPixels(x, y): void

  • Moves the window on the desktop. Coordinates are in screen space using pixels.

    Parameters

    • x: number
    • y: number

    Returns void

setSize

  • setSize(width, height): void

  • Resizes the window using a width and height in points.

    Parameters

    • width: number
    • height: number

    Returns void

setSizeInPixels

  • setSizeInPixels(width, height): void

  • Resizes the window using a width and height in pixels.

    Parameters

    • width: number
    • height: number

    Returns void

undo

  • undo(): void

  • Executes the last command on the undo stack, undoing its operations.

    Returns void

unlockKeyWindow

  • unlockKeyWindow(): void

  • Unlocks the window to allow to be closed by the user.

    Returns void

ProtectedwillRedo

  • willRedo(): void
  • Virtual

    A method called internally before the last action is redone.

    Returns void

ProtectedwillUndo

  • willUndo(): void
  • Virtual

    A method called internally before the last action is undone.

    Returns void

windowToScreenPosition

Events

ReadonlyonResize

onResize: Event<[], void>

Event triggered once the window is resized.

ReadonlyonMove

onMove: Event<[], void>

Event triggered once the window is moved.

ReadonlyonClose

onClose: Event<[], void>

Event triggered when the window is closed.

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
Events