Back to Three Js

InstanceNode

docs/pages/InstanceNode.html

latest3.2 KB
Original Source

Constructor

new InstanceNode( count : number, instanceMatrix : InstancedBufferAttribute | StorageInstancedBufferAttribute, instanceColor : InstancedBufferAttribute | StorageInstancedBufferAttribute )

Constructs a new instance node.

| count |

The number of instances.

| | instanceMatrix |

Instanced buffer attribute representing the instance transformations.

| | instanceColor |

Instanced buffer attribute representing the instance colors.

Default is null.

|

Properties

.buffer : InstancedInterleavedBuffer

A reference to a buffer that is used by instanceMatrixNode.

.bufferColor : InstancedBufferAttribute

A reference to a buffer that is used by instanceColorNode.

.count : number

The number of instances.

.instanceColor : InstancedBufferAttribute

Instanced buffer attribute representing the color of instances.

.instanceColorNode : Node

The node that represents the instance color data.

Default is null.

.instanceMatrix : InstancedBufferAttribute

Instanced buffer attribute representing the transformation of instances.

.instanceMatrixNode : Node

The node that represents the instance matrix data.

.isStorageColor : boolean

Tracks whether the color data is provided via a storage buffer.

.isStorageMatrix : boolean

Tracks whether the matrix data is provided via a storage buffer.

.previousInstanceMatrixNode : Node

The previous instance matrices. Required for computing motion vectors.

Default is null.

.updateType : string

The update type is set to frame since an update of instanced buffer data must be checked per frame.

Default is 'frame'.

Overrides: Node#updateType

Methods

.getPreviousInstancedPosition( builder : NodeBuilder ) : Node.<vec3>

Computes the transformed/instanced vertex position of the previous frame.

| builder |

The current node builder.

|

Returns: The instanced position from the previous frame.

.setup( builder : NodeBuilder )

Setups the internal buffers and nodes and assigns the transformed vertex data to predefined node variables for accumulation. That follows the same patterns like with morph and skinning nodes.

| builder |

The current node builder.

|

Overrides: Node#setup

.update( frame : NodeFrame )

Checks if the internal buffers require an update.

| frame |

The current node frame.

|

Overrides: Node#update

Source

src/nodes/accessors/InstanceNode.js