Class ComponentPickerCalloutWindow

A callout window that allows the user to pick components.

Hierarchy (view full)

CalloutWindow
- ComponentPickerCalloutWindow

Constructors

`Protected`constructor

new ComponentPickerCalloutWindow(isInternalConstructor?): ComponentPickerCalloutWindow
Parameters
- OptionalisInternalConstructor: boolean
Returns ComponentPickerCalloutWindow
Inherited from CalloutWindow.constructor

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.

Inherited from CalloutWindow.dpiScale

getMaximumSize

get getMaximumSize(): Immutable<Size2>
Returns Immutable<Size2>
Inherited from CalloutWindow.getMaximumSize

getMinimumSize

get getMinimumSize(): Immutable<Size2>
Returns Immutable<Size2>
Inherited from CalloutWindow.getMinimumSize

height

get height(): number
Sets the height of the window in points.

Returns number
Inherited from CalloutWindow.height
set height(value): void
Parameters
- value: number
Returns void
Inherited from CalloutWindow.height

heightInPixels

get heightInPixels(): number
Sets the height of the window in pixels.

Returns number
Inherited from CalloutWindow.heightInPixels
set heightInPixels(value): void
Parameters
- value: number
Returns void
Inherited from CalloutWindow.heightInPixels

isDestroyed

get isDestroyed(): boolean
Check whether the window was destroyed.

Returns boolean
Inherited from CalloutWindow.isDestroyed

isFocused

get isFocused(): boolean
Checks whether the window currently has keyboard focus.

Returns boolean
Inherited from CalloutWindow.isFocused
set isFocused(value): void
Parameters
- value: boolean
Returns void
Inherited from CalloutWindow.isFocused

keyWindow

get keyWindow(): KeyWindowBase
Gets the key window which owns this window.

Returns KeyWindowBase
Inherited from CalloutWindow.keyWindow

left

get left(): number
Returns the X position of the window in screen coordinates in points.

Returns number
Inherited from CalloutWindow.left

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
Inherited from CalloutWindow.localShortcutContext

parentWindow

get parentWindow(): EditorWindowBase
Gets the parent EditorWindow.

Returns EditorWindowBase
Inherited from CalloutWindow.parentWindow

position

get position(): Immutable<Vector2>
Determines the position in which the key window is, in screen coordinates.

Returns Immutable<Vector2>
Inherited from CalloutWindow.position

renderWindow

get renderWindow(): RenderWindow
Gets the RenderWindow associated with this EditorWindow.

Returns RenderWindow
Inherited from CalloutWindow.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
Inherited from CalloutWindow.shortcutContext

size

get size(): Immutable<Size2>
Determines the size of the keu window.

Returns Immutable<Size2>
Inherited from CalloutWindow.size

top

get top(): number
Returns the X position of the window in screen coordinates in points.

Returns number
Inherited from CalloutWindow.top

ui

get ui(): UIPanel
Returns UIPanel
Inherited from CalloutWindow.ui

width

get width(): number
Sets the width of the window in points.

Returns number
Inherited from CalloutWindow.width
set width(value): void
Parameters
- value: number
Returns void
Inherited from CalloutWindow.width

widthInPixels

get widthInPixels(): number
Sets the width of the window in pixels.

Returns number
Inherited from CalloutWindow.widthInPixels
set widthInPixels(value): void
Parameters
- value: number
Returns void
Inherited from CalloutWindow.widthInPixels

Methods

center

center(): void
Centers the window within it's parent window.

Returns void
Inherited from CalloutWindow.center

close

close(): void
Closes and destroys the window.

Returns void
Inherited from CalloutWindow.close

isVisible

isVisible(): boolean
Determines if the window is visible.

Returns boolean
Inherited from CalloutWindow.isVisible

onClose

onClose(): void
Virtual
Called whenever the user or the program requested to close the window.

Returns void
Overrides CalloutWindow.onClose

`Protected`onDestroy

onDestroy(): void
Virtual
Method to override to implement destruction of custom windows. Called by the engine before the window is destroyed.

Returns void
Inherited from CalloutWindow.onDestroy

`Protected`onEditorUpdate

onEditorUpdate(): void
Virtual
Method to override to implement custom behavior of a window, called by the engine once per frame.

Returns void
Inherited from CalloutWindow.onEditorUpdate

`Protected`onEditorUpdateLate

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
Inherited from CalloutWindow.onEditorUpdateLate

onInitialize

onInitialize(options): void
Virtual
Method to override to implement initialization of custom windows. Called by the engine after window creation.
Parameters
- options: {
  callback: ((componentType: Type) => void);
  initialType: Type;
  }
  - callback: ((componentType: Type) => void)
    - (componentType): void
      Parameters
      componentType: Type
      Returns void
  - initialType: Type
Returns void
Overrides CalloutWindow.onInitialize

onVisibilityChanged

onVisibilityChanged(isVisible): void
Virtual
Called whenever window visibility changed.
Parameters
- isVisible: boolean
Returns void
Note
Implementing classes must call super.

Inherited from CalloutWindow.onVisibilityChanged

onWindowDPIChanged

onWindowDPIChanged(): void
Virtual
Triggered whenever the window's screen dpi changes.

Returns void
Inherited from CalloutWindow.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
Inherited from CalloutWindow.onWindowFocusChanged

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
Inherited from CalloutWindow.onWindowResized

screenToWindowPosition

screenToWindowPosition(screenPosition): Vector2
Converts screen coordinates to coordinates relative to the widget.
Parameters
- screenPosition: Immutable<Vector2>
Returns Vector2
Inherited from CalloutWindow.screenToWindowPosition

setAnchor

setAnchor(anchorScreenBounds): void
Changes anchoring of callout window to anchor manually to a given screen rectangle.
Parameters
- anchorScreenBounds: Immutable<Rect2>
Returns void
Inherited from CalloutWindow.setAnchor

setMaximumSize

setMaximumSize(maxWidth, maxHeight): void
Defines the window maximum width and height in points.
Parameters
- maxWidth: number
- maxHeight: number
Returns void
Inherited from CalloutWindow.setMaximumSize

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
Inherited from CalloutWindow.setMinimumSize

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
Inherited from CalloutWindow.setPosition

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
Inherited from CalloutWindow.setPositionInPixels

setSize

setSize(width, height): void
Resizes the window using a width and height in points.
Parameters
- width: number
- height: number
Returns void
Inherited from CalloutWindow.setSize

setSizeInPixels

setSizeInPixels(width, height): void
Resizes the window using a width and height in pixels.
Parameters
- width: number
- height: number
Returns void
Inherited from CalloutWindow.setSizeInPixels

windowToScreenPosition

windowToScreenPosition(windowPosition): Vector2
Converts window relative coordinates to screen coordiantes.
Parameters
- windowPosition: Immutable<Vector2>
Returns Vector2
Inherited from CalloutWindow.windowToScreenPosition

`Protected` `Static`construct

construct<T>(windowClass, keyWindow, anchor, anchorPosition?, placement?, windowOptions?): T
Opens a CalloutWindow of the specified windowClass.
Type Parameters
- T
Parameters
- windowClass: ClassOf<T>
  The CalloutWindow subclass to open.
- keyWindow: KeyWindowBase
  The parent key window, if null, will use the current.
- anchor: UIElementBase
  The anchoring element.
- OptionalanchorPosition: number
  The optional anchor position.
- Optionalplacement: EnumValue<CalloutPlacement, number>
  The optional placement.
- OptionalwindowOptions: any
  Options to pass to the onInitialize implementation of the windowClass.
Returns T
The newly constructed window.

Inherited from CalloutWindow.construct

`Static`constructInternal

constructInternal(windowClass, keyWindow, anchor, arrowPosition, placement, windowOptions): CalloutWindow
Parameters
- windowClass: Type
- keyWindow: KeyWindowBase
- anchor: UIElementBase
- arrowPosition: number
- placement: EnumValue<CalloutPlacement, number>
- windowOptions: any
Returns CalloutWindow
Inherited from CalloutWindow.constructInternal

`Static`open

open(keyWindow, anchor, callback, initialType?, placement?): ComponentPickerCalloutWindow
Opens the component picker callout window anchored to the given anchor.
Parameters
- keyWindow: KeyWindowBase
- anchor: UIElementBase
  The element to act as an anchor to the callout window.
- callback: ((componentType: Type) => void)
  A callback to be called once the user picks a component on the picker.
  - - (componentType): void
    - Parameters
      componentType: Type
      Returns void
- OptionalinitialType: Type
  The initially selected type.
- Optionalplacement: EnumValue<CalloutPlacement, number>
Returns ComponentPickerCalloutWindow
The newly created resource picker window.

Events

`Readonly`onFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Class ComponentPickerCalloutWindow

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

Protectedconstructor

Parameters

Returns ComponentPickerCalloutWindow

Accessors

dpiScale

Returns number

Note

getMaximumSize

Returns Immutable<Size2>

getMinimumSize

Returns Immutable<Size2>

height

Returns number

Parameters

Returns void

heightInPixels

Returns number

Parameters

Returns void

isDestroyed

Returns boolean

isFocused

Returns boolean

Parameters

Returns void

keyWindow

Returns KeyWindowBase

left

Returns number

localShortcutContext

Returns ShortcutContext

parentWindow

Returns EditorWindowBase

position

Returns Immutable<Vector2>

renderWindow

Returns RenderWindow

shortcutContext

Returns ShortcutContext

size

Returns Immutable<Size2>

top

Returns number

ui

Returns UIPanel

width

Returns number

Parameters

Returns void

widthInPixels

Returns number

Parameters

Returns void

Methods

center

Returns void

close

Returns void

isVisible

Returns boolean

onClose

Returns void

ProtectedonDestroy

Returns void

ProtectedonEditorUpdate

Returns void

ProtectedonEditorUpdateLate

Returns void

onInitialize

Parameters

callback: ((componentType: Type) => void)

`Protected`constructor

`Protected`onDestroy

`Protected`onEditorUpdate

`Protected`onEditorUpdateLate

`Protected` `Static`construct

`Static`constructInternal

`Static`open

`Readonly`onFocusChangedInternal