RSX Code Reference
    Preparing search index...

    Class UserSettingsWindow

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

    Hierarchy (View Summary)

    Index
    constructor
    _currentPanel _preferencePanels _stack _tabBar onTabSwitched defaultContentPadding defaultWindowPadding shared
    activeTabID contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize height heightInPixels isDestroyed isFocused keyWindow left localShortcutContext parentWindow position renderWindow shortcutContext size styleSheet styleSheetHandle title top ui width widthInPixels
    activatePanel center close isVisible onClose onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized screenToWindowPosition setActivePanel setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels windowToScreenPosition construct constructInternal open openPanel
    onResized onFocusChangedInternal

    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.

    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: number): void

      • Parameters

        • tabID: number

          The tab/panel ID the user has switched to.

        Returns void

    defaultContentPadding: Immutable<RectOffset>

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

    defaultWindowPadding: number

    The default window padding to be used for modal windows.

    shared: UserSettingsWindow

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

    • get activeTabID(): number

      Activates the tab button with the specified unique index.

      Returns number

    • set activeTabID(tabID: number): void

      Parameters

      • tabID: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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 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

    • set title(value: I18N): void

      Changes the text in the modal window title bar.

      Parameters

      Returns void

    • get top(): number

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

      Returns number

    • 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

    • Activates the first loaded preferences panel matching the specified panel type.

      Type Parameters

      Parameters

      Returns boolean

    • Centers the window within it's parent window.

      Returns void

    • Shortcut triggered when Escape is pressed.

      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's screen dpi changes.

      Returns void

    • 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

    • Activates the panel with the specified unique ID.

      Parameters

      • tabUniqueID: number

      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

    • Opens the Preferences editor window.

      Returns void

    • Opens the Preferences editor window and activates the specified panel type when available.

      Type Parameters

      Parameters

      Returns void

    onResized: Event<[p0: number, p1: number]>

    Triggered whenever window size changes.

    onFocusChangedInternal: Event<[isFocused: boolean]>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods
    Events