Class RenderableNode`Abstract`

A node in a scene graph that can be rendered.

Hierarchy (View Summary)

Node
- RenderableNode

Implements

ReadonlyRenderableNode

Index

Constructors

constructor

new RenderableNode(
    enabled?: boolean,
    transparent?: boolean,
    ui?: boolean,
): RenderableNode
Create a renderable node in a scene graph.
Parameters
- enabled: boolean = true
  Whether or not the node should be enabled.
- transparent: boolean = true
  Whether or not the node may be not completely opaque. Setting this to false can improve performance but may make transparent nodes display wrong.
- ui: boolean = false
  Whether or not the node belongs to a user interface or a 2D scene. Setting this to true can improve performance but may make non-user interface nodes display in the wrong order.
Returns RenderableNode
Overrides Node.constructor
- Defined in RenderableNode.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.

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 ReadonlyNode[]
The children of this node. Do not modify this value directly (use Node.addChild and Node.removeChild instead).

Returns readonly ReadonlyNode[]
Implementation of ReadonlyRenderableNode.children
Inherited from Node.children
- Defined in Node.ts:109

parent

get parent(): Node | undefined
The parent of this node. Set this value by calling Node.addChild on the parent.

Returns Node | undefined
Implementation of ReadonlyRenderableNode.parent
Inherited from Node.parent
- Defined in Node.ts:114

rotation

get rotation(): Readonly<QuaternionLike> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
The rotation of this node relative to its parent.

Returns Readonly<QuaternionLike> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
- Readonlybuffer: Readonly<
      Pick<
          Float32Array["buffer"],
          "byteLength"
          | "maxByteLength"
          | "slice"
          | typeof Symbol.toStringTag,
      >,
  >
  The ArrayBuffer instance referenced by the array.
Implementation of ReadonlyRenderableNode.rotation
Inherited from Node.rotation
- Defined in Node.ts:131
set rotation(value: Readonly<QuaternionLike>): void
The rotation of this node relative to its parent.
Parameters
- value: Readonly<QuaternionLike>
Returns void
Implementation of ReadonlyRenderableNode.rotation
Inherited from Node.rotation
- Defined in Node.ts:135

scaling

get scaling(): Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
The scaling of this node relative to its parent.

Returns Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
- Readonlybuffer: Readonly<
      Pick<
          Float32Array["buffer"],
          "byteLength"
          | "maxByteLength"
          | "slice"
          | typeof Symbol.toStringTag,
      >,
  >
  The ArrayBuffer instance referenced by the array.
Implementation of ReadonlyRenderableNode.scaling
Inherited from Node.scaling
- Defined in Node.ts:145
set scaling(value: Readonly<Vector3Like>): void
The scaling of this node relative to its parent.
Parameters
- value: Readonly<Vector3Like>
Returns void
Implementation of ReadonlyRenderableNode.scaling
Inherited from Node.scaling
- Defined in Node.ts:149

scene

get scene(): Node
The root node of this node's scene.

Returns Node
Implementation of ReadonlyRenderableNode.scene
Inherited from Node.scene
- Defined in Node.ts:159

translation

get translation(): Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
The translation of this node relative to its parent.

Returns Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
- Readonlybuffer: Readonly<
      Pick<
          Float32Array["buffer"],
          "byteLength"
          | "maxByteLength"
          | "slice"
          | typeof Symbol.toStringTag,
      >,
  >
  The ArrayBuffer instance referenced by the array.
Implementation of ReadonlyRenderableNode.translation
Inherited from Node.translation
- Defined in Node.ts:164
set translation(value: Readonly<Vector3Like>): void
The translation of this node relative to its parent.
Parameters
- value: Readonly<Vector3Like>
Returns void
Implementation of ReadonlyRenderableNode.translation
Inherited from Node.translation
- Defined in Node.ts:168

worldMat

get worldMat(): Readonly<Matrix4Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
The world matrix of this node, which represents its transformation relative to the origin.

Returns Readonly<Matrix4Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
- Readonlybuffer: Readonly<
      Pick<
          Float32Array["buffer"],
          "byteLength"
          | "maxByteLength"
          | "slice"
          | typeof Symbol.toStringTag,
      >,
  >
  The ArrayBuffer instance referenced by the array.
Implementation of ReadonlyRenderableNode.worldMat
Inherited from Node.worldMat
- Defined in Node.ts:173

worldTranslation

get worldTranslation(): Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
The translation of this node relative to the origin.

Returns Readonly<Vector3Like> & Readonly<
    Omit<
        Float32Array<ArrayBufferLike>,
        "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
    >,
> & {
    buffer: Readonly<
        Pick<
            Float32Array["buffer"],
            "byteLength"
            | "maxByteLength"
            | "slice"
            | typeof Symbol.toStringTag,
        >,
    >;
}
- Readonlybuffer: Readonly<
      Pick<
          Float32Array["buffer"],
          "byteLength"
          | "maxByteLength"
          | "slice"
          | typeof Symbol.toStringTag,
      >,
  >
  The ArrayBuffer instance referenced by the array.
Implementation of ReadonlyRenderableNode.worldTranslation
Inherited from Node.worldTranslation
- Defined in Node.ts:183

Methods

addChild

addChild(node: Node): void
Add a child to this node.
Parameters
- node: Node
  The child. The child's parent will be updated to point to this node. If the child already had a parent, it will be removed from that parent's children.
Returns void
Inherited from Node.addChild
- Defined in Node.ts:214

identity

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

Returns void
Inherited from Node.identity
- Defined in Node.ts:225

removeChild

removeChild(node: Node): void
Remove a child from this node.
Parameters
- node: Node
  The child. The child's parent will be updated to point to nothing.
Returns void
Inherited from Node.removeChild
- Defined in Node.ts:234

`Abstract`render

render(): void
Render this node.

Returns void
- Defined in RenderableNode.ts:42

rotate

rotate(r: number, axis: Readonly<Vector3Like>): void
Rotate this node relative to its parent.
Parameters
- r: number
  The number of radians to rotate by.
- axis: Readonly<Vector3Like>
  The axis to rotate around.
Returns void
Inherited from Node.rotate
- Defined in Node.ts:249

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
Inherited from Node.rotateX
- Defined in Node.ts:257

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
Inherited from Node.rotateY
- Defined in Node.ts:265

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
Inherited from Node.rotateZ
- Defined in Node.ts:273

scale

scale(s: Readonly<Vector3Like>): void
Scale this node relative to its parent.
Parameters
- s: Readonly<Vector3Like>
  The scaling factor.
Returns void
Inherited from Node.scale
- Defined in Node.ts:281

targetTo

targetTo(
    eye: Readonly<Vector3Like>,
    target: Readonly<Vector3Like>,
    up?: Readonly<Vector3Like>,
): void
Position this node such that it is pointing at a target position.
Parameters
- eye: Readonly<Vector3Like>
  The new position of this node.
- target: Readonly<Vector3Like>
  The position for this node to point at.
- up: Readonly<Vector3Like> = ...
  The up vector.
Returns void
Inherited from Node.targetTo
- Defined in Node.ts:291

translate

translate(t: Readonly<Vector3Like>): void
Translate this node relative to its parent.
Parameters
- t: Readonly<Vector3Like>
  The translation vector.
Returns void
Inherited from Node.translate
- Defined in Node.ts:303

traverse

traverse(
    f:
        | (
            (
                self: Node,
                worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
            ) => boolean
        )
        | (
            (
                self: Node,
                worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
            ) => void
        ),
): void
Perform a function on this node and each of its children recursively.
Parameters
- f:
      | (
          (
              self: Node,
              worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
          ) => boolean
      )
      | (
          (
              self: Node,
              worldMat: Float32Array<ArrayBufferLike> & Matrix4Like,
          ) => void
      )
  The function to perform for each node. Receives as an argument the node and the node's transformation matrix relative to the node on which the traversal started. If this function returns false, the node's children are not included in the traversal.
Returns void
Implementation of ReadonlyRenderableNode.traverse
Inherited from Node.traverse
- Defined in Node.ts:311

Class RenderableNodeAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderableNode

Properties

enabled

matrix

transparent

ui

Accessors

children

Returns readonly ReadonlyNode[]

parent

Returns Node | undefined

rotation

Returns Readonly<QuaternionLike> & Readonly< Omit< Float32Array<ArrayBufferLike>, "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort", >,> & { buffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >, >;}

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Parameters

Returns void

scaling

Returns Readonly<Vector3Like> & Readonly< Omit< Float32Array<ArrayBufferLike>, "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort", >,> & { buffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >, >;}

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Parameters

Returns void

scene

Returns Node

translation

Returns Readonly<Vector3Like> & Readonly< Omit< Float32Array<ArrayBufferLike>, "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort", >,> & { buffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >, >;}

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Parameters

Returns void

worldMat

Returns Readonly<Matrix4Like> & Readonly< Omit< Float32Array<ArrayBufferLike>, "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort", >,> & { buffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >, >;}

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

worldTranslation

Returns Readonly<Vector3Like> & Readonly< Omit< Float32Array<ArrayBufferLike>, "buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort", >,> & { buffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >, >;}

Readonlybuffer: Readonly< Pick< Float32Array["buffer"], "byteLength" | "maxByteLength" | "slice" | typeof Symbol.toStringTag, >,>

Methods

addChild

Parameters

Returns void

identity

Returns void

removeChild

Parameters

Returns void

Abstractrender

Returns void

rotate

Parameters

Returns void

rotateX

Parameters

Returns void

rotateY

Parameters

Returns void

rotateZ

Parameters

Returns void

scale

Parameters

Returns void

targetTo

Parameters

Returns void

translate

Parameters

Returns void

traverse

Parameters

Returns void

Class RenderableNode`Abstract`

Returns Readonly<QuaternionLike> & Readonly<
Omit<
Float32Array<ArrayBufferLike>,
"buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
>,
> & {
buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>;
}

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

Returns Readonly<Vector3Like> & Readonly<
Omit<
Float32Array<ArrayBufferLike>,
"buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
>,
> & {
buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>;
}

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

Returns Readonly<Vector3Like> & Readonly<
Omit<
Float32Array<ArrayBufferLike>,
"buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
>,
> & {
buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>;
}

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

Returns Readonly<Matrix4Like> & Readonly<
Omit<
Float32Array<ArrayBufferLike>,
"buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
>,
> & {
buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>;
}

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

Returns Readonly<Vector3Like> & Readonly<
Omit<
Float32Array<ArrayBufferLike>,
"buffer" | "copyWithin" | "fill" | "reverse" | "set" | "sort",
>,
> & {
buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>;
}

`Readonly`buffer: Readonly<
Pick<
Float32Array["buffer"],
"byteLength"
| "maxByteLength"
| "slice"
| typeof Symbol.toStringTag,
>,
>

`Abstract`render