Interface IPositionGizmo
Hierarchy
- IGizmo
- IPositionGizmo
Implemented by
Index
Properties
Methods
Properties
_root MeshSearch playground for _rootMesh
The root mesh of the gizmo
attached MeshSearch playground for attachedMesh
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
attached NodeSearch playground for attachedNode
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
custom Rotation QuaternionSearch playground for customRotationQuaternion
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))
gizmo LayerSearch playground for gizmoLayer
The utility layer the gizmo will be added to
Readonly is HoveredSearch playground for isHovered
True when the mouse pointer is hovered a gizmo mesh
on Drag End ObservableSearch playground for onDragEndObservable
Fires an event when any of it's sub gizmos are released from dragging
on Drag Start ObservableSearch playground for onDragStartObservable
Fires an event when any of it's sub gizmos are dragged
planar Gizmo EnabledSearch playground for planarGizmoEnabled
If the planar drag gizmo is enabled setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
scale RatioSearch playground for scaleRatio
Ratio for the scale of the gizmo
snap DistanceSearch playground for snapDistance
Drag distance in babylon units that the gizmo will snap to when dragged
update Gizmo Position To Match Attached MeshSearch playground for updateGizmoPositionToMatchAttachedMesh
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
update Gizmo Rotation To Match Attached MeshSearch playground for updateGizmoRotationToMatchAttachedMesh
If set the gizmo's rotation 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)
x GizmoSearch playground for xGizmo
Internal gizmo used for interactions on the x axis
x Plane GizmoSearch playground for xPlaneGizmo
Internal gizmo used for interactions on the yz plane
y GizmoSearch playground for yGizmo
Internal gizmo used for interactions on the y axis
y Plane GizmoSearch playground for yPlaneGizmo
Internal gizmo used for interactions on the xz plane
z GizmoSearch playground for zGizmo
Internal gizmo used for interactions on the z axis
z Plane GizmoSearch playground for zPlaneGizmo
Internal gizmo used for interactions on the xy plane
Methods
add To Axis CacheSearch playground for addToAxisCache
Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
Parameters
mesh: Mesh
Axis gizmo mesh
cache: GizmoAxisCache
Gizmo axis definition used for reactive gizmo UI
Returns void
disposeSearch playground for dispose
Releases all held resources
Returns void
set Custom MeshSearch playground for setCustomMesh
Disposes and replaces the current meshes in the gizmo with the specified mesh
Parameters
mesh: Mesh
Returns void
Interface for position gizmo