Class DragSelectionViewportInteraction

Selecting objects by spanning a rectangle over them.

Hierarchy (View Summary)

ViewportInteractionBase
- DragSelectionViewportInteraction

Index

Constructors

Properties

viewportRenderer

Accessors

isAvailable isDragSelectionActive scenePicking viewportCamera viewportData

Methods

onCommandEvent onDestroy onDisable onEditorUpdate onEnable onModeChange onMouseEvent performSelection

Constructors

constructor

new DragSelectionViewportInteraction(
viewportRender: UIViewportRenderer,
): DragSelectionViewportInteraction
Parameters
- viewportRender: UIViewportRenderer
Returns DragSelectionViewportInteraction

Overrides ViewportInteractionBase.constructor

Properties

`Readonly`viewportRenderer

viewportRenderer: UIViewportRenderer

The viewport this interaction controls.

Accessors

isAvailable

get isAvailable(): boolean

Virtual
Determines if the interaction is available.

Returns boolean

Note
If the interaction is not available, no events will be forwarded to it. This property allows interactions to determines if all the dependencies are availble for it to execute.

Inherited from ViewportInteractionBase.isAvailable

isDragSelectionActive

get isDragSelectionActive(): boolean

Determines if the drag selection is active and engaging with the scene as the primary input mode.

Returns boolean

scenePicking

get scenePicking(): ScenePicking

The ScenePicking.

Returns ScenePicking

Inherited from ViewportInteractionBase.scenePicking

viewportCamera

get viewportCamera(): ViewportCamera

The ViewportCamera the interaction controls.

Returns ViewportCamera

Inherited from ViewportInteractionBase.viewportCamera

viewportData

get viewportData(): IViewportRendererData

The ViewportRendererData used with this interaction.

Returns IViewportRendererData

Inherited from ViewportInteractionBase.viewportData

Methods

onCommandEvent

onCommandEvent(theEvent: UICommandEvent): boolean
Virtual
Handles the specified command event.
Parameters
- theEvent: UICommandEvent
Returns boolean

Inherited from ViewportInteractionBase.onCommandEvent

onDestroy

onDestroy(): void

Virtual
Called when the editor window is being destroyed.

Returns void

Inherited from ViewportInteractionBase.onDestroy

onDisable

onDisable(): void

Virtual
Called when the mode is being deactivated.

Returns void

Inherited from ViewportInteractionBase.onDisable

onEditorUpdate

onEditorUpdate(): void

Virtual
Called when the editor updates.

Returns void

Inherited from ViewportInteractionBase.onEditorUpdate

onEnable

onEnable(): void

Virtual
Called when the mode is activated.

Returns void

Inherited from ViewportInteractionBase.onEnable

onModeChange

onModeChange(): void

Virtual
Called on all modes when currently active mode is changed.

Returns void

Inherited from ViewportInteractionBase.onModeChange

onMouseEvent

onMouseEvent(theEvent: UIMouseEvent): boolean
Virtual
Handles the specified mouse event.
Parameters
- theEvent: UIMouseEvent
Returns boolean

Overrides ViewportInteractionBase.onMouseEvent

`Protected`performSelection

performSelection(
    regionPointA: Immutable<Vector2>,
    regionPointB: Immutable<Vector2>,
    allowCacheUpdate: boolean,
): SceneObject[]
Performs the selection based on the specified region. The region is defined by the AABB that encapuslates regionPointA and regionPointB.
Parameters
- regionPointA: Immutable<Vector2>
- regionPointB: Immutable<Vector2>
- allowCacheUpdate: boolean
  Determines if the cached object texture can be updated in a blocking call.
Returns SceneObject[]