@loaders.gl/tile-converter 4.2.0-alpha.5 → 4.2.0-alpha.6

package/src/i3s-converter/helpers/geometry-converter.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import type {FeatureTableJson, Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 import type {
   GLTFAccessorPostprocessed,
@@ -95,21 +96,35 @@ let scratchVector = new Vector3();
  * @param metadataClass `- user selected feature metadata class name`
  * @returns Array of node resources to create one or more i3s nodes
  */
-export default async function convertB3dmToI3sGeometry(
-  tileContent: Tiles3DTileContent,
-  tileTransform: Matrix4,
-  tileBoundingVolume: OrientedBoundingBox | BoundingSphere,
-  addNodeToNodePage: () => Promise<number>,
-  propertyTable: FeatureTableJson | null,
-  featuresHashArray: string[],
-  attributeStorageInfo: AttributeStorageInfo[] | undefined,
-  draco: boolean,
-  generateBoundingVolumes: boolean,
-  shouldMergeMaterials: boolean,
-  geoidHeightModel: Geoid,
-  libraries: Record<string, string>,
-  metadataClass?: string
-): Promise<I3SConvertedResources[] | null> {
+export default async function convertB3dmToI3sGeometry({
+  tileContent,
+  tileTransform,
+  tileBoundingVolume,
+  addNodeToNodePage,
+  propertyTable,
+  featuresHashArray,
+  attributeStorageInfo,
+  draco,
+  generateBoundingVolumes,
+  shouldMergeMaterials,
+  geoidHeightModel,
+  libraries,
+  metadataClass
+}: {
+  tileContent: Tiles3DTileContent;
+  tileTransform: Matrix4;
+  tileBoundingVolume: OrientedBoundingBox | BoundingSphere;
+  addNodeToNodePage: () => Promise<number>;
+  propertyTable: FeatureTableJson | null;
+  featuresHashArray: string[];
+  attributeStorageInfo: AttributeStorageInfo[] | undefined;
+  draco: boolean;
+  generateBoundingVolumes: boolean;
+  shouldMergeMaterials: boolean;
+  geoidHeightModel: Geoid;
+  libraries: Record<string, string>;
+  metadataClass?: string;
+}): Promise<I3SConvertedResources[] | null> {
   const useCartesianPositions = generateBoundingVolumes;
   const materialAndTextureList: I3SMaterialWithTexture[] = await convertMaterials(
     tileContent.gltf?.materials,
@@ -149,7 +164,7 @@ export default async function convertB3dmToI3sGeometry(
     }
     const convertedAttributes = convertedAttributesMap.get(originarMaterialId);
     if (!convertedAttributes) {
-      continue;
+      continue; // eslint-disable-line no-continue
     }
     const {material, texture} = materialAndTexture;
     const nodeId = await addNodeToNodePage();
@@ -278,21 +293,22 @@ async function _makeNodeResources({
       faceRange.buffer
     )
   );
+  // prettier-ignore
   const compressedGeometry = draco
     ? generateCompressedGeometry(
-        vertexCount,
-        convertedAttributes,
-        {
-          positions,
-          normals,
-          texCoords: texture ? texCoords : new Float32Array(0),
-          colors,
-          uvRegions,
-          featureIds,
-          faceRange
-        },
-        libraries
-      )
+      vertexCount,
+      convertedAttributes,
+      {
+        positions,
+        normals,
+        texCoords: texture ? texCoords : new Float32Array(0),
+        colors,
+        uvRegions,
+        featureIds,
+        faceRange
+      },
+      libraries
+    )
     : null;
 
   let attributes: ArrayBuffer[] = [];
@@ -356,21 +372,20 @@ export async function convertAttributes(
     }
   }
 
-  convertNodes(
+  convertNodes({
     nodes,
     images,
     cartographicOrigin,
     cartesianModelMatrix,
     attributesMap,
     useCartesianPositions,
-    undefined,
     featureTexture
-  );
+  });
 
   for (const attrKey of attributesMap.keys()) {
     const attributes = attributesMap.get(attrKey);
     if (!attributes) {
-      continue;
+      continue; // eslint-disable-line no-continue
     }
     if (attributes.positions.length === 0) {
       attributesMap.delete(attrKey);
@@ -401,19 +416,28 @@ export async function convertAttributes(
  * @param featureTexture - feature texture key
  * @returns {void}
  */
-function convertNodes(
-  nodes: GLTFNodePostprocessed[],
-  images: (TextureImageProperties | null)[],
-  cartographicOrigin: Vector3,
-  cartesianModelMatrix: Matrix4,
-  attributesMap: Map<string, ConvertedAttributes>,
-  useCartesianPositions: boolean,
-  matrix: Matrix4 = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
-  featureTexture: string | null
-) {
+function convertNodes({
+  nodes,
+  images,
+  cartographicOrigin,
+  cartesianModelMatrix,
+  attributesMap,
+  useCartesianPositions,
+  matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
+  featureTexture
+}: {
+  nodes: GLTFNodePostprocessed[];
+  images: (TextureImageProperties | null)[];
+  cartographicOrigin: Vector3;
+  cartesianModelMatrix: Matrix4;
+  attributesMap: Map<string, ConvertedAttributes>;
+  useCartesianPositions: boolean;
+  matrix?: Matrix4;
+  featureTexture: string | null;
+}) {
   if (nodes) {
     for (const node of nodes) {
-      convertNode(
+      convertNode({
         node,
         images,
         cartographicOrigin,
@@ -422,7 +446,7 @@ function convertNodes(
         useCartesianPositions,
         matrix,
         featureTexture
-      );
+      });
     }
   }
 }
@@ -470,43 +494,52 @@ function getCompositeTransformationMatrix(node: GLTFNodePostprocessed, matrix: M
  * @param matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
  * @param featureTexture - feature texture key
  */
-function convertNode(
-  node: GLTFNodePostprocessed,
-  images: (TextureImageProperties | null)[],
-  cartographicOrigin: Vector3,
-  cartesianModelMatrix: Matrix4,
-  attributesMap: Map<string, ConvertedAttributes>,
+function convertNode({
+  node,
+  images,
+  cartographicOrigin,
+  cartesianModelMatrix,
+  attributesMap,
   useCartesianPositions,
   matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
-  featureTexture: string | null
-) {
+  featureTexture
+}: {
+  node: GLTFNodePostprocessed;
+  images: (TextureImageProperties | null)[];
+  cartographicOrigin: Vector3;
+  cartesianModelMatrix: Matrix4;
+  attributesMap: Map<string, ConvertedAttributes>;
+  useCartesianPositions: boolean;
+  matrix: Matrix4;
+  featureTexture: string | null;
+}) {
   const transformationMatrix = getCompositeTransformationMatrix(node, matrix);
 
   const mesh = node.mesh;
 
   if (mesh) {
-    convertMesh(
+    convertMesh({
       mesh,
       images,
       cartographicOrigin,
       cartesianModelMatrix,
       attributesMap,
       useCartesianPositions,
-      transformationMatrix,
+      matrix: transformationMatrix,
       featureTexture
-    );
+    });
   }
 
-  convertNodes(
-    node.children || [],
+  convertNodes({
+    nodes: node.children || [],
     images,
     cartographicOrigin,
     cartesianModelMatrix,
     attributesMap,
     useCartesianPositions,
-    transformationMatrix,
+    matrix: transformationMatrix,
     featureTexture
-  );
+  });
 }
 
 /**
@@ -524,16 +557,25 @@ function convertNode(
  * @param matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
  * @param featureTexture - feature texture key
  */
-function convertMesh(
-  mesh: GLTFMeshPostprocessed,
-  images: (TextureImageProperties | null)[],
-  cartographicOrigin: Vector3,
-  cartesianModelMatrix: Matrix4,
-  attributesMap: Map<string, ConvertedAttributes>,
+function convertMesh({
+  mesh,
+  images,
+  cartographicOrigin,
+  cartesianModelMatrix,
+  attributesMap,
   useCartesianPositions = false,
-  matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
-  featureTexture: string | null
-) {
+  matrix,
+  featureTexture
+}: {
+  mesh: GLTFMeshPostprocessed;
+  images: (TextureImageProperties | null)[];
+  cartographicOrigin: Vector3;
+  cartesianModelMatrix: Matrix4;
+  attributesMap: Map<string, ConvertedAttributes>;
+  useCartesianPositions: boolean;
+  matrix: Matrix4;
+  featureTexture: string | null;
+}) {
   for (const primitive of mesh.primitives) {
     let outputAttributes: ConvertedAttributes | null | undefined = null;
     let materialUvRegion: Uint16Array | undefined;
@@ -556,7 +598,7 @@ function convertMesh(
     );
     const attributes = primitive.attributes;
     if (!outputAttributes) {
-      continue;
+      continue; // eslint-disable-line no-continue
     }
 
     const indices = normalizeIndices(primitive);
@@ -647,7 +689,7 @@ function normalizeIndices(primitive: GLTFMeshPrimitivePostprocessed): TypedArray
     }
     indices = newIndices;
   }
-  return indices as TypedArray;
+  return indices;
 }
 
 /**
@@ -893,6 +935,7 @@ async function convertMaterials(
  * @param materials materials array
  * @returns merged materials array
  */
+// eslint-disable-next-line max-statements, complexity
 async function mergeAllMaterials(
   materials: I3SMaterialWithTexture[]
 ): Promise<I3SMaterialWithTexture[]> {
@@ -984,6 +1027,7 @@ async function mergeMaterials(
         .toFormat(material1.texture.mimeType === 'image/png' ? 'png' : 'jpeg')
         .toBuffer();
     } catch (error) {
+      // eslint-disable-next-line no-console
       console.log(
         'Join images into a texture atlas has failed. Consider usage `--split-nodes` option. (See documentation https://loaders.gl/modules/tile-converter/docs/cli-reference/tile-converter)'
       );
@@ -1035,7 +1079,7 @@ function convertMaterial(sourceMaterial: GLTFMaterialPostprocessed): I3SMaterial
   }
 
   sourceMaterial.id = Number.isFinite(sourceMaterial.id) ? sourceMaterial.id : uuidv4();
-  let mergedMaterials: MergedMaterial[] = [{originalMaterialId: sourceMaterial.id}];
+  const mergedMaterials: MergedMaterial[] = [{originalMaterialId: sourceMaterial.id}];
   if (!texture) {
     // Should use default baseColorFactor if it is not present in source material
     // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#reference-pbrmetallicroughness
@@ -1419,6 +1463,7 @@ function generateAttributeBuffer(type: string, value: any): ArrayBuffer {
 function getAttributeType(key: string, attributeStorageInfo: any[]): string {
   const attribute = attributeStorageInfo.find((attr) => attr.name === key);
   if (!attribute) {
+    // eslint-disable-next-line no-console
     console.error(
       `attribute is null, key=${key}, attributeStorageInfo=${JSON.stringify(
         attributeStorageInfo,
@@ -1429,6 +1474,7 @@ function getAttributeType(key: string, attributeStorageInfo: any[]): string {
     return '';
   }
   if (!attribute.attributeValues) {
+    // eslint-disable-next-line no-console
     console.error(`attributeValues is null, attribute=${attribute}`);
     return '';
   }

package/src/i3s-converter/helpers/gltf-attributes.ts

@@ -18,7 +18,7 @@ export function prepareDataForAttributesConversion(
   tileTransform: Matrix4,
   boundingVolume: OrientedBoundingBox | BoundingSphere
 ): GLTFAttributesData {
-  let nodes =
+  const nodes =
     tileContent.gltf?.scene?.nodes ||
     tileContent.gltf?.scenes?.[0]?.nodes ||
     tileContent.gltf?.nodes ||
@@ -29,19 +29,18 @@ export function prepareDataForAttributesConversion(
       // Need data only for uncompressed images because we can't get batchIds from compressed textures.
       if (imageObject?.image?.compressed) {
         return null;
-      } else {
-        const data = imageObject?.image?.data;
-        const dataCopy = new Uint8Array(data.length);
-        dataCopy.set(data);
-        return {
-          data: dataCopy,
-          compressed: false,
-          height: imageObject.image.height,
-          width: imageObject.image.width,
-          components: imageObject.image.components,
-          mimeType: imageObject.mimeType
-        };
       }
+      const data = imageObject?.image?.data;
+      const dataCopy = new Uint8Array(data.length);
+      dataCopy.set(data);
+      return {
+        data: dataCopy,
+        compressed: false,
+        height: imageObject.image.height,
+        width: imageObject.image.width,
+        components: imageObject.image.components,
+        mimeType: imageObject.mimeType
+      };
     }) || [];
 
   prepareNodes(nodes);

package/src/i3s-converter/helpers/node-index-document.ts

@@ -85,7 +85,7 @@ export class NodeIndexDocument {
 
     let data: Node3DIndexDocument | null = this.data;
     if (this.converter.options.instantNodeWriting) {
-      data = (await this.load()) as Node3DIndexDocument;
+      data = await this.load();
     }
     if (data) {
       data.children = data.children ?? [];
@@ -227,14 +227,21 @@ export class NodeIndexDocument {
    * @param converter - I3SConverter instance
    * @returns NodeIndexDocument instance
    */
-  static async createNode(
-    parentNode: NodeIndexDocument,
-    boundingVolumes: BoundingVolumes,
-    lodSelection: LodSelection[],
-    nodeInPage: NodeInPage,
-    resources: I3SConvertedResources,
-    converter: I3SConverter
-  ): Promise<NodeIndexDocument> {
+  static async createNode({
+    parentNode,
+    boundingVolumes,
+    lodSelection,
+    nodeInPage,
+    resources,
+    converter
+  }: {
+    parentNode: NodeIndexDocument;
+    boundingVolumes: BoundingVolumes;
+    lodSelection: LodSelection[];
+    nodeInPage: NodeInPage;
+    resources: I3SConvertedResources;
+    converter: I3SConverter;
+  }): Promise<NodeIndexDocument> {
     const data = await NodeIndexDocument.createNodeIndexDocument(
       parentNode,
       boundingVolumes,
@@ -283,6 +290,7 @@ export class NodeIndexDocument {
    * @param resources.attributes - feature attributes
    * @return 3DNodeIndexDocument https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md object
    */
+  // eslint-disable-next-line complexity
   static async createNodeIndexDocument(
     parentNode: NodeIndexDocument,
     boundingVolumes: BoundingVolumes,
@@ -290,7 +298,7 @@ export class NodeIndexDocument {
     nodeInPage: NodeInPage,
     resources: I3SConvertedResources | DumpMetadata
   ): Promise<Node3DIndexDocument> {
-    const nodeId = nodeInPage.index!;
+    const nodeId = nodeInPage.index;
     const parentNodeData = await parentNode.load();
     const nodeData = {
       version: parentNodeData.version,

package/src/i3s-converter/helpers/node-pages.ts

@@ -99,9 +99,8 @@ export default class NodePages {
     if (await isFileExists(fullName)) {
       console.log(`load ${fullName}.`); // eslint-disable-line
       return (await openJson(filePath, fileName)) as {nodes: NodeInPage[]};
-    } else {
-      return {nodes: []};
     }
+    return {nodes: []};
   }
 
   /**
@@ -180,34 +179,33 @@ export default class NodePages {
   async saveNode(node: NodeInPage): Promise<void> {
     if (!this.converter.options.instantNodeWriting) {
       return;
+    }
+    const nodePageIndex = this.getPageIndexByNodeId(node.index);
+    const nodePage = await this.getPageByNodeId(node.index);
+    const {filePath, fileName} = this.getNodePageFileName(nodePageIndex);
+    const nodeToUpdate = await this.getNodeById(node.index, nodePage);
+    if (nodeToUpdate) {
+      NodePages.updateAll(nodeToUpdate, node);
     } else {
-      const nodePageIndex = this.getPageIndexByNodeId(node.index);
-      const nodePage = await this.getPageByNodeId(node.index);
-      const {filePath, fileName} = this.getNodePageFileName(nodePageIndex);
-      const nodeToUpdate = await this.getNodeById(node.index, nodePage);
-      if (nodeToUpdate) {
-        NodePages.updateAll(nodeToUpdate, node);
-      } else {
-        nodePage.nodes.push(node);
-      }
-      const nodePageStr = JSON.stringify(nodePage);
-      if (this.converter.options.slpk) {
-        await this.converter.writeQueue.enqueue(
-          {
-            archiveKey: `nodePages/${nodePageIndex.toString()}.json.gz`,
-            writePromise: () =>
-              this.writeFile(filePath, nodePageStr, fileName, true, this.converter.compressList)
-          },
-          true
-        );
-      } else {
-        await this.converter.writeQueue.enqueue(
-          {
-            writePromise: () => this.writeFile(filePath, nodePageStr)
-          },
-          true
-        );
-      }
+      nodePage.nodes.push(node);
+    }
+    const nodePageStr = JSON.stringify(nodePage);
+    if (this.converter.options.slpk) {
+      await this.converter.writeQueue.enqueue(
+        {
+          archiveKey: `nodePages/${nodePageIndex.toString()}.json.gz`,
+          writePromise: () =>
+            this.writeFile(filePath, nodePageStr, fileName, true, this.converter.compressList)
+        },
+        true
+      );
+    } else {
+      await this.converter.writeQueue.enqueue(
+        {
+          writePromise: () => this.writeFile(filePath, nodePageStr)
+        },
+        true
+      );
     }
   }
 

package/src/i3s-converter/helpers/preprocess-3d-tiles.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 import {GLTFPrimitiveModeString, PreprocessData} from '../types';
 import {

package/src/i3s-converter/helpers/progress.ts

@@ -32,6 +32,7 @@ export class Progress {
   private getTime: () => bigint;
 
   constructor(options: {threshold?: number; getTime?: () => bigint} = {}) {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     this.getTime = options.getTime || process.hrtime.bigint;
     this.threshold = options.threshold || THRESHOLD_DEFAULT;
   }

package/src/i3s-converter/helpers/tileset-traversal.ts

@@ -23,14 +23,21 @@ export type TraversalConversionProps = {
  *                traversal at the some level of the tree
  * @returns void
  */
-export const traverseDatasetWith = async <TProps>(
-  tile: Tiles3DTileJSONPostprocessed,
-  traversalProps: TProps,
-  processTile: (tile: Tiles3DTileJSONPostprocessed, traversalProps: TProps) => Promise<TProps>,
-  postprocessTile?: (processResults: TProps[], currentTraversalProps: TProps) => Promise<void>,
-  maxDepth?: number,
+export const traverseDatasetWith = async <TProps>({
+  tile,
+  traversalProps,
+  processTile,
+  postprocessTile,
+  maxDepth,
   level = 0
-): Promise<void> => {
+}: {
+  tile: Tiles3DTileJSONPostprocessed;
+  traversalProps: TProps;
+  processTile: (tile: Tiles3DTileJSONPostprocessed, traversalProps: TProps) => Promise<TProps>;
+  postprocessTile?: (processResults: TProps[], currentTraversalProps: TProps) => Promise<void>;
+  maxDepth?: number;
+  level?: number;
+}): Promise<void> => {
   if (maxDepth && level > maxDepth) {
     return;
   }
@@ -38,14 +45,16 @@ export const traverseDatasetWith = async <TProps>(
   const newTraversalProps: TProps = await processTile(tile, traversalProps);
   processResults.push(newTraversalProps);
   for (const childTile of tile.children) {
-    await traverseDatasetWith(
-      childTile,
-      newTraversalProps,
+    await traverseDatasetWith({
+      tile: childTile,
+      traversalProps: newTraversalProps,
       processTile,
       postprocessTile,
       maxDepth,
-      level + 1
-    );
+      level: level + 1
+    });
+  }
+  if (postprocessTile) {
+    await postprocessTile(processResults, traversalProps);
   }
-  postprocessTile && (await postprocessTile(processResults, traversalProps));
 };