CameraGizmo

Gizmo that enables viewing a camera

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

_rootMesh

Find examples in Playground
_rootMesh: Mesh

The root mesh of the gizmo

gizmoLayer

Find examples in Playground

The utility layer the gizmo will be added to

onClickedObservable

Find examples in Playground
onClickedObservable: Observable<Camera>

Event that fires each time the gizmo is clicked

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)

updateScale

Find examples in Playground
updateScale: boolean

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

Accessors

attachedMesh

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

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

camera

Find examples in Playground
  • The camera that the gizmo is attached to

    Returns Nullable<Camera>

  • The camera that the gizmo is attached to

    Parameters

    Returns any

displayFrustum

Find examples in Playground
  • get displayFrustum(): boolean
  • set displayFrustum(value: boolean): any
  • Gets or sets a boolean indicating if frustum lines must be rendered (true by default))

    Returns boolean

  • Gets or sets a boolean indicating if frustum lines must be rendered (true by default))

    Parameters

    • value: boolean

    Returns any

isHovered

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

    Returns boolean

material

Find examples in Playground

scaleRatio

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

Find examples in Playground
  • get updateGizmoRotationToMatchAttachedMesh(): boolean
  • set updateGizmoRotationToMatchAttachedMesh(value: boolean): any

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