Class PlaneRotationGizmo
Hierarchy
-
Gizmo
- PlaneRotationGizmo
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a PlaneRotationGizmo
Parameters
-
planeNormal: Vector3
The normal of the plane which the gizmo will be able to rotate on
-
Optional color: Color3
The color of the gizmo
-
Optional gizmoLayer: UtilityLayerRenderer
The utility layer the gizmo will be added to
-
Optional tessellation: number
Amount of tessellation to be used when creating rotation circles
-
Optional parent: Nullable<RotationGizmo>
-
Optional useEulerRotation: boolean
Use and update Euler angle instead of quaternion
-
Optional thickness: number
display gizmo axis thickness
Returns PlaneRotationGizmo
-
Properties
_root
The root mesh of the gizmo
angleSearch playground for angle
Accumulated relative angle value for rotation on the axis. Reset to 0 when a dragStart occurs
drag
Drag behavior responsible for the gizmos dragging interactions
gizmo
The utility layer the gizmo will be added to
on
Event that fires each time the gizmo snaps to a new location.
- snapDistance is the the change in distance
snap
Rotation distance in radians that the gizmo will snap to (Default: 0)
update
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
update
When set, the gizmo will always appear the same size no matter where the camera is (default: true)
Static Max
The maximum angle between the camera and the rotation allowed for interaction If a rotation plane appears 'flat', a lower value allows interaction.
Static Preserve
When enabled, any gizmo operation will perserve scaling sign. Default is off. Only valid for TransformNode derived classes (Mesh, AbstractMesh, ...)
Accessors
attached
-
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 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
custom
-
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
-
If the gizmo is enabled
Returns boolean
-
If the gizmo is enabled
Parameters
-
value: boolean
Returns any
-
is
-
True when the mouse pointer is hovered a gizmo mesh
Returns boolean
scale
-
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
-
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
-
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
-
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
-
Single plane rotation gizmo