Class Instance

An instance of thing in the world to be rendered, with position, rotation, scale etc

Hierarchy (View Summary)

Constructors

constructor

Properties

customProgramName? flipTextureX flipTextureY id material? metadata position quaternion renderable scale uniformOverrides?

Accessors

castShadow children enabled modelMatrix parent physicsBody receiveShadow

Methods

addChild addEventHandler getQuaternion removeAllChildren removeChild render rotate rotateX rotateXDeg rotateY rotateYDeg rotateZ rotateZDeg setPosition setQuaternion updateFromPhysicsBody

Constructors

constructor

Properties

OptionalcustomProgramName

customProgramName?: string

Very advanced feature, set this to plugin a custom shader program Use ProgramCache.compileShader to create a named program

flipTextureX

flipTextureX: boolean = false

Flip all textures on this instance on the X axis

flipTextureY

flipTextureY: boolean = false

Flip all textures on this instance on the Y axis

Readonlyid

id: string

Unique ID for this node

Optionalmaterial

material?: Material

Material override. This will override the renderable's material. This is only useful on simple models that probably consist of one surface

metadata

metadata: Record<string, string | number | boolean>

Metadata is a key/value store for any extra data you want to store on a node

position

position: XYZ

Position of this Node in world space, relative to any parent nodes (if any)

quaternion

quaternion: quat

Rotation quaternion of this Node in world space, relative to any parent nodes (if any)

Readonlyrenderable

renderable: undefined | Renderable

Main renderable thing this instance represents

scale

scale: XYZ

Scale of this Node in world space, relative to any parent nodes (if any)

OptionaluniformOverrides

uniformOverrides?: UniformSet

Inject additional uniforms to the shader for this instance. Prefix with u_mat. e.g. u_mat.diffuse to change material properties for a single instance. Warning an advanced feature!

Accessors

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

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

Methods

addChild

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

removeAllChildren

removeChild

render

  • render(
        gl: WebGL2RenderingContext,
        uniforms: UniformSet,
        programOverride?: ProgramInfo,
    ): void

  • Render this instance in the world, called internally by the context when rendering

    Parameters

    • gl: WebGL2RenderingContext

      WebGL context to render into

    • uniforms: UniformSet

      Map of uniforms to pass to shader

    • OptionalprogramOverride: ProgramInfo

    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

setPosition

  • setPosition(x: number | XYZ, y?: number, z?: number): void

  • Parameters

    • x: number | XYZ
    • Optionaly: number
    • Optionalz: 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

    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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods