A special version of [page:Mesh] with multi draw batch rendering support. Use
[name] if you have to render a large number of objects with the same
- material but with different world transformations and geometry. The usage
- of [name] will help you to reduce the number of draw calls and thus
- improve the overall rendering performance in your application.
+ material but with different world transformations. The usage of [name] will
+ help you to reduce the number of draw calls and thus improve the overall
+ rendering performance in your application.
If the [link:https://developer.mozilla.org/en-US/docs/Web/API/WEBGL_multi_draw WEBGL_multi_draw extension] is
- not supported then a less performant callback is used.
+ not supported then a less performant fallback is used.
const box = new THREE.BoxGeometry( 1, 1, 1 );
- const sphere = new THREE.BoxGeometry( 1, 1, 1 );
+ const sphere = new THREE.SphereGeometry( 1, 12, 12 );
const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
// initialize and add geometries into the batched mesh
const batchedMesh = new BatchedMesh( 10, 5000, 10000, material );
- const boxId = batchedMesh.addGeometry( box );
- const sphereId = batchedMesh.addGeometry( sphere );
+ const boxGeometryId = batchedMesh.addGeometry( box );
+ const sphereGeometryId = batchedMesh.addGeometry( sphere );
+
+ // create instances of those geometries
+ const boxInstancedId1 = batchedMesh.addInstance( boxGeometryId );
+ const boxInstancedId2 = batchedMesh.addInstance( boxGeometryId );
+
+ const sphereInstancedId1 = batchedMesh.addInstance( sphereGeometryId );
+ const sphereInstancedId2 = batchedMesh.addInstance( sphereGeometryId );
// position the geometries
- batchedMesh.setMatrixAt( boxId, boxMatrix );
- batchedMesh.setMatrixAt( sphereId, sphereMatrix );
+ batchedMesh.setMatrixAt( boxInstancedId1, boxMatrix1 );
+ batchedMesh.setMatrixAt( boxInstancedId2, boxMatrix2 );
+
+ batchedMesh.setMatrixAt( sphereInstancedId1, sphereMatrix1 );
+ batchedMesh.setMatrixAt( sphereInstancedId2, sphereMatrix2 );
scene.add( batchedMesh );
@@ -52,16 +62,15 @@
- [page:Integer maxGeometryCount] - the max number of individual geometries planned to be added.
- [page:Integer maxVertexCount] - the max number of vertices to be used by all geometries.
- [page:Integer maxIndexCount] - the max number of indices to be used by all geometries.
- [page:Material material] - an instance of [page:Material]. Default is a
- new [page:MeshBasicMaterial].
+ [page:Integer maxInstanceCount] - the max number of individual instances planned to be added and rendered.
+ [page:Integer maxVertexCount] - the max number of vertices to be used by all unique geometries.
+ [page:Integer maxIndexCount] - the max number of indices to be used by all unique geometries.
+ [page:Material material] - an instance of [page:Material]. Default is a new [page:MeshBasicMaterial].
- Takes a sort a function that is run before render. The function takes a list of items to sort and a camera. The objects + Takes a sort a function that is run before render. The function takes a list of instances to sort and a camera. The objects in the list include a "z" field to perform a depth-ordered sort with.
- [page:Integer index]: The index of a geometry. Values have to be in the - range [0, count]. + [page:Integer instanceId]: The id of an instance to get the color of.
- [page:Color color]: This color object will be set to the color of the - defined geometry. + [page:Color target]: The target object to copy the color in to.
Get the color of the defined geometry.
- [page:Integer index]: The index of an instance. Values have to be in the - range [0, count]. + [page:Integer instanceId]: The id of an instance to get the matrix of.
- [page:Matrix4 matrix]: This 4x4 matrix will be set to the local + [page:Matrix4 target]: This 4x4 matrix will be set to the local transformation matrix of the defined instance.
Get the local transformation matrix of the defined instance.
- [page:Integer index]: The index of an instance. Values have to be in the - range [0, count]. + [page:Integer instanceId]: The id of an instance to get the visibility state of.
Get whether the given instance is marked as "visible" or not.
- [page:Integer index]: The index of a geometry. Values have to be in the - range [0, count]. + [page:Integer instanceId]: The id of the instance to set the color of.
-[page:Color color]: The color of a single geometry.
+[page:Color color]: The color to set the instance to.
- Sets the given color to the defined geometry. + Sets the given color to the defined geometry instance.
- [page:Integer index]: The index of an instance. Values have to be in the - range [0, count]. + [page:Integer instanceId]: The id of an instance to set the matrix of.
[page:Matrix4 matrix]: A 4x4 matrix representing the local transformation @@ -192,17 +195,16 @@
- [page:Integer index]: The index of an instance. Values have to be in the - range [0, count]. + [page:Integer instanceId]: The id of the instance to set the visibility of.
[page:Boolean visible]: A boolean value indicating the visibility state.
- Sets the visibility of the object at the given index. + Sets the visibility of the instance at the given index.
- Adds the given geometry to the [name] and returns the associated index referring to it. + Adds the given geometry to the [name] and returns the associated geometry id referring to it to be used in other functions. +
+ ++ [page:Integer geometryId]: The id of a previously added geometry via "addGeometry" to add into the [name] to render. +
++ Adds a new instance to the [name] using the geometry of the given geometryId and returns a new id referring to the new instance to be used + by other functions.
- [page:Integer index]: Which geometry index to replace with this geometry. + [page:Integer geometryId]: Which geometry id to replace with this geometry.
- [page:BufferGeometry geometry]: The geometry to substitute at the given geometry index. + [page:BufferGeometry geometry]: The geometry to substitute at the given geometry id.
- Replaces the geometry at `index` with the provided geometry. Throws an error if there is not enough space reserved for geometry at the index. + Replaces the geometry at `geometryId` with the provided geometry. Throws an error if there is not enough space reserved for geometry. + Calling this will change all instances that are rendering that geometry.
+