Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Gizmo

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

Hierarchy

Implements

Index

Constructors

constructor

  • Creates a gizmo

    Parameters

    Returns Gizmo

Properties

_rootMeshSearch playground for _rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

gizmoLayerSearch playground for gizmoLayer

The utility layer the gizmo will be added to

updateGizmoPositionToMatchAttachedMeshSearch playground for updateGizmoPositionToMatchAttachedMesh

updateGizmoPositionToMatchAttachedMesh: boolean

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

updateScaleSearch playground for updateScale

updateScale: boolean

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

Accessors

attachedMesh

  • 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>

  • 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

    Returns any

attachedNode

  • 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>

  • 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

    Returns any

customRotationQuaternion

  • poseture that the gizmo will be display

    • When set null, default value will be used (Quaternion(0, 0, 0, 1))

    Returns Nullable<Quaternion>

  • poseture that the gizmo will be display

    • When set null, default value will be used (Quaternion(0, 0, 0, 1))

    Parameters

    Returns any

isHovered

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

    Returns boolean

scaleRatio

  • get scaleRatio(): number
  • set scaleRatio(value: number): any
  • Ratio for the scale of the gizmo (Default: 1)

    Returns number

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

    Parameters

    • value: number

    Returns any

updateGizmoRotationToMatchAttachedMesh

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

    Returns boolean

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

    Parameters

    • value: boolean

    Returns any

Methods

disposeSearch playground for dispose

  • dispose(): void
  • Disposes of the gizmo

    Returns void

setCustomMeshSearch playground for 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

Static GizmoAxisPointerObserverSearch playground for GizmoAxisPointerObserver

  • Subscribes to pointer up, down, and hover events. Used for responsive gizmos.

    Parameters

    Returns Observer<PointerInfo>

    pointerObserver

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method