Class CameraModeViewportInteraction

Mode used for switching between different camera movement types.

Hierarchy (view full)

ViewportInteractionBase
- CameraModeViewportInteraction

Index

Constructors

Constructors

constructor

new CameraModeViewportInteraction(viewportRender): CameraModeViewportInteraction
Creates a new instance of CameraModeViewportInteraction.
Parameters
- viewportRender: UIViewportRenderer
Returns CameraModeViewportInteraction
Overrides ViewportInteractionBase.constructor

Properties

`Protected`_cameraWorldPostionOnEngagementStart

_cameraWorldPostionOnEngagementStart: Immutable<Vector3>

`Protected`_cursorMoveDeltaDuringEngagement

_cursorMoveDeltaDuringEngagement: number

The absolute move delta during engagement.

`Protected`_isEngaging

_isEngaging: boolean

Determines if the camera was moved while the pointer was held down.

hideCursorWhenEngaged

hideCursorWhenEngaged: boolean

Determines if the cursor should be hidden when the user engages with the interaction.

`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

mode

get mode(): EnumValue<ViewportCameraNavigationMode, number>
Sets or gets the camera mode.

Returns EnumValue<ViewportCameraNavigationMode, number>
set mode(value): void
Parameters
- value: EnumValue<ViewportCameraNavigationMode, number>
Returns void

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): 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
Overrides 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
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

Class CameraModeViewportInteraction

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CameraModeViewportInteraction

Properties

Protected_cameraWorldPostionOnEngagementStart

Protected_cursorMoveDeltaDuringEngagement

Protected_isEngaging

hideCursorWhenEngaged

ReadonlyviewportRenderer

Accessors

isAvailable

Returns boolean

Note

mode

Returns EnumValue<ViewportCameraNavigationMode, number>

Parameters

Returns void

scenePicking

Returns ScenePicking

viewportCamera

Returns ViewportCamera

viewportData

Returns IViewportRendererData

Methods

onCommandEvent

Parameters

Returns boolean

onDestroy

Returns void

onDisable

Returns void

onEditorUpdate

Returns void

onEnable

Returns void

onModeChange

Returns void

onMouseEvent

Parameters

Returns boolean

Settings

On This Page

`Protected`_cameraWorldPostionOnEngagementStart

`Protected`_cursorMoveDeltaDuringEngagement

`Protected`_isEngaging

`Readonly`viewportRenderer