Merge pull request #1238 from tmarti/add-type-annotations

chore: JSDoc types for `uniquifyPositions` and `rebucketPositions`
xeokit · Nov 16, 2023 · ec4cfb4 · ec4cfb4
2 parents 6eae278 + 5801875
commit ec4cfb4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/src/viewer/scene/model/dtx/triangles/calculateUniquePositions.js b/src/viewer/scene/model/dtx/triangles/calculateUniquePositions.js
@@ -60,9 +60,9 @@ function setMaxNumberOfPositions(maxPositions) {
  * in order to calculate the mapping between original indices and unique
  * indices.
  *
- * @param {*} mesh The input mesh to process, with `positionsCompressed`, `indices` and `edgeIndices` keys.
+ * @param {{positionsCompressed: number[],indices: number[], edgeIndices: number[]}} mesh The input mesh to process, with `positionsCompressed`, `indices` and `edgeIndices` keys.
  *
- * @returns An array with 3 elements: 0 => the uniquified positionsCompressed; 1 and 2 => the remapped edges and edgeIndices arrays
+ * @returns {[Uint16Array, UInt32Array, UInt32Array]} An array with 3 elements: 0 => the uniquified positionsCompressed; 1 and 2 => the remapped edges and edgeIndices arrays
  */
 export function uniquifyPositions(mesh) {
     const _positions = mesh.positionsCompressed;

diff --git a/src/viewer/scene/model/dtx/triangles/rebucketPositions.js b/src/viewer/scene/model/dtx/triangles/rebucketPositions.js
@@ -86,6 +86,13 @@ function preSortEdgeIndices(edgeIndices) {
     return sortedEdgeIndices;
 }
 
+/**
+ * @param {{positionsCompressed: number[], indices: number[], edgeIndices: number[]}} mesh 
+ * @param {number} bitsPerBucket 
+ * @param {boolean} checkResult 
+ * 
+ * @returns {{positionsCompressed: number[], indices: number[], edgeIndices: number[]}[]}
+ */
 function rebucketPositions(mesh, bitsPerBucket, checkResult = false) {
     const positionsCompressed = (mesh.positionsCompressed || []);
     const indices = preSortIndices(mesh.indices || [], bitsPerBucket);