Class Node

constructor

• new Node(): Node

• Create a default node, at origin with scale of [1,1,1] and no rotation

  Returns Node

Readonlyid

metadata

position

quaternion

scale

castShadow

• get castShadow(): boolean

• Does this Node cast shadows, default true

  Returns boolean
• set castShadow(value: boolean): void

• Set will this Node cast shadows, this will also set all child nodes

  Parameters

  • value: boolean

  Returns void

children

• get children(): Node[]

• Fetch all child Nodes of this Node

  Returns Node[]

enabled

• get enabled(): boolean

• Is this Node enabled. Disabled nodes will not be rendered

  Returns boolean
• set enabled(enabled: boolean): void

• Set enabled state of this Node, this will also set all child nodes

  Parameters

  • enabled: boolean

  Returns void

modelMatrix

• get modelMatrix(): mat4

• Return the world or model matrix for this node, this is the matrix that places this node in the world. This will be in relation to the parent node, if there is one.

  Returns mat4

parent

• get parent(): undefined | Node

• Get current parent of this Node

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

• Sets the parent this Node, to the provided Node

  Parameters

  • node: undefined | Node

  Returns void

physicsBody

• get physicsBody(): undefined | Body

• Get the physics body for this Node, if there is one

  Returns undefined | Body
• set physicsBody(body: undefined | Body): void

• Set the physics body for this Node

  Parameters

  • body: undefined | Body

  Returns void

receiveShadow

• get receiveShadow(): boolean

• Does this Node receive shadows, default true

  Returns boolean
• set receiveShadow(value: boolean): void

• Set will this Node receive shadows, this will also set all child nodes

  Parameters

  • value: boolean

  Returns void

addChild

• addChild(node: Node): void

• Convenience method to make another Node a child of this one

  Parameters

  • node: Node

  Returns void

addEventHandler

• addEventHandler(event: string, handler: (event: NodeEvent) => void): void

• Add an event handler to listen for node changes

  Parameters

  • event: string

    NodeEvent type, one of 'position', 'rotation', 'scale'
  • handler: (event: NodeEvent) => void

    Function to call when event is triggered

  Returns void

getQuaternion

• getQuaternion(): XYZW

• Get the rotation quaternion as a XYZW 4-tuple

  Returns XYZW

removeAllChildren

• removeAllChildren(): void

• Convenience method to remove all child Nodes

  Returns void

removeChild

• removeChild(node: Node): void

• Convenience method to remove a child Node

  Parameters

  • node: Node

  Returns void

rotate

• rotate(ax: number, ay: number, az: number): void

• Rotate this instance around the X, Y and Z axis in radians

  Parameters

  • ax: number
  • ay: number
  • az: number

  Returns void

rotateX

• rotateX(angle: number): void

• Rotate this instance around the X axis

  Parameters

  • angle: number

  Returns void

rotateXDeg

• rotateXDeg(angle: number): void

• Rotate this instance around the Z axis by a given angle in degrees

  Parameters

  • angle: number

  Returns void

rotateY

• rotateY(angle: number): void

• Rotate this instance around the Y axis

  Parameters

  • angle: number

  Returns void

rotateYDeg

• rotateYDeg(angle: number): void

• Rotate this instance around the Y axis by a given angle in degrees

  Parameters

  • angle: number

  Returns void

rotateZ

• rotateZ(angle: number): void

• Rotate this instance around the Z axis, in radians

  Parameters

  • angle: number

  Returns void

rotateZDeg

• rotateZDeg(angle: number): void

• Rotate this instance around the X axis by a given angle in degrees

  Parameters

  • angle: number

  Returns void

setQuaternion

• setQuaternion(quatArray: XYZW): void

• Set the rotation quaternion directly, normally users should use the rotate methods. This method is for advanced uses, like integration with an external physics system

  Parameters

  • quatArray: XYZW

  Returns void

updateFromPhysicsBody

• updateFromPhysicsBody(): void

• Updates the position & rotation of this node to match it's linked physics Body This is called automatically by the engine, but can be called manually if needed

  Returns void