BatchedMesh: add `deleteInstance()` #29449

Jordan-Lane · 2024-09-19T22:35:40Z

Description

The BatchedMesh currently has no way to remove an instance.

Solution

Adding the deleteInstance() method to the BatchedMesh class will allow users to remove instances easily from the BatchedMesh.

The previous commented out code stated that we would need to implement an optimize function to be able to repack the data. Instead, I added a _fragInfo array to keep track of 'fragmented' or open blocks. The BatchedMesh will still fill the DataTexture the same way it did before, but once it is at capacity, then it will begin adding instances to open spots in the Texture.

Additional context

The BatchedMesh has been a pleasure to work with, I just need the ability to remove existing instances. This is my first time opening a PR to three.js, so please let me know if I am missing anything. I am open to any additional changes or suggestions!

github-actions · 2024-09-19T22:38:50Z

📦 Bundle size

Full ESM build, minified and gzipped.

	Before	After	Diff
WebGL	686.03 169.81	686.37 169.89	+345 B +78 B
WebGPU	835 223.93	835.34 224.02	+345 B +82 B
WebGPU Nodes	834.5 223.81	834.85 223.89	+345 B +82 B

🌳 Bundle size after tree-shaking

Minimal build including a renderer, camera, empty scene, and dependencies.

	Before	After	Diff
WebGL	462.34 111.55	462.34 111.55	+0 B +0 B
WebGPU	531.77 143.36	531.77 143.36	+0 B +0 B
WebGPU Nodes	488.43 133.22	488.43 133.22	+0 B +0 B

gkjohnson

Thank you! #28638 also implemented deleteInstance but I quite like the approach of reusing instance Ids which will generally be more performant than having to re-pack the matrix & color buffers when trying to shrink and remap the list of instances.

The only potential point of confusion is that a user will have "deleted" an id only for it to be re-used again, which isn't necessarily severe. It just means that users will need to be diligent about tracking their ids.

cc @Mugen87 unless you have objections I'm happy with this approach for instance deletion and is a lot less complex than the other implementation. Supporting deletion / repacking of geometry is still an open question but we can address that in the future.

gkjohnson · 2024-09-20T09:02:17Z

src/objects/BatchedMesh.js

@@ -144,6 +144,7 @@ class BatchedMesh extends Mesh {

 		// stores visible, active, and geometry id per object
 		this._drawInfo = [];
+		this._fragInfo = [];


What does the name "_fragInfo" refer to? It would be better to call this something like "availableInstanceIds"

Sounds good, I like the name "availableInstanceIds". Will make that change

gkjohnson · 2024-09-20T09:04:05Z

src/objects/BatchedMesh.js

+		let drawId = null;
+
+		// If at capacity, rewrite over an inactive block
+		if ( atCapacity ) {


I think we should check if there are any available deleted Ids and reuse those ids first rather than waiting until the full capacity has been used.

I like this idea. It would be best to keep both the drawInfo and the available deleted ids as small as possible. I will make that change

Mugen87 · 2024-09-20T09:59:33Z

cc @Mugen87 unless you have objections I'm happy with this approach for instance deletion and is a lot less complex than the other implementation. Supporting deletion / repacking of geometry is still an open question but we can address that in the future.

Sounds good!

Jordan-Lane · 2024-09-20T18:20:32Z

@gkjohnson Updated the PR with your suggestions

_fragInfo has now been renamed to _ availableInstanceIds
When adding a new instance we prioritize using any available Ids before expanding the drawInfo

BatchedMesh: add `deleteInstance()` (mrdoob#29449) * BatchedMesh: add `deleteInstance()` * BatchedMesh: prioritize reusing freed instance ids when adding instance Update Three.js r169 Lensflare: Add WebGPU version. (mrdoob#29451) * lensflare example * fix depth * remove forceWebGL * rename * fix typo * follow original code * Update LensflareMesh.js --------- Co-authored-by: aardgoose <[email protected]> Co-authored-by: Michael Herzog <[email protected]> Examples: Update lensflare colors. (mrdoob#29458) WebGLRenderer: add reverse-z via EXT_clip_control (mrdoob#29445) * WebGLRenderer: add reverse-z via EXT_clip_control * WebGLRenderer: move conversion methods to utils Updated builds. Docs: Improve `WebGLRenderer` page. (mrdoob#29459) WebGLProgram: add USE_REVERSEDEPTHBUF define (mrdoob#29461) CylinderGeometry: Don't add degenerate triangles (mrdoob#29460) * CylinderGeometry: Don't add degenerate triangles * Change comparison RenderObject: Introduce `getGeometryCacheKey()` (mrdoob#29465) * RenderObject: Added `getGeometryCacheKey()` * NodeMaterialObserver: Improve skinnedmesh and morph supports * cleanup Update actions/setup-node digest to 0a44ba7 (mrdoob#29466) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Update github/codeql-action digest to 294a9d9 (mrdoob#29467) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Update devDependencies (non-major) (mrdoob#29468) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Updated builds. CurveModifierGPU: WebGPURenderer port. (mrdoob#29453) * curve mod * lint * update screenshot * use correct constant * use filtered texture --------- Co-authored-by: aardgoose <[email protected]> Examples: Clean up. (mrdoob#29473) * Examples: Clean up. * E2E: Update screenshot. SpriteNodeMaterial: Add sizeAttenuation (mrdoob#29394) * SpriteNodeMaterial: Add sizeAttenuation * Regenerate screenshot * revert mat4 mul with vec4(,1)? * revert * using let and toVar fixes the issue? * merge upstream/dev * revert screenshot * does reverting SpriteNode even fix? * revert fix * revert everything fix tsl galaxy? * checkout dev SpriteNodeMaterial.js... * smaller change test * convert scale to var * convert scale to var * simply adding toVar breaks tsl_galaxy? * fix multiple spritematerial with different center position * feedbacks * cleanup * feedbacks * cleanup * cleanup --------- Co-authored-by: sunag <[email protected]> WebGPURenderer: Prevent out of bounds `textureLoad` access in WGSL (mrdoob#29470) Co-authored-by: aardgoose <[email protected]> SkyMesh,WaterMesh: Fix NodeMaterial imports (mrdoob#29477) WebGPURenderer: Reuse LightNode when available (mrdoob#29480) * WebGPURenderer: Reuse LightNode when available * cleanup DecalGeometry: Transform normal with normal matrix (mrdoob#29476) * Transform normal with normal matrix * Transform normal with normal matrix Examples: add reflection mask in `retargeting_readyplayer` (mrdoob#29485) BatchedMesh: Add `getGeometryRangeAt` (mrdoob#29409) * BatchedMesh: Add getGeometryRangeAt Co-authored-by: Luigi Denora <[email protected]> * Fix eslint error Co-authored-by: Luigi Denora <[email protected]> * Doc changed * Add optional target --------- Co-authored-by: Luigi Denora <[email protected]> WebGPURenderer: Introduce hash-based cache key (mrdoob#29479) * introduce numeric cache key * cleanup * cleanup * simplification * revision * rev * rev * cleanup Nodes: Access Remaining Compute Builtins (mrdoob#29469) * init * remove duplicated function Add decal as child of mesh (mrdoob#29486) Update webgl_postprocessing_ssaa.html Update webgpu_postprocessing_ssaa.html ToonOutlinePassNode: Add FX pass for toon outlines. (mrdoob#29483) * ToonOutlineNode: Add FX pass for toon outlines. * ToonOutlinePassNode: Refactor code. * E2E: Update screenshot. * ToonOutlinePassNode: Clean up. * ToonOutlinePassNode: More clean up. * ToonOutlinePassNode: More clean up. Update Addons.js (mrdoob#29493) leftovers after removing `PackedPhongMaterial ` mrdoob#29382 ReferenceNode: Fix null reference using `getNodeType()` (mrdoob#29498) * fix null reference using `getNodeType()` * add `sprite.center` check NodeBuilder: Introduce `addFlowCodeHierarchy()` / `NodeBlock` (mrdoob#29495) * VolumeNodeMaterial: simplify a little * cleanup * NodeBuilder: Introduce `addFlowCodeHierarchy()` Examples: Improve shadow map size in `webgpu_tsl_angular_slicing` (mrdoob#29499) WebGPURenderer: respect the `renderer.shadowMap.enabled` property (mrdoob#29492) * enable/disable shadow * enable shadowmaps * enable more examples * and another one * Update Nodes.js --------- Co-authored-by: aardgoose <[email protected]> Updated builds. GLTFLoader: Remove deprecated code. (mrdoob#29502) TiltLoader: Remove loader. (mrdoob#29471) Update Chinese translation of InstancedMesh. (mrdoob#29506) r169

gkjohnson reviewed Sep 20, 2024

View reviewed changes

gkjohnson added this to the r169 milestone Sep 20, 2024

Jordan-Lane added 2 commits September 20, 2024 11:28

BatchedMesh: add deleteInstance()

7592481

BatchedMesh: prioritize reusing freed instance ids when adding instance

114489b

Jordan-Lane force-pushed the JL-batchmesh-delete-instance branch from 3f5f814 to 114489b Compare September 20, 2024 17:29

gkjohnson merged commit 44cb404 into mrdoob:dev Sep 21, 2024
12 checks passed

gkjohnson mentioned this pull request Sep 22, 2024

BatchedMesh: Plans for adding "optimize" function #29463

Closed

This was referenced Sep 25, 2024

BatchedMesh: add deleteInstance() three-types/three-ts-types#1271

Merged

r169 three-types/three-ts-types#1224

Closed

gkjohnson mentioned this pull request Sep 28, 2024

BatchedMesh: Add deleteGeometry(). #29523

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BatchedMesh: add `deleteInstance()` #29449

BatchedMesh: add `deleteInstance()` #29449

Jordan-Lane commented Sep 19, 2024

github-actions bot commented Sep 19, 2024 •

edited

Loading

gkjohnson left a comment

gkjohnson Sep 20, 2024

Jordan-Lane Sep 20, 2024

gkjohnson Sep 20, 2024

Jordan-Lane Sep 20, 2024 •

edited

Loading

Mugen87 commented Sep 20, 2024

Jordan-Lane commented Sep 20, 2024

BatchedMesh: add deleteInstance() #29449

BatchedMesh: add deleteInstance() #29449

Conversation

Jordan-Lane commented Sep 19, 2024

github-actions bot commented Sep 19, 2024 • edited Loading

📦 Bundle size

🌳 Bundle size after tree-shaking

gkjohnson left a comment

Choose a reason for hiding this comment

gkjohnson Sep 20, 2024

Choose a reason for hiding this comment

Jordan-Lane Sep 20, 2024

Choose a reason for hiding this comment

gkjohnson Sep 20, 2024

Choose a reason for hiding this comment

Jordan-Lane Sep 20, 2024 • edited Loading

Choose a reason for hiding this comment

Mugen87 commented Sep 20, 2024

Jordan-Lane commented Sep 20, 2024

BatchedMesh: add `deleteInstance()` #29449

BatchedMesh: add `deleteInstance()` #29449

github-actions bot commented Sep 19, 2024 •

edited

Loading

Jordan-Lane Sep 20, 2024 •

edited

Loading