Class GizmoOrbit

Manages the camera target gizmo

Index

Constructors

Accessors

Methods

dispose setColor setOpacity setPosition setSize show

Constructors

constructor

new GizmoOrbit(
    renderer: Core.Webgl.Renderer,
    camera: Core.Webgl.Camera,
    input: InputHandler,
    settings: ViewerSettings,
): GizmoOrbit
Parameters
- renderer: Core.Webgl.Renderer
- camera: Core.Webgl.Camera
- input: InputHandler
- settings: ViewerSettings
Returns GizmoOrbit
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/gizmoOrbit.ts:39

Accessors

enabled

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

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

Methods

dispose

dispose(): void
Disposes of all resources.

Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/gizmoOrbit.ts:202

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-web/core-viewers/webgl/viewer/gizmos/gizmoOrbit.ts:142

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-web/core-viewers/webgl/viewer/gizmos/gizmoOrbit.ts:130

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-web/core-viewers/webgl/viewer/gizmos/gizmoOrbit.ts:112

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-web/core-viewers/webgl/viewer/gizmos/gizmoOrbit.ts:121

show

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