@itwin/core-frontend 4.0.0-dev.41 → 4.0.0-dev.46

package/lib/esm/tile/GltfReader.js

@@ -16,102 +16,7 @@ import { RealityMeshParams } from "../render/RealityMeshParams";
 import { DisplayParams } from "../render/primitives/DisplayParams";
 import { Mesh } from "../render/primitives/mesh/MeshPrimitives";
 import { Triangle } from "../render/primitives/Primitives";
-/* eslint-disable no-restricted-syntax */
-/** Enumerates the types of [[GltfMeshPrimitive]] topologies. */
-var GltfMeshMode;
-(function (GltfMeshMode) {
-    GltfMeshMode[GltfMeshMode["Points"] = 0] = "Points";
-    GltfMeshMode[GltfMeshMode["Lines"] = 1] = "Lines";
-    GltfMeshMode[GltfMeshMode["LineStrip"] = 3] = "LineStrip";
-    GltfMeshMode[GltfMeshMode["Triangles"] = 4] = "Triangles";
-    /** Not currently supported. */
-    GltfMeshMode[GltfMeshMode["TriangleStrip"] = 5] = "TriangleStrip";
-    /** Not currently supported. */
-    GltfMeshMode[GltfMeshMode["TriangleFan"] = 6] = "TriangleFan";
-})(GltfMeshMode || (GltfMeshMode = {}));
-/** Enumerates the basic data types supported by accessors, material values, technique uniforms, etc.
- * @internal
- */
-export var GltfDataType;
-(function (GltfDataType) {
-    GltfDataType[GltfDataType["SignedByte"] = 5120] = "SignedByte";
-    GltfDataType[GltfDataType["UnsignedByte"] = 5121] = "UnsignedByte";
-    GltfDataType[GltfDataType["SignedShort"] = 5122] = "SignedShort";
-    GltfDataType[GltfDataType["UnsignedShort"] = 5123] = "UnsignedShort";
-    GltfDataType[GltfDataType["UInt32"] = 5125] = "UInt32";
-    GltfDataType[GltfDataType["Float"] = 5126] = "Float";
-    GltfDataType[GltfDataType["Rgb"] = 6407] = "Rgb";
-    GltfDataType[GltfDataType["Rgba"] = 6408] = "Rgba";
-    GltfDataType[GltfDataType["IntVec2"] = 35667] = "IntVec2";
-    GltfDataType[GltfDataType["IntVec3"] = 35668] = "IntVec3";
-    GltfDataType[GltfDataType["FloatVec2"] = 35664] = "FloatVec2";
-    GltfDataType[GltfDataType["FloatVec3"] = 35665] = "FloatVec3";
-    GltfDataType[GltfDataType["FloatVec4"] = 35666] = "FloatVec4";
-    GltfDataType[GltfDataType["FloatMat3"] = 35675] = "FloatMat3";
-    GltfDataType[GltfDataType["FloatMat4"] = 35676] = "FloatMat4";
-    GltfDataType[GltfDataType["Sampler2d"] = 35678] = "Sampler2d";
-})(GltfDataType || (GltfDataType = {}));
-/** @internal */
-var GltfMagFilter;
-(function (GltfMagFilter) {
-    GltfMagFilter[GltfMagFilter["Nearest"] = 9728] = "Nearest";
-    GltfMagFilter[GltfMagFilter["Linear"] = 9729] = "Linear";
-})(GltfMagFilter || (GltfMagFilter = {}));
-/** @internal */
-var GltfMinFilter;
-(function (GltfMinFilter) {
-    GltfMinFilter[GltfMinFilter["Nearest"] = 9728] = "Nearest";
-    GltfMinFilter[GltfMinFilter["Linear"] = 9729] = "Linear";
-    GltfMinFilter[GltfMinFilter["NearestMipMapNearest"] = 9984] = "NearestMipMapNearest";
-    GltfMinFilter[GltfMinFilter["LinearMipMapNearest"] = 9985] = "LinearMipMapNearest";
-    GltfMinFilter[GltfMinFilter["NearestMipMapLinear"] = 9986] = "NearestMipMapLinear";
-    GltfMinFilter[GltfMinFilter["LinearMipMapLinear"] = 9987] = "LinearMipMapLinear";
-})(GltfMinFilter || (GltfMinFilter = {}));
-/** Describes how texture coordinates outside of the range [0..1] are handled.
- * @internal
- */
-export var GltfWrapMode;
-(function (GltfWrapMode) {
-    GltfWrapMode[GltfWrapMode["ClampToEdge"] = 33071] = "ClampToEdge";
-    GltfWrapMode[GltfWrapMode["MirroredRepeat"] = 33648] = "MirroredRepeat";
-    GltfWrapMode[GltfWrapMode["Repeat"] = 10497] = "Repeat";
-})(GltfWrapMode || (GltfWrapMode = {}));
-/** Describes the intended target of a [[GltfBufferViewProps]]. */
-var GltfBufferTarget;
-(function (GltfBufferTarget) {
-    GltfBufferTarget[GltfBufferTarget["ArrayBuffer"] = 34962] = "ArrayBuffer";
-    GltfBufferTarget[GltfBufferTarget["ElementArrayBuffer"] = 24963] = "ElementArrayBuffer";
-})(GltfBufferTarget || (GltfBufferTarget = {}));
-function* dictionaryIterator(dict) {
-    if (Array.isArray(dict)) {
-        for (const elem of dict)
-            yield elem;
-    }
-    else {
-        for (const key of Object.keys(dict)) {
-            const value = dict[key];
-            if (undefined !== value)
-                yield value;
-        }
-    }
-}
-function getNodeMeshIds(node) {
-    if (undefined !== node.meshes)
-        return typeof node.meshes === "string" ? [node.meshes] : node.meshes;
-    else if (undefined !== node.mesh)
-        return [node.mesh];
-    return [];
-}
-/** GL states that can be enabled by a [[GltfTechnique]]. Only those queried by this implementation are enumerated. */
-var GltfTechniqueState;
-(function (GltfTechniqueState) {
-    /** Enables alpha blending. */
-    GltfTechniqueState[GltfTechniqueState["Blend"] = 3042] = "Blend";
-})(GltfTechniqueState || (GltfTechniqueState = {}));
-function isGltf1Material(material) {
-    const mat1 = material;
-    return undefined !== mat1.technique || undefined !== mat1.values;
-}
+import { getGltfNodeMeshIds, GltfDataType, gltfDictionaryIterator, GltfMeshMode, GltfTechniqueState, GltfWrapMode, isGltf1Material, traverseGltfNodes, } from "../gltf/GltfSchema";
 /**
  * A chunk of binary data exposed as a typed array.
  * The count member indicates how many elements exist. This may be less than this.buffer.length due to padding added to the
@@ -349,20 +254,6 @@ class TransformStack {
         this._stack.pop();
     }
 }
-function* traverseNodes(ids, nodes, traversed) {
-    for (const id of ids) {
-        if (traversed.has(id))
-            throw new Error("Cycle detected while traversing glTF nodes");
-        const node = nodes[id];
-        if (!node)
-            continue;
-        traversed.add(id);
-        yield node;
-        if (node.children)
-            for (const child of traverseNodes(node.children, nodes, traversed))
-                yield child;
-    }
-}
 function compareTextureKeys(lhs, rhs) {
     const cmp = compareBooleans(lhs.isTransparent, rhs.isTransparent);
     if (0 !== cmp)
@@ -436,7 +327,7 @@ export class GltfReader {
      * @throws Error if a node appears more than once during traversal
      */
     traverseNodes(nodeIds) {
-        return traverseNodes(nodeIds, this._nodes, new Set());
+        return traverseGltfNodes(nodeIds, this._nodes, new Set());
     }
     /** Traverse the nodes specified by their scene, recursing into their child nodes.
      * @throws Error if a node appears more than once during traversal
@@ -558,7 +449,7 @@ export class GltfReader {
         let thisBias;
         if (undefined !== pseudoRtcBias)
             thisBias = (undefined === thisTransform) ? pseudoRtcBias : thisTransform.matrix.multiplyInverse(pseudoRtcBias);
-        for (const meshKey of getNodeMeshIds(node)) {
+        for (const meshKey of getGltfNodeMeshIds(node)) {
             const nodeMesh = this._meshes[meshKey];
             if (nodeMesh?.primitives) {
                 const meshes = this.readMeshPrimitives(node, featureTable, thisTransform, thisBias);
@@ -776,7 +667,7 @@ export class GltfReader {
     }
     readMeshPrimitives(node, featureTable, thisTransform, thisBias) {
         const meshes = [];
-        for (const meshKey of getNodeMeshIds(node)) {
+        for (const meshKey of getGltfNodeMeshIds(node)) {
             const nodeMesh = this._meshes[meshKey];
             if (nodeMesh?.primitives) {
                 for (const primitive of nodeMesh.primitives) {
@@ -832,30 +723,43 @@ export class GltfReader {
             quantizePositions: true,
         });
         const mesh = new GltfMeshData(meshPrimitive);
-        // We don't have real colormap - just load material color.  This will be used if non-Bentley
-        // tile or fit the color table is uniform. For a non-Bentley, non-Uniform, we'll set the
-        // uv parameters to pick the colors out of the color map texture.
-        meshPrimitive.colorMap.insert(displayParams.fillColor.tbgr); // White...
-        const colorIndices = this.readBufferData16(primitive.attributes, "_COLORINDEX");
-        if (undefined !== colorIndices && material) {
-            let texStep;
-            if (isGltf1Material(material))
-                texStep = material.values?.texStep;
-            else
-                texStep = material.extensions?.KHR_techniques_webgl?.values?.u_texStep;
-            if (texStep) {
-                const uvParams = [];
-                for (let i = 0; i < colorIndices.count; i++)
-                    uvParams.push(new Point2d(texStep[1] + texStep[0] * colorIndices.buffer[i], .5));
-                const paramList = QPoint2dList.fromPoints(uvParams);
-                mesh.uvs = paramList.toTypedArray();
-                mesh.uvQParams = paramList.params;
+        // ###TODO_GLTF: There can be more than one color attribute; COLOR_0 might not be the one we want.
+        if (!this.readColors(mesh, primitive.attributes, "COLOR_0")) {
+            // We don't have real colormap - just load material color.  This will be used if non-Bentley
+            // tile or fit the color table is uniform. For a non-Bentley, non-Uniform, we'll set the
+            // uv parameters to pick the colors out of the color map texture.
+            meshPrimitive.colorMap.insert(displayParams.fillColor.tbgr); // White...
+            // _COLORINDEX is an ancient holdover from glTF 1.0 and Bimium...unlikely to actually encounter it in the wild.
+            const colorIndices = this.readBufferData16(primitive.attributes, "_COLORINDEX");
+            if (undefined !== colorIndices && material) {
+                let texStep;
+                if (isGltf1Material(material))
+                    texStep = material.values?.texStep;
+                else
+                    texStep = material.extensions?.KHR_techniques_webgl?.values?.u_texStep;
+                if (texStep) {
+                    const uvParams = [];
+                    for (let i = 0; i < colorIndices.count; i++)
+                        uvParams.push(new Point2d(texStep[1] + texStep[0] * colorIndices.buffer[i], .5));
+                    const paramList = QPoint2dList.fromPoints(uvParams);
+                    mesh.uvs = paramList.toTypedArray();
+                    mesh.uvQParams = paramList.params;
+                }
             }
         }
         const draco = primitive.extensions?.KHR_draco_mesh_compression;
         if (draco)
             return this.readDracoMeshPrimitive(mesh.primitive, draco) ? mesh : undefined;
         this.readBatchTable(mesh.primitive, primitive);
+        if (mesh.primitive.features) {
+            const features = this.readPrimitiveFeatures(primitive);
+            if (features) {
+                if (features instanceof Feature)
+                    mesh.primitive.features.add(features, 1);
+                else
+                    mesh.primitive.features.setIndices(features);
+            }
+        }
         if (!this.readVertices(mesh, primitive, pseudoRtcBias))
             return undefined;
         switch (primitiveType) {
@@ -1017,14 +921,12 @@ export class GltfReader {
         else {
             if (GltfDataType.UnsignedShort !== view.type)
                 return false;
-            const extensions = JsonUtils.asObject(view.accessor.extensions);
-            const quantized = undefined !== extensions ? JsonUtils.asObject(extensions.WEB3D_quantized_attributes) : undefined;
-            if (undefined === quantized)
-                return false;
-            const rangeMin = JsonUtils.asArray(quantized.decodedMin);
-            const rangeMax = JsonUtils.asArray(quantized.decodedMax);
-            if (undefined === rangeMin || undefined === rangeMax)
+            const quantized = view.accessor.extensions?.WEB3D_quantized_attributes;
+            const rangeMin = quantized?.decodedMin;
+            const rangeMax = quantized?.decodedMax;
+            if (!rangeMin || !rangeMax) // required by spec...
                 return false;
+            // ###TODO apply WEB3D_quantized_attributes.decodeMatrix? Have not encountered in the wild; glTF 1.0 only.
             const buffer = view.toBufferData(GltfDataType.UnsignedShort);
             if (undefined === buffer || !(buffer.buffer instanceof Uint16Array))
                 return false;
@@ -1061,6 +963,9 @@ export class GltfReader {
     }
     readBatchTable(_mesh, _json) {
     }
+    readPrimitiveFeatures(_primitive) {
+        return undefined;
+    }
     readMeshIndices(mesh, json) {
         if (undefined !== json.indices) {
             const data = this.readBufferData16(json, "indices") || this.readBufferData32(json, "indices");
@@ -1115,6 +1020,27 @@ export class GltfReader {
                 return false;
         }
     }
+    readColors(mesh, attribute, accessorName) {
+        const view = this.getBufferView(attribute, accessorName);
+        if (!view || (GltfDataType.Float !== view.type && GltfDataType.UnsignedByte !== view.type && GltfDataType.SignedByte !== view.type))
+            return false;
+        const data = view.toBufferData(view.type);
+        if (!data)
+            return false;
+        const hasAlpha = "VEC4" === view.accessor.type;
+        const factor = view.type === GltfDataType.Float ? 255 : 1;
+        const rgbt = new Uint8Array(4);
+        const color = new Uint32Array(rgbt.buffer);
+        for (let i = 0; i < data.count; i++) {
+            const index = view.stride * i;
+            rgbt[0] = data.buffer[index] * factor;
+            rgbt[1] = data.buffer[index + 1] * factor;
+            rgbt[2] = data.buffer[index + 2] * factor;
+            rgbt[3] = hasAlpha ? (255 - data.buffer[index + 3] * factor) : 0;
+            mesh.primitive.colors.push(mesh.primitive.colorMap.insert(color[0]));
+        }
+        return true;
+    }
     readUVParams(mesh, json, accessorName) {
         const view = this.getBufferView(json, accessorName);
         if (view === undefined)
@@ -1139,12 +1065,9 @@ export class GltfReader {
                 return true;
             }
             case GltfDataType.UnsignedShort: {
-                const extensions = JsonUtils.asObject(view.accessor.extensions);
-                const quantized = undefined !== extensions ? JsonUtils.asObject(extensions.WEB3D_quantized_attributes) : undefined;
-                if (undefined === quantized)
-                    return false;
-                const rangeMin = JsonUtils.asArray(quantized.decodedMin);
-                const rangeMax = JsonUtils.asArray(quantized.decodedMax);
+                const quantized = view.accessor.extensions?.WEB3D_quantized_attributes;
+                const rangeMin = quantized?.decodedMin;
+                const rangeMax = quantized?.decodedMax;
                 if (undefined === rangeMin || undefined === rangeMax)
                     return false;
                 const qData = view.toBufferData(GltfDataType.UnsignedShort);
@@ -1204,7 +1127,7 @@ export class GltfReader {
         // If any meshes are draco-compressed, dynamically load the decoder module and then decode the meshes.
         const dracoMeshes = [];
         for (const node of this.traverseScene()) {
-            for (const meshId of getNodeMeshIds(node)) {
+            for (const meshId of getGltfNodeMeshIds(node)) {
                 const mesh = this._meshes[meshId];
                 if (mesh?.primitives)
                     for (const primitive of mesh.primitives)
@@ -1228,14 +1151,14 @@ export class GltfReader {
         // be required for the scene.
         const promises = [];
         try {
-            for (const buffer of dictionaryIterator(this._buffers))
+            for (const buffer of gltfDictionaryIterator(this._buffers))
                 if (!buffer.resolvedBuffer)
                     promises.push(this.resolveBuffer(buffer));
             await Promise.all(promises);
             if (this._isCanceled)
                 return;
             promises.length = 0;
-            for (const image of dictionaryIterator(this._images))
+            for (const image of gltfDictionaryIterator(this._images))
                 if (!image.resolvedImage)
                     promises.push(this.resolveImage(image));
             await Promise.all(promises);
@@ -1258,7 +1181,9 @@ export class GltfReader {
     }
     resolveUrl(uri) {
         try {
-            return new URL(uri, this._baseUrl).toString();
+            const resolved = new URL(uri, this._baseUrl);
+            resolved.search = this._baseUrl?.search ?? "";
+            return resolved.toString();
         }
         catch (_) {
             return undefined;
@@ -1387,7 +1312,8 @@ export class GltfReader {
  * @public
  */
 export async function readGltfGraphics(args) {
-    const props = GltfReaderProps.create(args.gltf, true, args.baseUrl); // glTF supports exactly one coordinate system with y axis up.
+    const baseUrl = typeof args.baseUrl === "string" ? new URL(args.baseUrl) : args.baseUrl;
+    const props = GltfReaderProps.create(args.gltf, true, baseUrl); // glTF supports exactly one coordinate system with y axis up.
     const reader = props ? new GltfGraphicsReader(props, args) : undefined;
     if (!reader)
         return undefined;