Class RenderableNodeAbstract

A node in a scene graph that can be rendered.

Hierarchy (View Summary)

Constructors

constructor

Properties

enabled matrix transparent ui

Accessors

children parent rotation scaling translation

Methods

addChild identity removeChild render rotate rotateX rotateY rotateZ scale targetTo translate traverse

Constructors

constructor

  • new RenderableNode(
        parent?: Node,
        enabled?: boolean,
        transparent?: boolean,
        ui?: boolean,
    ): RenderableNode

    Create a renderable 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.

    • transparent: boolean = false

      Whether or not the node may be not completely opaque.

    • ui: boolean = false

      Whether or not the node belongs to a user interface or a 2D scene.

    Returns RenderableNode

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.

transparent

transparent: boolean

Whether or not this node may be not completely opaque.

ui

ui: boolean

Whether or not this node belongs to a user interface or a 2D scene.

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[]

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

Methods

addChild

identity

  • identity(): void

    Reset this node's transformation relative to its parent.

    Returns void

removeChild

Abstractrender

  • render(worldMatrix: Matrix4Like): void

    Render this node.

    Parameters

    • worldMatrix: Matrix4Like

      The world matrix of this node.

    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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods