Class SceneWindow

Displays the scene view camera and various scene controls.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

onSceneWindowSettingsDirty onViewportCameraSettingsDirty onViewportCameraTransformChanged onViewportContextMenuRequested setRaytracingActive highDefinitionFeatureQualityThreshold selectionLayer toolbarButtonsNames toolbarButtonWidth viewportClearColor windowContentPadding windowPadding

Accessors

active bounds boundsInPixels cameraRenderTarget containerWindow contentBoundsInPixels contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize gizmoViewportInteraction height heightInPixels icon iconHandle isAltPressed isControlPressed isDestroyed isDragSelectionActive isFocused isHighDefinitionRenderingEnabled isInitialized isLoadedRaytracingSceneRequired isPointerHovering isRaytracingActive isShiftPressed keyWindow left localShortcutContext menuItemDelegate name overlayLabelContent parentWindow position renderWindow sceneActivityHighlightRenderer sceneGizmos sceneGrid sceneKeyWindow scenePicking sceneSelectionState sceneUserActivity screenBoundsInPixels selectionHighlightRenderer shortcutContext shouldHandleInput size title toolBar top ui undoRedo vertexRenderer viewportCamera viewportPanel viewportRenderer viewportSettingsWindow viewSpherePanel width widthInPixels wireframeRenderer

Methods

addOSDropTypeSupport applyViewportCameraSettings center changeSceneViewTool close convertScreenToViewportTexturePosition dockManagerToWindowPosition getActionNameForOSDropType getScreen initializeCamera initializeInternal isClosed isDocked isFloating isOSDropTypeSupported isScreenPositionInsideViewport lookAlongAxisInOrbit onCopyPressed onCutPressed onDeletePressed onDestroy onDuplicatePressed onDuplicateWithTransformPressed onEditorUpdate onEditorUpdateLate onFocusSelectionPressed onGroupPressed onInitialize onPastePressed onSelectAllPressed onSelectVisiblePressed onToggleVisibilityPressed onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized raise releaseCameraDependantObjects screenToWindowPosition setActive setMaximumSize setMinimumSize setOverlayLabelVisible setPosition setPositionInPixels setSize setSizeInPixels setSnappingDestination toggleProfilerOverlay truncateRoots updateEditorCameraRenderMode updateLoadingProgressAndPausedState windowToDockManagerPosition windowToScreenPosition openDockableWindow

Events

onEditorCameraTransformChanged onResized onDPIChanged onMoved onFocusChanged onOSDropEnter onOSDropLeave onOSDropCommit onFocusChangedInternal

Constructors

constructor

Properties

onSceneWindowSettingsDirty

onSceneWindowSettingsDirty: ((settings: SceneWindowSettings) => void)

onViewportCameraSettingsDirty

onViewportCameraSettingsDirty: ((settings: ViewportCameraSettings) => void)

onViewportCameraTransformChanged

onViewportCameraTransformChanged: (() => void)

Event sent by the viewport renderer when the viewport camera transform changed.

onViewportContextMenuRequested

onViewportContextMenuRequested: ((scenePickInformation?: ScenePickInformation) => void)

Event sent by the viewport renderer when a context menu is requested.

setRaytracingActive

setRaytracingActive: ((active: boolean) => void)

Static ReadonlyhighDefinitionFeatureQualityThreshold

highDefinitionFeatureQualityThreshold = 3

The feature quality threshold that permits high defintion rendering to be used.

Note

This is only relevant if a manual feature quality is set.

Static ReadonlyselectionLayer

selectionLayer: rsx.LayerMask

Static ReadonlytoolbarButtonsNames

toolbarButtonsNames: {
    automaticMouseLock: string;
    coordinateSystem: string;
    focus: string;
    gizmoMode: string;
    gizmoSettings: string;
    gridSettings: string;
    highDefinition: string;
    pivotMode: string;
    raiseMainCameraWindowOnPlay: string;
    raytracing: string;
    sceneUserActivity: string;
    snappingSettings: string;
    standardDefinition: string;
    standardDefinitionQuality: string;
}

Static ReadonlytoolbarButtonWidth

toolbarButtonWidth: number

Static ReadonlyviewportClearColor

viewportClearColor: Immutable<SRGBColor>

Static ReadonlywindowContentPadding

windowContentPadding: RectOffset

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

Static ReadonlywindowPadding

windowPadding: number

The default window padding.

Accessors

active

  • get active(): 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

bounds

  • get bounds(): Immutable<Rect2>

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

    Returns Immutable<Rect2>

boundsInPixels

  • get boundsInPixels(): Immutable<Rect2>

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

    Returns Immutable<Rect2>

cameraRenderTarget

containerWindow

  • 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

contentBoundsInPixels

  • get contentBoundsInPixels(): Immutable<Rect2>

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

    Returns Immutable<Rect2>

contentHeight

  • get contentHeight(): number

  • Returns the height of the window contents in points.

    Returns number

contentHeightInPixels

  • get contentHeightInPixels(): number

  • Returns the height of the window contents in pixels.

    Returns number

contentWidth

  • get contentWidth(): number

  • Returns the width of the window contents in points.

    Returns number

contentWidthInPixels

  • get contentWidthInPixels(): number

  • Returns the width of the window contents in pixels.

    Returns number

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

gizmoViewportInteraction

height

  • get height(): number

  • Returns the height of the window in points.

    Returns number

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

isAltPressed

  • get isAltPressed(): boolean

  • Alt modifier key state.

    Returns boolean

isControlPressed

  • get isControlPressed(): boolean

  • Control modifier key state.

    Returns boolean

isDestroyed

  • get isDestroyed(): boolean

  • Determines whether the window has been destroyed or not.

    Returns boolean

isDragSelectionActive

  • get isDragSelectionActive(): boolean

  • Determines if the drag selection viewport interaction is active.

    Returns boolean

isFocused

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

  • Checks whether the window currently has keyboard focus.

    Parameters

    • value: boolean

    Returns void

isHighDefinitionRenderingEnabled

  • get isHighDefinitionRenderingEnabled(): boolean

  • Determines if the viewport is currently rendering in high dpi mode.

    Returns boolean

isInitialized

  • get isInitialized(): boolean

  • Checks has the TypeScript window been initialized.

    Returns boolean

isLoadedRaytracingSceneRequired

  • get isLoadedRaytracingSceneRequired(): boolean

  • Returns true if this window requires the raytracer scene to be loaded.

    Returns boolean

isPointerHovering

  • get isPointerHovering(): boolean

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

    Returns boolean

isRaytracingActive

  • get isRaytracingActive(): boolean

  • Determines if ray tracing is currently active.

    Returns boolean

isShiftPressed

  • get isShiftPressed(): boolean

  • Shift modifier key state.

    Returns boolean

keyWindow

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

menuItemDelegate

  • Returns MenuItemDelegate

  • Parameters

    Returns void

name

  • get name(): string

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

    Returns string

overlayLabelContent

  • get overlayLabelContent(): string

  • Sets the content of the middle Overlay Label.

    Returns string

  • set overlayLabelContent(value): void

  • Parameters

    • value: string

    Returns void

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

sceneActivityHighlightRenderer

sceneGizmos

sceneGrid

sceneKeyWindow

scenePicking

  • get scenePicking(): ScenePicking

  • The ScenePicking instance used to interact with scene objects.

    Returns ScenePicking

sceneSelectionState

sceneUserActivity

screenBoundsInPixels

  • get screenBoundsInPixels(): Immutable<Rect2>

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

    Returns Immutable<Rect2>

selectionHighlightRenderer

shortcutContext

  • get shortcutContext(): ShortcutContext

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

    Returns ShortcutContext

shouldHandleInput

  • 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

size

title

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

  • Parameters

    Returns void

toolBar

  • get toolBar(): UIToolBar

  • Returns UIToolBar

top

  • get top(): number

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

    Returns number

ui

  • get ui(): UIPanel

  • Returns UIPanel

undoRedo

  • get undoRedo(): UndoRedo

  • Get the local undo redo of the window.

    Returns UndoRedo

vertexRenderer

viewportCamera

viewportPanel

viewportRenderer

viewportSettingsWindow

viewSpherePanel

  • get viewSpherePanel(): UIPanel

  • Panel handling rendering axes gizmo UI elements.

    Returns UIPanel

width

  • get width(): number

  • Returns the width of the window in points.

    Returns number

widthInPixels

  • get widthInPixels(): number

  • Sets the width of the window in pixels.

    Returns number

  • set widthInPixels(value): void

  • Parameters

    • value: number

    Returns void

wireframeRenderer

Methods

addOSDropTypeSupport

  • addOSDropTypeSupport(osDropType, actionName): void

  • Add support to the given Drop data type.

    Parameters

    • osDropType: EnumValue<OSDropDataType, number>

      The type of the data from OS to support.

    • actionName: string

      The text representing the action of dropping into this window.

    Returns void

applyViewportCameraSettings

center

changeSceneViewTool

  • changeSceneViewTool(tool, forceChange?): void

  • Triggered when one of the scene tool buttons is clicked, changing the active scene handle.

    Parameters

    • tool: EnumValueTyped<TransformGizmoMode, number>

      Clicked scene tool to activate.

    • OptionalforceChange: boolean

      True to force the change, even if the camera is not idle.

    Returns void

close

  • close(): void

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

    Returns void

convertScreenToViewportTexturePosition

dockManagerToWindowPosition

getActionNameForOSDropType

getScreen

initializeCamera

  • initializeCamera(viewportCamera): void

  • Creates all the necessary components and Scene Objects for the Editor Camera.

    Parameters

    Returns void

ProtectedinitializeInternal

isClosed

isDocked

isFloating

isOSDropTypeSupported

isScreenPositionInsideViewport

  • isScreenPositionInsideViewport(screenPosition): boolean

  • Returns whether or not the given position (in screen space) is within bounds of the Viewport.

    Parameters

    Returns boolean

lookAlongAxisInOrbit

  • lookAlongAxisInOrbit(axis): void

  • Orients the camera so it looks along the provided axis.

    Parameters

    Returns void

onCopyPressed

  • onCopyPressed(): void

  • Returns void

onCutPressed

  • onCutPressed(): void

  • Returns void

onDeletePressed

  • onDeletePressed(): void

  • 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

onDuplicatePressed

  • onDuplicatePressed(): void

  • Returns void

onDuplicateWithTransformPressed

  • onDuplicateWithTransformPressed(): void

  • 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

onEditorUpdateLate

  • 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

onFocusSelectionPressed

  • onFocusSelectionPressed(): void

  • Returns void

onGroupPressed

  • onGroupPressed(): void

  • 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

onPastePressed

  • onPastePressed(): void

  • Returns void

onSelectAllPressed

  • onSelectAllPressed(): void

  • Returns void

onSelectVisiblePressed

  • onSelectVisiblePressed(): void

  • Returns void

onToggleVisibilityPressed

  • onToggleVisibilityPressed(): void

  • 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

raise

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

releaseCameraDependantObjects

  • releaseCameraDependantObjects(): void

  • Releases all the Editor Camera relevant component references.

    Returns void

screenToWindowPosition

setActive

  • setActive(): void

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

    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

setOverlayLabelVisible

  • setOverlayLabelVisible(enabled): void

  • Toggle visibility of the Overlay UI Label placed in the middle of the Viewport.

    Parameters

    • enabled: boolean

      Enable or not the overlay label.

    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

setSnappingDestination

  • setSnappingDestination(snappingDestination): void

  • Set the snapping destination that is applied to handle snapping.

    Parameters

    Returns void

toggleProfilerOverlay

  • toggleProfilerOverlay(): void

  • Action triggered by the shortcut manager whenever the user presses the toggle profiler overlay hotkey.

    Returns void

truncateRoots

  • truncateRoots(objects): SceneObject[]

  • Parses an array of scene objects and removes elements that are children of elements that are also in the array.

    Parameters

    Returns SceneObject[]

    An array containing the truncated roots without children.

updateEditorCameraRenderMode

  • updateEditorCameraRenderMode(): void

  • Updates the current camera render mode.

    Returns void

updateLoadingProgressAndPausedState

  • updateLoadingProgressAndPausedState(): void

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

    Returns void

windowToDockManagerPosition

windowToScreenPosition

StaticopenDockableWindow

Events

ReadonlyonEditorCameraTransformChanged

onEditorCameraTransformChanged: Event<[], void>

Notifies that the scene camera as been moved.

ReadonlyonResized

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

Triggered whenever window size changes.

ReadonlyonDPIChanged

onDPIChanged: Event<[], void>

Triggered whenever window's screen dpi changes.

ReadonlyonMoved

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

Triggered whenever window position changes.

ReadonlyonFocusChanged

onFocusChanged: Event<[boolean], void>

Triggered whenever window receives or loses focus.

ReadonlyonOSDropEnter

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

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

ReadonlyonOSDropLeave

onOSDropLeave: Event<[], void>

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

ReadonlyonOSDropCommit

onOSDropCommit: Event<[number, number, readonly Immutable<OSDropData>[]], void>

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

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
activeboundsboundsInPixelscameraRenderTargetcontainerWindowcontentBoundsInPixelscontentHeightcontentHeightInPixelscontentWidthcontentWidthInPixelsdpiScalegetMaximumSizegetMinimumSizegizmoViewportInteractionheightheightInPixelsiconiconHandleisAltPressedisControlPressedisDestroyedisDragSelectionActiveisFocusedisHighDefinitionRenderingEnabledisInitializedisLoadedRaytracingSceneRequiredisPointerHoveringisRaytracingActiveisShiftPressedkeyWindowleftlocalShortcutContextmenuItemDelegatenameoverlayLabelContentparentWindowpositionrenderWindowsceneActivityHighlightRenderersceneGizmossceneGridsceneKeyWindowscenePickingsceneSelectionStatesceneUserActivityscreenBoundsInPixelsselectionHighlightRenderershortcutContextshouldHandleInputsizetitletoolBartopuiundoRedovertexRendererviewportCameraviewportPanelviewportRendererviewportSettingsWindowviewSpherePanelwidthwidthInPixelswireframeRenderer
Methods
addOSDropTypeSupportapplyViewportCameraSettingscenterchangeSceneViewToolcloseconvertScreenToViewportTexturePositiondockManagerToWindowPositiongetActionNameForOSDropTypegetScreeninitializeCamerainitializeInternalisClosedisDockedisFloatingisOSDropTypeSupportedisScreenPositionInsideViewportlookAlongAxisInOrbitonCopyPressedonCutPressedonDeletePressedonDestroyonDuplicatePressedonDuplicateWithTransformPressedonEditorUpdateonEditorUpdateLateonFocusSelectionPressedonGroupPressedonInitializeonPastePressedonSelectAllPressedonSelectVisiblePressedonToggleVisibilityPressedonVisibilityChangedonWindowDPIChangedonWindowFocusChangedonWindowResizedraisereleaseCameraDependantObjectsscreenToWindowPositionsetActivesetMaximumSizesetMinimumSizesetOverlayLabelVisiblesetPositionsetPositionInPixelssetSizesetSizeInPixelssetSnappingDestinationtoggleProfilerOverlaytruncateRootsupdateEditorCameraRenderModeupdateLoadingProgressAndPausedStatewindowToDockManagerPositionwindowToScreenPositionopenDockableWindow
Events