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)

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]

    Retuns

    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.

Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: