@itwin/core-common 4.0.0-dev.6 → 4.0.0-dev.60

package/lib/esm/TextureMapping.js

@@ -1,171 +1,177 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-import { Matrix3d, Point2d, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
-/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].
- * @public
- */
-export class TextureMapping {
-    constructor(tx, params) {
-        this.texture = tx;
-        this.params = params;
-    }
-    /** @internal */
-    computeUVParams(visitor, transformToImodel) {
-        return this.params.computeUVParams(visitor, transformToImodel);
-    }
-}
-/** @public */
-(function (TextureMapping) {
-    /** Enumerates the possible texture mapping modes. */
-    let Mode;
-    (function (Mode) {
-        Mode[Mode["None"] = -1] = "None";
-        Mode[Mode["Parametric"] = 0] = "Parametric";
-        Mode[Mode["ElevationDrape"] = 1] = "ElevationDrape";
-        Mode[Mode["Planar"] = 2] = "Planar";
-        /** @internal */
-        Mode[Mode["DirectionalDrape"] = 3] = "DirectionalDrape";
-        /** @internal */
-        Mode[Mode["Cubic"] = 4] = "Cubic";
-        /** @internal */
-        Mode[Mode["Spherical"] = 5] = "Spherical";
-        /** @internal */
-        Mode[Mode["Cylindrical"] = 6] = "Cylindrical";
-        /** @internal */
-        Mode[Mode["Solid"] = 7] = "Solid";
-        /** @internal Only valid for lights */
-        Mode[Mode["FrontProject"] = 8] = "FrontProject";
-    })(Mode = TextureMapping.Mode || (TextureMapping.Mode = {}));
-    /** A 2x3 matrix for mapping a texture image to a surface. */
-    class Trans2x3 {
-        /** Construct from the two rows of the matrix:
-         * ```
-         *  | m00 m01 originX |
-         *  | m10 m11 originY |
-         * ```
-         * Producing the [Transform]($core-geometry):
-         * ```
-         *  | m00 m01 0 originX |
-         *  | m10 m11 0 originY |
-         *  | 0   0   1 0       |
-         * ```
-         */
-        constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {
-            const origin = new Point3d(originX, originY, 0);
-            const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);
-            this.transform = Transform.createRefs(origin, matrix);
-        }
-    }
-    /** An immutable 2x3 identity matrix. */
-    Trans2x3.identity = new Trans2x3();
-    TextureMapping.Trans2x3 = Trans2x3;
-    /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */
-    class Params {
-        constructor(props) {
-            var _a, _b, _c, _d;
-            this.textureMatrix = (_a = props === null || props === void 0 ? void 0 : props.textureMat2x3) !== null && _a !== void 0 ? _a : Trans2x3.identity;
-            this.weight = (_b = props === null || props === void 0 ? void 0 : props.textureWeight) !== null && _b !== void 0 ? _b : 1;
-            this.mode = (_c = props === null || props === void 0 ? void 0 : props.mapMode) !== null && _c !== void 0 ? _c : Mode.Parametric;
-            this.worldMapping = (_d = props === null || props === void 0 ? void 0 : props.worldMapping) !== null && _d !== void 0 ? _d : false;
-        }
-        /**
-         * Generates UV parameters for textured surfaces. Returns undefined on failure.
-         * @internal
-         */
-        computeUVParams(visitor, transformToImodel) {
-            switch (this.mode) {
-                default: // Fall through to parametric in default case
-                case TextureMapping.Mode.Parametric: {
-                    return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);
-                }
-                case TextureMapping.Mode.Planar: {
-                    const normalIndices = visitor.normalIndex;
-                    if (!normalIndices)
-                        return undefined;
-                    // Ignore planar mode unless master or sub units for scaleMode and facet is planar
-                    if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {
-                        return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);
-                    }
-                    else {
-                        return this.computePlanarUVParams(visitor, this.textureMatrix.transform);
-                    }
-                }
-                case TextureMapping.Mode.ElevationDrape: {
-                    return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);
-                }
-            }
-        }
-        /** Computes UV parameters given a texture mapping mode of parametric. */
-        computeParametricUVParams(visitor, uvTransform, isRelativeUnits) {
-            const params = [];
-            for (let i = 0; i < visitor.numEdgesThisFacet; i++) {
-                let param = Point2d.create();
-                if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {
-                    if (!visitor.tryGetNormalizedParameter(i, param)) {
-                        // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present
-                        param = visitor.getParam(i);
-                    }
-                }
-                params.push(uvTransform.multiplyPoint2d(param));
-            }
-            return params;
-        }
-        /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */
-        computePlanarUVParams(visitor, uvTransform) {
-            const params = [];
-            const points = visitor.point;
-            let normal;
-            if (visitor.normal === undefined)
-                normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));
-            else
-                normal = visitor.normal.getVector3dAtCheckedVectorIndex(0);
-            if (!normal.normalize(normal))
-                return undefined;
-            // adjust U texture coordinate to be a continuous length starting at the
-            // origin. V coordinate stays the same. This mode assumes Z is up vector
-            // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system
-            normal.scale(-1.0, normal);
-            // pick the first vertex normal
-            const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);
-            // if the magnitude of the normal is near zero, the real normal points
-            // almost straighten up.. In this case, use Y as the up vector to match QV
-            const magnitude = sideVector.magnitude();
-            sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..
-            if (magnitude < 1e-3) {
-                normal.set(0, 0, -1);
-                sideVector.set(1, 0, 0);
-            }
-            const upVector = sideVector.crossProduct(normal).normalize();
-            if (!upVector)
-                return undefined;
-            const numEdges = visitor.numEdgesThisFacet;
-            for (let i = 0; i < numEdges; i++) {
-                const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));
-                params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));
-                uvTransform.multiplyPoint2d(params[i], params[i]);
-            }
-            return params;
-        }
-        /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */
-        computeElevationDrapeUVParams(visitor, uvTransform, transformToIModel) {
-            const params = [];
-            const numEdges = visitor.numEdgesThisFacet;
-            for (let i = 0; i < numEdges; i++) {
-                const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);
-                if (transformToIModel !== undefined)
-                    transformToIModel.multiplyPoint3d(point, point);
-                params.push(Point2d.createFrom(point));
-                uvTransform.multiplyPoint2d(params[i], params[i]);
-            }
-            return params;
-        }
-    }
-    TextureMapping.Params = Params;
-})(TextureMapping || (TextureMapping = {}));
-Object.freeze(TextureMapping.Trans2x3.identity);
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { Matrix3d, Point2d, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
+/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].
+ * @public
+ */
+export class TextureMapping {
+    constructor(tx, params) {
+        this.texture = tx;
+        this.params = params;
+    }
+    /** @internal */
+    computeUVParams(visitor, transformToImodel) {
+        return this.params.computeUVParams(visitor, transformToImodel);
+    }
+}
+/** @public */
+(function (TextureMapping) {
+    /** Enumerates the possible texture mapping modes. */
+    let Mode;
+    (function (Mode) {
+        Mode[Mode["None"] = -1] = "None";
+        Mode[Mode["Parametric"] = 0] = "Parametric";
+        Mode[Mode["ElevationDrape"] = 1] = "ElevationDrape";
+        Mode[Mode["Planar"] = 2] = "Planar";
+        /** @internal */
+        Mode[Mode["DirectionalDrape"] = 3] = "DirectionalDrape";
+        /** @internal */
+        Mode[Mode["Cubic"] = 4] = "Cubic";
+        /** @internal */
+        Mode[Mode["Spherical"] = 5] = "Spherical";
+        /** @internal */
+        Mode[Mode["Cylindrical"] = 6] = "Cylindrical";
+        /** @internal */
+        Mode[Mode["Solid"] = 7] = "Solid";
+        /** @internal Only valid for lights */
+        Mode[Mode["FrontProject"] = 8] = "FrontProject";
+    })(Mode = TextureMapping.Mode || (TextureMapping.Mode = {}));
+    /** A 2x3 matrix for mapping a texture image to a surface. */
+    class Trans2x3 {
+        /** Construct from the two rows of the matrix:
+         * ```
+         *  | m00 m01 originX |
+         *  | m10 m11 originY |
+         * ```
+         * Producing the [Transform]($core-geometry):
+         * ```
+         *  | m00 m01 0 originX |
+         *  | m10 m11 0 originY |
+         *  | 0   0   1 0       |
+         * ```
+         */
+        constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {
+            const origin = new Point3d(originX, originY, 0);
+            const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);
+            this.transform = Transform.createRefs(origin, matrix);
+        }
+    }
+    /** An immutable 2x3 identity matrix. */
+    Trans2x3.identity = new Trans2x3();
+    TextureMapping.Trans2x3 = Trans2x3;
+    /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */
+    class Params {
+        constructor(props) {
+            this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;
+            this.weight = props?.textureWeight ?? 1;
+            this.mode = props?.mapMode ?? Mode.Parametric;
+            this.worldMapping = props?.worldMapping ?? false;
+            this.useConstantLod = props?.useConstantLod ?? false;
+            this.constantLodParams = {
+                repetitions: props?.constantLodParams?.repetitions ?? 1,
+                offset: props?.constantLodParams?.offset ?? { x: 0, y: 0 },
+                minDistClamp: props?.constantLodParams?.minDistClamp ?? 1,
+                maxDistClamp: props?.constantLodParams?.maxDistClamp ?? 4096 * 1024 * 1024,
+            };
+        }
+        /**
+         * Generates UV parameters for textured surfaces. Returns undefined on failure.
+         * @internal
+         */
+        computeUVParams(visitor, transformToImodel) {
+            switch (this.mode) {
+                default: // Fall through to parametric in default case
+                case TextureMapping.Mode.Parametric: {
+                    return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);
+                }
+                case TextureMapping.Mode.Planar: {
+                    const normalIndices = visitor.normalIndex;
+                    if (!normalIndices)
+                        return undefined;
+                    // Ignore planar mode unless master or sub units for scaleMode and facet is planar
+                    if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {
+                        return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);
+                    }
+                    else {
+                        return this.computePlanarUVParams(visitor, this.textureMatrix.transform);
+                    }
+                }
+                case TextureMapping.Mode.ElevationDrape: {
+                    return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);
+                }
+            }
+        }
+        /** Computes UV parameters given a texture mapping mode of parametric. */
+        computeParametricUVParams(visitor, uvTransform, isRelativeUnits) {
+            const params = [];
+            for (let i = 0; i < visitor.numEdgesThisFacet; i++) {
+                let param = Point2d.create();
+                if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {
+                    if (!visitor.tryGetNormalizedParameter(i, param)) {
+                        // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present
+                        param = visitor.getParam(i);
+                    }
+                }
+                params.push(uvTransform.multiplyPoint2d(param));
+            }
+            return params;
+        }
+        /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */
+        computePlanarUVParams(visitor, uvTransform) {
+            const params = [];
+            const points = visitor.point;
+            let normal;
+            if (visitor.normal === undefined)
+                normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));
+            else
+                normal = visitor.normal.getVector3dAtCheckedVectorIndex(0);
+            if (!normal.normalize(normal))
+                return undefined;
+            // adjust U texture coordinate to be a continuous length starting at the
+            // origin. V coordinate stays the same. This mode assumes Z is up vector
+            // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system
+            normal.scale(-1.0, normal);
+            // pick the first vertex normal
+            const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);
+            // if the magnitude of the normal is near zero, the real normal points
+            // almost straighten up.. In this case, use Y as the up vector to match QV
+            const magnitude = sideVector.magnitude();
+            sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..
+            if (magnitude < 1e-3) {
+                normal.set(0, 0, -1);
+                sideVector.set(1, 0, 0);
+            }
+            const upVector = sideVector.crossProduct(normal).normalize();
+            if (!upVector)
+                return undefined;
+            const numEdges = visitor.numEdgesThisFacet;
+            for (let i = 0; i < numEdges; i++) {
+                const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));
+                params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));
+                uvTransform.multiplyPoint2d(params[i], params[i]);
+            }
+            return params;
+        }
+        /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */
+        computeElevationDrapeUVParams(visitor, uvTransform, transformToIModel) {
+            const params = [];
+            const numEdges = visitor.numEdgesThisFacet;
+            for (let i = 0; i < numEdges; i++) {
+                const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);
+                if (transformToIModel !== undefined)
+                    transformToIModel.multiplyPoint3d(point, point);
+                params.push(Point2d.createFrom(point));
+                uvTransform.multiplyPoint2d(params[i], params[i]);
+            }
+            return params;
+        }
+    }
+    TextureMapping.Params = Params;
+})(TextureMapping || (TextureMapping = {}));
+Object.freeze(TextureMapping.Trans2x3.identity);
 //# sourceMappingURL=TextureMapping.js.map

package/lib/esm/TextureMapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAA0B,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAmB,SAAS,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAiBhI;;GAEG;AACH,MAAM,OAAO,cAAc;IAUzB,YAAmB,EAAiB,EAAE,MAA6B;QACjE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,eAAe,CAAC,OAAwB,EAAE,iBAA4B;QAC3E,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,CAAC;CACF;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,qDAAqD;IACrD,IAAY,IAiBX;IAjBD,WAAY,IAAI;QACd,gCAAS,CAAA;QACT,2CAAc,CAAA;QACd,mDAAkB,CAAA;QAClB,mCAAU,CAAA;QACV,gBAAgB;QAChB,uDAAoB,CAAA;QACpB,gBAAgB;QAChB,iCAAS,CAAA;QACT,gBAAgB;QAChB,yCAAa,CAAA;QACb,gBAAgB;QAChB,6CAAe,CAAA;QACf,gBAAgB;QAChB,iCAAS,CAAA;QACT,sCAAsC;QACtC,+CAAgB,CAAA;IAClB,CAAC,EAjBW,IAAI,GAAJ,mBAAI,KAAJ,mBAAI,QAiBf;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QAInB;;;;;;;;;;;WAWG;QACH,YAAmB,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC;YAC7E,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;;IAED,wCAAwC;IACjB,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAvBtC,uBAAQ,WAwBpB,CAAA;IAoBD,oFAAoF;IACpF,MAAa,MAAM;QAYjB,YAAmB,KAAiC;;YAClD,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,QAAQ,CAAC,QAAQ,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,IAAI,CAAC,UAAU,CAAC;YAC9C,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,mCAAI,KAAK,CAAC;QACnD,CAAC;QAED;;;WAGG;QACI,eAAe,CAAC,OAA+B,EAAE,iBAA4B;YAClF,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACjB,QAAQ,CAAE,6CAA6C;gBACvD,KAAK,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACnC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAClG;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;oBAC1C,IAAI,CAAC,aAAa;wBAChB,OAAO,SAAS,CAAC;oBAEnB,kFAAkF;oBAClF,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;wBACjJ,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;qBAClG;yBAAM;wBACL,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;qBAC1E;iBACF;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;oBACvC,OAAO,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;iBACrG;aACF;QACH,CAAC;QAED,yEAAyE;QACjE,yBAAyB,CAAC,OAA+B,EAAE,WAAsB,EAAE,eAAwB;YACjH,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE;gBAClD,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;gBAE7B,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;oBACjE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;wBAChD,wGAAwG;wBACxG,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC;qBAC9B;iBACF;gBAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,sHAAsH;QAC9G,qBAAqB,CAAC,OAA+B,EAAE,WAAsB;YACnF,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAC7B,IAAI,MAAgB,CAAC;YAErB,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAC9B,MAAM,GAAG,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;;gBAE9J,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAE,CAAC;YAE9D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC3B,OAAO,SAAS,CAAC;YAEnB,wEAAwE;YACxE,wEAAwE;YAExE,sGAAsG;YACtG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAE3B,+BAA+B;YAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAE7D,sEAAsE;YACtE,0EAA0E;YAE1E,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;YACzC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,4DAA4D;YAE9F,IAAI,SAAS,GAAG,IAAI,EAAE;gBACpB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrB,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;aACzB;YAED,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,IAAI,CAAC,QAAQ;gBACX,OAAO,SAAS,CAAC;YAEnB,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9E,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxF,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+HAA+H;QACvH,6BAA6B,CAAC,OAA+B,EAAE,WAAsB,EAAE,iBAA6B;YAC1H,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,iBAAiB,KAAK,SAAS;oBACjC,iBAAiB,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAElD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IAhIY,qBAAM,SAgIlB,CAAA;AACH,CAAC,EApMgB,cAAc,KAAd,cAAc,QAoM9B;AAED,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d } from \"@itwin/core-geometry\";\r\nimport { RenderTexture } from \"./RenderTexture\";\r\n\r\n/** Defines normal map parameters.\r\n * @beta\r\n */\r\nexport interface NormalMapParams {\r\n  /** The texture to use as a normal map. If not present then the pattern map texture will be used as a normal map. */\r\n  normalMap?: RenderTexture;\r\n  /** True if the Y component stored in the green channel should be negated. By default, positive Y points downward, but some\r\n   * normal maps are created with positive Y pointing upward.\r\n   */\r\n  greenUp?: boolean;\r\n  /** Scale factor by which to multiply the components of the normal extracted from [[normalMap]]. */\r\n  scale?: number;\r\n}\r\n\r\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\r\n * @public\r\n */\r\nexport class TextureMapping {\r\n  /** The texture to be mapped to the surface. If normalMapParams is present but does not contain a normal map, then texture is used as a normal map rather than a pattern map. */\r\n  public readonly texture: RenderTexture;\r\n  /** The parameters for normal mapping.\r\n   * @beta\r\n   */\r\n  public normalMapParams?: NormalMapParams;\r\n  /** The parameters describing how the textures are mapped to the surface. */\r\n  public readonly params: TextureMapping.Params;\r\n\r\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\r\n    this.texture = tx;\r\n    this.params = params;\r\n  }\r\n\r\n  /** @internal */\r\n  public computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\r\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, transformToImodel);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace TextureMapping { // eslint-disable-line no-redeclare\r\n  /** Enumerates the possible texture mapping modes. */\r\n  export enum Mode {\r\n    None = -1,\r\n    Parametric = 0,\r\n    ElevationDrape = 1,\r\n    Planar = 2,\r\n    /** @internal */\r\n    DirectionalDrape = 3,\r\n    /** @internal */\r\n    Cubic = 4,\r\n    /** @internal */\r\n    Spherical = 5,\r\n    /** @internal */\r\n    Cylindrical = 6,\r\n    /** @internal */\r\n    Solid = 7,\r\n    /** @internal Only valid for lights */\r\n    FrontProject = 8,\r\n  }\r\n\r\n  /** A 2x3 matrix for mapping a texture image to a surface. */\r\n  export class Trans2x3 {\r\n    /** The 3x4 transform produced from the 2x3 matrix. */\r\n    public readonly transform: Transform;\r\n\r\n    /** Construct from the two rows of the matrix:\r\n     * ```\r\n     *  | m00 m01 originX |\r\n     *  | m10 m11 originY |\r\n     * ```\r\n     * Producing the [Transform]($core-geometry):\r\n     * ```\r\n     *  | m00 m01 0 originX |\r\n     *  | m10 m11 0 originY |\r\n     *  | 0   0   1 0       |\r\n     * ```\r\n     */\r\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\r\n      const origin = new Point3d(originX, originY, 0);\r\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\r\n      this.transform = Transform.createRefs(origin, matrix);\r\n    }\r\n\r\n    /** An immutable 2x3 identity matrix. */\r\n    public static readonly identity = new Trans2x3();\r\n  }\r\n\r\n  /** Properties used to construct a [[TextureMapping.Params]]. */\r\n  export interface ParamProps {\r\n    /** The matrix used to map the image to a surface. */\r\n    textureMat2x3?: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\r\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\r\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\r\n     * @note Defaults to 1.0\r\n     */\r\n    textureWeight?: number;\r\n    /** The mode by which to map the image to a surface.\r\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\r\n     */\r\n    mapMode?: TextureMapping.Mode;\r\n    /** @internal */\r\n    worldMapping?: boolean;\r\n  }\r\n\r\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\r\n  export class Params {\r\n    /** The matrix used to map the image to a surface. */\r\n    public textureMatrix: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\r\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\r\n     */\r\n    public weight: number;\r\n    /** The mode by which to map the image to a surface. */\r\n    public mode: TextureMapping.Mode;\r\n    /** @internal */\r\n    public worldMapping: boolean;\r\n\r\n    public constructor(props?: TextureMapping.ParamProps) {\r\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\r\n      this.weight = props?.textureWeight ?? 1;\r\n      this.mode = props?.mapMode ?? Mode.Parametric;\r\n      this.worldMapping = props?.worldMapping ?? false;\r\n    }\r\n\r\n    /**\r\n     * Generates UV parameters for textured surfaces. Returns undefined on failure.\r\n     * @internal\r\n     */\r\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\r\n      switch (this.mode) {\r\n        default:  // Fall through to parametric in default case\r\n        case TextureMapping.Mode.Parametric: {\r\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n        }\r\n        case TextureMapping.Mode.Planar: {\r\n          const normalIndices = visitor.normalIndex;\r\n          if (!normalIndices)\r\n            return undefined;\r\n\r\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\r\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\r\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n          } else {\r\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\r\n          }\r\n        }\r\n        case TextureMapping.Mode.ElevationDrape: {\r\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);\r\n        }\r\n      }\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of parametric. */\r\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\r\n        let param = Point2d.create();\r\n\r\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\r\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\r\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\r\n            param = visitor.getParam(i)!;\r\n          }\r\n        }\r\n\r\n        params.push(uvTransform.multiplyPoint2d(param));\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\r\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\r\n      const params: Point2d[] = [];\r\n      const points = visitor.point;\r\n      let normal: Vector3d;\r\n\r\n      if (visitor.normal === undefined)\r\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\r\n      else\r\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\r\n\r\n      if (!normal.normalize(normal))\r\n        return undefined;\r\n\r\n      // adjust U texture coordinate to be a continuous length starting at the\r\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\r\n\r\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\r\n      normal.scale(-1.0, normal);\r\n\r\n      // pick the first vertex normal\r\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\r\n\r\n      // if the magnitude of the normal is near zero, the real normal points\r\n      // almost straighten up.. In this case, use Y as the up vector to match QV\r\n\r\n      const magnitude = sideVector.magnitude();\r\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\r\n\r\n      if (magnitude < 1e-3) {\r\n        normal.set(0, 0, -1);\r\n        sideVector.set(1, 0, 0);\r\n      }\r\n\r\n      const upVector = sideVector.crossProduct(normal).normalize();\r\n      if (!upVector)\r\n        return undefined;\r\n\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\r\n\r\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\r\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, transformToIModel?: Transform): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\r\n\r\n        if (transformToIModel !== undefined)\r\n          transformToIModel.multiplyPoint3d(point, point);\r\n\r\n        params.push(Point2d.createFrom(point));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n  }\r\n}\r\n\r\nObject.freeze(TextureMapping.Trans2x3.identity);\r\n"]}
+{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAA0B,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAmB,SAAS,EAAE,QAAQ,EAAS,MAAM,sBAAsB,CAAC;AAmBvI;;GAEG;AACH,MAAM,OAAO,cAAc;IAUzB,YAAmB,EAAiB,EAAE,MAA6B;QACjE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,eAAe,CAAC,OAAwB,EAAE,iBAA4B;QAC3E,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,CAAC;CACF;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,qDAAqD;IACrD,IAAY,IAiBX;IAjBD,WAAY,IAAI;QACd,gCAAS,CAAA;QACT,2CAAc,CAAA;QACd,mDAAkB,CAAA;QAClB,mCAAU,CAAA;QACV,gBAAgB;QAChB,uDAAoB,CAAA;QACpB,gBAAgB;QAChB,iCAAS,CAAA;QACT,gBAAgB;QAChB,yCAAa,CAAA;QACb,gBAAgB;QAChB,6CAAe,CAAA;QACf,gBAAgB;QAChB,iCAAS,CAAA;QACT,sCAAsC;QACtC,+CAAgB,CAAA;IAClB,CAAC,EAjBW,IAAI,GAAJ,mBAAI,KAAJ,mBAAI,QAiBf;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QAInB;;;;;;;;;;;WAWG;QACH,YAAmB,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC;YAC7E,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;;IAED,wCAAwC;IACjB,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAvBtC,uBAAQ,WAwBpB,CAAA;IAiDD,oFAAoF;IACpF,MAAa,MAAM;QAgBjB,YAAmB,KAAiC;YAClD,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,QAAQ,CAAC,QAAQ,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC;YAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;YACjD,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,cAAc,IAAI,KAAK,CAAC;YACrD,IAAI,CAAC,iBAAiB,GAAG;gBACvB,WAAW,EAAE,KAAK,EAAE,iBAAiB,EAAE,WAAW,IAAI,CAAC;gBACvD,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBAC1D,YAAY,EAAE,KAAK,EAAE,iBAAiB,EAAE,YAAY,IAAI,CAAC;gBACzD,YAAY,EAAE,KAAK,EAAE,iBAAiB,EAAE,YAAY,IAAI,IAAI,GAAG,IAAI,GAAG,IAAI;aAC3E,CAAC;QACJ,CAAC;QAED;;;WAGG;QACI,eAAe,CAAC,OAA+B,EAAE,iBAA4B;YAClF,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACjB,QAAQ,CAAE,6CAA6C;gBACvD,KAAK,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACnC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAClG;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;oBAC1C,IAAI,CAAC,aAAa;wBAChB,OAAO,SAAS,CAAC;oBAEnB,kFAAkF;oBAClF,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;wBACjJ,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;qBAClG;yBAAM;wBACL,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;qBAC1E;iBACF;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;oBACvC,OAAO,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;iBACrG;aACF;QACH,CAAC;QAED,yEAAyE;QACjE,yBAAyB,CAAC,OAA+B,EAAE,WAAsB,EAAE,eAAwB;YACjH,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE;gBAClD,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;gBAE7B,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;oBACjE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;wBAChD,wGAAwG;wBACxG,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC;qBAC9B;iBACF;gBAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,sHAAsH;QAC9G,qBAAqB,CAAC,OAA+B,EAAE,WAAsB;YACnF,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAC7B,IAAI,MAAgB,CAAC;YAErB,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAC9B,MAAM,GAAG,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;;gBAE9J,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAE,CAAC;YAE9D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC3B,OAAO,SAAS,CAAC;YAEnB,wEAAwE;YACxE,wEAAwE;YAExE,sGAAsG;YACtG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAE3B,+BAA+B;YAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAE7D,sEAAsE;YACtE,0EAA0E;YAE1E,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;YACzC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,4DAA4D;YAE9F,IAAI,SAAS,GAAG,IAAI,EAAE;gBACpB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrB,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;aACzB;YAED,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,IAAI,CAAC,QAAQ;gBACX,OAAO,SAAS,CAAC;YAEnB,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9E,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxF,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+HAA+H;QACvH,6BAA6B,CAAC,OAA+B,EAAE,WAAsB,EAAE,iBAA6B;YAC1H,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,iBAAiB,KAAK,SAAS;oBACjC,iBAAiB,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAElD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IA3IY,qBAAM,SA2IlB,CAAA;AACH,CAAC,EA5OgB,cAAc,KAAd,cAAc,QA4O9B;AAED,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Rendering\n */\n\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d, XAndY } from \"@itwin/core-geometry\";\nimport { RenderTexture } from \"./RenderTexture\";\n\n/** Defines normal map parameters.\n * @beta\n */\nexport interface NormalMapParams {\n  /** The texture to use as a normal map. If not present then the pattern map texture will be used as a normal map. */\n  normalMap?: RenderTexture;\n  /** True if the Y component stored in the green channel should be negated. By default, positive Y points downward, but some\n   * normal maps are created with positive Y pointing upward.\n   */\n  greenUp?: boolean;\n  /** Scale factor by which to multiply the components of the normal extracted from [[normalMap]]. */\n  scale?: number;\n  /** True if want to use constant LOD texture mapping for the normal map texture. */\n  useConstantLod?: boolean;\n}\n\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\n * @public\n */\nexport class TextureMapping {\n  /** The texture to be mapped to the surface. If normalMapParams is present but does not contain a normal map, then texture is used as a normal map rather than a pattern map. */\n  public readonly texture: RenderTexture;\n  /** The parameters for normal mapping.\n   * @beta\n   */\n  public normalMapParams?: NormalMapParams;\n  /** The parameters describing how the textures are mapped to the surface. */\n  public readonly params: TextureMapping.Params;\n\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\n    this.texture = tx;\n    this.params = params;\n  }\n\n  /** @internal */\n  public computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, transformToImodel);\n  }\n}\n\n/** @public */\nexport namespace TextureMapping { // eslint-disable-line no-redeclare\n  /** Enumerates the possible texture mapping modes. */\n  export enum Mode {\n    None = -1,\n    Parametric = 0,\n    ElevationDrape = 1,\n    Planar = 2,\n    /** @internal */\n    DirectionalDrape = 3,\n    /** @internal */\n    Cubic = 4,\n    /** @internal */\n    Spherical = 5,\n    /** @internal */\n    Cylindrical = 6,\n    /** @internal */\n    Solid = 7,\n    /** @internal Only valid for lights */\n    FrontProject = 8,\n  }\n\n  /** A 2x3 matrix for mapping a texture image to a surface. */\n  export class Trans2x3 {\n    /** The 3x4 transform produced from the 2x3 matrix. */\n    public readonly transform: Transform;\n\n    /** Construct from the two rows of the matrix:\n     * ```\n     *  | m00 m01 originX |\n     *  | m10 m11 originY |\n     * ```\n     * Producing the [Transform]($core-geometry):\n     * ```\n     *  | m00 m01 0 originX |\n     *  | m10 m11 0 originY |\n     *  | 0   0   1 0       |\n     * ```\n     */\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\n      const origin = new Point3d(originX, originY, 0);\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\n      this.transform = Transform.createRefs(origin, matrix);\n    }\n\n    /** An immutable 2x3 identity matrix. */\n    public static readonly identity = new Trans2x3();\n  }\n\n  /** Properties used to construct a [[TextureMapping.ConstantLodParams]]. */\n  export interface ConstantLodParamProps {\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1. */\n    repetitions?: number;\n    /** An offset in world units used to shift the texture. Defaults to (0, 0). */\n    offset?: XAndY;\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. Defaults to 1.*/\n    minDistClamp?: number;\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. Defaults to 2^32. */\n    maxDistClamp?: number;\n  }\n\n  /** Parameters to define constant level of detail mapping mode, a mode of texture coordinate generation which dynamically creates\n   * texture cooprdinates so that the level of detail of the texture in the rendered image remains somewhat constant. */\n  export interface ConstantLodParams {\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. */\n    repetitions: number;\n    /** An offset in world units used to shift the texture. */\n    offset: XAndY;\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. */\n    minDistClamp: number;\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. */\n    maxDistClamp: number;\n  }\n\n  /** Properties used to construct a [[TextureMapping.Params]]. */\n  export interface ParamProps {\n    /** The matrix used to map the image to a surface. */\n    textureMat2x3?: TextureMapping.Trans2x3;\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\n     * @note Defaults to 1.0\n     */\n    textureWeight?: number;\n    /** The mode by which to map the image to a surface.\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\n     */\n    mapMode?: TextureMapping.Mode;\n    /** @internal */\n    worldMapping?: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    useConstantLod?: boolean;\n    /** Parameters for constantLod mapping mode. */\n    constantLodParams?: ConstantLodParamProps;\n  }\n\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\n  export class Params {\n    /** The matrix used to map the image to a surface. */\n    public textureMatrix: TextureMapping.Trans2x3;\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\n     */\n    public weight: number;\n    /** The mode by which to map the image to a surface. */\n    public mode: TextureMapping.Mode;\n    /** @internal */\n    public worldMapping: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    public useConstantLod: boolean;\n    /** Parameters for constantLod mapping mode. */\n    public constantLodParams: ConstantLodParams;\n\n    public constructor(props?: TextureMapping.ParamProps) {\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\n      this.weight = props?.textureWeight ?? 1;\n      this.mode = props?.mapMode ?? Mode.Parametric;\n      this.worldMapping = props?.worldMapping ?? false;\n      this.useConstantLod = props?.useConstantLod ?? false;\n      this.constantLodParams = {\n        repetitions: props?.constantLodParams?.repetitions ?? 1,\n        offset: props?.constantLodParams?.offset ?? { x: 0, y: 0 },\n        minDistClamp: props?.constantLodParams?.minDistClamp ?? 1,\n        maxDistClamp: props?.constantLodParams?.maxDistClamp ?? 4096 * 1024 * 1024,\n      };\n    }\n\n    /**\n     * Generates UV parameters for textured surfaces. Returns undefined on failure.\n     * @internal\n     */\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\n      switch (this.mode) {\n        default:  // Fall through to parametric in default case\n        case TextureMapping.Mode.Parametric: {\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n        }\n        case TextureMapping.Mode.Planar: {\n          const normalIndices = visitor.normalIndex;\n          if (!normalIndices)\n            return undefined;\n\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n          } else {\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\n          }\n        }\n        case TextureMapping.Mode.ElevationDrape: {\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);\n        }\n      }\n    }\n\n    /** Computes UV parameters given a texture mapping mode of parametric. */\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\n      const params: Point2d[] = [];\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\n        let param = Point2d.create();\n\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\n            param = visitor.getParam(i)!;\n          }\n        }\n\n        params.push(uvTransform.multiplyPoint2d(param));\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\n      const params: Point2d[] = [];\n      const points = visitor.point;\n      let normal: Vector3d;\n\n      if (visitor.normal === undefined)\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\n      else\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\n\n      if (!normal.normalize(normal))\n        return undefined;\n\n      // adjust U texture coordinate to be a continuous length starting at the\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\n\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\n      normal.scale(-1.0, normal);\n\n      // pick the first vertex normal\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\n\n      // if the magnitude of the normal is near zero, the real normal points\n      // almost straighten up.. In this case, use Y as the up vector to match QV\n\n      const magnitude = sideVector.magnitude();\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\n\n      if (magnitude < 1e-3) {\n        normal.set(0, 0, -1);\n        sideVector.set(1, 0, 0);\n      }\n\n      const upVector = sideVector.crossProduct(normal).normalize();\n      if (!upVector)\n        return undefined;\n\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\n\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, transformToIModel?: Transform): Point2d[] {\n      const params: Point2d[] = [];\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\n\n        if (transformToIModel !== undefined)\n          transformToIModel.multiplyPoint3d(point, point);\n\n        params.push(Point2d.createFrom(point));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n  }\n}\n\nObject.freeze(TextureMapping.Trans2x3.identity);\n"]}

package/lib/esm/TextureProps.d.ts

@@ -1,66 +1,66 @@
-/** @packageDocumentation
- * @module Entities
- */
-import { Id64String } from "@itwin/core-bentley";
-import { DefinitionElementProps } from "./ElementProps";
-import { ImageSourceFormat } from "./Image";
-import { Base64EncodedString } from "./Base64EncodedString";
-/** Properties that define a [Texture]($backend) element.
- * @public
- * @extensions
- */
-export interface TextureProps extends DefinitionElementProps {
-    /** Format of the image data. */
-    format: ImageSourceFormat;
-    /** The image data stored in a Base64-encoded string according to the specified format.
-     * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.
-     * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.
-     */
-    data: Base64EncodedString;
-    /** An optional description of the texture. */
-    description?: string;
-}
-/** Properties that specify what texture should be loaded and how it should be loaded.
- * @public
- * @extensions
- */
-export interface TextureLoadProps {
-    /** A valid Id64 string identifying the texture */
-    name: Id64String;
-    /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */
-    maxTextureSize?: number;
-}
-/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
- * Each pixel can be classified as either opaque or translucent.
- * The transparency of the image as a whole is based on the combination of pixel transparencies.
- * If this information is known, it should be supplied when creating a texture for more efficient rendering.
- * @see [TextureImage.transparency]($frontend).
- * @public
- */
-export declare enum TextureTransparency {
-    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
-    Opaque = 0,
-    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
-    Translucent = 1,
-    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
-     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
-     */
-    Mixed = 2
-}
-/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].
- * @public
- * @extensions
- */
-export interface TextureData {
-    /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */
-    width: number;
-    /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */
-    height: number;
-    /** The format of the image (Jpeg or Png). */
-    format: ImageSourceFormat;
-    /** The encoded image bytes. */
-    bytes: Uint8Array;
-    /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */
-    transparency?: TextureTransparency;
-}
+/** @packageDocumentation
+ * @module Entities
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { DefinitionElementProps } from "./ElementProps";
+import { ImageSourceFormat } from "./Image";
+import { Base64EncodedString } from "./Base64EncodedString";
+/** Properties that define a [Texture]($backend) element.
+ * @public
+ * @extensions
+ */
+export interface TextureProps extends DefinitionElementProps {
+    /** Format of the image data. */
+    format: ImageSourceFormat;
+    /** The image data stored in a Base64-encoded string according to the specified format.
+     * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.
+     * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.
+     */
+    data: Base64EncodedString;
+    /** An optional description of the texture. */
+    description?: string;
+}
+/** Properties that specify what texture should be loaded and how it should be loaded.
+ * @public
+ * @extensions
+ */
+export interface TextureLoadProps {
+    /** A valid Id64 string identifying the texture */
+    name: Id64String;
+    /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */
+    maxTextureSize?: number;
+}
+/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
+ * Each pixel can be classified as either opaque or translucent.
+ * The transparency of the image as a whole is based on the combination of pixel transparencies.
+ * If this information is known, it should be supplied when creating a texture for more efficient rendering.
+ * @see [TextureImage.transparency]($frontend).
+ * @public
+ */
+export declare enum TextureTransparency {
+    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
+    Opaque = 0,
+    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
+    Translucent = 1,
+    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
+     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
+     */
+    Mixed = 2
+}
+/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].
+ * @public
+ * @extensions
+ */
+export interface TextureData {
+    /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */
+    width: number;
+    /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */
+    height: number;
+    /** The format of the image (Jpeg or Png). */
+    format: ImageSourceFormat;
+    /** The encoded image bytes. */
+    bytes: Uint8Array;
+    /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */
+    transparency?: TextureTransparency;
+}
 //# sourceMappingURL=TextureProps.d.ts.map

package/lib/esm/TextureProps.js

@@ -1,26 +1,26 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Entities
- */
-/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
- * Each pixel can be classified as either opaque or translucent.
- * The transparency of the image as a whole is based on the combination of pixel transparencies.
- * If this information is known, it should be supplied when creating a texture for more efficient rendering.
- * @see [TextureImage.transparency]($frontend).
- * @public
- */
-export var TextureTransparency;
-(function (TextureTransparency) {
-    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
-    TextureTransparency[TextureTransparency["Opaque"] = 0] = "Opaque";
-    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
-    TextureTransparency[TextureTransparency["Translucent"] = 1] = "Translucent";
-    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
-     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
-     */
-    TextureTransparency[TextureTransparency["Mixed"] = 2] = "Mixed";
-})(TextureTransparency || (TextureTransparency = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Entities
+ */
+/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
+ * Each pixel can be classified as either opaque or translucent.
+ * The transparency of the image as a whole is based on the combination of pixel transparencies.
+ * If this information is known, it should be supplied when creating a texture for more efficient rendering.
+ * @see [TextureImage.transparency]($frontend).
+ * @public
+ */
+export var TextureTransparency;
+(function (TextureTransparency) {
+    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
+    TextureTransparency[TextureTransparency["Opaque"] = 0] = "Opaque";
+    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
+    TextureTransparency[TextureTransparency["Translucent"] = 1] = "Translucent";
+    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
+     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
+     */
+    TextureTransparency[TextureTransparency["Mixed"] = 2] = "Mixed";
+})(TextureTransparency || (TextureTransparency = {}));
 //# sourceMappingURL=TextureProps.js.map