Class GizmoManager
Hierarchy
- GizmoManager
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Instantiates a gizmo manager
Parameters
_scene: Scene
the scene to overlay the gizmos on top of
Optional thickness: number
display gizmo axis thickness
Optional utilityLayer: UtilityLayerRenderer
the layer where gizmos are rendered
Optional keepDepthUtilityLayer: UtilityLayerRenderer
the layer where occluded gizmos are rendered
Returns GizmoManager
Properties
attachable
Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
attachable
Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
bounding
When bounding box gizmo is enabled, this can be used to track drag/end events
clear
When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh
enable
When true (default), picking to attach a new mesh is enabled. This works in sync with inspector autopicking.
gizmosSearch playground for gizmos
Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
Type declaration
bounding
Box Gizmo: Nullable<IBoundingBoxGizmo> position
Gizmo: Nullable<IPositionGizmo> rotation
Gizmo: Nullable<IRotationGizmo> scale
Gizmo: Nullable<IScaleGizmo>
on
Fires an event when the manager is attached to a mesh
on
Fires an event when the manager is attached to a node
use
If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
Accessors
bounding
If the boundingBox gizmo is enabled
Returns boolean
If the boundingBox gizmo is enabled
Parameters
value: boolean
Returns void
coordinates
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
updateGizmoRotationToMatchAttachedMeshandupdateGizmoPositionToMatchAttachedMeshReturns 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
updateGizmoRotationToMatchAttachedMeshandupdateGizmoPositionToMatchAttachedMeshParameters
coordinatesMode: GizmoCoordinatesMode
Returns void
is
True when the mouse pointer is hovering a gizmo mesh
Returns boolean
keep
Utility layer that the bounding box gizmo belongs to
Returns UtilityLayerRenderer
position
If the position gizmo is enabled
Returns boolean
If the position gizmo is enabled
Parameters
value: boolean
Returns void
rotation
If the rotation gizmo is enabled
Returns boolean
If the rotation gizmo is enabled
Parameters
value: boolean
Returns void
scale
If the scale gizmo is enabled
Returns boolean
If the scale gizmo is enabled
Parameters
value: boolean
Returns void
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 void
utility
Utility layer that all gizmos besides bounding box belong to
Returns UtilityLayerRenderer
Methods
add
Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
Parameters
gizmoAxisCache: Map<Mesh, GizmoAxisCache>
Gizmo axis definition used for reactive gizmo UI
Returns void
attach
Attaches a set of gizmos to the specified mesh
Parameters
mesh: Nullable<AbstractMesh>
The mesh the gizmo's should be attached to
Returns void
attach
disposeSearch playground for dispose
Disposes of the gizmo manager
Returns void
Helps setup gizmo's in the scene to rotate/scale/position nodes