Class ViewportViewSphereInteractiveGizmo

The ViewportViewSphereInteractiveGizmo implements an InteractiveGizmo that draws a view sphere that display the orientation of the scene camera.

Hierarchy (View Summary)

InteractiveGizmo
- ViewportViewSphereInteractiveGizmo

Index

Constructors

Properties

_axisHandles _baseColorTexture _clickStates _normalMapTexture _viewSphereMeshData axes axisCount axisDiskDistance axisDiskRadius drawAxisSpheres enableThreshold viewSphereRadius

Accessors

Methods

destroy draw drawSliderGizmos postInput preInput

Constructors

constructor

new ViewportViewSphereInteractiveGizmo(): ViewportViewSphereInteractiveGizmo

Returns ViewportViewSphereInteractiveGizmo

Overrides InteractiveGizmo.constructor

Properties

`Protected` `Readonly`_axisHandles

_axisHandles: InteractiveGizmoSliderOmidirectional[]

`Protected` `Readonly`_baseColorTexture

_baseColorTexture: Texture

`Protected` `Readonly`_clickStates

_clickStates: boolean[]

`Protected` `Readonly`_normalMapTexture

_normalMapTexture: Texture

`Protected` `Readonly`_viewSphereMeshData

_viewSphereMeshData: MeshData

`Static` `Readonly`axes

axes: Immutable<Vector3>[]

`Static` `Readonly`axisCount

axisCount: number

`Static` `Readonly`axisDiskDistance

axisDiskDistance: number

`Static` `Readonly`axisDiskRadius

axisDiskRadius: number

`Static`drawAxisSpheres

drawAxisSpheres: boolean

Determines if the axis selector spheres should be drawn.

`Static` `Readonly`enableThreshold

enableThreshold: number

`Static` `Readonly`viewSphereRadius

viewSphereRadius: number

Accessors

isEnabled

get isEnabled(): boolean

Determines the active state of the gizmo. If disabled, the gizmo will not render or receive input.

Returns boolean

Inherited from InteractiveGizmo.isEnabled

Methods

destroy

destroy(): void

Destroy the interactive gizmo and registered slider gizmos.

Returns void

Inherited from InteractiveGizmo.destroy

`Abstract`draw

draw(event: InteractiveGizmoEvent): void
Virtual
Called every frame after postInput. Allows interactive gizmo graphics to be drawn. This is the only method that draw methods may be called
Parameters
- event: InteractiveGizmoEvent
Returns void

Overrides InteractiveGizmo.draw

drawSliderGizmos

drawSliderGizmos(event: InteractiveGizmoEvent): void
Draws all child slider gizmos registered to this gizmo.
Parameters
- event: InteractiveGizmoEvent
Returns void

Inherited from InteractiveGizmo.drawSliderGizmos

`Abstract`postInput

postInput(event: InteractiveGizmoEvent): void
Virtual
Called every frame after interactive gizmo input is processed. Active interactive gizmos will now contain values and signals if and how much they were dragged.
Parameters
- event: InteractiveGizmoEvent
Returns void

Overrides InteractiveGizmo.postInput

`Abstract`preInput

preInput(event: InteractiveGizmoEvent): void
Virtual
Called every frame before interactive gizmo input is processed. Allows interactive gizmo transforms to be updated before input.
Parameters
- event: InteractiveGizmoEvent
Returns void

Overrides InteractiveGizmo.preInput