Class GizmoOrbit

Manages the camera target gizmo

Hierarchy

GizmoOrbit

Index

Constructors

Accessors

Methods

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/vim-webgl-viewer/gizmos/gizmoOrbit.ts:42

Accessors

enabled

get enabled(): boolean
Determines whether the orbit gizmo is enabled.

Returns boolean
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:80
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:84

Methods

dispose

dispose(): void
Disposes of all resources.

Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:222

setColor

setColor(color: Color): void
Updates the color of the orbit gizmo.
Parameters
- color: Color
  
  The new color for the orbit gizmo.
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:141

setOpacity

setOpacity(opacity: number, opacityAlways: number): void
Updates the opacity of the orbit gizmo.
Parameters
- opacity: number
  
  The opacity of the non-occluded part.
- opacityAlways: number
  
  The opacity of the occluded part.
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:129

setPosition

setPosition(position: Vector3): void
Updates the position of the orbit gizmo.
Parameters
- position: Vector3
  
  The new position of the orbit gizmo.
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:111

setSize

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

show

show(show??: boolean): void
Show or hide the gizmo for a brief delay if the gizmo is active.
Parameters
- Optional show: boolean = true
  
  Whether to show or hide the gizmo.
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoOrbit.ts:92

Generated using TypeDoc