Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for scale gizmo

Hierarchy

Implemented by

Index

Properties

_rootMesh: Mesh

The root mesh of the gizmo

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
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
customRotationQuaternion: Nullable<Quaternion>

posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

The utility layer the gizmo will be added to

isHovered: boolean

True when the mouse pointer is hovered a gizmo mesh

onDragEndObservable: Observable<unknown>

Fires an event when any of it's sub gizmos are released from dragging

onDragStartObservable: Observable<unknown>

Fires an event when any of it's sub gizmos are dragged

scaleRatio: number

Ratio for the scale of the gizmo

sensitivity: number

Sensitivity factor for dragging

snapDistance: number

Drag distance in babylon units that the gizmo will snap to when dragged

uniformScaleGizmo: IAxisScaleGizmo

Internal gizmo used to scale all axis equally

updateGizmoPositionToMatchAttachedMesh: boolean

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

updateGizmoRotationToMatchAttachedMesh: boolean

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

updateScale: boolean

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

Internal gizmo used for interactions on the x axis

Internal gizmo used for interactions on the y axis

Internal gizmo used for interactions on the z axis

Methods

  • Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation

    Parameters

    • mesh: Mesh

      Axis gizmo mesh

    • cache: GizmoAxisCache

      Gizmo axis definition used for reactive gizmo UI

    Returns void

  • dispose(): void
  • Releases all held resources

    Returns void

  • setCustomMesh(mesh: Mesh): void
  • Disposes and replaces the current meshes in the gizmo with the specified mesh

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme