Class AxesViewer

constructor

• new AxesViewer(
      scene?: Scene,
      scaleLines?: number,
      renderingGroupId?: Nullable<number>,
      xAxis?: TransformNode,
      yAxis?: TransformNode,
      zAxis?: TransformNode,
      lineThickness?: number,
  ): AxesViewer

  Creates a new AxesViewer

  Parameters

  • Optionalscene: Scene

    defines the hosting scene

  • scaleLines: number = 1

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

  • renderingGroupId: Nullable<number> = 2

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

  • OptionalxAxis: TransformNode

    defines the node hierarchy used to render the x-axis

  • OptionalyAxis: TransformNode

    defines the node hierarchy used to render the y-axis

  • OptionalzAxis: TransformNode

    defines the node hierarchy used to render the z-axis

  • lineThickness: number = 1

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

  Returns AxesViewer

scene

scaleLines

• get scaleLines(): number

  Gets or sets a number used to scale line length

  Returns number

• set scaleLines(value: number): void

  Parameters

  • value: number

  Returns void

xAxis

• get xAxis(): TransformNode

  Gets the node hierarchy used to render x-axis

  Returns TransformNode

yAxis

• get yAxis(): TransformNode

  Gets the node hierarchy used to render y-axis

  Returns TransformNode

zAxis

• get zAxis(): TransformNode

  Gets the node hierarchy used to render z-axis

  Returns TransformNode

createInstance

• createInstance(): AxesViewer

  Creates an instance of this axes viewer.

  Returns AxesViewer

  a new axes viewer with instanced meshes

dispose

• dispose(): void

  Releases resources

  Returns void

update

• update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void

  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