SlateGizmo | Babylon.js API documentation

Class SlateGizmo

BABYLON.Gizmo to resize 2D slates

Hierarchy (View Summary)

Gizmo
- SlateGizmo

Constructors

constructor

new SlateGizmo(utilityLayer?: UtilityLayerRenderer): SlateGizmo
Parameters
- OptionalutilityLayer: UtilityLayerRenderer
Returns SlateGizmo
Overrides Gizmo.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:148626

Properties

_rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

fixedScreenSize

fixedScreenSize: boolean

If set, the handles will increase in size based on the distance away from the camera to have a consistent screen size (Default: true)

fixedScreenSizeDistanceFactor

fixedScreenSizeDistanceFactor: number

The distance away from the object which the draggable meshes should appear world sized when fixedScreenSize is set to true (default: 10)

gizmoLayer

gizmoLayer: UtilityLayerRenderer

[Object] The utility layer the gizmo will be added to

`Static`PreserveScaling

PreserveScaling: boolean

When enabled, any gizmo operation will perserve scaling sign. Default is off. Only valid for TransformNode derived classes (Mesh, AbstractMesh, ...)

`Static`UseAbsoluteScaling

UseAbsoluteScaling: boolean

There are 2 ways to preserve scaling: using mesh scaling or absolute scaling. Depending of hierarchy, non uniform scaling and LH or RH coordinates. One is preferable than the other. If the scaling to be preserved is the local scaling, then set this value to false. Default is true which means scaling to be preserved is absolute one (with hierarchy applied)

Accessors

additionalTransformNode

get additionalTransformNode(): undefined | TransformNode
Additional transform applied to the gizmo. It's useful when the gizmo is attached to a bone: if the bone is part of a skeleton attached to a mesh, you should define the mesh as additionalTransformNode if you want the gizmo to be displayed at the bone's correct location. Otherwise, as the gizmo is relative to the skeleton root, the mesh transformation will not be taken into account.

Returns undefined | TransformNode
Inherited from BABYLON.Gizmo.additionalTransformNode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99355
set additionalTransformNode(value: undefined | TransformNode): void
Additional transform applied to the gizmo. It's useful when the gizmo is attached to a bone: if the bone is part of a skeleton attached to a mesh, you should define the mesh as additionalTransformNode if you want the gizmo to be displayed at the bone's correct location. Otherwise, as the gizmo is relative to the skeleton root, the mesh transformation will not be taken into account.
Parameters
- value: undefined | TransformNode
Returns void
Inherited from BABYLON.Gizmo.additionalTransformNode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99356

anchorPoint

get anchorPoint(): GizmoAnchorPoint
Defines where the gizmo will be positioned if updateGizmoPositionToMatchAttachedMesh is enabled. (Default: GizmoAnchorPoint.Origin)

Returns GizmoAnchorPoint
Inherited from BABYLON.Gizmo.anchorPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99378
set anchorPoint(value: GizmoAnchorPoint): void
Defines where the gizmo will be positioned if updateGizmoPositionToMatchAttachedMesh is enabled. (Default: GizmoAnchorPoint.Origin)
Parameters
- value: GizmoAnchorPoint
Returns void
Inherited from BABYLON.Gizmo.anchorPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99377

attachedMesh

get attachedMesh(): 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
Returns Nullable<AbstractMesh>
Inherited from BABYLON.Gizmo.attachedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99337
set attachedMesh(value: Nullable<AbstractMesh>): void
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
Inherited from BABYLON.Gizmo.attachedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99338

attachedNode

get attachedNode(): 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
Returns Nullable<Node>
Inherited from BABYLON.Gizmo.attachedNode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99343
set attachedNode(value: Nullable<Node>): void
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
- value: Nullable<Node>
Returns void
Inherited from BABYLON.Gizmo.attachedNode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99344

attachedSlate

get attachedSlate(): Nullable<HolographicSlate>
Returns Nullable<HolographicSlate>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:148625
set attachedSlate(control: Nullable<HolographicSlate>): void
The slate attached to this gizmo
Parameters
- control: Nullable<HolographicSlate>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:148624

coordinatesMode

get coordinatesMode(): GizmoCoordinatesMode
Set the coordinate mode to use. By default it's local.

Returns GizmoCoordinatesMode
Inherited from BABYLON.Gizmo.coordinatesMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99385
set coordinatesMode(coordinatesMode: GizmoCoordinatesMode): void
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 updateGizmoRotationToMatchAttachedMesh and updateGizmoPositionToMatchAttachedMesh
Parameters
- coordinatesMode: GizmoCoordinatesMode
Returns void
Inherited from BABYLON.Gizmo.coordinatesMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99384

customRotationQuaternion

get customRotationQuaternion(): Nullable<Quaternion>
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

Returns Nullable<Quaternion>
Inherited from BABYLON.Gizmo.customRotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99406
set customRotationQuaternion(
customRotationQuaternion: Nullable<Quaternion>,
): void
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
Inherited from BABYLON.Gizmo.customRotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99407

isHovered

get isHovered(): boolean
True when the mouse pointer is hovered a gizmo mesh

Returns boolean
Inherited from BABYLON.Gizmo.isHovered
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99328

scaleRatio

get scaleRatio(): number
Ratio for the scale of the gizmo

Returns number
Inherited from BABYLON.Gizmo.scaleRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99324
set scaleRatio(value: number): void
Ratio for the scale of the gizmo (Default: 1)
Parameters
- value: number
Returns void
Inherited from BABYLON.Gizmo.scaleRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99323

updateGizmoPositionToMatchAttachedMesh

get updateGizmoPositionToMatchAttachedMesh(): boolean
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)

Returns boolean
Inherited from BABYLON.Gizmo.updateGizmoPositionToMatchAttachedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99372
set updateGizmoPositionToMatchAttachedMesh(value: boolean): void
If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
Parameters
- value: boolean
Returns void
Inherited from BABYLON.Gizmo.updateGizmoPositionToMatchAttachedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99371

updateGizmoRotationToMatchAttachedMesh

get updateGizmoRotationToMatchAttachedMesh(): boolean
If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)

Returns boolean
Inherited from BABYLON.Gizmo.updateGizmoRotationToMatchAttachedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99367
set updateGizmoRotationToMatchAttachedMesh(value: boolean): void
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
Inherited from BABYLON.Gizmo.updateGizmoRotationToMatchAttachedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99366

updateScale

get updateScale(): boolean
When set, the gizmo will always appear the same size no matter where the camera is (default: true)

Returns boolean
Inherited from BABYLON.Gizmo.updateScale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99390
set updateScale(value: boolean): void
When set, the gizmo will always appear the same size no matter where the camera is (default: true)
Parameters
- value: boolean
Returns void
Inherited from BABYLON.Gizmo.updateScale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99389

Methods

dispose

dispose(): void
Disposes of the gizmo

Returns void
Overrides Gizmo.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:148641

setCustomMesh

setCustomMesh(mesh: Mesh): void
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
Inherited from Gizmo.setCustomMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99349

updateBoundingBox

updateBoundingBox(): void
Updates the bounding box information for the gizmo

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:148637

`Static`GizmoAxisPointerObserver

GizmoAxisPointerObserver(
gizmoLayer: UtilityLayerRenderer,
gizmoAxisCache: Map<Mesh, GizmoAxisCache>,
): Observer<PointerInfo>
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
Inherited from Gizmo.GizmoAxisPointerObserver
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99437

Class SlateGizmo

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SlateGizmo

Properties

_rootMesh

fixedScreenSize

fixedScreenSizeDistanceFactor

gizmoLayer

StaticPreserveScaling

StaticUseAbsoluteScaling

Accessors

additionalTransformNode

Returns undefined | TransformNode

Parameters

Returns void

anchorPoint

Returns GizmoAnchorPoint

Parameters

Returns void

attachedMesh

Returns Nullable<AbstractMesh>

Parameters

Returns void

attachedNode

Returns Nullable<Node>

Parameters

Returns void

attachedSlate

Returns Nullable<HolographicSlate>

Parameters

Returns void

coordinatesMode

Returns GizmoCoordinatesMode

Parameters

Returns void

customRotationQuaternion

Returns Nullable<Quaternion>

Parameters

Returns void

isHovered

Returns boolean

scaleRatio

Returns number

Parameters

Returns void

updateGizmoPositionToMatchAttachedMesh

Returns boolean

Parameters

Returns void

updateGizmoRotationToMatchAttachedMesh

Returns boolean

Parameters

Returns void

updateScale

Returns boolean

Parameters

Returns void

Methods

dispose

Returns void

setCustomMesh

Parameters

Returns void

updateBoundingBox

Returns void

StaticGizmoAxisPointerObserver

Parameters

Returns Observer<PointerInfo>

Settings

On This Page

`Static`PreserveScaling

`Static`UseAbsoluteScaling

`Static`GizmoAxisPointerObserver