Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for axis drag 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))

dragBehavior: PointerDragBehavior

Drag behavior responsible for the gizmos dragging interactions

The utility layer the gizmo will be added to

isEnabled: boolean

If the gizmo is enabled

isHovered: boolean

True when the mouse pointer is hovered a gizmo mesh

onSnapObservable: Observable<{ snapDistance: number }>

Event that fires each time the gizmo snaps to a new location.

  • snapDistance is the the change in distance
scaleRatio: number

Ratio for the scale of the gizmo

snapDistance: number

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

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)

Methods

  • 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