Class PolyverseWindow

Static ReadonlywindowContentPadding

Static ReadonlywindowPadding

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

• get getMaximumSize(): Immutable<Size2>

• Returns Immutable<Size2>

getMinimumSize

• get getMinimumSize(): Immutable<Size2>

• Returns Immutable<Size2>

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

  • value: Image

  Returns void

iconHandle

• get iconHandle(): ResourceHandle<Image>

• Gets the icon for the window.

  Returns ResourceHandle<Image>
• set iconHandle(value): void

• Parameters

  • value: Image | ResourceHandle<Image>

  Returns void

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

• get keyWindow(): KeyWindow

• Gets the KeyWindow which owns this window.

  Returns 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

• get menuItemDelegate(): MenuItemDelegate

• Returns MenuItemDelegate

• set menuItemDelegate(value): void

• Parameters

  • value: MenuItemDelegate

  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

• get parentWindow(): EditorWindowBase

• Gets the parent EditorWindow.

  Returns EditorWindowBase

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

• get size(): Immutable<Size2>

• Determines the size of the keu window.

  Returns Immutable<Size2>

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

  • value: I18N

  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

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

• center(): void

• Centers the window within it's parent window.

  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

• dockManagerToWindowPosition(dockManagerPosition): Vector2

• Converts dock manager coordinates to coordinates relative to the window.

  Parameters

  • dockManagerPosition: Immutable<Vector2>

  Returns Vector2

  Note

  If the window is undocked, the coordinates will not be modified.

getActionNameForOSDropType

• getActionNameForOSDropType(osDropType): string

• Gets the action name for the given OS drop type. Only relevant if window supports the type.

  Parameters

  • osDropType: EnumValue<OSDropDataType, number>

    The OS type of the drag and drop to get the action name from.

  Returns string

getScreen

• getScreen(): Screen

• The screen on which this window is displayed.

  Returns Screen

isClosed

• isClosed(): boolean

• Determines if the window is currently closed. *

  Returns boolean

isDocked

• isDocked(): boolean

• Determines if the window is currently docked. *

  Returns boolean

isFloating

• isFloating(): boolean

• Determines if the window is currently undocked and floating. *

  Returns boolean

isOSDropTypeSupported

• isOSDropTypeSupported(osDropType): boolean

• Returns whether or not this window supports the given OS data type drop.

  Parameters

  • osDropType: EnumValue<OSDropDataType, number>

  Returns boolean

onVisibilityChanged

• onVisibilityChanged(isVisible): void
• Virtual

  Called whenever window visibility changed.

  Parameters

  • isVisible: boolean

  Returns void

  Note

  Implementing classes must call super.

onWindowDPIChanged

• onWindowDPIChanged(): void
• Virtual

  Triggered whenever the window's screen dpi changes.

  Returns void

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

• screenToWindowPosition(screenPosition): Vector2

• Converts screen coordinates to coordinates relative to the widget.

  Parameters

  • screenPosition: Immutable<Vector2>

  Returns Vector2

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

• windowToDockManagerPosition(windowPosition): Vector2

• Converts window relative coordinates to dock manager coordinates.

  Parameters

  • windowPosition: Immutable<Vector2>

  Returns Vector2

  Note

  If the window is undocked, the coordinates will not be modified.

windowToScreenPosition

• windowToScreenPosition(windowPosition): Vector2

• Converts window relative coordinates to screen coordiantes.

  Parameters

  • windowPosition: Immutable<Vector2>

  Returns Vector2

StaticopenDockableWindow

• openDockableWindow<T>(type): T

• Opens an editor window. If window is already open it returns the existing instance.

  Type Parameters

  • T extends DockableEditorWindow

    Type of window to open.

  Parameters

  • type: ClassOf<T>

  Returns T

  Instance of the open window.

ReadonlyonResized

ReadonlyonDPIChanged

ReadonlyonMoved

ReadonlyonFocusChanged

ReadonlyonOSDropEnter

ReadonlyonOSDropLeave

ReadonlyonOSDropCommit

ReadonlyonFocusChangedInternal