Class: PlumGizmoManager
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:4
Extends
GizmoManager
Constructors
Constructor
new PlumGizmoManager(
_scene,thickness?,utilityLayer?,keepDepthUtilityLayer?):PlumGizmoManager
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:10
Parameters
_scene
Scene
thickness?
number
utilityLayer?
UtilityLayerRenderer
keepDepthUtilityLayer?
UtilityLayerRenderer
Returns
PlumGizmoManager
Overrides
GizmoManager.constructor
Properties
_additionalTransformNode?
protectedoptional_additionalTransformNode:TransformNode
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:56
Inherited from
GizmoManager._additionalTransformNode
_attachedMesh
protected_attachedMesh:AbstractMesh
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:48
Inherited from
GizmoManager._attachedMesh
_attachedNode
protected_attachedNode:Node
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:49
Inherited from
GizmoManager._attachedNode
_boundingBoxColor
protected_boundingBoxColor:Color3
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:50
Inherited from
GizmoManager._boundingBoxColor
_coordinatesMode
protected_coordinatesMode:GizmoCoordinatesMode
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:55
Inherited from
GizmoManager._coordinatesMode
_defaultKeepDepthUtilityLayer
protected_defaultKeepDepthUtilityLayer:UtilityLayerRenderer
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:52
Inherited from
GizmoManager._defaultKeepDepthUtilityLayer
_defaultUtilityLayer
protected_defaultUtilityLayer:UtilityLayerRenderer
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:51
Inherited from
GizmoManager._defaultUtilityLayer
_gizmosEnabled
protected_gizmosEnabled:object
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:41
boundingBoxGizmo
boundingBoxGizmo:
boolean
positionGizmo
positionGizmo:
boolean
rotationGizmo
rotationGizmo:
boolean
scaleGizmo
scaleGizmo:
boolean
Inherited from
GizmoManager._gizmosEnabled
_pointerObservers
protected_pointerObservers:Observer<PointerInfo>[]
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:47
Inherited from
GizmoManager._pointerObservers
_scaleRatio
protected_scaleRatio:number
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:54
Inherited from
GizmoManager._scaleRatio
_thickness
protected_thickness:number
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:53
Inherited from
GizmoManager._thickness
attachableMeshes
attachableMeshes:
AbstractMesh[]
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:66
Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
Inherited from
GizmoManager.attachableMeshes
attachableNodes
attachableNodes:
Node[]
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:70
Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
Inherited from
GizmoManager.attachableNodes
boundingBoxDragBehavior
boundingBoxDragBehavior:
SixDofDragBehavior
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:62
When bounding box gizmo is enabled, this can be used to track drag/end events
Inherited from
GizmoManager.boundingBoxDragBehavior
cameraGizmosMap
cameraGizmosMap:
Map<Camera,CameraGizmo>
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:8
clearGizmoOnEmptyPointerEvent
clearGizmoOnEmptyPointerEvent:
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:34
When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh
Inherited from
GizmoManager.clearGizmoOnEmptyPointerEvent
enableAutoPicking
enableAutoPicking:
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:36
When true (default), picking to attach a new mesh is enabled. This works in sync with inspector autopicking.
Inherited from
GizmoManager.enableAutoPicking
gizmos
gizmos:
object
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:27
Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
boundingBoxGizmo
boundingBoxGizmo:
IBoundingBoxGizmo
positionGizmo
positionGizmo:
IPositionGizmo
rotationGizmo
rotationGizmo:
IRotationGizmo
scaleGizmo
scaleGizmo:
IScaleGizmo
Inherited from
GizmoManager.gizmos
lightGizmosMap
lightGizmosMap:
Map<Light,LightGizmo>
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:6
onAttachedToMeshObservable
onAttachedToMeshObservable:
Observable<AbstractMesh>
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:38
Fires an event when the manager is attached to a mesh
Inherited from
GizmoManager.onAttachedToMeshObservable
onAttachedToNodeObservable
onAttachedToNodeObservable:
Observable<Node>
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:40
Fires an event when the manager is attached to a node
Inherited from
GizmoManager.onAttachedToNodeObservable
usePointerToAttachGizmos
usePointerToAttachGizmos:
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:74
If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
Inherited from
GizmoManager.usePointerToAttachGizmos
Accessors
additionalTransformNode
Get Signature
get additionalTransformNode():
TransformNode
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:114
Additional transform node that will be used to transform all the gizmos
Returns
TransformNode
Set Signature
set additionalTransformNode(
node):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:164
Sets the additional transform applied to all the gizmos.
See
Gizmo.additionalTransformNode for more detail
Parameters
node
TransformNode
Returns
void
Inherited from
GizmoManager.additionalTransformNode
attachedMesh
Get Signature
get attachedMesh():
AbstractMesh
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:106
The mesh the gizmo's is attached to
Returns
AbstractMesh
Inherited from
GizmoManager.attachedMesh
attachedNode
Get Signature
get attachedNode():
Node
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:110
The node the gizmo's is attached to
Returns
Node
Inherited from
GizmoManager.attachedNode
boundingBoxGizmoEnabled
Get Signature
get boundingBoxGizmoEnabled():
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:159
Returns
boolean
Set Signature
set boundingBoxGizmoEnabled(
value):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:158
If the boundingBox gizmo is enabled
Parameters
value
boolean
Returns
void
Inherited from
GizmoManager.boundingBoxGizmoEnabled
coordinatesMode
Get Signature
get coordinatesMode():
GizmoCoordinatesMode
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:102
Returns
GizmoCoordinatesMode
Set Signature
set coordinatesMode(
coordinatesMode):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:101
Set the coordinate system to use. By default it's local.
But it's possible for a user to tweak so its local for translation and world for rotation.
In that case, setting the coordinate system will change updateGizmoRotationToMatchAttachedMesh and updateGizmoPositionToMatchAttachedMesh
Parameters
coordinatesMode
GizmoCoordinatesMode
Returns
void
Inherited from
GizmoManager.coordinatesMode
isDragging
Get Signature
get isDragging():
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:90
True when the mouse pointer is dragging a gizmo mesh
Returns
boolean
Inherited from
GizmoManager.isDragging
isHovered
Get Signature
get isHovered():
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:86
True when the mouse pointer is hovering a gizmo mesh
Returns
boolean
Inherited from
GizmoManager.isHovered
keepDepthUtilityLayer
Get Signature
get keepDepthUtilityLayer():
UtilityLayerRenderer
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:78
Utility layer that the bounding box gizmo belongs to
Returns
UtilityLayerRenderer
Inherited from
GizmoManager.keepDepthUtilityLayer
positionGizmoEnabled
Get Signature
get positionGizmoEnabled():
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:144
Returns
boolean
Set Signature
set positionGizmoEnabled(
value):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:143
If the position gizmo is enabled
Parameters
value
boolean
Returns
void
Inherited from
GizmoManager.positionGizmoEnabled
rotationGizmoEnabled
Get Signature
get rotationGizmoEnabled():
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:149
Returns
boolean
Set Signature
set rotationGizmoEnabled(
value):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:148
If the rotation gizmo is enabled
Parameters
value
boolean
Returns
void
Inherited from
GizmoManager.rotationGizmoEnabled
scaleGizmoEnabled
Get Signature
get scaleGizmoEnabled():
boolean
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:154
Returns
boolean
Set Signature
set scaleGizmoEnabled(
value):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:153
If the scale gizmo is enabled
Parameters
value
boolean
Returns
void
Inherited from
GizmoManager.scaleGizmoEnabled
scaleRatio
Get Signature
get scaleRatio():
number
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:95
Returns
number
Set Signature
set scaleRatio(
value):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:94
Ratio for the scale of the gizmo (Default: 1)
Parameters
value
number
Returns
void
Inherited from
GizmoManager.scaleRatio
utilityLayer
Get Signature
get utilityLayer():
UtilityLayerRenderer
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:82
Utility layer that all gizmos besides bounding box belong to
Returns
UtilityLayerRenderer
Inherited from
GizmoManager.utilityLayer
Methods
addToAxisCache()
addToAxisCache(
gizmoAxisCache):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:170
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
Inherited from
GizmoManager.addToAxisCache
attachToMesh()
attachToMesh(
mesh):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:134
Attaches a set of gizmos to the specified mesh
Parameters
mesh
AbstractMesh
The mesh the gizmo's should be attached to
Returns
void
Inherited from
GizmoManager.attachToMesh
attachToNode()
attachToNode(
node):void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:139
Attaches a set of gizmos to the specified node
Parameters
node
Node
The node the gizmo's should be attached to
Returns
void
Inherited from
GizmoManager.attachToNode
dispose()
dispose():
void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:178
Disposes of the gizmo manager
Returns
void
Inherited from
GizmoManager.dispose
enableCameraGizmo()
enableCameraGizmo(
camera):CameraGizmo
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:27
Parameters
camera
Camera
Returns
CameraGizmo
enableLightGizmo()
enableLightGizmo(
light):LightGizmo
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:15
Parameters
light
Light
Returns
LightGizmo
releaseDrag()
releaseDrag():
void
Defined in: node_modules/@babylonjs/core/Gizmos/gizmoManager.d.ts:174
Force release the drag action by code
Returns
void
Inherited from
GizmoManager.releaseDrag
removeCameraGizmo()
removeCameraGizmo(
camera):void
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:43
Parameters
camera
Camera
Returns
void
removeLightGizmo()
removeLightGizmo(
light):void
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:38
Parameters
light
Light
Returns
void
setGizmoType()
setGizmoType(
value):void
Defined in: packages/core/sdk/src/manager/PlumGizmoManager.ts:48
Parameters
value
Returns
void