Interface ReadonlyCamera

A camera that views a scene. Read-only.

interface ReadonlyCamera {
    children: readonly ReadonlyNode[];
    enabled: boolean;
    getWorldViewProjMat: (
        worldMat: Readonly<Matrix4Like>,
    ) => Readonly<Matrix4Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    matrix: Readonly<Matrix4Like>;
    parent: ReadonlyNode | undefined;
    projMat: Readonly<Matrix4Like>;
    rotation: Readonly<QuaternionLike> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    scaling: Readonly<Vector3Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    scene: ReadonlyNode;
    translation: Readonly<Vector3Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    traverse: (
        f:
            | (
                (
                    self: ReadonlyNode,
                    worldMat: Readonly<Matrix4Like> & Readonly<
                        Omit<
                            Float32Array<ArrayBufferLike>,
                            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                        >,
                    > & {
                        buffer: Readonly<
                            Pick<
                                Float32Array["buffer"],
                                "byteLength"
                                | "maxByteLength"
                                | "slice"
                                | typeof Symbol.toStringTag,
                            >,
                        >;
                    },
                ) => boolean
            )
            | (
                (
                    self: ReadonlyNode,
                    worldMat: Readonly<Matrix4Like> & Readonly<
                        Omit<
                            Float32Array<ArrayBufferLike>,
                            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                        >,
                    > & {
                        buffer: Readonly<
                            Pick<
                                Float32Array["buffer"],
                                "byteLength"
                                | "maxByteLength"
                                | "slice"
                                | typeof Symbol.toStringTag,
                            >,
                        >;
                    },
                ) => void
            ),
    ) => void;
    viewMat: Readonly<Matrix4Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    viewProjMat: Readonly<Matrix4Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    worldMat: Readonly<Matrix4Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
    worldTranslation: Readonly<Vector3Like> & Readonly<
        Omit<
            Float32Array<ArrayBufferLike>,
            "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
        >,
    > & {
        buffer: Readonly<
            Pick<
                Float32Array["buffer"],
                "byteLength"
                | "maxByteLength"
                | "slice"
                | typeof Symbol.toStringTag,
            >,
        >;
    };
}

Hierarchy (View Summary)

ReadonlyNode
- ReadonlyCamera

Implemented by

Camera

Index

Properties

children enabled getWorldViewProjMat matrix parent projMat rotation scaling scene translation traverse viewMat viewProjMat worldMat worldTranslation

Properties

`Readonly`children

children: readonly ReadonlyNode[]

The children of this node. Do not modify this value directly (use Node.addChild and Node.removeChild instead).

`Readonly`enabled

enabled: boolean

Whether or not this node is enabled. Disabled nodes and their descendents are not included in traversals.

`Readonly`getWorldViewProjMat

getWorldViewProjMat: (
    worldMat: Readonly<Matrix4Like>,
) => Readonly<Matrix4Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

Get the world view projection matrix created by multiplying this camera's view projection matrix by the given world matrix. This can be used to render a node as it would appear from the perspective of this camera.

Type Declaration

- (
      worldMat: Readonly<Matrix4Like>,
  ): Readonly<Matrix4Like> & Readonly<
      Omit<
          Float32Array<ArrayBufferLike>,
          "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
      >,
  > & {
      buffer: Readonly<
          Pick<
              Float32Array["buffer"],
              "byteLength"
              | "maxByteLength"
              | "slice"
              | typeof Symbol.toStringTag,
          >,
      >;
  }
- Parameters
  - worldMat: Readonly<Matrix4Like>
    The world matrix.
  Returns Readonly<Matrix4Like> & Readonly<
      Omit<
          Float32Array<ArrayBufferLike>,
          "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
      >,
  > & {
      buffer: Readonly<
          Pick<
              Float32Array["buffer"],
              "byteLength"
              | "maxByteLength"
              | "slice"
              | typeof Symbol.toStringTag,
          >,
      >;
  }
  The world view projection matrix.
  - Readonlybuffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >
    The ArrayBuffer instance referenced by the array.

`Readonly`matrix

matrix: Readonly<Matrix4Like>

The transformation matrix of this node relative to its parent.

`Readonly`parent

parent: ReadonlyNode | undefined

The parent of this node.

`Readonly`projMat

projMat: Readonly<Matrix4Like>

The projection matrix of this camera.

`Readonly`rotation

rotation: Readonly<QuaternionLike> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The rotation of this node relative to its parent.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

`Readonly`scaling

scaling: Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The scaling of this node relative to its parent.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

`Readonly`scene

scene: ReadonlyNode

The root node of this node's scene.

`Readonly`translation

translation: Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The translation of this node relative to its parent.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

`Readonly`traverse

traverse: (
    f:
        | (
            (
                self: ReadonlyNode,
                worldMat: Readonly<Matrix4Like> & Readonly<
                    Omit<
                        Float32Array<ArrayBufferLike>,
                        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                    >,
                > & {
                    buffer: Readonly<
                        Pick<
                            Float32Array["buffer"],
                            "byteLength"
                            | "maxByteLength"
                            | "slice"
                            | typeof Symbol.toStringTag,
                        >,
                    >;
                },
            ) => boolean
        )
        | (
            (
                self: ReadonlyNode,
                worldMat: Readonly<Matrix4Like> & Readonly<
                    Omit<
                        Float32Array<ArrayBufferLike>,
                        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                    >,
                > & {
                    buffer: Readonly<
                        Pick<
                            Float32Array["buffer"],
                            "byteLength"
                            | "maxByteLength"
                            | "slice"
                            | typeof Symbol.toStringTag,
                        >,
                    >;
                },
            ) => void
        ),
) => void

Perform a function on this node and each of its children recursively.

Type Declaration

- (
      f:
          | (
              (
                  self: ReadonlyNode,
                  worldMat: Readonly<Matrix4Like> & Readonly<
                      Omit<
                          Float32Array<ArrayBufferLike>,
                          "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                      >,
                  > & {
                      buffer: Readonly<
                          Pick<
                              Float32Array["buffer"],
                              "byteLength"
                              | "maxByteLength"
                              | "slice"
                              | typeof Symbol.toStringTag,
                          >,
                      >;
                  },
              ) => boolean
          )
          | (
              (
                  self: ReadonlyNode,
                  worldMat: Readonly<Matrix4Like> & Readonly<
                      Omit<
                          Float32Array<ArrayBufferLike>,
                          "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                      >,
                  > & {
                      buffer: Readonly<
                          Pick<
                              Float32Array["buffer"],
                              "byteLength"
                              | "maxByteLength"
                              | "slice"
                              | typeof Symbol.toStringTag,
                          >,
                      >;
                  },
              ) => void
          ),
  ): void
- Parameters
  - f:
        | (
            (
                self: ReadonlyNode,
                worldMat: Readonly<Matrix4Like> & Readonly<
                    Omit<
                        Float32Array<ArrayBufferLike>,
                        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                    >,
                > & {
                    buffer: Readonly<
                        Pick<
                            Float32Array["buffer"],
                            "byteLength"
                            | "maxByteLength"
                            | "slice"
                            | typeof Symbol.toStringTag,
                        >,
                    >;
                },
            ) => boolean
        )
        | (
            (
                self: ReadonlyNode,
                worldMat: Readonly<Matrix4Like> & Readonly<
                    Omit<
                        Float32Array<ArrayBufferLike>,
                        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
                    >,
                > & {
                    buffer: Readonly<
                        Pick<
                            Float32Array["buffer"],
                            "byteLength"
                            | "maxByteLength"
                            | "slice"
                            | typeof Symbol.toStringTag,
                        >,
                    >;
                },
            ) => void
        )
    The function to perform for each node. Receives as an argument the node and the node's world matrix. If this function returns true, the node's children are not included in the traversal.
  Returns void

`Readonly`viewMat

viewMat: Readonly<Matrix4Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The view matrix of this camera, which represents the transformation that would move a scene into view of this camera. This is the inverse of this camera's world matrix.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

`Readonly`viewProjMat

viewProjMat: Readonly<Matrix4Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The view projection matrix of this camera, which represents the transformation that would move a scene into view of this camera and apply a projection to it. This is the product of this camera's view matrix and projection matrix.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

`Readonly`worldMat

worldMat: Readonly<Matrix4Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The world matrix of this node, which represents its transformation relative to the origin.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

`Readonly`worldTranslation

worldTranslation: Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}

The translation of this node relative to the origin.

Type Declaration

Readonlybuffer: Readonly<
    Pick<
        Float32Array["buffer"],
        "byteLength"
        | "maxByteLength"
        | "slice"
        | typeof Symbol.toStringTag,
    >,
>
The ArrayBuffer instance referenced by the array.

Interface ReadonlyCamera

Hierarchy (View Summary)

Implemented by

Index

Properties

Properties

Readonlychildren

Readonlyenabled

ReadonlygetWorldViewProjMat

Type Declaration

Parameters

Returns Readonly<Matrix4Like> & Readonly< Omit< Float32Array<ArrayBufferLike>, "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort", >,> & { buffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >, >;}

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Readonlymatrix

Readonlyparent

ReadonlyprojMat

Readonlyrotation

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Readonlyscaling

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Readonlyscene

Readonlytranslation

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Readonlytraverse

Type Declaration

Parameters

Returns void

ReadonlyviewMat

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

ReadonlyviewProjMat

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

ReadonlyworldMat

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

ReadonlyworldTranslation

Type Declaration

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Settings

On This Page

`Readonly`children

`Readonly`enabled

`Readonly`getWorldViewProjMat

Returns Readonly<Matrix4Like> & Readonly<
Omit<
Float32Array<ArrayBufferLike>,
"buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
>,
> & {
buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>;
}

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`matrix

`Readonly`parent

`Readonly`projMat

`Readonly`rotation

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`scaling

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`scene

`Readonly`translation

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`traverse

`Readonly`viewMat

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`viewProjMat

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`worldMat

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Readonly`worldTranslation

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>