PlaneRotationGizmo

Single plane rotation gizmo

Hierarchy

  • Gizmo
    • PlaneRotationGizmo

Implements

Index

Constructors

constructor

Properties

attachedMesh

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

dragBehavior

dragBehavior: PointerDragBehavior

Drag behavior responsible for the gizmos dragging interactions

gizmoLayer

The utility layer the gizmo will be added to

onSnapObservable

onSnapObservable: Observable<object>

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

  • snapDistance is the the change in distance

scaleRatio

scaleRatio: number

Ratio for the scale of the gizmo (Default: 1)

snapDistance

snapDistance: number

Rotation distance in radians that the gizmo will snap to (Default: 0)

updateGizmoPositionToMatchAttachedMesh

updateGizmoPositionToMatchAttachedMesh: boolean

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

updateGizmoRotationToMatchAttachedMesh

updateGizmoRotationToMatchAttachedMesh: boolean

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

Methods

dispose

  • dispose(): void

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

Generated using TypeDoc