Class SlateGizmo
Hierarchy
- Gizmo
- SlateGizmo
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a gizmo
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
Static Preserve ScalingSearch playground for PreserveScaling
When enabled, any gizmo operation will perserve scaling sign. Default is off. Only valid for TransformNode derived classes (Mesh, AbstractMesh, ...)
Static Use Absolute ScalingSearch playground for UseAbsoluteScaling
There are 2 ways to preserve scaling: using mesh scaling or absolute scaling. Depending of hierarchy, non uniform scaling and LH or RH coordinates. One is preferable than the other. If the scaling to be preserved is the local scaling, then set this value to false. Default is true which means scaling to be preserved is absolute one (with hierarchy applied)
Accessors
anchor Point
Defines where the gizmo will be positioned if
updateGizmoPositionToMatchAttachedMesh
is enabled. (Default: GizmoAnchorPoint.Origin)Returns GizmoAnchorPoint
Defines where the gizmo will be positioned if
updateGizmoPositionToMatchAttachedMesh
is enabled. (Default: GizmoAnchorPoint.Origin)Parameters
value: GizmoAnchorPoint
Returns void
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 void
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 void
attached Slate
The slate attached to this gizmo
Returns Nullable<HolographicSlate>
The slate attached to this gizmo
Parameters
control: Nullable<HolographicSlate>
Returns void
coordinates Mode
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
andupdateGizmoPositionToMatchAttachedMesh
Returns GizmoCoordinatesMode
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
andupdateGizmoPositionToMatchAttachedMesh
Parameters
coordinatesMode: GizmoCoordinatesMode
Returns void
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 void
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 void
update Gizmo Position To Match Attached Mesh
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
Returns boolean
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
Parameters
value: boolean
Returns void
update Gizmo Rotation To Match Attached Mesh
If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true) NOTE: This is only possible for meshes with uniform scaling, as otherwise it's not possible to decompose the rotation
Returns boolean
If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true) NOTE: This is only possible for meshes with uniform scaling, as otherwise it's not possible to decompose the rotation
Parameters
value: boolean
Returns void
update Scale
When set, the gizmo will always appear the same size no matter where the camera is (default: true)
Returns boolean
When set, the gizmo will always appear the same size no matter where the camera is (default: true)
Parameters
value: boolean
Returns void
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
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