Class BoundingBoxGizmo
Hierarchy
- Gizmo
- BoundingBoxGizmo
Implements
Index
Constructors
Properties
- _root
Mesh - fixed
Drag Mesh Bounds Size - fixed
Drag Mesh Screen Size - fixed
Drag Mesh Screen Size Distance Factor - gizmo
Layer - ignore
Children - include
Child Predicate - on
Drag Start Observable - on
Rotation Sphere Drag End Observable - on
Rotation Sphere Drag Observable - on
Scale Box Drag End Observable - on
Scale Box Drag Observable - rotation
Snap Distance - rotation
Sphere Size - scale
Box Size - scale
Pivot - scaling
Snap Distance - Preserve
Scaling
Accessors
Methods
Constructors
constructor
Creates an BoundingBoxGizmo
Parameters
Optional color: Color3
The color of the gizmo
Optional gizmoLayer: UtilityLayerRenderer
The utility layer the gizmo will be added to
Returns BoundingBoxGizmo
Properties
_root
The root mesh of the gizmo
fixed
If set, the rotation spheres and scale boxes will increase in size based on the size of the bounding box Note : fixedDragMeshScreenSize takes precedence over fixedDragMeshBoundsSize if both are true
fixed
If set, the rotation spheres and scale boxes will increase in size based on the distance away from the camera to have a consistent screen size (Default: false) Note : fixedDragMeshScreenSize takes precedence over fixedDragMeshBoundsSize if both are true
fixed
The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
gizmo
The utility layer the gizmo will be added to
ignore
If child meshes should be ignored when calculating the bounding box. This should be set to true to avoid perf hits with heavily nested meshes (Default: false)
include
Returns true if a descendant should be included when computing the bounding box. When null, all descendants are included. If ignoreChildren is set this will be ignored. (Default: null)
on
Fired when a rotation sphere or scale box is dragged
on
Fired when a rotation sphere drag is ended
on
Fired when a rotation sphere is dragged
on
Fired when a scale box drag is ended
on
Fired when a scale box is dragged
rotation
Drag distance in babylon units that the gizmo will snap rotation to when dragged
rotation
The size of the rotation spheres attached to the bounding box (Default: 0.1)
scale
The size of the scale boxes attached to the bounding box (Default: 0.1)
scale
Relative bounding box pivot used when scaling the attached node. When null object with scale from the opposite corner. 0.5,0.5,0.5 for center and 0.5,0,0.5 for bottom (Default: null)
scaling
Drag distance in babylon units that the gizmo will snap scaling to when dragged
Static Preserve
When enabled, any gizmo operation will perserve scaling sign. Default is off. Only valid for TransformNode derived classes (Mesh, AbstractMesh, ...)
Accessors
anchor
Defines where the gizmo will be positioned if
updateGizmoPositionToMatchAttachedMeshis enabled. (Default: GizmoAnchorPoint.Origin)Returns GizmoAnchorPoint
Defines where the gizmo will be positioned if
updateGizmoPositionToMatchAttachedMeshis enabled. (Default: GizmoAnchorPoint.Origin)Parameters
value: GizmoAnchorPoint
Returns void
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 void
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 void
axis
colored
Default material used to render when gizmo is not disabled or hovered
Returns StandardMaterial
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
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 void
hover
Material used to render when gizmo is hovered with mouse
Returns StandardMaterial
is
True when the mouse pointer is hovered a gizmo mesh
Returns boolean
pointer
Get the pointerDragBehavior
Returns PointerDragBehavior
scale
Gets scale drag speed
Returns number
the scale speed number
Sets scale drag speed value
Parameters
value: number
the new speed value
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
update
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
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
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
enable
Enables a pointer drag behavior on the bounding box of the gizmo
Returns void
get
returns an array containing all boxes used for scaling (in increasing x, y and z orders)
Returns AbstractMesh[]
set
Sets the color of the bounding box gizmo
Parameters
color: Color3
the color to set
Returns void
set
CustomMeshes are not supported by this gizmo
Returns void
set
Enables rotation on the specified axis and disables rotation on the others
Parameters
axis: string
The list of axis that should be enabled (eg. "xy" or "xyz")
Returns void
set
Enables/disables scaling
Parameters
enable: boolean
if scaling should be enabled
Optional homogeneousScaling: boolean
defines if scaling should only be homogeneous
Returns void
update
Updates the bounding box information for 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
Static Make
Makes a mesh not pickable and wraps the mesh inside of a bounding box mesh that is pickable. (This is useful to avoid picking within complex geometry)
Parameters
mesh: Mesh
the mesh to wrap in the bounding box mesh and make not pickable
Returns Mesh
the bounding box mesh with the passed in mesh as a child
Bounding box gizmo