Class Node

constructor

• new Node(parent?: Node, enabled?: boolean): Node

  Create a node in a scene graph.

  Parameters

  • Optionalparent: Node

    The parent of the node. Should only be undefined for the root of a scene graph.
  • enabled: boolean = true

    Whether or not the node should be enabled.

  Returns Node

enabled

matrix

children

• get children(): readonly Node[]

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

  Returns readonly Node[]

parent

• get parent(): undefined | Node

  The parent of this node.

  Returns undefined | Node
• set parent(value: undefined | Node): void

  The parent of this node.

  Parameters

  • value: undefined | Node

  Returns void

rotation

• get rotation(): Float32Array<ArrayBufferLike> & QuaternionLike

  The rotation of this node relative to its parent.

  Returns Float32Array<ArrayBufferLike> & QuaternionLike
• set rotation(value: QuaternionLike): void

  The rotation of this node relative to its parent.

  Parameters

  • value: QuaternionLike

  Returns void

scaling

• get scaling(): Float32Array<ArrayBufferLike> & Vector3Like

  The scale of this node relative to its parent.

  Returns Float32Array<ArrayBufferLike> & Vector3Like
• set scaling(value: Vector3Like): void

  The scale of this node relative to its parent.

  Parameters

  • value: Vector3Like

  Returns void

translation

• get translation(): Readonly<Float32Array<ArrayBufferLike> & Vector3Like>

  The translation of this node relative to its parent.

  Returns Readonly<Float32Array<ArrayBufferLike> & Vector3Like>
• set translation(value: Vector3Like): void

  The translation of this node relative to its parent.

  Parameters

  • value: Vector3Like

  Returns void

addChild

• addChild(node: Node): void

  Adds a child to this node.

  Parameters

  • node: Node

    The child.

  Returns void

identity

• identity(): void

  Reset this node's transformation relative to its parent.

  Returns void

removeChild

• removeChild(node: Node): void

  Removes a child to this node.

  Parameters

  • node: Node

    The child.

  Returns void

rotate

• rotate(r: number, axis: Vector3Like): void

  Rotate this node relative to its parent.

  Parameters

  • r: number

    The number of radians to rotate by.
  • axis: 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: Vector3Like): void

  Scale this node relative to its parent.

  Parameters

  • s: Vector3Like

    The scaling factor.

  Returns void

targetTo

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

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

  Parameters

  • eye: Vector3Like

    The new position of this node.
  • target: Vector3Like

    The position for this node to point at.
  • up: Vector3Like = ...

    The up vector.

  Returns void

translate

• translate(t: Vector3Like): void

  Translate this node relative to its parent.

  Parameters

  • t: Vector3Like

    The translation vector.

  Returns void

traverse

• traverse(
      f:
          | (self: Node, worldMatrix: Matrix4Like) => boolean
          | (self: Node, worldMatrix: Matrix4Like) => void,
  ): void

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

  Parameters

  • f:
        | (self: Node, worldMatrix: Matrix4Like) => boolean
        | (self: Node, worldMatrix: Matrix4Like) => 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