Interface IBoundingBoxGizmo
Hierarchy
- IGizmo
- IBoundingBoxGizmo
Implemented by
Index
Properties
- _root
Mesh - anchor
Point - attached
Mesh - attached
Node - axis
Factor - colored
Material - coordinates
Mode - custom
Rotation Quaternion - fixed
Drag Mesh Bounds Size - fixed
Drag Mesh Screen Size - fixed
Drag Mesh Screen Size Distance Factor - gizmo
Layer - hover
Material - ignore
Children - include
Child Predicate - is
Hovered - 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
Drag Speed - scale
Pivot - scale
Ratio - scaling
Snap Distance - update
Gizmo Position To Match Attached Mesh - update
Gizmo Rotation To Match Attached Mesh - update
Scale
Methods
Properties
_root
The root mesh of the gizmo
anchor
Defines where the gizmo will be positioned if updateGizmoPositionToMatchAttachedMesh is enabled.
(Default: GizmoAnchorPoint.Origin)
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
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
axis
Scale factor vector used for masking some axis
colored
Default material used to render when gizmo is not disabled or hovered
coordinates
Set the coordinate mode to use. By default it's local.
custom
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))
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 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
gizmo
The utility layer the gizmo will be added to
hover
Material used to render when gizmo is hovered with mouse
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.
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.
Readonly is
True when the mouse pointer is hovered a gizmo mesh
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
scale
The size of the scale boxes attached to the bounding box
scale
Scale factor scalar affecting all axes' drag speed
scale
Relative bounding box pivot used when scaling the attached node.
scale
Ratio for the scale of the gizmo
scaling
Drag distance in babylon units that the gizmo will snap scaling to when dragged
update
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
update
If set the gizmo's rotation 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)
Methods
disposeSearch playground for dispose
Releases all held resources
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
Disposes and replaces the current meshes in the gizmo with the specified mesh
Parameters
mesh: Mesh
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
Interface for bounding box gizmo