Interface ReadonlyNode

A node in a scene graph. Read-only.

interface ReadonlyNode {
    children: readonly ReadonlyNode[];
    enabled: boolean;
    matrix: Readonly<Matrix4Like>;
    parent: ReadonlyNode | undefined;
    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;
    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
- ReadonlyRenderableNode

Implemented by

Node

Index

Properties

children enabled matrix parent rotation scaling scene translation traverse 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`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`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`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 ReadonlyNode

Hierarchy (View Summary)

Implemented by

Index

Properties

Properties

`Readonly`children

`Readonly`enabled

`Readonly`matrix

`Readonly`parent

`Readonly`rotation

Type Declaration

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

`Readonly`scaling

Type Declaration

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

`Readonly`scene

`Readonly`translation

Type Declaration

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

`Readonly`traverse

Type Declaration

Parameters

Returns void

`Readonly`worldMat

Type Declaration

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

`Readonly`worldTranslation

Type Declaration

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

Settings

On This Page

Interface ReadonlyNode

Hierarchy (View Summary)

Implemented by

Index

Properties

Properties

Readonlychildren

Readonlyenabled

Readonlymatrix

Readonlyparent

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

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`matrix

`Readonly`parent

`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`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,
>,
>