Class GizmoOrbit

Manages the camera target gizmo

Hierarchy

GizmoOrbit

Index

Constructors

Accessors

Methods

applySettings dispose setColor setOpacity setPosition setSize show

Constructors

constructor

new GizmoOrbit(renderer: Renderer, camera: Camera, input: Input, settings: Settings): GizmoOrbit
Parameters
- renderer: Renderer
- camera: Camera
- input: Input
- settings: Settings
Returns GizmoOrbit
- Defined in src/viewer/gizmos/gizmoOrbit.ts:43

Accessors

enabled

get enabled(): boolean
Orbit gizmo will only show when enabled is true.

Returns boolean
- Defined in src/viewer/gizmos/gizmoOrbit.ts:103
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:107

Methods

applySettings

applySettings(settings: Settings): void
Parameters
- settings: Settings
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:189

dispose

dispose(): void
Disposes all resources.

Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:80

setColor

setColor(color: Color): void
Updates color of the orbit gizmo
Parameters
- color: Color
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:182

setOpacity

setOpacity(opacity: number, opacityAlways: number): void
Updates opacity of the orbit gizmo

Opacity
opacity of the non occluded part.

Opacity Always
opacity of the occluded part.
Parameters
- opacity: number
- opacityAlways: number
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:171

setPosition

setPosition(position: THREE.Vector3): void
Updates the position of the orbit gizmo
Parameters
- position: THREE.Vector3
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:154

setSize

setSize(size: number): void
Updates the size of the orbit gizmo
Parameters
- size: number
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:162

show

show(show?: boolean): void
Show/Hide the gizmo for a brief delay if the gizmo is actives.
Parameters
- show: boolean = true
Returns void
- Defined in src/viewer/gizmos/gizmoOrbit.ts:114

Generated using TypeDoc