Publish to NPM about three-mesh-bvh HOT 6 CLOSED

@mquander Thoughts on how an NPM package should be structured?

What are your opinions on automatically binding to the THREE.js prototypes vs requiring explicit registration by the user? I figure that MeshBVH and MeshBVHVisualizer should be exported from the main package, as well.

from three-mesh-bvh.

Although Javascript culture doesn't line up perfectly with my beliefs, I strongly prefer being explicit and making it clear what's going on. I would expose the function you're using to override the prototype and expect people to write code like

import { MeshBVH } from 'threejs-fast-raycast';

// make BVH-enabled raycasting the default for every mesh with a bvh on its geometry
THREE.Mesh.prototype.raycast = MeshBVH.acceleratedRaycast;

// ...then:
const { bvh, index } = MeshBVH.buildTree(obj.mesh.geometry);
obj.mesh.geometry.bvh = bvh;
obj.mesh.geometry.setIndex(index);

I specifically prefer the BVH storage on the geometry and the index-swapping to be visible to programmers, because those are big chunks of memory that they should be clearly aware of and ready to dispose of if they cease to become useful. I think if programmers don't have a mental model of what the BVH computation is producing and what happens to it, they will make more mistakes.

(I'm actually not even happy with how "magical" MeshBVH.acceleratedRaycast is but I don't have a confident suggestion of how to improve it, given the existing three.js raycast infrastructure.)

from three-mesh-bvh.

I agree -- I'll think about how to update the API when I get a chance

from three-mesh-bvh.

@mquander Okay what do you think -- are we ready for a first publish to NPM?

from three-mesh-bvh.

My only complaint is that I don't really like computeBoundsTree and disposeBoundsTree as an API -- I would remove them. I can understand if you don't want to, though.

Other than that, I see no reason not to publish.

from three-mesh-bvh.

Okay I think I'll publish as-is for now and we can re-evaluate the API in a future release.

from three-mesh-bvh.