Class ResourceDragDropViewportInteraction

Handles dragging a resource into the scene.

Hierarchy (view full)

ViewportInteractionBase
- ResourceDragDropViewportInteraction

Constructors

constructor

new ResourceDragDropViewportInteraction(viewportRender, sceneWindow): ResourceDragDropViewportInteraction
Parameters
- viewportRender: UIViewportRenderer
- sceneWindow: SceneWindow
Returns ResourceDragDropViewportInteraction
Overrides ViewportInteractionBase.constructor

Properties

`Protected`_activeDragHandler

_activeDragHandler: ResourceDragDropInteractionHandler

`Protected`_dragDropData

_dragDropData: ResourceDragDropData

`Protected`_isContinousDrop

_isContinousDrop: boolean

Determines if the user did a drop operation and continues placing objects. This mode is entered when a drop happens while shift is pressed.

`Protected` `Readonly`_sceneWindow

_sceneWindow: SceneWindow

`Readonly`dragHandlers

dragHandlers: ResourceDragDropInteractionHandler[]

`Protected`onProjectEditorModuleDomainReload

onProjectEditorModuleDomainReload: (() => void)

`Readonly`viewportRenderer

viewportRenderer: UIViewportRenderer

The viewport this interaction controls.

`Readonly`wireframeRenderer

wireframeRenderer: WireframeRenderer

`Static` `Readonly`kDefaultSceneObjectViewSpaceDistance

kDefaultSceneObjectViewSpaceDistance: number

Accessors

isDraggingResource

get isDraggingResource(): boolean
Determines if a resource is currently being dragged.

Returns boolean

scenePicking

get scenePicking(): ScenePicking
The ScenePicking.

Returns ScenePicking
Inherited from ViewportInteractionBase.scenePicking

sceneWindow

get sceneWindow(): SceneWindow
Returns SceneWindow

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

cancelResourceDrag

cancelResourceDrag(): void
Cancels the active resource drag.

Returns void

`Protected`didEndResourceDrag

didEndResourceDrag(): void
Invoked when the user finished a resource drag.

Returns void

`Protected`dropResource

dropResource(theEvent): void
Performs a drop of the active resource drag.
Parameters
- theEvent: UIMouseEvent
Returns void

enableWireframeRenderer

enableWireframeRenderer(): void
Enables the wireframe renderer.

Returns void

onCommandEvent

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

onDestroy

onDestroy(): void
Virtual
Called when the editor window is being destroyed.

Returns void
Overrides ViewportInteractionBase.onDestroy

onDisable

onDisable(): void
Virtual
Called when the mode is being deactivated.

Returns void
Overrides ViewportInteractionBase.onDisable

onEditorUpdate

onEditorUpdate(): void
Virtual
Called when the editor updates.

Returns void
Overrides ViewportInteractionBase.onEditorUpdate

onEnable

onEnable(): void
Virtual
Called when the mode is activated.

Returns void
Overrides 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): boolean
Virtual
Handles the specified mouse event.
Parameters
- theEvent: UIMouseEvent
Returns boolean
Overrides ViewportInteractionBase.onMouseEvent

`Protected`startResourceDrag

startResourceDrag(theEvent, dragDropData): boolean
Starts the resource drag for the specified drag data.
Parameters
- theEvent: UIMouseEvent
- dragDropData: ResourceDragDropData
Returns boolean

`Protected`updateResourceDrag

updateResourceDrag(theEvent): void
Updates the active resource drag.
Parameters
- theEvent: UIMouseEvent
Returns void