Class SlateGizmo
Hierarchy
-
Gizmo
- SlateGizmo
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Parameters
-
Optional utilityLayer: UtilityLayerRenderer
Returns SlateGizmo
-
Properties
_root MeshSearch playground for _rootMesh
The root mesh of the gizmo
fixed Screen SizeSearch playground for fixedScreenSize
If set, the handles will increase in size based on the distance away from the camera to have a consistent screen size (Default: true)
fixed Screen Size Distance FactorSearch playground for fixedScreenSizeDistanceFactor
The distance away from the object which the draggable meshes should appear world sized when fixedScreenSize is set to true (default: 10)
gizmo LayerSearch playground for gizmoLayer
The utility layer the gizmo will be added to
handle SizeSearch playground for handleSize
Size of the handles (meters in XR)
update Gizmo Position ToMatch Attached MeshSearch playground for updateGizmoPositionToMatchAttachedMesh
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
update ScaleSearch playground for updateScale
When set, the gizmo will always appear the same size no matter where the camera is (default: true)
Accessors
attached Mesh
-
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>
-
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
attached Node
-
Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
- When set, interactions will be enabled
Returns Nullable<Node>
-
Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
- When set, interactions will be enabled
Parameters
Returns any
attached Slate
-
The slate attached to this gizmo
Returns Nullable<HolographicSlate>
-
The slate attached to this gizmo
Parameters
-
control: Nullable<HolographicSlate>
Returns any
-
custom Rotation Quaternion
-
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))
Returns Nullable<Quaternion>
-
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
-
is Hovered
-
True when the mouse pointer is hovered a gizmo mesh
Returns boolean
scale Ratio
-
Ratio for the scale of the gizmo (Default: 1)
Returns number
-
Ratio for the scale of the gizmo (Default: 1)
Parameters
-
value: number
Returns any
-
update Gizmo Rotation ToMatch Attached Mesh
-
If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
Returns boolean
-
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
-
Returns void
set Custom MeshSearch playground for setCustomMesh
-
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
-
update Bounding BoxSearch playground for updateBoundingBox
-
Updates the bounding box information for the gizmo
Returns void
Static Gizmo Axis Pointer ObserverSearch playground for GizmoAxisPointerObserver
-
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
-
BABYLON.Gizmo to resize 2D slates