Class LightGizmo

Gizmo that enables viewing a light

Hierarchy

Gizmo
- LightGizmo

Implements

IDisposable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new LightGizmo(gizmoLayer?: UtilityLayerRenderer): LightGizmo

Overrides Gizmo.constructor
- Defined in .temp/docdirectory/doc.d.ts:28445
Creates a LightGizmo

Parameters
- Optional gizmoLayer: UtilityLayerRenderer
  
  The utility layer the gizmo will be added to
Returns LightGizmo

Properties

_rootMeshSearch playground for _rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

gizmoLayerSearch playground for gizmoLayer

gizmoLayer: UtilityLayerRenderer

The utility layer the gizmo will be added to

onClickedObservableSearch playground for onClickedObservable

onClickedObservable: Observable<Light>

Event that fires each time the gizmo is clicked

updateGizmoPositionToMatchAttachedMeshSearch playground for updateGizmoPositionToMatchAttachedMesh

updateGizmoPositionToMatchAttachedMesh: boolean

If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)

updateScaleSearch playground for updateScale

updateScale: boolean

When set, the gizmo will always appear the same size no matter where the camera is (default: true)

Static PreserveScalingSearch playground for PreserveScaling

PreserveScaling: boolean

When enabled, any gizmo operation will perserve scaling sign. Default is off. Only valid for TransformNode derived classes (Mesh, AbstractMesh, ...)

Accessors

attachedMesh

get attachedMesh(): Nullable<AbstractMesh>
set attachedMesh(value: Nullable<AbstractMesh>): any

Inherited from AxisDragGizmo.attachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28228
Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
- When set, interactions will be enabled
Returns Nullable<AbstractMesh>
Inherited from AxisDragGizmo.attachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28229
Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
- When set, interactions will be enabled
Parameters
- value: Nullable<AbstractMesh>
Returns any

attachedNode

get attachedNode(): Nullable<Node>
set attachedNode(value: Nullable<Node>): any

Overrides AxisDragGizmo.attachedNode
- Defined in .temp/docdirectory/doc.d.ts:28457
Override attachedNode because lightgizmo only support attached mesh It will return the attached mesh (if any) and setting an attached node will log a warning

Returns Nullable<Node>
Overrides AxisDragGizmo.attachedNode
- Defined in .temp/docdirectory/doc.d.ts:28458
Override attachedNode because lightgizmo only support attached mesh It will return the attached mesh (if any) and setting an attached node will log a warning

Parameters
- value: Nullable<Node>
Returns any

customRotationQuaternion

get customRotationQuaternion(): Nullable<Quaternion>
set customRotationQuaternion(customRotationQuaternion: Nullable<Quaternion>): any

Inherited from AxisDragGizmo.customRotationQuaternion
- Defined in .temp/docdirectory/doc.d.ts:28275
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

Returns Nullable<Quaternion>
Inherited from AxisDragGizmo.customRotationQuaternion
- Defined in .temp/docdirectory/doc.d.ts:28276
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

Parameters
- customRotationQuaternion: Nullable<Quaternion>
Returns any

isHovered

get isHovered(): boolean

Inherited from AxisDragGizmo.isHovered
- Defined in .temp/docdirectory/doc.d.ts:28219
True when the mouse pointer is hovered a gizmo mesh

Returns boolean

light

get light(): Nullable<Light>
set light(light: Nullable<Light>): any

- Defined in .temp/docdirectory/doc.d.ts:28463
The light that the gizmo is attached to

Returns Nullable<Light>
- Defined in .temp/docdirectory/doc.d.ts:28462
The light that the gizmo is attached to

Parameters
- light: Nullable<Light>
Returns any

material

get material(): StandardMaterial

- Defined in .temp/docdirectory/doc.d.ts:28467
Gets the material used to render the light gizmo

Returns StandardMaterial

scaleRatio

get scaleRatio(): number
set scaleRatio(value: number): any

Inherited from AxisDragGizmo.scaleRatio
- Defined in .temp/docdirectory/doc.d.ts:28215
Ratio for the scale of the gizmo (Default: 1)

Returns number
Inherited from AxisDragGizmo.scaleRatio
- Defined in .temp/docdirectory/doc.d.ts:28214
Ratio for the scale of the gizmo (Default: 1)

Parameters
- value: number
Returns any

updateGizmoRotationToMatchAttachedMesh

get updateGizmoRotationToMatchAttachedMesh(): boolean
set updateGizmoRotationToMatchAttachedMesh(value: boolean): any

Inherited from AxisDragGizmo.updateGizmoRotationToMatchAttachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28246
If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)

Returns boolean
Inherited from AxisDragGizmo.updateGizmoRotationToMatchAttachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28245
If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)

Parameters
- value: boolean
Returns any

Methods

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose

Overrides Gizmo.dispose
- Defined in .temp/docdirectory/doc.d.ts:28483
Disposes of the light gizmo

Returns void

setCustomMeshSearch playground for setCustomMesh

setCustomMesh(mesh: Mesh): void

Inherited from AxisDragGizmo.setCustomMesh
- Defined in .temp/docdirectory/doc.d.ts:28240
Disposes and replaces the current meshes in the gizmo with the specified mesh

Parameters
- mesh: Mesh
  
  The mesh to replace the default mesh of the gizmo
Returns void

Static GizmoAxisPointerObserverSearch playground for GizmoAxisPointerObserver

GizmoAxisPointerObserver(gizmoLayer: UtilityLayerRenderer, gizmoAxisCache: Map<Mesh, GizmoAxisCache>): Observer<PointerInfo>

Inherited from AxisDragGizmo.GizmoAxisPointerObserver
- Defined in .temp/docdirectory/doc.d.ts:28301
Subscribes to pointer up, down, and hover events. Used for responsive gizmos.

Parameters
- gizmoLayer: UtilityLayerRenderer
  
  The utility layer the gizmo will be added to
- gizmoAxisCache: Map<Mesh, GizmoAxisCache>
  
  Gizmo axis definition used for reactive gizmo UI
Returns Observer<PointerInfo>

pointerObserver

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional gizmoLayer: UtilityLayerRenderer

Returns LightGizmo

Properties

_rootMeshSearch playground for _rootMesh

gizmoLayerSearch playground for gizmoLayer

onClickedObservableSearch playground for onClickedObservable

updateGizmoPositionToMatchAttachedMeshSearch playground for updateGizmoPositionToMatchAttachedMesh

updateScaleSearch playground for updateScale

Static PreserveScalingSearch playground for PreserveScaling

Accessors

attachedMesh

Returns Nullable<AbstractMesh>

Parameters

value: Nullable<AbstractMesh>

Returns any

attachedNode

Returns Nullable<Node>

Parameters

value: Nullable<Node>

Returns any

customRotationQuaternion

Returns Nullable<Quaternion>

Parameters

customRotationQuaternion: Nullable<Quaternion>

Returns any

isHovered

Returns boolean

light

Returns Nullable<Light>

Parameters

light: Nullable<Light>

Returns any

material

Returns StandardMaterial

scaleRatio

Returns number

Parameters

value: number

Returns any

updateGizmoRotationToMatchAttachedMesh

Returns boolean

Parameters

value: boolean

Returns any

Methods

disposeSearch playground for dispose

Returns void

setCustomMeshSearch playground for setCustomMesh

Parameters

mesh: Mesh

Returns void

Static GizmoAxisPointerObserverSearch playground for GizmoAxisPointerObserver

Parameters

gizmoLayer: UtilityLayerRenderer

gizmoAxisCache: Map<Mesh, GizmoAxisCache>

Returns Observer<PointerInfo>