Class ResourceInspectorWindow

The ResourceInspectorWindow class implements a DockableEditorWindow for subclasses of Resource.

It can be used to inspect and modify the properties of a resource, as well as to reimport the resource from disk.

Hierarchy (view full)

Constructors

constructor

Properties

isAutomaticallyDirtyingResource isLoadingResourceWhenInactive isObservingResourceSelection isUsingImportOptions isUsingResourceActionButtons onResourceDirtyChanged onResourceHandleChanged onResourceImported onSelectionChanged windowContentPadding windowPadding

Accessors

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

Methods

addOSDropTypeSupport center clear close dockManagerToWindowPosition focusOnField getActionNameForOSDropType getScreen initializeInternal initializeMultiSelection initializeResourceInspector initializeScrollArea isClosed isDocked isFloating isOSDropTypeSupported notifyNeedsRefresh onActionTriggeredOpenResourceInspectorWindow onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized raise screenToWindowPosition setActive setMaximumSize setMinimumSize setPosition setPositionInPixels setResourcePath setResourcePaths setSize setSizeInPixels setWindowMessage windowToDockManagerPosition windowToScreenPosition openDockableWindow

Events

onResourcePropertyModified onResized onDPIChanged onMoved onFocusChanged onOSDropEnter onOSDropLeave onOSDropCommit onFocusChangedInternal

Constructors

Protectedconstructor

Properties

isAutomaticallyDirtyingResource

isAutomaticallyDirtyingResource: boolean

Determines if the edited resource is automatically marked dirty upon property changes.

isLoadingResourceWhenInactive

isLoadingResourceWhenInactive: boolean

Determines if the resource will be loaded and the inspector constructed, when the window is inactive.

isObservingResourceSelection

isObservingResourceSelection: boolean

Determines if the resource inspector updates it's inspected resource if the global resource selection is changed.

isUsingImportOptions

isUsingImportOptions: boolean

Determies if the import options should be used to select the custom resource inspector type.

isUsingResourceActionButtons

isUsingResourceActionButtons: boolean

Determines if the resource action buttons will be visible.

onResourceDirtyChanged

onResourceDirtyChanged: ((resource: Resource, isDirty: boolean) => void)

Called when the resource dirty state changed.

onResourceHandleChanged

onResourceHandleChanged: ((resourceHandle: ResourceHandle<Resource>) => void)

Called by the resource manager whenever a resource is modified. If the active resource is modified, will rebuild the inspector.

Type declaration

    • (resourceHandle): void

    • Parameters

      Returns void

onResourceImported

onResourceImported: ((path: LibraryIdentifierPath) => void)

Updates the inspector if the inspected resource just got reimported.

Type declaration

onSelectionChanged

onSelectionChanged: ((resourcePaths: FilePath[]) => void)

Triggered when the user selects a new resource or a scene object, or deselects everything.

Type declaration

    • (resourcePaths): void

    • Parameters

      • resourcePaths: FilePath[]

        Set of selected resource paths.

      Returns void

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

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

inspector

  • get inspector(): CustomInspector<any>

  • Gets the current inspector.

    Returns CustomInspector<any>

    Note

    The instance will be recreated, when a new resoure is assigned.

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>

renderWindow

  • get renderWindow(): RenderWindow

  • Gets the RenderWindow associated with this EditorWindow.

    Returns RenderWindow

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

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

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

center

clear

  • clear(): void

  • Clears the UI and sets the currently inspected object to null.

    Returns void

close

  • close(): void

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

    Returns void

dockManagerToWindowPosition

focusOnField

  • focusOnField(uuid, path): void

  • Changes keyboard focus to a specific field on the resource with the provided UUID.

    Parameters

    • uuid: Const<UUID>

      UUID of the resource on which to select the field.

    • path: string

      Path to the field on the resource being inspected.

    Returns void

getActionNameForOSDropType

getScreen

ProtectedinitializeInternal

ProtectedinitializeMultiSelection

  • initializeMultiSelection(resourcePaths): void

  • Initializes the window for a multi-selection UX to inspect the resourcePaths.

    Parameters

    Returns void

ProtectedinitializeResourceInspector

  • initializeResourceInspector(resourcePath): boolean

  • Initializes the window for the resource inspector to inspect the resource at the resourcePath.

    Parameters

    Returns boolean

ProtectedinitializeScrollArea

  • initializeScrollArea(name, subtitle, description, resourceEntry?, hasInspector?): UIScrollArea

  • Function that creates the header and scroll area with a name.

    Parameters

    • name: string
    • subtitle: string
    • description: string
    • OptionalresourceEntry: ResourceEntry
    • OptionalhasInspector: boolean

    Returns UIScrollArea

isClosed

isDocked

isFloating

isOSDropTypeSupported

notifyNeedsRefresh

  • notifyNeedsRefresh(): void

  • Forces all the UI fields for the active resource to be refreshed.

    Returns void

onActionTriggeredOpenResourceInspectorWindow

  • onActionTriggeredOpenResourceInspectorWindow(): void

  • Opens the inspector window from the menu bar.

    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

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

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

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

setResourcePath

  • setResourcePath(resourcePath): boolean

  • Sets a resources whose reimport options to displayed in the inspector. Clears any previous contents of the window.

    Parameters

    Returns boolean

setResourcePaths

  • setResourcePaths(resourcePaths): boolean

  • Sets a resources whose reimport options to displayed in the inspector. Clears any previous contents of the window.

    Parameters

    • resourcePaths: LibraryIdentifierPath[]

      Resource paths relative to the project of the resource to inspect.

    Returns boolean

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

ProtectedsetWindowMessage

  • setWindowMessage(message): void

  • Replaces the contents of the window with a static message.

    Parameters

    • message: {
          __brand: "EditorI18N";
          compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
          trimString(value: string): string;
          trimStringEnd(value: string): string;
          trimStringStart(value: string): string;
      }
      • __brand: "EditorI18N"
      • compare:function
        • compare(other, mode): boolean

        • Compares two strings for equality by respecting the given comparison mode.

          Parameters

          • other: string

            The string to compare to.

          • mode: EnumValue<StringCompareMode, number>

            The mode to compare the string. Allows specifying how case sensitivity should be treated on the compare.

          Returns boolean

          True if the strings are considered equal for the given mode; false otherwise.

      • trimString:function
        • trimString(value): string

        • Trims the characters from the start and the end and returns the result as a new string.

          Parameters

          • value: string

          Returns string

      • trimStringEnd:function
        • trimStringEnd(value): string

        • Trims the characters from the end and returns the result as a new string.

          Parameters

          • value: string

          Returns string

      • trimStringStart:function
        • trimStringStart(value): string

        • Trims the characters from the start and returns the result as a new string.

          Parameters

          • value: string

          Returns string

    Returns void

windowToDockManagerPosition

windowToScreenPosition

StaticopenDockableWindow

Events

ReadonlyonResourcePropertyModified

onResourcePropertyModified: Event<[Resource], void>

The event is invoked when the user changed a field of the Resource.

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