Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

CoordinateSystemAPI

• webVis API Reference
• CoordinateSystemAPI

Interface CoordinateSystemAPI

interface CoordinateSystemAPI {
    getCoordinateSystemForwardVector(): | Float32Array<ArrayBufferLike>
    | [number, number, number];
    getCoordinateSystemMatrix(): | Float32Array<ArrayBufferLike>
    | [
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
    ];
    getCoordinateSystemRightVector(): | Float32Array<ArrayBufferLike>
    | [number, number, number];
    getCoordinateSystemUpVector(): | Float32Array<ArrayBufferLike>
    | [number, number, number];
}

Hierarchy (View Summary)

• CoordinateSystemAPI
  • ContextAPI

Index

Methods

getCoordinateSystemForwardVector getCoordinateSystemMatrix getCoordinateSystemRightVector getCoordinateSystemUpVector

Methods

getCoordinateSystemForwardVector

• getCoordinateSystemForwardVector(): | Float32Array<ArrayBufferLike>
  | [number, number, number]

• Returns the forward vector of the current coordinate system.

  Returns Float32Array<ArrayBufferLike> | [number, number, number]

  The forward vector of the current coordinate system.

getCoordinateSystemMatrix

• getCoordinateSystemMatrix(): | Float32Array<ArrayBufferLike>
  | [
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
  ]

• Returns a 4x4 rotation matrix which is used to transform the internal default right-handed coordinate system with X and Y as front plane axis to the configured one.

  Returns
      | Float32Array<ArrayBufferLike>
      | [
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
      ]

  The CoordinateSystem Matrix

getCoordinateSystemRightVector

• getCoordinateSystemRightVector(): | Float32Array<ArrayBufferLike>
  | [number, number, number]

• Returns the right vector of the current coordinate system.

  Returns Float32Array<ArrayBufferLike> | [number, number, number]

  The right vector of the current coordinate system.

getCoordinateSystemUpVector

• getCoordinateSystemUpVector(): | Float32Array<ArrayBufferLike>
  | [number, number, number]

• Returns the up vector of the current coordinate system.

  Returns Float32Array<ArrayBufferLike> | [number, number, number]

  The up vector of the current coordinate system.