Class Gizmo
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a gizmo
Parameters
-
Optional gizmoLayer: UtilityLayerRenderer
The utility layer the gizmo will be added to
Returns Gizmo
-
Properties
_root MeshSearch playground for _rootMesh
The root mesh of the gizmo
gizmo LayerSearch playground for gizmoLayer
The utility layer the gizmo will be added to
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
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
-
Disposes of the gizmo
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
-
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
-
Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.