RSX Code Reference
    Preparing search index...

    Class EditorWindow

    Base class for all editor windows.

    Hierarchy (View Summary)

    Index
    • get dpiScale(): number

      Returns the DPI scale factor.

      Returns number

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

    • get height(): number

      Sets the height of the window in points.

      Returns number

    • set height(value: number): void

      Parameters

      • value: number

      Returns void

    • get heightInPixels(): number

      Sets the height of the window in pixels.

      Returns number

    • set heightInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • get isDestroyed(): boolean

      Check whether the window was destroyed.

      Returns boolean

    • get isFocused(): boolean

      Checks whether the window currently has keyboard focus.

      Returns boolean

    • set isFocused(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get keyWindow(): KeyWindowBase

      Gets the key window which owns this window.

      Returns KeyWindowBase

    • get left(): number

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

      Returns number

    • get localShortcutContext(): ShortcutContext

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

      Returns ShortcutContext

    • get position(): Immutable<rsx.UIPoint>

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

      Returns Immutable<rsx.UIPoint>

    • get renderWindow(): RenderWindow

      Gets the RenderWindow associated with this EditorWindow.

      Returns RenderWindow

    • get shortcutContext(): ShortcutContext

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

      Returns ShortcutContext

    • get styleSheet(): StyleSheet

      Sets the stylesheet for this window's UI surface.

      Returns StyleSheet

    • set styleSheet(value: StyleSheet): void

      Sets the stylesheet for this window's UI surface.

      Parameters

      Returns void

    • get top(): number

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

      Returns number

    • get ui(): UIPanel

      Returns UIPanel

    • get width(): number

      Sets the width of the window in points.

      Returns number

    • set width(value: number): void

      Parameters

      • value: number

      Returns void

    • get widthInPixels(): number

      Sets the width of the window in pixels.

      Returns number

    • set widthInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • Centers the window within it's parent window.

      Returns void

    • Closes and destroys the window.

      Returns void

    • Determines if the window is visible.

      Returns boolean

    • Virtual

      Called whenever the user or the program requested to close the window.

      Returns void

    • Virtual

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

      Returns void

    • Virtual

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

      Returns 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

    • Virtual

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

      Parameters

      • options: any

      Returns void

    • Virtual

      Called whenever window visibility changed.

      Parameters

      • isVisible: boolean

      Returns void

      Implementing classes must call super.

    • Virtual

      Triggered whenever the window gains or loses focus.

      Parameters

      • inFocus: boolean

        True if focus was gained, false otherwise.

      Returns 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

    • Defines the window maximum width and height in points.

      Parameters

      • maxWidth: number
      • maxHeight: number

      Returns 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

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

      Parameters

      • x: number
      • y: number

      Returns void

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

      Parameters

      • x: number
      • y: number

      Returns void

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

      Parameters

      • width: number
      • height: number

      Returns void

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

      Parameters

      • width: number
      • height: number

      Returns void

    onFocusChangedInternal: Event<[isFocused: boolean]>