Class GraphInspectorWindow

The GraphInspectorWindow implements a window that can be used to inspect a Graph or a GraphObject.

Hierarchy (view full)

Constructors

constructor

Properties

onUndoRedo refreshTarget accessoryPinShapeMap categoryFieldNames windowContentPadding windowPadding

Accessors

active bounds boundsInPixels containerWindow contentBoundsInPixels contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize graph graphObject height heightInPixels icon iconHandle 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 close createCustomInspectorElementsForVariable dockManagerToWindowPosition focusOnField getActionNameForOSDropType getScreen initializeInternal isClosed isDocked isFloating isOSDropTypeSupported markGraphAsDirty onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized open openObjectTypeChangeWindow openVariableTypeChangeWindow raise screenToWindowPosition setActive setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels windowToDockManagerPosition windowToScreenPosition focusInspectorField inspect openDockableWindow

Events

onCreateCustomInspectorElementsForVariable onCreateInspectablePropertyStyleForVariable onInitializeVariableEditDropDownWindowForVariable onResized onDPIChanged onMoved onFocusChanged onOSDropEnter onOSDropLeave onOSDropCommit onFocusChangedInternal

Constructors

Protectedconstructor

Properties

ProtectedonUndoRedo

onUndoRedo: (() => void)

refreshTarget

refreshTarget: (() => void)

Refreshes the window with data from the target.

Protected StaticaccessoryPinShapeMap

accessoryPinShapeMap: DynamicMap<GraphType, Shape>

A dynamic map that creates the shape for the type pin used as an inspector accessory.

Static ReadonlycategoryFieldNames

categoryFieldNames: {
    graph: string;
    inputs: string;
    outputs: string;
    parameters: string;
    variables: string;
}

The name of the category fields.

Note

These values can be used to address a particular path in the inspector.

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

graph

graphObject

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>

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

close

  • close(): void

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

    Returns void

ProtectedcreateCustomInspectorElementsForVariable

  • createCustomInspectorElementsForVariable(variable, variableFriendlyName): CustomInspectorElementAttribute[]
  • Virtual

    Creates custom inspector elements for the specified GraphVariable in the graph inspector window.

    Parameters

    • variable: GraphVariable

      The graph variable for which the custom inspector elements are being created.

    • variableFriendlyName: string

      A user-friendly name for the variable.

    Returns CustomInspectorElementAttribute[]

    An array of custom inspector elements.

    The custom inspector elements include:

    • Type indicator button: Displays the type of the variable and allows changing the variable type.
    • Visibility button: Toggles the visibility of the variable.
    • Delete button: Deletes the variable and its associated connections and getters.
    • Drag handle: Allows dragging the variable to create a property on the canvas.

dockManagerToWindowPosition

focusOnField

  • focusOnField(uuid, path): boolean

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

    Parameters

    • uuid: Const<UUID>

      UUID of the object on which to select the field.

    • path: string

      Path to the field on the object being inspected.

    Returns boolean

    True if the field was found and focused, false otherwise.

getActionNameForOSDropType

getScreen

ProtectedinitializeInternal

isClosed

isDocked

isFloating

isOSDropTypeSupported

ProtectedmarkGraphAsDirty

  • markGraphAsDirty(): void

  • Marks the current graph as dirty.

    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

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

open

  • open(): void

  • Opens the graph inspector window from the menu bar.

    Returns void

openObjectTypeChangeWindow

  • openObjectTypeChangeWindow(currentType, anchorElement, onTypeSelected): void

  • Opens a dropdown window that enables the user to change the type of an object.

    Parameters

    • currentType: GraphType

      The current GraphType of the object to edit.

    • anchorElement: UIElementBase

      The anchoring element.

    • onTypeSelected: ((newType: GraphType) => void)

      The callback that is invoked when a new type is selected.

        • (newType): void

        • Parameters

          Returns void

    Returns void

openVariableTypeChangeWindow

  • openVariableTypeChangeWindow(variable, anchorElement): void

  • Opens a dropdown window that enables the user to change the type of the variable.

    Parameters

    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

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

StaticfocusInspectorField

  • focusInspectorField(uuid, path): void

  • Focuses the specified field path in the inspector.

    Parameters

    Returns void

Staticinspect

  • inspect(target): void

  • Inspects a GraphObject. If no window is open, opens a new window.

    Parameters

    Returns void

StaticopenDockableWindow

Events

onCreateCustomInspectorElementsForVariable

onCreateCustomInspectorElementsForVariable: Event<[variable: GraphVariable, elements: CustomInspectorElementAttribute[]], void>

Invoked when the custom inspector elements for the specified variable are created.

onCreateInspectablePropertyStyleForVariable

onCreateInspectablePropertyStyleForVariable: Event<[variable: GraphVariable, style: Partial<InspectablePropertyDecoration>], void>

Invoked when the InspectablePropertyDecoration for the specified variable is created.

onInitializeVariableEditDropDownWindowForVariable

onInitializeVariableEditDropDownWindowForVariable: Event<[variable: GraphVariable, window: DropDownWindow, layout: UILayout, options: any], void>

Invoked when the inspector initializes the drop down used to edit a variable.

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