Interface IPlaneRotationGizmo
Hierarchy
- IGizmo
- IPlaneRotationGizmo
Implemented by
Index
Properties
- _root
Mesh - anchor
Point - angle
- attached
Mesh - attached
Node - colored
Material - coordinates
Mode - custom
Rotation Quaternion - disable
Material - drag
Behavior - gizmo
Layer - hover
Material - is
Enabled - is
Hovered - on
Snap Observable - rotation
Color - scale
Ratio - sensitivity
- snap
Distance - update
Gizmo Position To Match Attached Mesh - update
Gizmo Rotation To Match Attached Mesh - update
Scale
Methods
Properties
_root MeshSearch playground for _rootMesh
The root mesh of the gizmo
anchor PointSearch playground for anchorPoint
Defines where the gizmo will be positioned if updateGizmoPositionToMatchAttachedMesh
is enabled.
(Default: GizmoAnchorPoint.Origin)
angleSearch playground for angle
Accumulated relative angle value for rotation on the axis.
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
colored MaterialSearch playground for coloredMaterial
Default material used to render when gizmo is not disabled or hovered
coordinates ModeSearch playground for coordinatesMode
Set the coordinate mode to use. By default it's local.
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))
disable MaterialSearch playground for disableMaterial
Material used to render when gizmo is disabled. typically grey.
drag BehaviorSearch playground for dragBehavior
Drag behavior responsible for the gizmos dragging interactions
gizmo LayerSearch playground for gizmoLayer
The utility layer the gizmo will be added to
hover MaterialSearch playground for hoverMaterial
Material used to render when gizmo is hovered with mouse
is EnabledSearch playground for isEnabled
If the gizmo is enabled
Readonly is HoveredSearch playground for isHovered
True when the mouse pointer is hovered a gizmo mesh
on Snap ObservableSearch playground for onSnapObservable
Event that fires each time the gizmo snaps to a new location.
- snapDistance is the change in distance
rotation ColorSearch playground for rotationColor
Color used to render the drag angle sector when gizmo is rotated with mouse
scale RatioSearch playground for scaleRatio
Ratio for the scale of the gizmo
sensitivitySearch playground for sensitivity
Sensitivity factor for dragging
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)
Methods
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 plane rotation gizmo