Class Node

A node in a scene graph.

Hierarchy (View Summary)

Node
- RenderableNode

Index

Constructors

Properties

Accessors

children parent rotation scaling translation

Methods

addChild identity removeChild rotate rotateX rotateY rotateZ scale targetTo translate traverse

Constructors

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
- Defined in Node.ts:35

Properties

enabled

enabled: boolean

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

matrix

matrix: Matrix4Like

The transformation matrix of this node relative to its parent.

Accessors

children

get children(): readonly Node[]
The children of this node. Do not modify this value directly (use addChild and removeChild instead).

Returns readonly Node[]
- Defined in Node.ts:180

parent

get parent(): undefined | Node
The parent of this node.

Returns undefined | Node
- Defined in Node.ts:160
set parent(value: undefined | Node): void
Parameters
- value: undefined | Node
Returns void
- Defined in Node.ts:164

rotation

get rotation(): Float32Array<ArrayBufferLike> & QuaternionLike
The rotation of this node relative to its parent.

Returns Float32Array<ArrayBufferLike> & QuaternionLike
- Defined in Node.ts:58
set rotation(value: QuaternionLike): void
Parameters
- value: QuaternionLike
Returns void
- Defined in Node.ts:62

scaling

get scaling(): Float32Array<ArrayBufferLike> & Vector3Like
The scaling of this node relative to its parent.

Returns Float32Array<ArrayBufferLike> & Vector3Like
- Defined in Node.ts:72
set scaling(value: Vector3Like): void
Parameters
- value: Vector3Like
Returns void
- Defined in Node.ts:76

translation

get translation(): Readonly<Float32Array & Vector3Like>
The translation of this node relative to its parent.

Returns Readonly<Float32Array & Vector3Like>
- Defined in Node.ts:49
set translation(value: Vector3Like): void
Parameters
- value: Vector3Like
Returns void
- Defined in Node.ts:53

Methods

addChild

addChild(node: Node): void
Add a child to this node.
Parameters
- node: Node
  The child.
Returns void
- Defined in Node.ts:188

identity

identity(): void
Reset this node's transformation relative to its parent.

Returns void
- Defined in Node.ts:86

removeChild

removeChild(node: Node): void
Remove a child from this node.
Parameters
- node: Node
  The child.
Returns void
- Defined in Node.ts:201

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
- Defined in Node.ts:95

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
- Defined in Node.ts:103

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
- Defined in Node.ts:111

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
- Defined in Node.ts:119

scale

scale(s: Vector3Like): void
Scale this node relative to its parent.
Parameters
- s: Vector3Like
  The scaling factor.
Returns void
- Defined in Node.ts:127

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
- Defined in Node.ts:145

translate

translate(t: Vector3Like): void
Translate this node relative to its parent.
Parameters
- t: Vector3Like
  The translation vector.
Returns void
- Defined in Node.ts:135

traverse

traverse(
    f:
        | ((self: Node, worldMatrix: Matrix4Like) => boolean)
        | ((self: Node, worldMatrix: Matrix4Like) => void),
): void
Perform 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
- Defined in Node.ts:215