Class GizmoManager

Helps setup gizmo's in the scene to rotate/scale/position nodes

Hierarchy

GizmoManager

Implements

IDisposable

Index

Constructors

constructor

new GizmoManager(_scene: Scene, thickness?: number, utilityLayer?: UtilityLayerRenderer, keepDepthUtilityLayer?: UtilityLayerRenderer): GizmoManager

- Defined in .temp/docdirectory/doc.d.ts:28374
Instantiates a gizmo manager

Parameters
- _scene: Scene
  
  the scene to overlay the gizmos on top of
- Optional thickness: number
  
  display gizmo axis thickness
- Optional utilityLayer: UtilityLayerRenderer
  
  the layer where gizmos are rendered
- Optional keepDepthUtilityLayer: UtilityLayerRenderer
  
  the layer where occluded gizmos are rendered
Returns GizmoManager

Properties

attachableMeshesSearch playground for attachableMeshes

attachableMeshes: Nullable<Array<AbstractMesh>>

Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)

attachableNodesSearch playground for attachableNodes

attachableNodes: Nullable<Array<Node>>

Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)

boundingBoxDragBehaviorSearch playground for boundingBoxDragBehavior

boundingBoxDragBehavior: SixDofDragBehavior

When bounding box gizmo is enabled, this can be used to track drag/end events

clearGizmoOnEmptyPointerEventSearch playground for clearGizmoOnEmptyPointerEvent

clearGizmoOnEmptyPointerEvent: boolean

When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh

enableAutoPickingSearch playground for enableAutoPicking

enableAutoPicking: boolean

When true (default), picking to attach a new mesh is enabled. This works in sync with inspector autopicking.

gizmosSearch playground for gizmos

gizmos: { boundingBoxGizmo: Nullable<BoundingBoxGizmo>; positionGizmo: Nullable<PositionGizmo>; rotationGizmo: Nullable<RotationGizmo>; scaleGizmo: Nullable<ScaleGizmo> }

Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time

Type declaration

boundingBoxGizmo: Nullable<BoundingBoxGizmo>
positionGizmo: Nullable<PositionGizmo>
rotationGizmo: Nullable<RotationGizmo>
scaleGizmo: Nullable<ScaleGizmo>

onAttachedToMeshObservableSearch playground for onAttachedToMeshObservable

onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>

Fires an event when the manager is attached to a mesh

onAttachedToNodeObservableSearch playground for onAttachedToNodeObservable

onAttachedToNodeObservable: Observable<Nullable<Node>>

Fires an event when the manager is attached to a node

usePointerToAttachGizmosSearch playground for usePointerToAttachGizmos

usePointerToAttachGizmos: boolean

If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)

Accessors

boundingBoxGizmoEnabled

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

- Defined in .temp/docdirectory/doc.d.ts:28417
If the boundingBox gizmo is enabled

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:28416
If the boundingBox gizmo is enabled

Parameters
- value: boolean
Returns any

isHovered

get isHovered(): boolean

- Defined in .temp/docdirectory/doc.d.ts:28369
True when the mouse pointer is hovering a gizmo mesh

Returns boolean

keepDepthUtilityLayer

get keepDepthUtilityLayer(): UtilityLayerRenderer

- Defined in .temp/docdirectory/doc.d.ts:28361
Utility layer that the bounding box gizmo belongs to

Returns UtilityLayerRenderer

positionGizmoEnabled

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

- Defined in .temp/docdirectory/doc.d.ts:28402
If the position gizmo is enabled

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:28401
If the position gizmo is enabled

Parameters
- value: boolean
Returns any

rotationGizmoEnabled

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

- Defined in .temp/docdirectory/doc.d.ts:28407
If the rotation gizmo is enabled

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:28406
If the rotation gizmo is enabled

Parameters
- value: boolean
Returns any

scaleGizmoEnabled

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

- Defined in .temp/docdirectory/doc.d.ts:28412
If the scale gizmo is enabled

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:28411
If the scale gizmo is enabled

Parameters
- value: boolean
Returns any

scaleRatio

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

- Defined in .temp/docdirectory/doc.d.ts:28374
Ratio for the scale of the gizmo (Default: 1)

Returns number
- Defined in .temp/docdirectory/doc.d.ts:28373
Ratio for the scale of the gizmo (Default: 1)

Parameters
- value: number
Returns any

utilityLayer

get utilityLayer(): UtilityLayerRenderer

- Defined in .temp/docdirectory/doc.d.ts:28365
Utility layer that all gizmos besides bounding box belong to

Returns UtilityLayerRenderer

Methods

addToAxisCacheSearch playground for addToAxisCache

addToAxisCache(gizmoAxisCache: Map<Mesh, GizmoAxisCache>): void

- Defined in .temp/docdirectory/doc.d.ts:28422
Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation

Parameters
- gizmoAxisCache: Map<Mesh, GizmoAxisCache>
  
  Gizmo axis definition used for reactive gizmo UI
Returns void

attachToMeshSearch playground for attachToMesh

attachToMesh(mesh: Nullable<AbstractMesh>): void

- Defined in .temp/docdirectory/doc.d.ts:28392
Attaches a set of gizmos to the specified mesh

Parameters
- mesh: Nullable<AbstractMesh>
  
  The mesh the gizmo's should be attached to
Returns void

attachToNodeSearch playground for attachToNode

attachToNode(node: Nullable<Node>): void

- Defined in .temp/docdirectory/doc.d.ts:28397
Attaches a set of gizmos to the specified node

Parameters
- node: Nullable<Node>
  
  The node the gizmo's should be attached to
Returns void

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose
- Defined in .temp/docdirectory/doc.d.ts:28426
Disposes of the gizmo manager

Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_scene: Scene

Optional thickness: number

Optional utilityLayer: UtilityLayerRenderer

Optional keepDepthUtilityLayer: UtilityLayerRenderer

Returns GizmoManager

Properties

attachableMeshesSearch playground for attachableMeshes

attachableNodesSearch playground for attachableNodes

boundingBoxDragBehaviorSearch playground for boundingBoxDragBehavior

clearGizmoOnEmptyPointerEventSearch playground for clearGizmoOnEmptyPointerEvent

enableAutoPickingSearch playground for enableAutoPicking

gizmosSearch playground for gizmos

Type declaration

boundingBoxGizmo: Nullable<BoundingBoxGizmo>

positionGizmo: Nullable<PositionGizmo>

rotationGizmo: Nullable<RotationGizmo>

scaleGizmo: Nullable<ScaleGizmo>

onAttachedToMeshObservableSearch playground for onAttachedToMeshObservable

onAttachedToNodeObservableSearch playground for onAttachedToNodeObservable

usePointerToAttachGizmosSearch playground for usePointerToAttachGizmos

Accessors

boundingBoxGizmoEnabled

Returns boolean

Parameters

value: boolean

Returns any

isHovered

Returns boolean

keepDepthUtilityLayer

Returns UtilityLayerRenderer

positionGizmoEnabled

Returns boolean

Parameters

value: boolean

Returns any

rotationGizmoEnabled

Returns boolean

Parameters

value: boolean

Returns any

scaleGizmoEnabled

Returns boolean

Parameters

value: boolean

Returns any

scaleRatio

Returns number

Parameters

value: number

Returns any

utilityLayer

Returns UtilityLayerRenderer

Methods

addToAxisCacheSearch playground for addToAxisCache

Parameters

gizmoAxisCache: Map<Mesh, GizmoAxisCache>

Returns void

attachToMeshSearch playground for attachToMesh

Parameters

mesh: Nullable<AbstractMesh>

Returns void

attachToNodeSearch playground for attachToNode

Parameters

node: Nullable<Node>

Returns void

disposeSearch playground for dispose

Returns void