Class UserSettingsWindow

The UserSettingsWindow implements a ModalWindow that allows configuring and setting user specific preferences for RSX.

Hierarchy (view full)

Constructors

constructor

Properties

_currentPanel _preferencePanels _stack _tabBar onTabSwitched kWindowContentPadding kWindowPadding shared

Accessors

activeTabID contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize height heightInPixels isDestroyed isFocused keyWindow left localShortcutContext parentWindow position renderWindow shortcutContext size title top ui width widthInPixels

Methods

center close isVisible onClose onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized screenToWindowPosition setActivePanel setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels windowToScreenPosition construct constructInternal open

Events

onResized onFocusChangedInternal

Constructors

Protectedconstructor

Properties

Protected_currentPanel

_currentPanel: PreferencesPanel

An instance to the currently active preferences panel.

Protected_preferencePanels

_preferencePanels: Map<number, PreferencesPanel>

An array that contains all the PreferencesPanel instances visible on the UserSettingsWindow.

Protected_stack

_stack: UIStack

The UIStack control that allows toggling visibility between the contents of all the PreferencesPanel on the window.

Protected_tabBar

_tabBar: UITabBar

The main tab bar that allows switching between available panels.

ProtectedonTabSwitched

onTabSwitched: ((tabID: number) => void)

An internal event callback that gets called whenever the user clicks on a tab. This will switch the currently active preferences panel.

Type declaration

    • (tabID): void

    • Parameters

      • tabID: number

        The tab/panel ID the user has switched to.

      Returns void

Static ReadonlykWindowContentPadding

kWindowContentPadding: RectOffset

The default window content padding to be used for modal windows.

Static ReadonlykWindowPadding

kWindowPadding: number

The default window padding to be used for modal windows.

Staticshared

shared: UserSettingsWindow

If a preferences window is open, this returns the currently open preferences window.

Accessors

activeTabID

  • get activeTabID(): number

  • Activates the tab button with the specified unique index.

    Returns number

  • set activeTabID(tabID): void

  • Parameters

    • tabID: number

    Returns void

contentHeight

  • get contentHeight(): number

  • Returns the height of the content area of the window, in points. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentHeight(value): void

  • Parameters

    • value: number

    Returns void

contentHeightInPixels

  • get contentHeightInPixels(): number

  • Returns the height of the content area of the window, in pixels. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentHeightInPixels(value): void

  • Parameters

    • value: number

    Returns void

contentWidth

  • get contentWidth(): number

  • Returns the width of the content area of the window, in points. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentWidth(value): void

  • Parameters

    • value: number

    Returns void

contentWidthInPixels

  • get contentWidthInPixels(): number

  • Returns the width of the content area of the window, in pixels. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentWidthInPixels(value): void

  • Parameters

    • value: number

    Returns void

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.

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

isDestroyed

  • get isDestroyed(): boolean

  • Check whether the window was destroyed.

    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

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

title

  • set title(value): void

  • Changes the text in the modal window title bar.

    Parameters

    Returns void

top

  • get top(): number

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

    Returns number

ui

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

Methods

center

  • center(): void

  • Centers the window within it's parent window.

    Returns void

close

  • close(): void

  • Closes and destroys the window.

    Returns void

isVisible

  • isVisible(): boolean

  • Determines if the window is visible.

    Returns boolean

onClose

  • onClose(): void
  • Virtual

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

    Returns void

onDestroy

  • onDestroy(): void
  • Virtual

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

    Returns void

onEditorUpdate

  • 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

onVisibilityChanged

  • onVisibilityChanged(isVisible): void
  • Virtual

    Called whenever window visibility changed.

    Parameters

    • isVisible: boolean

    Returns void

    Note

    Implementing classes must call super.

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

screenToWindowPosition

ProtectedsetActivePanel

  • setActivePanel(tabUniqueID): void

  • Activates the panel with the specified unique ID.

    Parameters

    • tabUniqueID: number

    Returns void

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

windowToScreenPosition

Staticconstruct

Protected StaticconstructInternal

Staticopen

  • open(): void

  • Opens the Preferences editor window.

    Returns void

Events

ReadonlyonResized

onResized: Event<[number, number], void>

Triggered whenever widget size changes.

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events