Gizmo

Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground
  • Creates a gizmo

    Parameters

    Returns Gizmo

Properties

attachedMesh

Find examples in Playground
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

gizmoLayer

Find examples in Playground

The utility layer the gizmo will be added to

scaleRatio

Find examples in Playground
scaleRatio: number

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

updateGizmoPositionToMatchAttachedMesh

Find examples in Playground
updateGizmoPositionToMatchAttachedMesh: boolean

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

updateGizmoRotationToMatchAttachedMesh

Find examples in Playground
updateGizmoRotationToMatchAttachedMesh: boolean

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

Methods

dispose

Find examples in Playground
  • dispose(): void

setCustomMesh

Find examples in Playground
  • 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