Class ModalWindow

contentHeight

• get contentHeight(): number

• Returns the height of the content area of the window, in points. The content area represents the area of the window not including the title bar and the border.

  Returns number
• set contentHeight(value): void

• Parameters

  • value: number

  Returns void

contentHeightInPixels

• get contentHeightInPixels(): number

• Returns the height of the content area of the window, in pixels. The content area represents the area of the window not including the title bar and the border.

  Returns number
• set contentHeightInPixels(value): void

• Parameters

  • value: number

  Returns void

contentWidth

• get contentWidth(): number

• Returns the width of the content area of the window, in points. The content area represents the area of the window not including the title bar and the border.

  Returns number
• set contentWidth(value): void

• Parameters

  • value: number

  Returns void

contentWidthInPixels

• get contentWidthInPixels(): number

• Returns the width of the content area of the window, in pixels. The content area represents the area of the window not including the title bar and the border.

  Returns number
• set contentWidthInPixels(value): void

• Parameters

  • value: number

  Returns void

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

• Sets the height of the window in points.

  Returns number
• set height(value): void

• Parameters

  • value: number

  Returns void

heightInPixels

• get heightInPixels(): number

• Sets the height of the window in pixels.

  Returns number
• set heightInPixels(value): void

• Parameters

  • value: number

  Returns void

isDestroyed

• get isDestroyed(): boolean

• Check whether the window was destroyed.

  Returns boolean

isFocused

• get isFocused(): boolean

• Checks whether the window currently has keyboard focus.

  Returns boolean
• set isFocused(value): void

• Parameters

  • value: boolean

  Returns void

keyWindow

• get keyWindow(): KeyWindowBase

• Gets the key window which owns this window.

  Returns KeyWindowBase

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

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

shortcutContext

• get shortcutContext(): ShortcutContext

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

  Returns ShortcutContext

size

• get size(): Immutable<Size2>

• Determines the size of the keu window.

  Returns Immutable<Size2>

title

• set title(value): void

• Changes the text in the modal window title bar.

  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

width

• get width(): number

• Sets the width of the window in points.

  Returns number
• set width(value): void

• Parameters

  • value: number

  Returns void

widthInPixels

• get widthInPixels(): number

• Sets the width of the window in pixels.

  Returns number
• set widthInPixels(value): void

• Parameters

  • value: number

  Returns void

center

• center(): void

• Centers the window within it's parent window.

  Returns void

close

• close(): void

• Closes and destroys the window.

  Returns void

isVisible

• isVisible(): boolean

• Determines if the window is visible.

  Returns boolean

onClose

• onClose(): void
• Virtual

  Called whenever the user or the program requested to close the window.

  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

• 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

screenToWindowPosition

• screenToWindowPosition(screenPosition): Vector2

• Converts screen coordinates to coordinates relative to the widget.

  Parameters

  • screenPosition: Immutable<Vector2>

  Returns Vector2

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

windowToScreenPosition

• windowToScreenPosition(windowPosition): Vector2

• Converts window relative coordinates to screen coordiantes.

  Parameters

  • windowPosition: Immutable<Vector2>

  Returns Vector2

ReadonlyonResized

ReadonlyonFocusChangedInternal