@lakuna/uscene
    Preparing search index...

    Interface ReadonlyRenderableNode

    A node in a scene graph that can be rendered. Read-only.

    interface ReadonlyRenderableNode {
        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,
                >,
            >;
        };
        transparent: boolean;
        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;
        ui: boolean;
        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)

    Implemented by

    Index

    Properties

    children enabled matrix parent rotation scaling scene translation transparent traverse ui worldMat worldTranslation

    Properties

    children: readonly ReadonlyNode[]

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

    enabled: boolean

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

    matrix: Readonly<Matrix4Like>

    The transformation matrix of this node relative to its parent.

    parent: ReadonlyNode | undefined

    The parent of this node.

    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.

    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.

    scene: ReadonlyNode

    The root node of this node's scene.

    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.

    transparent: boolean

    Whether or not this node may be not completely opaque.

    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

    ui: boolean

    Whether or not this node belongs to a user interface or a 2D scene.

    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.

    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.

    Settings

    Member Visibility

    On This Page

    Properties