@loaders.gl/tile-converter 5.0.0-alpha.11 → 5.0.0-alpha.14

package/src/v4/3d-tiles-converter/json-templates/tileset.ts

@@ -1,42 +1,61 @@
-import transform from 'json-map-transform';
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 
-const ASSET = () => ({
-  version: {
-    path: 'version',
-    default: '1.0'
-  }
-});
+import type {BuilderInput} from '../../lib/utils/builder-input';
 
-const TILE = () => ({
-  boundingVolume: {
-    path: 'boundingVolume'
-  },
-  geometricError: {
-    path: 'geometricError'
-  },
-  refine: {
-    path: 'refine'
-  },
-  content: {
-    path: 'content'
-  },
-  children: {
-    path: 'children',
-    transform: val => val.map(tile => transform(tile, TILE()))
-  }
-});
+/** Tile asset metadata used by the legacy writer. */
+export type TilesetAsset = {
+  /** Target version. */
+  version?: string;
+};
+/** Selected legacy tileset fields. */
+export type TilesetTile = {
+  /** Bounding volume. */
+  boundingVolume?: unknown;
+  /** Geometric error. */
+  geometricError?: number;
+  /** Refinement policy. */
+  refine?: string;
+  /** Content link. */
+  content?: unknown;
+  /** Child tiles. */
+  children: TilesetTile[];
+};
+/** Input to the legacy tileset writer. */
+export type TilesetInput = {
+  /** Asset metadata. */
+  asset: TilesetAsset;
+  /** Root tile. */
+  root: TilesetTile;
+};
 
-export const TILESET = () => ({
-  asset: {
-    path: 'asset',
-    transform: val => transform(val, ASSET())
-  },
-  geometricError: {
-    path: 'root',
-    transform: val => val.geometricError
-  },
-  root: {
-    path: 'root',
-    transform: val => transform(val, TILE())
-  }
-});
+/** Builds asset with the legacy field selection and defaults. */
+function createAsset(input: BuilderInput<TilesetAsset> | null | undefined) {
+  const source = input ?? {};
+  return {
+    version: source.version ?? '1.0'
+  };
+}
+
+/** Builds tile with the legacy field selection and defaults. */
+function createTile(input: BuilderInput<TilesetTile> | null | undefined): TilesetTile {
+  const source = input ?? {};
+  return {
+    boundingVolume: source.boundingVolume ?? undefined,
+    geometricError: source.geometricError ?? undefined,
+    refine: source.refine ?? undefined,
+    content: source.content ?? undefined,
+    children: source.children!.map(tile => createTile(tile))
+  };
+}
+
+/** Builds tileset with the legacy field selection and defaults. */
+export function createTileset(input: BuilderInput<TilesetInput> | null | undefined) {
+  const source = input ?? {};
+  return {
+    asset: createAsset(source.asset),
+    geometricError: source.root!.geometricError,
+    root: createTile(source.root)
+  };
+}

package/src/v4/converter-cli.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import '@loaders.gl/polyfills';
+import '@loaders.gl/core/polyfills';
 import {join} from 'path';
 import inquirer from 'inquirer';
 import {I3SConverter, Tiles3DConverter} from '@loaders.gl/tile-converter';
@@ -11,8 +11,8 @@ import {
   getURLValue,
   validateOptionsWithEqual
 } from './lib/utils/cli-utils';
-import {addOneFile, composeHashFile, makeZipCDHeaderIterator} from '@loaders.gl/zip';
-import {NodeFile} from '@loaders.gl/loader-utils';
+import {addOneFile, composeHashFile, openZipArchive} from '@loaders.gl/archives/zip';
+import {NodeFile} from '@loaders.gl/core/loader-utils';
 // @ts-ignore
 import {copyFile} from 'node:fs/promises';
 
@@ -141,7 +141,13 @@ async function main() {
     if (finalPath !== validatedOptions.tileset) {
       await copyFile(validatedOptions.tileset, finalPath);
     }
-    const hashTable = await composeHashFile(makeZipCDHeaderIterator(new NodeFile(finalPath)));
+    const archive = await openZipArchive(new NodeFile(finalPath));
+    let hashTable: ArrayBuffer;
+    try {
+      hashTable = await composeHashFile(archive.entries());
+    } finally {
+      await archive.close();
+    }
     await addOneFile(finalPath, hashTable, '@specialIndexFileHASH128@');
 
     return;

package/src/v4/deps-installer/deps-installer.ts

@@ -3,10 +3,10 @@
 // Copyright vis.gl contributors
 
 import {load, fetchFile} from '@loaders.gl/core';
-import {ZipLoader} from '@loaders.gl/zip';
+import {ZipLoader} from '@loaders.gl/archives/zip';
 import {writeFile} from '../lib/utils/file-utils';
 import {join, dirname} from 'path';
-import {ChildProcessProxy} from '@loaders.gl/worker-utils';
+import {ChildProcessProxy} from '@loaders.gl/core/worker-utils';
 import {DRACO_EXTERNAL_LIBRARIES, DRACO_EXTERNAL_LIBRARY_URLS} from '@loaders.gl/draco';
 import {BASIS_EXTERNAL_LIBRARIES} from '@loaders.gl/textures';
 
@@ -42,7 +42,7 @@ export class DepsInstaller {
     await writeFile(depsPath, new Uint8Array(fileMap['geoids/egm2008-5.pgm']), 'egm2008-5.pgm');
 
     console.log('Installing "I3S Content Loader" worker'); // eslint-disable-line no-console
-    await this.installFromNpm('i3s', 'i3s-content-worker-node.js');
+    await this.installFromNpm('tiles-3d', 'i3s-content-worker-node.js');
 
     console.log('Installing "Draco Loader" worker'); // eslint-disable-line no-console
     await this.installFromNpm('draco', 'draco-worker-node.js');

package/src/v4/i3s-converter/helpers/attribute-metadata-info.ts

@@ -5,7 +5,7 @@ import type {
   Field,
   FieldInfo,
   PopupInfo
-} from '@loaders.gl/i3s';
+} from '@loaders.gl/tiles-3d/i3s';
 
 import {AttributeType} from '../types';
 

package/src/v4/i3s-converter/helpers/batch-ids-extensions.ts

@@ -1,16 +1,15 @@
+import type {ConversionAccessor, ConversionPrimitive} from './conversion-gltf';
 /* eslint-disable camelcase */
-import type {NumericArray} from '@loaders.gl/loader-utils';
+import type {NumericArray} from '@loaders.gl/core/loader-utils';
 import type {
-  GLTFAccessorPostprocessed,
-  GLTFMeshPrimitivePostprocessed,
   GLTF_EXT_feature_metadata_FeatureIdTexture,
   GLTF_EXT_feature_metadata_GLTF,
   GLTF_EXT_feature_metadata_Primitive,
   GLTF_EXT_mesh_features
 } from '@loaders.gl/gltf';
 import {EXT_MESH_FEATURES, EXT_FEATURE_METADATA} from '@loaders.gl/gltf';
-import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
-import {emod} from '@math.gl/geometry-utils';
+import {Tiles3DTileContent} from '@loaders.gl/tiles-3d/3d-tiles';
+import {emod} from '@math.gl/geometry/utils';
 import {TypedArray} from '@math.gl/core';
 import {TextureImageProperties} from '../types';
 
@@ -27,7 +26,7 @@ export function getTextureByMetadataClass(
   tileContent: Tiles3DTileContent,
   metadataClass?: string
 ): string | null {
-  const extFeatureMetadata = tileContent.gltf?.extensions?.[
+  const extFeatureMetadata = tileContent.gltf?.json.extensions?.[
     EXT_FEATURE_METADATA
   ] as GLTF_EXT_feature_metadata_GLTF;
   if (!extFeatureMetadata?.featureTextures) {
@@ -52,9 +51,9 @@ export function getTextureByMetadataClass(
  */
 export function handleBatchIdsExtensions(
   attributes: {
-    [key: string]: GLTFAccessorPostprocessed;
+    [key: string]: ConversionAccessor;
   },
-  primitive: GLTFMeshPrimitivePostprocessed,
+  primitive: ConversionPrimitive,
   images: (TextureImageProperties | null)[],
   featureTexture: string | null
 ): NumericArray {
@@ -90,7 +89,7 @@ export function handleBatchIdsExtensions(
  */
 function handleExtMeshFeaturesExtension(
   attributes: {
-    [key: string]: GLTFAccessorPostprocessed;
+    [key: string]: ConversionAccessor;
   },
   extMeshFeatures: GLTF_EXT_mesh_features
 ): NumericArray {
@@ -114,7 +113,7 @@ function handleExtMeshFeaturesExtension(
  */
 function handleExtFeatureMetadataExtension(
   attributes: {
-    [key: string]: GLTFAccessorPostprocessed;
+    [key: string]: ConversionAccessor;
   },
   extFeatureMetadata: GLTF_EXT_feature_metadata_Primitive,
   images: (TextureImageProperties | null)[],

package/src/v4/i3s-converter/helpers/conversion-gltf.ts

@@ -0,0 +1,108 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {GLTFScenegraph, getGLTFAccessor, getGLTFAccessorValue} from '@loaders.gl/gltf';
+import type {
+  GLTFWithBuffers,
+  GLTFAccessor,
+  GLTFNode,
+  GLTFMeshPrimitive,
+  GLTFMaterial,
+  GLTFTexture,
+  GLTFImage
+} from '@loaders.gl/gltf';
+import type {TypedArray} from '@math.gl/core';
+
+/** Packed geometry passed to the legacy conversion worker, independent of scene JSON. */
+export type ConversionAccessor = Omit<GLTFAccessor, 'bufferView' | 'sparse'> & {
+  value: TypedArray;
+  components: number;
+};
+/** Selected primitive data consumed by conversion workers. */
+export type ConversionPrimitive = Omit<GLTFMeshPrimitive, 'attributes' | 'indices' | 'material'> & {
+  attributes: Record<string, ConversionAccessor>;
+  indices?: ConversionAccessor;
+  material?: ConversionMaterial;
+};
+/** Selected mesh data consumed by conversion workers. */
+export type ConversionMesh = {primitives: ConversionPrimitive[]};
+/** Tree of placements passed to a conversion worker. */
+export type ConversionNode = Omit<GLTFNode, 'mesh' | 'children'> & {
+  mesh?: ConversionMesh;
+  children?: ConversionNode[];
+};
+/** Decoded image and optional encoded storage needed by the I3S writer. */
+export type ConversionImage = Omit<GLTFImage, 'bufferView'> & {
+  image: any;
+  bufferView?: {data: Uint8Array};
+};
+/** Selected texture data needed by the I3S writer. */
+export type ConversionTexture = Omit<GLTFTexture, 'source' | 'sampler'> & {
+  source?: ConversionImage;
+};
+/** Selected material data needed by the I3S writer. */
+export type ConversionMaterial = Omit<GLTFMaterial, 'pbrMetallicRoughness' | 'emissiveTexture'> & {
+  id: string;
+  uniqueId?: string;
+  pbrMetallicRoughness?: Omit<
+    NonNullable<GLTFMaterial['pbrMetallicRoughness']>,
+    'baseColorTexture'
+  > & {baseColorTexture?: {texture: ConversionTexture}};
+  emissiveTexture?: {texture: ConversionTexture};
+};
+
+/** Select decoded accessor data for the conversion worker without linking glTF resources. */
+export function getConversionAccessor(
+  gltf: GLTFWithBuffers,
+  reference: number | GLTFAccessor
+): ConversionAccessor {
+  const accessor = getGLTFAccessor(gltf, reference);
+  const {bufferView, sparse, ...metadata} = accessor;
+  const source = getGLTFAccessorValue(gltf, reference);
+  // Invoke the intrinsic typed-array copy; Node Buffer.slice() would retain borrowed storage.
+  const value = Uint8Array.prototype.slice.call(source) as TypedArray;
+  return {
+    ...metadata,
+    value,
+    components: accessor.type === 'SCALAR' ? 1 : Number(accessor.type.slice(3))
+  };
+}
+
+/** Resolve only the image and texture fields used by the legacy I3S material writer. */
+export function getConversionMaterials(gltf: GLTFWithBuffers): ConversionMaterial[] {
+  const scenegraph = new GLTFScenegraph(gltf);
+  const getTexture = (index: number): ConversionTexture => {
+    const texture = gltf.json.textures![index];
+    const image = texture.source === undefined ? undefined : gltf.json.images?.[texture.source];
+    return {
+      ...texture,
+      sampler: undefined,
+      source: image
+        ? {
+            ...image,
+            image: gltf.images?.[texture.source!],
+            bufferView:
+              image.bufferView === undefined
+                ? undefined
+                : {data: scenegraph.getTypedArrayForBufferView(image.bufferView)}
+          }
+        : undefined
+    } as ConversionTexture;
+  };
+  return (gltf.json.materials || []).map((material, index) => ({
+    ...material,
+    id: String(index),
+    pbrMetallicRoughness: material.pbrMetallicRoughness
+      ? {
+          ...material.pbrMetallicRoughness,
+          baseColorTexture: material.pbrMetallicRoughness.baseColorTexture
+            ? {texture: getTexture(material.pbrMetallicRoughness.baseColorTexture.index)}
+            : undefined
+        }
+      : undefined,
+    emissiveTexture: material.emissiveTexture
+      ? {texture: getTexture(material.emissiveTexture.index)}
+      : undefined
+  }));
+}

package/src/v4/i3s-converter/helpers/coordinate-converter.ts

@@ -1,14 +1,15 @@
-import type {BoundingVolumes, FullExtent, Mbs, Obb} from '@loaders.gl/i3s';
+import type {BoundingVolumes, FullExtent, Mbs, Obb} from '@loaders.gl/tiles-3d/i3s';
 
 import {Matrix3, Quaternion, Vector3} from '@math.gl/core';
 import {Ellipsoid} from '@math.gl/geospatial';
 import {
   OrientedBoundingBox,
   makeOrientedBoundingBoxFromPoints,
+  getOrientedBoundingBoxQuaternion,
   makeBoundingSphereFromPoints,
   BoundingSphere
-} from '@math.gl/culling';
-import {Geoid} from '@math.gl/geoid';
+} from '@math.gl/geometry/culling';
+import {Geoid} from '@math.gl/earth/geoid';
 
 /**
  * Create bounding volumes object from tile and geoid height model.
@@ -38,7 +39,7 @@ export function createBoundingVolumes(
   if (sourceBoundingVolume instanceof OrientedBoundingBox) {
     halfSize = sourceBoundingVolume.halfSize;
     radius = new Vector3(halfSize[0], halfSize[1], halfSize[2]).len();
-    quaternion = sourceBoundingVolume.quaternion;
+    quaternion = getOrientedBoundingBoxQuaternion(sourceBoundingVolume);
   } else {
     radius = sourceBoundingVolume.radius;
     halfSize = [radius, radius, radius];
@@ -84,7 +85,7 @@ export function createBoundingVolumesFromGeometry(
     obb: {
       center: obbCenter,
       halfSize: geometryObb.halfSize,
-      quaternion: geometryObb.quaternion
+      quaternion: getOrientedBoundingBoxQuaternion(geometryObb)
     }
   };
 }

package/src/v4/i3s-converter/helpers/create-scene-server-path.ts

@@ -1,9 +1,8 @@
-import type {SceneLayer3D} from '@loaders.gl/i3s';
-import {v4 as uuidv4} from 'uuid';
-import transform from 'json-map-transform';
+import type {SceneLayer3D} from '@loaders.gl/tiles-3d/i3s';
+import {randomUUID} from 'node:crypto';
 import {join} from 'path';
 
-import {SCENE_SERVER as sceneServerTemplate} from '../json-templates/scene-server';
+import {createSceneServer} from '../json-templates/scene-server';
 import {writeFile} from '../../lib/utils/file-utils';
 
 /**
@@ -18,12 +17,12 @@ export async function createSceneServerPath(
   rootPath: string
 ): Promise<void> {
   const sceneServerData = {
-    serviceItemId: uuidv4().replace(/-/gi, ''),
+    serviceItemId: randomUUID().replace(/-/gi, ''),
     layerName,
     layers0
   };
 
-  const sceneServer = transform(sceneServerData, sceneServerTemplate());
+  const sceneServer = createSceneServer(sceneServerData);
   const nodePagePath = join(rootPath, 'SceneServer');
   await writeFile(nodePagePath, JSON.stringify(sceneServer));
 }

package/src/v4/i3s-converter/helpers/feature-attributes.ts

@@ -1,8 +1,8 @@
 /* eslint-disable camelcase */
-import type {FeatureTableJson} from '@loaders.gl/3d-tiles';
-import type {Attribute} from '@loaders.gl/i3s';
+import type {FeatureTableJson} from '@loaders.gl/tiles-3d/3d-tiles';
+import type {Attribute} from '@loaders.gl/tiles-3d/i3s';
 import type {
-  GLTFPostprocessed,
+  GLTF,
   GLTF_EXT_feature_metadata_GLTF,
   GLTF_EXT_feature_metadata_ClassProperty,
   GLTF_EXT_structural_metadata_GLTF,
@@ -130,7 +130,7 @@ export function getAttributeTypesMapFromPropertyTable(
  * }
  */
 export const getAttributeTypesMapFromSchema = (
-  gltfJson: GLTFPostprocessed,
+  gltfJson: GLTF,
   metadataClass: string
 ): Record<string, Attribute> | null => {
   const attributeTypesMap: Record<string, Attribute> = {};

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

@@ -4,7 +4,7 @@ import type {
   GroupedByFeatureIdAttributes,
   GroupedAttributes
 } from '../types';
-import {concatenateTypedArrays} from '@loaders.gl/loader-utils';
+import {concatenateTypedArrays} from '@loaders.gl/core/loader-utils';
 
 const VALUES_PER_VERTEX = 3;
 const POSITIONS_AND_NORMALS_PER_TRIANGLE = 9;