Class ResourcePreviewWindow

The ResourcePreviewWindow implements a DockableEditorWindow that can be used to preview scene relevant Resource such as meshes and materials under different lighting presets in editor.

The window provides a toolbar with buttons to switch between different presets and to focus the scene. Essentially, this window is a wrapper around the UIPreviewSceneRenderer class.

Hierarchy (view full)

Constructors

constructor

Properties

_presetButtons _sceneRenderer _toolBar onActionTriggeredFocusScene onActionTriggeredSelectMesh toolbarButtonNames windowContentPadding windowPadding

Accessors

active bounds boundsInPixels containerWindow contentBoundsInPixels contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize gizmoSelectedSceneObjects height heightInPixels icon iconHandle isDestroyed isFocused isInitialized isPointerHovering keyWindow left localShortcutContext menuItemDelegate name parentWindow position previewContentRoot renderWindow resource sceneGizmos sceneInstance sceneRenderer screenBoundsInPixels shortcutContext shouldHandleInput size title toolbar top ui undoRedo viewportCamera width widthInPixels

Methods

addOSDropTypeSupport applyCameraSettings center close dockManagerToWindowPosition getActionNameForOSDropType getScreen initializeInternal initializeToolBar isClosed isDocked isFloating isOSDropTypeSupported loadPreviewSceneTemplate onDestroy onDragDropFinished onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized raise rebuild screenToWindowPosition setActive setActivePreset setMaximumSize setMinimumSize setPosition setPositionInPixels setPreviewResource setSize setSizeInPixels windowToDockManagerPosition windowToScreenPosition openDockableWindow openWithResource

Events

onPreviewSceneInitialized onResized onDPIChanged onMoved onFocusChanged onOSDropEnter onOSDropLeave onOSDropCommit onFocusChangedInternal

Constructors

Protectedconstructor

Properties

Protected_presetButtons

_presetButtons: UIToggle[]

Protected_sceneRenderer

_sceneRenderer: UIPreviewSceneRenderer

Protected_toolBar

_toolBar: UIToolBar

ProtectedonActionTriggeredFocusScene

onActionTriggeredFocusScene: (() => void)

Focuses the active scene.

ProtectedonActionTriggeredSelectMesh

onActionTriggeredSelectMesh: (() => void)

Selects a viewport mesh.

StatictoolbarButtonNames

toolbarButtonNames: {
    focus: string;
    redraw: string;
    selectMesh: string;
}

The names of all toolbar buttons of the main toolbar.

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>

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

gizmoSelectedSceneObjects

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

isDestroyed

  • get isDestroyed(): boolean

  • Determines whether the window has been destroyed or not.

    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

isInitialized

  • get isInitialized(): boolean

  • Checks has the TypeScript window been initialized.

    Returns boolean

isPointerHovering

  • get isPointerHovering(): boolean

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

    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

parentWindow

position

  • get position(): Immutable<Vector2>

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

    Returns Immutable<Vector2>

previewContentRoot

  • get previewContentRoot(): SceneObject

  • Gets the preview scene content root.

    Returns SceneObject

    Note

    Only available once the onPreviewSceneInitialized was fired.

renderWindow

  • get renderWindow(): RenderWindow

  • Gets the RenderWindow associated with this EditorWindow.

    Returns RenderWindow

resource

sceneGizmos

  • get sceneGizmos(): SceneGizmos

  • Gets the scene gizmos.

    Returns SceneGizmos

    Note

    Only available once the onPreviewSceneInitialized was fired.

sceneInstance

  • get sceneInstance(): SceneInstance

  • Gets the preview scene instance.

    Returns SceneInstance

    Note

    Only available once the onPreviewSceneInitialized was fired.

sceneRenderer

screenBoundsInPixels

  • get screenBoundsInPixels(): Immutable<Rect2>

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

    Returns Immutable<Rect2>

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

  • The main toolbar.

    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

viewportCamera

  • get viewportCamera(): ViewportCamera

  • Gets the viewport camera.

    Returns ViewportCamera

    Note

    Only available once the onPreviewSceneInitialized was fired.

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

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

applyCameraSettings

  • applyCameraSettings(viewportCameraSettings): boolean

  • Applies the specified camera settings.

    Parameters

    Returns boolean

center

close

  • close(): void

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

    Returns void

dockManagerToWindowPosition

getActionNameForOSDropType

getScreen

ProtectedinitializeInternal

ProtectedinitializeToolBar

  • initializeToolBar(): void

  • Initializes the main toolbar of the window

    Returns void

isClosed

isDocked

isFloating

isOSDropTypeSupported

loadPreviewSceneTemplate

  • loadPreviewSceneTemplate(indexOrName): void

  • Loads the preview scene template at the specified index.

    Parameters

    • indexOrName: string | number

    Returns void

ProtectedonDestroy

  • onDestroy(): void
  • Virtual

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

    Returns void

ProtectedonDragDropFinished

  • onDragDropFinished(): void

  • Handles a drag and drop window event.

    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

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

rebuild

  • rebuild(): void

  • Rebuilds the currently loaded scene.

    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

setActivePreset

  • setActivePreset(value): void

  • Switches active preview preset. Check ProjectSettings.getPreviewScenePreset for reference.

    Parameters

    • value: number

      Preset index

    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

setPreviewResource

  • setPreviewResource(resource): boolean

  • Sets the resources to be previewed.

    Parameters

    Returns boolean

    Note

    The resource will begin loading in the next call to onEditorUpdate.

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

windowToDockManagerPosition

windowToScreenPosition

StaticopenDockableWindow

StaticopenWithResource

  • openWithResource(resourceEntryOrPath): void

  • Preview element with given path. Creates a new window if one does not exist.

    Parameters

    Returns void

Events

ReadonlyonPreviewSceneInitialized

onPreviewSceneInitialized: Event<[], void>

The event is invoked when the preview scene has been fully initialized.

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
Methods
Events