docs: improve TriMesh documentation with examples#364
Open
kbo4sho wants to merge 1 commit intodimforge:masterfrom
Open
docs: improve TriMesh documentation with examples#364kbo4sho wants to merge 1 commit intodimforge:masterfrom
kbo4sho wants to merge 1 commit intodimforge:masterfrom
Conversation
Add detailed JSDoc to ColliderDesc.trimesh() explaining: - How the flat vertices array maps to vertex positions - How the indices array defines triangles by referencing vertices - Compatibility with Three.js BufferGeometry layout - Two practical examples (single triangle and quad with shared vertices) Closes dimforge#272
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves the JSDoc documentation for
ColliderDesc.trimesh()with:verticesarray maps to vertex positions ([x1, y1, z1, x2, y2, z2, ...])indicesarray defines triangles by referencing vertex indicesBufferGeometrylayout (same arrays can be shared)@exampleblocks: single triangle floor and a quad with shared verticesflagsparameterMotivation
As noted in #272, the current documentation for
trimesh()is minimal and the vertex/index relationship is not intuitive — leading users to create incorrect index arrays (e.g.Uint32Array(9)filled with zeros instead of vertex references). The issue author figured out the correct usage and suggested adding examples to prevent others from hitting the same problem.Closes #272