Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AxesViewer

The Axes viewer will show 3 axes in a specific point in space

see

https://doc.babylonjs.com/toolsAndResources/utilities/World_Axes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates a new AxesViewer

    Parameters

    • Optional scene: Scene

      defines the hosting scene

    • Optional scaleLines: number

      defines a number used to scale line length (1 by default)

    • Optional renderingGroupId: Nullable<number>

      defines a number used to set the renderingGroupId of the meshes (2 by default)

    • Optional xAxis: TransformNode

      defines the node hierarchy used to render the x-axis

    • Optional yAxis: TransformNode

      defines the node hierarchy used to render the y-axis

    • Optional zAxis: TransformNode

      defines the node hierarchy used to render the z-axis

    • Optional lineThickness: number

      The line thickness to use when creating the arrow. defaults to 1.

    Returns AxesViewer

Properties

scaleLinesSearch playground for scaleLines

scaleLines: number

Gets or sets a number used to scale line length

sceneSearch playground for scene

scene: Nullable<Scene>

Gets the hosting scene

Accessors

xAxis

  • Gets the node hierarchy used to render x-axis

    Returns TransformNode

yAxis

  • Gets the node hierarchy used to render y-axis

    Returns TransformNode

zAxis

  • Gets the node hierarchy used to render z-axis

    Returns TransformNode

Methods

createInstanceSearch playground for createInstance

  • Creates an instance of this axes viewer.

    Returns AxesViewer

    a new axes viewer with instanced meshes

disposeSearch playground for dispose

  • dispose(): void
  • Releases resources

    Returns void

updateSearch playground for update

  • Force the viewer to update

    Parameters

    • position: Vector3

      defines the position of the viewer

    • xaxis: Vector3

      defines the x axis of the viewer

    • yaxis: Vector3

      defines the y axis of the viewer

    • zaxis: Vector3

      defines the z axis of the viewer

    Returns void

Legend

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