@itwin/core-frontend 3.0.0-dev.170 → 3.0.0-dev.175

package/lib/esm/tile/GltfReader.js

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module Tiles
  */
-import { assert, ByteStream, JsonUtils, utf8ToString } from "@itwin/core-bentley";
+import { assert, ByteStream, compareBooleans, compareNumbers, compareStrings, Dictionary, JsonUtils, utf8ToString } from "@itwin/core-bentley";
 import { Angle, Matrix3d, Point2d, Point3d, Point4d, Range2d, Range3d, Transform, Vector3d } from "@itwin/core-geometry";
 import { BatchType, ColorDef, Feature, FeatureTable, FillFlags, GlbHeader, ImageSource, LinePixels, MeshEdge, MeshEdges, MeshPolyline, OctEncodedNormal, PackedFeatureTable, QParams2d, QParams3d, QPoint2dList, QPoint3dList, Quantization, RenderTexture, TextureMapping, TileFormat, TileReadStatus, } from "@itwin/core-common";
 import { getImageSourceFormatForMimeType, imageElementFromImageSource, tryImageElementFromUrl } from "../ImageUtil";
@@ -99,6 +99,12 @@ function getNodeMeshIds(node) {
         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;
@@ -283,21 +289,23 @@ const emptyDict = {};
 function colorFromJson(values) {
     return ColorDef.from(values[0] * 255, values[1] * 255, values[2] * 255, (1.0 - values[3]) * 255);
 }
-function colorFromMaterial(material) {
+function colorFromMaterial(material, isTransparent) {
     var _a, _b, _c, _d, _e;
-    if (material) {
-        if (isGltf1Material(material)) {
-            if (((_a = material.values) === null || _a === void 0 ? void 0 : _a.color) && Array.isArray(material.values.color))
-                return colorFromJson(material.values.color);
-        }
-        else if ((_d = (_c = (_b = material.extensions) === null || _b === void 0 ? void 0 : _b.KHR_techniques_webgl) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d.u_color) {
-            return colorFromJson(material.extensions.KHR_techniques_webgl.values.u_color);
-        }
-        else if ((_e = material.pbrMetallicRoughness) === null || _e === void 0 ? void 0 : _e.baseColorFactor) {
-            return colorFromJson(material.pbrMetallicRoughness.baseColorFactor);
-        }
+    let color = ColorDef.white;
+    if (isGltf1Material(material)) {
+        if (((_a = material.values) === null || _a === void 0 ? void 0 : _a.color) && Array.isArray(material.values.color))
+            color = colorFromJson(material.values.color);
+    }
+    else if ((_d = (_c = (_b = material.extensions) === null || _b === void 0 ? void 0 : _b.KHR_techniques_webgl) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d.u_color) {
+        color = colorFromJson(material.extensions.KHR_techniques_webgl.values.u_color);
+    }
+    else if ((_e = material.pbrMetallicRoughness) === null || _e === void 0 ? void 0 : _e.baseColorFactor) {
+        color = colorFromJson(material.pbrMetallicRoughness.baseColorFactor);
     }
-    return ColorDef.white;
+    // SPEC: Opaque materials ignore any alpha channel.
+    if (!isTransparent)
+        color = color.withTransparency(0);
+    return color;
 }
 class TransformStack {
     constructor() {
@@ -351,12 +359,25 @@ function* traverseNodes(ids, nodes, traversed) {
                 yield child;
     }
 }
+function compareTextureKeys(lhs, rhs) {
+    const cmp = compareBooleans(lhs.isTransparent, rhs.isTransparent);
+    if (0 !== cmp)
+        return cmp;
+    assert(typeof lhs.id === typeof rhs.id);
+    if ("string" === typeof lhs.id) {
+        assert("string" === typeof rhs.id);
+        return compareStrings(lhs.id, rhs.id);
+    }
+    assert("number" === typeof lhs.id && "number" === typeof rhs.id);
+    return compareNumbers(lhs.id, rhs.id);
+}
 /** Deserializes [glTF](https://www.khronos.org/gltf/).
  * @internal
  */
 export class GltfReader {
     constructor(args) {
         var _a, _b, _c, _d, _e, _f, _g;
+        this._resolvedTextures = new Dictionary((lhs, rhs) => compareTextureKeys(lhs, rhs));
         this._glTF = args.props.glTF;
         this._version = args.props.version;
         this._yAxisUp = args.props.yAxisUp;
@@ -654,22 +675,41 @@ export class GltfReader {
                 }
             }
         }
-        const id = extractId((_g = material.emissiveTexture) === null || _g === void 0 ? void 0 : _g.index);
-        return id !== null && id !== void 0 ? id : extractId((_j = (_h = material.pbrMetallicRoughness) === null || _h === void 0 ? void 0 : _h.baseColorTexture) === null || _j === void 0 ? void 0 : _j.index);
+        const id = extractId((_h = (_g = material.pbrMetallicRoughness) === null || _g === void 0 ? void 0 : _g.baseColorTexture) === null || _h === void 0 ? void 0 : _h.index);
+        return id !== null && id !== void 0 ? id : extractId((_j = material.emissiveTexture) === null || _j === void 0 ? void 0 : _j.index);
+    }
+    isMaterialTransparent(material) {
+        var _a, _b;
+        if (isGltf1Material(material)) {
+            if (this._glTF.techniques && undefined !== material.technique) {
+                const technique = this._glTF.techniques[material.technique];
+                if ((_b = (_a = technique === null || technique === void 0 ? void 0 : technique.states) === null || _a === void 0 ? void 0 : _a.enable) === null || _b === void 0 ? void 0 : _b.some((state) => state === GltfTechniqueState.Blend))
+                    return true;
+            }
+            return false;
+        }
+        else {
+            // Default: OPAQUE.
+            // ###TODO support MASK. For now treat as opaque.
+            return "BLEND" === material.alphaMode;
+        }
     }
-    createDisplayParams(materialJson, hasBakedLighting) {
-        const textureId = this.extractTextureId(materialJson);
-        const textureMapping = undefined !== textureId ? this.findTextureMapping(textureId) : undefined;
-        const color = colorFromMaterial(materialJson);
+    createDisplayParams(material, hasBakedLighting) {
+        const isTransparent = this.isMaterialTransparent(material);
+        const textureId = this.extractTextureId(material);
+        const textureMapping = undefined !== textureId ? this.findTextureMapping(textureId, isTransparent) : undefined;
+        const color = colorFromMaterial(material, isTransparent);
         return new DisplayParams(DisplayParams.Type.Mesh, color, color, 1, LinePixels.Solid, FillFlags.Always, undefined, undefined, hasBakedLighting, textureMapping);
     }
     readMeshPrimitive(primitive, featureTable, pseudoRtcBias) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const materialName = JsonUtils.asString(primitive.material);
-        const hasBakedLighting = undefined === primitive.attributes.NORMAL;
         const material = 0 < materialName.length ? this._materials[materialName] : undefined;
+        if (!material)
+            return undefined;
+        const hasBakedLighting = undefined === primitive.attributes.NORMAL || undefined !== ((_a = material.extensions) === null || _a === void 0 ? void 0 : _a.KHR_materials_unlit);
         const displayParams = material ? this.createDisplayParams(material, hasBakedLighting) : undefined;
-        if (undefined === displayParams)
+        if (!displayParams)
             return undefined;
         let primitiveType = -1;
         const meshMode = JsonUtils.asInt(primitive.mode, GltfMeshMode.Triangles);
@@ -707,9 +747,9 @@ export class GltfReader {
         if (undefined !== colorIndices && material) {
             let texStep;
             if (isGltf1Material(material))
-                texStep = (_a = material.values) === null || _a === void 0 ? void 0 : _a.texStep;
+                texStep = (_b = material.values) === null || _b === void 0 ? void 0 : _b.texStep;
             else
-                texStep = (_d = (_c = (_b = material.extensions) === null || _b === void 0 ? void 0 : _b.KHR_techniques_webgl) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d.u_texStep;
+                texStep = (_e = (_d = (_c = material.extensions) === null || _c === void 0 ? void 0 : _c.KHR_techniques_webgl) === null || _d === void 0 ? void 0 : _d.values) === null || _e === void 0 ? void 0 : _e.u_texStep;
             if (texStep) {
                 const uvParams = [];
                 for (let i = 0; i < colorIndices.count; i++)
@@ -719,7 +759,7 @@ export class GltfReader {
                 mesh.uvQParams = paramList.params;
             }
         }
-        if ((_e = primitive.extensions) === null || _e === void 0 ? void 0 : _e.KHR_draco_mesh_compression) {
+        if ((_f = primitive.extensions) === null || _f === void 0 ? void 0 : _f.KHR_draco_mesh_compression) {
             return undefined; // Defer Draco decompression until web workers implementation.
             /*
             const dracoExtension = primitive.extensions.KHR_draco_mesh_compression;
@@ -738,8 +778,12 @@ export class GltfReader {
                     return undefined;
                 if (!displayParams.ignoreLighting && !this.readNormals(mesh, primitive.attributes, "NORMAL"))
                     return undefined;
-                if (!mesh.uvs)
-                    this.readUVParams(mesh, primitive.attributes, "TEXCOORD_0");
+                if (!mesh.uvs) {
+                    let texCoordIndex = 0;
+                    if (!isGltf1Material(material) && undefined !== ((_h = (_g = material.pbrMetallicRoughness) === null || _g === void 0 ? void 0 : _g.baseColorTexture) === null || _h === void 0 ? void 0 : _h.texCoord))
+                        texCoordIndex = JsonUtils.asInt(material.pbrMetallicRoughness.baseColorTexture.texCoord);
+                    this.readUVParams(mesh, primitive.attributes, `TEXCOORD_${texCoordIndex}`);
+                }
                 if (this._deduplicateVertices && !this.deduplicateVertices(mesh))
                     return undefined;
                 break;
@@ -757,7 +801,7 @@ export class GltfReader {
         }
         if (displayParams.textureMapping && !mesh.uvs)
             return undefined;
-        if ((_f = primitive.extensions) === null || _f === void 0 ? void 0 : _f.CESIUM_primitive_outline) {
+        if ((_j = primitive.extensions) === null || _j === void 0 ? void 0 : _j.CESIUM_primitive_outline) {
             const data = this.readBufferData32(primitive.extensions.CESIUM_primitive_outline, "indices");
             if (data !== undefined) {
                 assert(0 === data.count % 2);
@@ -776,6 +820,8 @@ export class GltfReader {
         const indices = mesh.indices;
         if (indices instanceof Uint16Array && numPoints > 0xffff)
             mesh.indices = new Uint32Array(numPoints);
+        else if (indices instanceof Uint8Array && numPoints > 0xff)
+            mesh.indices = new Uint32Array(numPoints);
         const points = new Uint16Array(3 * numPoints);
         const normals = mesh.normals ? new Uint16Array(numPoints) : undefined;
         const uvs = mesh.uvs ? new Uint16Array(2 * numPoints) : undefined;
@@ -876,10 +922,22 @@ export class GltfReader {
     readBatchTable(_mesh, _json) {
     }
     readMeshIndices(mesh, json) {
-        const data = this.readBufferData16(json, "indices") || this.readBufferData32(json, "indices");
-        if (undefined === data || (!(data.buffer instanceof (Uint16Array)) && !(data.buffer instanceof (Uint32Array))))
+        var _a;
+        if (undefined !== json.indices) {
+            const data = this.readBufferData16(json, "indices") || this.readBufferData32(json, "indices");
+            if (data && (data.buffer instanceof Uint8Array || data.buffer instanceof Uint16Array || data.buffer instanceof Uint32Array)) {
+                mesh.indices = data.buffer;
+                return true;
+            }
+            return false;
+        }
+        // Non-indexed geometry. Manufacture triangle indices from points.
+        const numPoints = (_a = mesh.points) === null || _a === void 0 ? void 0 : _a.length;
+        if (undefined === numPoints || 0 !== numPoints % 3)
             return false;
-        mesh.indices = data.buffer;
+        mesh.indices = numPoints < 255 ? new Uint8Array(numPoints) : (numPoints < 0xffff ? new Uint16Array(numPoints) : new Uint32Array(numPoints));
+        for (let i = 0; i < numPoints; i++)
+            mesh.indices[i] = i;
         return true;
     }
     readNormals(mesh, json, accessorName) {
@@ -1017,9 +1075,6 @@ export class GltfReader {
                 if (!image.resolvedImage)
                     promises.push(this.resolveImage(image));
             await Promise.all(promises);
-            if (this._isCanceled)
-                return;
-            this.resolveTextures();
         }
         catch (_) {
         }
@@ -1077,64 +1132,33 @@ export class GltfReader {
         if (undefined !== url)
             image.resolvedImage = await tryImageElementFromUrl(url);
     }
-    resolveTextures() {
-        var _a, _b;
-        if (undefined === this._glTF.textures)
-            return;
-        // ###TODO this seems pretty hacky, and won't work for glTF 2.0 even if the KHR_techniques_webgl extension is used...
-        const transparentTextures = new Set();
-        if (this._glTF.techniques) {
-            for (const name of Object.keys(this._materials)) {
-                const material = this._materials[name];
-                if (material && isGltf1Material(material) && undefined !== material.technique && undefined !== ((_a = material.values) === null || _a === void 0 ? void 0 : _a.tex)) {
-                    const technique = this._glTF.techniques[material.technique];
-                    if ((_b = technique === null || technique === void 0 ? void 0 : technique.states) === null || _b === void 0 ? void 0 : _b.enable) {
-                        for (const enable of technique.states.enable) {
-                            if (3042 === enable) { // 3042 = BLEND
-                                transparentTextures.add(material.values.tex.toString());
-                                break;
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        for (const node of this.traverseScene()) {
-            for (const meshId of getNodeMeshIds(node)) {
-                const mesh = this._meshes[meshId];
-                if (!(mesh === null || mesh === void 0 ? void 0 : mesh.primitives))
-                    continue;
-                for (const primitive of mesh.primitives) {
-                    const material = undefined !== primitive.material ? this._materials[primitive.material] : undefined;
-                    const textureId = material ? this.extractTextureId(material) : undefined;
-                    if (undefined !== textureId)
-                        this.resolveTexture(textureId, transparentTextures.has(textureId));
-                }
-            }
-        }
-    }
     resolveTexture(textureId, isTransparent) {
         var _a;
         const texture = this._textures[textureId];
-        if (!texture || texture.resolvedTexture || undefined === texture.source)
-            return;
+        if (!texture || undefined === texture.source)
+            return false;
         const image = (_a = this._images[texture.source]) === null || _a === void 0 ? void 0 : _a.resolvedImage;
         if (!image)
-            return;
+            return false;
         const samplerId = texture.sampler;
         const sampler = undefined !== samplerId ? this._samplers[samplerId] : undefined;
-        const textureType = undefined !== (sampler === null || sampler === void 0 ? void 0 : sampler.wrapS) || undefined !== (sampler === null || sampler === void 0 ? void 0 : sampler.wrapT) ? RenderTexture.Type.TileSection : RenderTexture.Type.Normal;
-        texture.resolvedTexture = this._system.createTexture({
+        // ###TODO: RenderTexture should support different wrapping behavior for U vs V, and support mirrored repeat.
+        // For now, repeat unless either explicitly clamps.
+        const textureType = GltfWrapMode.ClampToEdge === (sampler === null || sampler === void 0 ? void 0 : sampler.wrapS) || GltfWrapMode.ClampToEdge === (sampler === null || sampler === void 0 ? void 0 : sampler.wrapT) ? RenderTexture.Type.TileSection : RenderTexture.Type.Normal;
+        const renderTexture = this._system.createTexture({
             type: textureType,
             image: {
                 source: image,
                 transparency: isTransparent ? TextureTransparency.Translucent : TextureTransparency.Opaque,
             },
         });
+        return renderTexture !== null && renderTexture !== void 0 ? renderTexture : false;
     }
-    findTextureMapping(textureId) {
-        const texture = this._textures[textureId];
-        return (texture === null || texture === void 0 ? void 0 : texture.resolvedTexture) ? new TextureMapping(texture.resolvedTexture, new TextureMapping.Params()) : undefined;
+    findTextureMapping(id, isTransparent) {
+        let texture = this._resolvedTextures.get({ id, isTransparent });
+        if (undefined === texture)
+            this._resolvedTextures.set({ id, isTransparent }, texture = this.resolveTexture(id, isTransparent));
+        return texture ? new TextureMapping(texture, new TextureMapping.Params()) : undefined;
     }
 }
 /** Produce a [[RenderGraphic]] from a [glTF](https://www.khronos.org/gltf/) asset suitable for use in [view decorations]($docs/learning/frontend/ViewDecorations).