Class InlineFloatingElementWindow

The InlineFloatingElementWindow class provides a quick way to construct inline FloatingElementWindow. The user of the class provides a callback that will be invoked when the window contents will be created.

Note

This class should not be used for complex windows and interactions. It aims to provide a quick way to construct a window without the need for subclassing, only to display a handful of UI elements.

Hierarchy (view full)

Constructors

constructor

Properties

_closeCallback _updateCallback

Accessors

dpiScale getMaximumSize getMinimumSize height heightInPixels isDestroyed isFocused keyWindow left localShortcutContext mouseOffsetInPoints parentWindow position renderWindow shortcutContext size styleSheet styleSheetHandle top ui width widthInPixels

Methods

center close isVisible onClose onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized screenToWindowPosition setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels setWindowPosition startFollowingCursor stopFollowingCursor windowToScreenPosition construct constructInternal open registerOnHoverForElement

Events

onFocusChangedInternal

Constructors

Protectedconstructor

Properties

Protected_closeCallback

_closeCallback: ((window: FloatingElementWindow, options?: any) => void)

Protected_updateCallback

_updateCallback: ((window: FloatingElementWindow) => void)

Accessors

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

  • 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

mouseOffsetInPoints

  • get mouseOffsetInPoints(): Immutable<Vector2>

  • Set the mouse offset from the mouse position to the window position.

    Returns Immutable<Vector2>

  • set mouseOffsetInPoints(value): void

  • Parameters

    Returns void

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

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

styleSheet

  • get styleSheet(): StyleSheet

  • Sets the stylesheet for this window's UI surface.

    Returns StyleSheet

  • set styleSheet(value): void

  • Sets the stylesheet for this window's UI surface.

    Parameters

    Returns void

styleSheetHandle

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

Methods

center

close

isVisible

onClose

  • onClose(): void
  • Virtual

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

    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

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

screenToWindowPosition

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

setWindowPosition

  • setWindowPosition(x, y): void

  • Manually sets the window position. This will be overwritten when the mouse moves again if startFollowingCursor() was called. Values in screen position.

    Parameters

    • x: number
    • y: number

    Returns void

startFollowingCursor

stopFollowingCursor

windowToScreenPosition

Staticconstruct

  • construct<T>(type, keyWindow, width, height, preventEvents, transparent, windowOptions): T

  • Opens a FloatingElementWindow of the specified type.

    Type Parameters

    Parameters

    • type: ClassOf<T>

      The type of the DropDownWindow to open.

    • keyWindow: KeyWindowBase

      The parent key window, if null, will use the current.

    • width: number

      The width of the floating window.

    • height: number

      The height of the floating window.

    • preventEvents: boolean

      Whether the window will receive input events.

    • transparent: boolean

      Whether the window should be transparent or not.

    • windowOptions: any

      The window options.

    Returns T

    A FloatingElementWindow of the specified type.

StaticconstructInternal

Staticopen

  • open(keyWindow, onInitialize, width, height, preventEvents, transparent, onUpdate?): InlineFloatingElementWindow

  • Opens an inline CalloutWindow that can be constructed in the specified onInitialize callback.

    Parameters

    • keyWindow: KeyWindowBase

      The parent key window, if null, will use the current.

    • onInitialize: ((window: FloatingElementWindow) => void)

      Callback to be called to perform window initialization.

    • width: number

      The width of the floating window.

    • height: number

      The height of the floating window.

    • preventEvents: boolean

      Whether the window will receive input events.

    • transparent: boolean

      Whether the window should be transparent or not.

    • OptionalonUpdate: ((window: FloatingElementWindow) => void)

    Returns InlineFloatingElementWindow

    The newly constructed window.

StaticregisterOnHoverForElement

  • registerOnHoverForElement(element, transparent, onInitialize): void

  • Registers a hover behavior for the given element that will show an inline floating element window when hovered.

    Parameters

    • element: UIElement

      The element to register hover behavior for.

    • transparent: boolean

      Whether the floating window should be transparent.

    • onInitialize: ((layout: UIVerticalLayout) => void)

      Callback to be called to perform window initialization. It receives a layoutthat will be used as the main element of the floating window. The callback should populate the layout with desired UI elements.

    Returns void

    Note

    It is important to use layout that are fixed in size to ensure the layout calculation can be performed correctly.

Events

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[p0: boolean], void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events