RSX Code Reference
    Preparing search index...

    Class OutlinerWindow

    Editor window that displays the scene hierarchy tree view, displaying all scene objects in the current scene.

    Hierarchy (View Summary)

    Index
    constructor
    _treeView onActionTriggeredApplyTemplate onActionTriggeredBreakTemplateLink onActionTriggeredClearSelection onActionTriggeredCopy onActionTriggeredCopyName onActionTriggeredCopyPath onActionTriggeredCreateSceneObject onActionTriggeredCreateTemplate onActionTriggeredCut onActionTriggeredDelete onActionTriggeredDuplicate onActionTriggeredGroup onActionTriggeredHideOthers onActionTriggeredPaste onActionTriggeredRename onActionTriggeredRevertToTemplate onActionTriggeredSelectAll onActionTriggeredSelectByName onActionTriggeredSelectChildren onActionTriggeredSelectVisible onActionTriggeredSelectVisibleRenderables onActionTriggeredToggleSelectionVisibility onActionTriggeredUnhideAll onActionTriggeredUpdateAllTemplateInstances onActionTriggeredUpdateTemplateInstance onSceneSelectionChanged onTreeViewDoubleClick onTreeViewResourceDropped onTreeViewRightClick onTreeViewSelectionChanged windowContentPadding windowPadding
    bounds boundsInPixels containerWindow contentBoundsInPixels contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize height heightInPixels icon iconHandle isActive isDestroyed isFocused isInitialized isPointerHovering keyWindow left localShortcutContext menuItemDelegate name parentWindow position renderWindow screenBoundsInPixels shortcutContext shouldHandleInput size styleSheet styleSheetHandle title top treeView ui undoRedo width widthInPixels
    activate addOSDropTypeSupport center close createContextMenuForSceneObject dockManagerToWindowPosition ensureRootIsCurrent getActionNameForOSDropType getScreen initializeInternal isClosed isDocked isFloating isOSDropTypeSupported onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized pingSceneObject raise screenToWindowPosition setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels updateLoadingProgress windowToDockManagerPosition windowToScreenPosition openDockableWindow
    onResized onDPIChanged onMoved onFocusChanged onOSDropEnter onOSDropLeave onOSDropCommit onFocusChangedInternal

    Protected_treeView

    _treeView: UISceneTreeView
    onActionTriggeredApplyTemplate: () => void

    Apply the state of selected scene objects to their respective templates.

    onActionTriggeredBreakTemplateLink: () => void

    Breaks a link between a template and its instance for selected objects.

    onActionTriggeredClearSelection: () => void

    Shortcut triggered when Escape is pressed.

    onActionTriggeredCopy: () => void
    onActionTriggeredCopyName: () => void
    onActionTriggeredCopyPath: () => void
    onActionTriggeredCreateSceneObject: () => void

    Creates an empty scene object.

    onActionTriggeredCreateTemplate: () => void

    Create templates for each of the selected objects.

    onActionTriggeredCut: () => void
    onActionTriggeredDelete: () => void
    onActionTriggeredDuplicate: () => void
    onActionTriggeredGroup: () => void
    onActionTriggeredHideOthers: () => void
    onActionTriggeredPaste: () => void
    onActionTriggeredRename: () => void
    onActionTriggeredRevertToTemplate: () => void

    Revert the selected scene object to the state of their template if any.

    onActionTriggeredSelectAll: () => void
    onActionTriggeredSelectByName: () => void
    onActionTriggeredSelectChildren: () => void
    onActionTriggeredSelectVisible: () => void
    onActionTriggeredSelectVisibleRenderables: () => void
    onActionTriggeredToggleSelectionVisibility: () => void
    onActionTriggeredUnhideAll: () => void
    onActionTriggeredUpdateAllTemplateInstances: () => void

    Updates all instances of the same template in the current scene.

    onActionTriggeredUpdateTemplateInstance: () => void

    Updates selected template instances to the latest template version.

    onSceneSelectionChanged: (selection: SceneObject[]) => void

    Triggered when the scene selection changed.

    Type Declaration

    onTreeViewDoubleClick: (position: Immutable<Vector2>) => void

    Called when the treeview was double-clicked to spawn a context menu.

    Type Declaration

    onTreeViewResourceDropped: (
        event: {
            element: UISceneTreeViewDataElement;
            insertionIndex?: number;
            insertionSceneObject: SceneObject;
            paths: LibraryIdentifierPath[];
        },
    ) => void

    Triggered by the TreeView when a resource is dropped on the scene tree view.

    onTreeViewRightClick: (position: Immutable<Vector2>) => void

    Called when the treeview was right clicked to spawn a context menu.

    Type Declaration

    onTreeViewSelectionChanged: () => void

    Triggered by the TreeView when the selection is modified from the native scene tree view.

    windowContentPadding: RectOffset

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

    windowPadding: number

    The default window padding.

    • get containerWindow(): EditorWindow

      Gets the parent editor window this window is docked in. Can be null (for example when window is in the process of dragging and not visible).

      Returns EditorWindow

    • get contentBoundsInPixels(): Immutable<rsx.UIRectPixel>

      Returns the bounds of the contents of the window in pixels, regardless of whether the window is docked or not.

      Returns Immutable<rsx.UIRectPixel>

    • get contentHeight(): number

      Returns the height of the window contents in points.

      Returns number

    • get contentHeightInPixels(): number

      Returns the height of the window contents in pixels.

      Returns number

    • get contentWidth(): number

      Returns the width of the window contents in points.

      Returns number

    • get contentWidthInPixels(): number

      Returns the width of the window contents in pixels.

      Returns number

    • 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

      Returns the height of the window in points.

      Returns number

    • get heightInPixels(): number

      Sets the height of the window in pixels.

      Returns number

    • set heightInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • get icon(): Image

      Gets the icon for the window.

      Returns Image

    • set icon(value: Image): void

      Gets the icon for the window.

      Parameters

      Returns void

    • get isActive(): boolean

      Checks whether the window the currently active window in its container. This means the window's tab is active or the window is the only one in its container.

      Returns boolean

    • get isDestroyed(): boolean

      Determines whether the window has been destroyed or not.

      Returns boolean

    • get isFocused(): boolean

      Makes the window in or out focus. Surface can only be made in focus if it is active.

      Returns boolean

    • set isFocused(value: boolean): void

      Checks whether the window currently has keyboard focus.

      Parameters

      • value: boolean

      Returns void

    • get isInitialized(): boolean

      Checks has the TypeScript window been initialized.

      Returns boolean

    • get isPointerHovering(): boolean

      Determines is the mouse pointer currently hovering over the editor window.

      Returns boolean

    • 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 name(): string

      Gets a unique name for this window. This name will be used for referencing the window by other systems.

      Returns string

    • 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 screenBoundsInPixels(): Immutable<rsx.UIRectPixel>

      Returns the bounds of the window in pixels, relative to its parent container in pixels.

      Returns Immutable<rsx.UIRectPixel>

    • get shortcutContext(): ShortcutContext

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

      Returns ShortcutContext

    • get shouldHandleInput(): boolean

      Checks if the window should handle input. This can be used by window implementations to check before handling input events.

      Returns boolean

    • 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 title(): I18N

      Gets the display name for the window. This is what editor users will see in the window title bar.

      Returns I18N

    • set title(value: I18N): void

      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 undoRedo(): UndoRedo

      Get the local undo redo of the window.

      Returns UndoRedo

    • get width(): number

      Returns the width of the window in points.

      Returns number

    • get widthInPixels(): number

      Sets the width of the window in pixels.

      Returns number

    • set widthInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • Makes the window active in its container. This means the windows tab is active and the window is visible.

      Returns void

    • Closes the window but keeps it on the dock manager. Calling raise will make it visible again.

      Returns void

    • Ensures that the root scene object is in sync with the scene key 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

    • Pings a scene object on the outliner.

      Parameters

      • sceneObject: SceneObject

        The scene object to be pinged.

      Returns void

    • Brings the editor window to focus. If it is docked, it's dock container will switch to the window's tab or if undocked the floating window will gain focus.

      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

    • Checks if the load progress bar needs to be shown, shows/hides it and updates the progress accordingly.

      Returns void

    onResized: Event<[width: number, height: number]>

    Triggered whenever window size changes.

    onDPIChanged: Event<[]>

    Triggered whenever window's screen dpi changes.

    onMoved: Event<[x: number, y: number]>

    Triggered whenever window position changes.

    onFocusChanged: Event<[isFocused: boolean]>

    Triggered whenever window receives or loses focus.

    onOSDropEnter: Event<[x: number, y: number]>

    Triggered when the user do a OS drag on top of this window.

    onOSDropLeave: Event<[]>

    Triggered when the user leaves the mouse from a OS drop.

    onOSDropCommit: Event<
        [x: number, y: number, dropData: readonly Immutable<OSDropData>[]],
    >

    Triggered when the user actually drops something on top of this window.

    onFocusChangedInternal: Event<[isFocused: boolean]>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    _treeViewonActionTriggeredApplyTemplateonActionTriggeredBreakTemplateLinkonActionTriggeredClearSelectiononActionTriggeredCopyonActionTriggeredCopyNameonActionTriggeredCopyPathonActionTriggeredCreateSceneObjectonActionTriggeredCreateTemplateonActionTriggeredCutonActionTriggeredDeleteonActionTriggeredDuplicateonActionTriggeredGrouponActionTriggeredHideOthersonActionTriggeredPasteonActionTriggeredRenameonActionTriggeredRevertToTemplateonActionTriggeredSelectAllonActionTriggeredSelectByNameonActionTriggeredSelectChildrenonActionTriggeredSelectVisibleonActionTriggeredSelectVisibleRenderablesonActionTriggeredToggleSelectionVisibilityonActionTriggeredUnhideAllonActionTriggeredUpdateAllTemplateInstancesonActionTriggeredUpdateTemplateInstanceonSceneSelectionChangedonTreeViewDoubleClickonTreeViewResourceDroppedonTreeViewRightClickonTreeViewSelectionChangedwindowContentPaddingwindowPadding
    Accessors
    Methods
    Events