Class Node

constructor

• new Node(enabled?: boolean): Node

  Create a node in a scene graph.

  Parameters

  • enabled: boolean = true

    Whether or not the node should be enabled.

  Returns Node

enabled

matrix

children

• get children(): readonly ReadonlyNode[]

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

  Returns readonly ReadonlyNode[]

parent

• get parent(): Node | undefined

  The parent of this node. Set this value by calling Node.addChild on the parent.

  Returns Node | undefined

rotation

• get 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.

  Returns Readonly<QuaternionLike> & 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,
        >,
    >

    The ArrayBuffer instance referenced by the array.

• set rotation(value: Readonly<QuaternionLike>): void

  The rotation of this node relative to its parent.

  Parameters

  • value: Readonly<QuaternionLike>

  Returns void

scaling

• get 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.

  Returns Readonly<Vector3Like> & 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,
        >,
    >

    The ArrayBuffer instance referenced by the array.

• set scaling(value: Readonly<Vector3Like>): void

  The scaling of this node relative to its parent.

  Parameters

  • value: Readonly<Vector3Like>

  Returns void

scene

• get scene(): Node

  The root node of this node's scene.

  Returns Node

translation

• get 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.

  Returns Readonly<Vector3Like> & 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,
        >,
    >

    The ArrayBuffer instance referenced by the array.

• set translation(value: Readonly<Vector3Like>): void

  The translation of this node relative to its parent.

  Parameters

  • value: Readonly<Vector3Like>

  Returns void

worldMat

• get 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.

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

    The ArrayBuffer instance referenced by the array.

worldTranslation

• get 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.

  Returns Readonly<Vector3Like> & 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,
        >,
    >

    The ArrayBuffer instance referenced by the array.

addChild

• addChild(node: Node): void

  Add a child to this node.

  Parameters

  • node: Node

    The child. The child's parent will be updated to point to this node. If the child already had a parent, it will be removed from that parent's children.

  Returns void

identity

• identity(): void

  Reset this node's transformation relative to its parent.

  Returns void

removeChild

• removeChild(node: Node): void

  Remove a child from this node.

  Parameters

  • node: Node

    The child. The child's parent will be updated to point to nothing.

  Returns void

rotate

• rotate(r: number, axis: Readonly<Vector3Like>): void

  Rotate this node relative to its parent.

  Parameters

  • r: number

    The number of radians to rotate by.

  • axis: Readonly<Vector3Like>

    The axis to rotate around.

  Returns void

rotateX

• rotateX(r: number): void

  Rotate this node around the X-axis relative to its parent.

  Parameters

  • r: number

    The number of radians to rotate by.

  Returns void

rotateY

• rotateY(r: number): void

  Rotate this node around the Y-axis relative to its parent.

  Parameters

  • r: number

    The number of radians to rotate by.

  Returns void

rotateZ

• rotateZ(r: number): void

  Rotate this node around the Z-axis relative to its parent.

  Parameters

  • r: number

    The number of radians to rotate by.

  Returns void

scale

• scale(s: Readonly<Vector3Like>): void

  Scale this node relative to its parent.

  Parameters

  • s: Readonly<Vector3Like>

    The scaling factor.

  Returns void

targetTo

• targetTo(
      eye: Readonly<Vector3Like>,
      target: Readonly<Vector3Like>,
      up?: Readonly<Vector3Like>,
  ): void

  Position this node such that it is pointing at a target position.

  Parameters

  • eye: Readonly<Vector3Like>

    The new position of this node.

  • target: Readonly<Vector3Like>

    The position for this node to point at.

  • up: Readonly<Vector3Like> = ...

    The up vector.

  Returns void

translate

• translate(t: Readonly<Vector3Like>): void

  Translate this node relative to its parent.

  Parameters

  • t: Readonly<Vector3Like>

    The translation vector.

  Returns void

traverse

• traverse(
      f:
          | (
              (
                  self: Node,
                  worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
              ) => boolean
          )
          | (
              (
                  self: Node,
                  worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
              ) => void
          ),
  ): void

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

  Parameters

  • f:
        | (
            (
                self: Node,
                worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
            ) => boolean
        )
        | (
            (
                self: Node,
                worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
            ) => void
        )

    The function to perform for each node. Receives as an argument the node and the node's transformation matrix relative to the node on which the traversal started. If this function returns false, the node's children are not included in the traversal.

  Returns void