@itwin/core-common 3.0.0-extension.1 → 3.1.0-dev.6

package/lib/cjs/TextureMapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgI;AAGhI;;GAEG;AACH,MAAa,cAAc;IAMzB,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;AAfD,wCAeC;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,uBAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,wBAAQ,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,yBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;KACF;IArBY,uBAAQ,WAqBpB,CAAA;IAoBD,oFAAoF;IACpF,MAAa,MAAM;QAYjB,YAAY,QAAQ,EAA+B;YACjD,MAAM,EAAE,aAAa,GAAG,IAAI,QAAQ,EAAE,EAAE,aAAa,GAAG,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,YAAY,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;YACvH,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;YAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YAAC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACzH,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,uBAAO,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,wBAAQ,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,wBAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9E,MAAM,CAAC,IAAI,CAAC,uBAAO,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,uBAAO,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;IA9HY,qBAAM,SA8HlB,CAAA;AACH,CAAC,EA/LgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA+L9B","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/** 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. */\r\n  public readonly texture: RenderTexture;\r\n  /** The parameters describing how the texture image is 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\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    constructor(props = {} as TextureMapping.ParamProps) {\r\n      const { textureMat2x3 = new Trans2x3(), textureWeight = 1.0, mapMode = Mode.Parametric, worldMapping = false } = props;\r\n      this.textureMatrix = textureMat2x3; this.weight = textureWeight; this.mode = mapMode; this.worldMapping = worldMapping;\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"]}
+{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgI;AAGhI;;GAEG;AACH,MAAa,cAAc;IAMzB,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;AAfD,wCAeC;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,uBAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,wBAAQ,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,yBAAS,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,uBAAO,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,wBAAQ,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,wBAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9E,MAAM,CAAC,IAAI,CAAC,uBAAO,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,uBAAO,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,GAAd,sBAAc,KAAd,sBAAc,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/** 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. */\r\n  public readonly texture: RenderTexture;\r\n  /** The parameters describing how the texture image is 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"]}

package/lib/cjs/TextureProps.d.ts

@@ -28,6 +28,23 @@ export interface TextureLoadProps {
     /** 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
  */
@@ -36,9 +53,11 @@ export interface TextureData {
     width: number;
     /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */
     height: number;
-    /** The format of the returned data, Jpeg or Png. */
+    /** The format of the image (Jpeg or Png). */
     format: ImageSourceFormat;
-    /** returned byte data */
+    /** 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/cjs/TextureProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextureProps.d.ts","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qHAAqH;IACrH,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,yBAAyB;IACzB,KAAK,EAAE,UAAU,CAAC;CACnB"}
+{"version":3,"file":"TextureProps.d.ts","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;GAMG;AACH,oBAAY,mBAAmB;IAC7B,kGAAkG;IAClG,MAAM,IAAA;IACN,mGAAmG;IACnG,WAAW,IAAA;IACX;;OAEG;IACH,KAAK,IAAA;CACN;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qHAAqH;IACrH,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,+BAA+B;IAC/B,KAAK,EAAE,UAAU,CAAC;IAClB,uGAAuG;IACvG,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC"}

package/lib/cjs/TextureProps.js

@@ -7,4 +7,23 @@
  * @module Entities
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextureTransparency = void 0;
+/** 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
+ */
+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 = exports.TextureTransparency || (exports.TextureTransparency = {}));
 //# sourceMappingURL=TextureProps.js.map

package/lib/cjs/TextureProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextureProps.js","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Entities\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { ImageSourceFormat } from \"./Image\";\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\n\r\n/** Properties that define a [Texture]($backend) element.\r\n * @public\r\n */\r\nexport interface TextureProps extends DefinitionElementProps {\r\n  /** Format of the image data. */\r\n  format: ImageSourceFormat;\r\n  /** The image data stored in a Base64-encoded string according to the specified format.\r\n   * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.\r\n   * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.\r\n   */\r\n  data: Base64EncodedString;\r\n  /** An optional description of the texture. */\r\n  description?: string;\r\n}\r\n\r\n/** Properties that specify what texture should be loaded and how it should be loaded.\r\n * @public\r\n */\r\nexport interface TextureLoadProps {\r\n  /** A valid Id64 string identifying the texture */\r\n  name: Id64String;\r\n  /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */\r\n  maxTextureSize?: number;\r\n}\r\n\r\n/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].\r\n * @public\r\n */\r\nexport interface TextureData {\r\n  /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */\r\n  width: number;\r\n  /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */\r\n  height: number;\r\n  /** The format of the returned data, Jpeg or Png. */\r\n  format: ImageSourceFormat;\r\n  /** returned byte data */\r\n  bytes: Uint8Array;\r\n}\r\n"]}
+{"version":3,"file":"TextureProps.js","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAgCH;;;;;;GAMG;AACH,IAAY,mBASX;AATD,WAAY,mBAAmB;IAC7B,kGAAkG;IAClG,iEAAM,CAAA;IACN,mGAAmG;IACnG,2EAAW,CAAA;IACX;;OAEG;IACH,+DAAK,CAAA;AACP,CAAC,EATW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAS9B","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 Entities\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { ImageSourceFormat } from \"./Image\";\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\n\r\n/** Properties that define a [Texture]($backend) element.\r\n * @public\r\n */\r\nexport interface TextureProps extends DefinitionElementProps {\r\n  /** Format of the image data. */\r\n  format: ImageSourceFormat;\r\n  /** The image data stored in a Base64-encoded string according to the specified format.\r\n   * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.\r\n   * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.\r\n   */\r\n  data: Base64EncodedString;\r\n  /** An optional description of the texture. */\r\n  description?: string;\r\n}\r\n\r\n/** Properties that specify what texture should be loaded and how it should be loaded.\r\n * @public\r\n */\r\nexport interface TextureLoadProps {\r\n  /** A valid Id64 string identifying the texture */\r\n  name: Id64String;\r\n  /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */\r\n  maxTextureSize?: number;\r\n}\r\n\r\n/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).\r\n * Each pixel can be classified as either opaque or translucent.\r\n * The transparency of the image as a whole is based on the combination of pixel transparencies.\r\n * If this information is known, it should be supplied when creating a texture for more efficient rendering.\r\n * @see [TextureImage.transparency]($frontend).\r\n * @public\r\n */\r\nexport enum TextureTransparency {\r\n  /** The image contains only opaque pixels. It should not blend with other objects in the scene. */\r\n  Opaque,\r\n  /** The image contains only translucent pixels. It should blend with other objects in the scene. */\r\n  Translucent,\r\n  /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while\r\n   * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.\r\n   */\r\n  Mixed,\r\n}\r\n\r\n/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].\r\n * @public\r\n */\r\nexport interface TextureData {\r\n  /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */\r\n  width: number;\r\n  /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */\r\n  height: number;\r\n  /** The format of the image (Jpeg or Png). */\r\n  format: ImageSourceFormat;\r\n  /** The encoded image bytes. */\r\n  bytes: Uint8Array;\r\n  /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */\r\n  transparency?: TextureTransparency;\r\n}\r\n"]}

package/lib/cjs/ThematicDisplay.d.ts

@@ -85,6 +85,12 @@ export declare class ThematicGradientSettings {
     static readonly defaults: ThematicGradientSettings;
     private static _defaultCustomKeys;
     equals(other: ThematicGradientSettings): boolean;
+    /** Compares two sets of thematic gradient settings.
+     * @param lhs First set of thematic gradient settings to compare
+     * @param rhs Second set of thematic gradient settings to compare
+     * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.
+     */
+    static compare(lhs: ThematicGradientSettings, rhs: ThematicGradientSettings): number;
     private constructor();
     static fromJSON(json?: ThematicGradientSettingsProps): ThematicGradientSettings;
     toJSON(): ThematicGradientSettingsProps;

package/lib/cjs/ThematicDisplay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThematicDisplay.d.ts","sourceRoot":"","sources":["../../src/ThematicDisplay.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,kDAAkD;IAClD,MAAM,IAAI;IACV,mDAAmD;IACnD,OAAO,IAAI;IACX,yJAAyJ;IACzJ,oBAAoB,IAAI;IACxB,uIAAuI;IACvI,QAAQ,IAAI;CACb;AAED;;;aAGa;AACb,oBAAY,2BAA2B;IACrC,uEAAuE;IACvE,OAAO,IAAI;IACX,uEAAuE;IACvE,OAAO,IAAI;IACX,uFAAuF;IACvF,UAAU,IAAI;IACd,kEAAkE;IAClE,WAAW,IAAI;IACf,mEAAmE;IACnE,WAAW,IAAI;IACf;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;IAEI;AACJ,MAAM,WAAW,6BAA6B;IAC5C,6HAA6H;IAC7H,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,mMAAmM;IACnM,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sKAAsK;IACtK,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,kJAAkJ;IAClJ,WAAW,CAAC,EAAE,2BAA2B,CAAC;IAC1C;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtC;kFAC8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACnC,0GAA0G;IAC1G,SAAgB,IAAI,EAAE,oBAAoB,CAAC;IAC3C,mMAAmM;IACnM,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,sKAAsK;IACtK,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,wJAAwJ;IACxJ,SAAgB,WAAW,EAAE,2BAA2B,CAAC;IACzD;;;OAGG;IACH,SAAgB,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAChD;kFAC8E;IAC9E,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,WAAkB,MAAM,IAAI,MAAM,CAAiB;IACnD,WAAkB,YAAY,IAAI,MAAM,CAAwD;IAChG,WAAkB,UAAU,IAAI,MAAM,CAAkD;IAExF,gBAAuB,QAAQ,2BAAqC;IAEpE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0C;IAEpE,MAAM,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO;IAsBvD,OAAO;WAqCO,QAAQ,CAAC,IAAI,CAAC,EAAE,6BAA6B;IAIpD,MAAM,IAAI,6BAA6B;IAwB9C;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,6BAA6B,GAAG,wBAAwB;CAerF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,0HAA0H;IAC1H,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,4EAA4E;IACrE,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,0HAA0H;IAC1H,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAcA,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;WAItC,QAAQ,CAAC,IAAI,CAAC,EAAE,0BAA0B;IAIjD,MAAM,IAAI,0BAA0B;CAM5C;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACvC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,6BAA6B;IACxC,+DAA+D;IAC/D,SAAgB,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjD;;;;OAIG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAYA,MAAM,CAAC,KAAK,EAAE,6BAA6B,GAAG,OAAO;WAkB9C,QAAQ,CAAC,IAAI,CAAC,EAAE,kCAAkC;IAIzD,MAAM,IAAI,kCAAkC;CAUpD;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,8GAA8G;IAC9G,MAAM,IAAI;IACV;;OAEG;IACH,8BAA8B,IAAI;IAClC;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,uJAAuJ;IACvJ,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,wKAAwK;IACxK,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IACjD;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,gPAAgP;IAChP,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,mHAAmH;IACnH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,kCAAkC,CAAC;CACrD;AAED;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,uJAAuJ;IACvJ,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,wKAAwK;IACxK,SAAgB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3D;;;;OAIG;IACH,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,2OAA2O;IAC3O,SAAgB,IAAI,EAAE,QAAQ,CAAC;IAC/B,mHAAmH;IACnH,SAAgB,YAAY,EAAE,QAAQ,CAAC;IACvC;;OAEG;IACH,SAAgB,cAAc,EAAE,6BAA6B,CAAC;IAEvD,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAiB9C,OAAO;WAkCO,QAAQ,CAAC,IAAI,CAAC,EAAE,oBAAoB;IAI3C,MAAM,IAAI,oBAAoB;CActC"}
+{"version":3,"file":"ThematicDisplay.d.ts","sourceRoot":"","sources":["../../src/ThematicDisplay.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,kDAAkD;IAClD,MAAM,IAAI;IACV,mDAAmD;IACnD,OAAO,IAAI;IACX,yJAAyJ;IACzJ,oBAAoB,IAAI;IACxB,uIAAuI;IACvI,QAAQ,IAAI;CACb;AAED;;;aAGa;AACb,oBAAY,2BAA2B;IACrC,uEAAuE;IACvE,OAAO,IAAI;IACX,uEAAuE;IACvE,OAAO,IAAI;IACX,uFAAuF;IACvF,UAAU,IAAI;IACd,kEAAkE;IAClE,WAAW,IAAI;IACf,mEAAmE;IACnE,WAAW,IAAI;IACf;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;IAEI;AACJ,MAAM,WAAW,6BAA6B;IAC5C,6HAA6H;IAC7H,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,mMAAmM;IACnM,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sKAAsK;IACtK,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,kJAAkJ;IAClJ,WAAW,CAAC,EAAE,2BAA2B,CAAC;IAC1C;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtC;kFAC8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACnC,0GAA0G;IAC1G,SAAgB,IAAI,EAAE,oBAAoB,CAAC;IAC3C,mMAAmM;IACnM,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,sKAAsK;IACtK,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,wJAAwJ;IACxJ,SAAgB,WAAW,EAAE,2BAA2B,CAAC;IACzD;;;OAGG;IACH,SAAgB,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAChD;kFAC8E;IAC9E,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,WAAkB,MAAM,IAAI,MAAM,CAAiB;IACnD,WAAkB,YAAY,IAAI,MAAM,CAAwD;IAChG,WAAkB,UAAU,IAAI,MAAM,CAAkD;IAExF,gBAAuB,QAAQ,2BAAqC;IAEpE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0C;IAEpE,MAAM,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO;IAsBvD;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,wBAAwB,GAAG,MAAM;IAuB3F,OAAO;WAqCO,QAAQ,CAAC,IAAI,CAAC,EAAE,6BAA6B;IAIpD,MAAM,IAAI,6BAA6B;IAwB9C;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,6BAA6B,GAAG,wBAAwB;CAerF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,0HAA0H;IAC1H,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,4EAA4E;IACrE,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,0HAA0H;IAC1H,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAcA,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;WAItC,QAAQ,CAAC,IAAI,CAAC,EAAE,0BAA0B;IAIjD,MAAM,IAAI,0BAA0B;CAM5C;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACvC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,6BAA6B;IACxC,+DAA+D;IAC/D,SAAgB,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjD;;;;OAIG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAYA,MAAM,CAAC,KAAK,EAAE,6BAA6B,GAAG,OAAO;WAkB9C,QAAQ,CAAC,IAAI,CAAC,EAAE,kCAAkC;IAIzD,MAAM,IAAI,kCAAkC;CAUpD;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,8GAA8G;IAC9G,MAAM,IAAI;IACV;;OAEG;IACH,8BAA8B,IAAI;IAClC;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,uJAAuJ;IACvJ,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,wKAAwK;IACxK,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IACjD;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,gPAAgP;IAChP,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,mHAAmH;IACnH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,kCAAkC,CAAC;CACrD;AAED;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,uJAAuJ;IACvJ,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,wKAAwK;IACxK,SAAgB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3D;;;;OAIG;IACH,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,2OAA2O;IAC3O,SAAgB,IAAI,EAAE,QAAQ,CAAC;IAC/B,mHAAmH;IACnH,SAAgB,YAAY,EAAE,QAAQ,CAAC;IACvC;;OAEG;IACH,SAAgB,cAAc,EAAE,6BAA6B,CAAC;IAEvD,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAiB9C,OAAO;WAkCO,QAAQ,CAAC,IAAI,CAAC,EAAE,oBAAoB;IAI3C,MAAM,IAAI,oBAAoB;CActC"}

package/lib/cjs/ThematicDisplay.js

@@ -8,6 +8,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThematicDisplay = exports.ThematicDisplayMode = exports.ThematicDisplaySensorSettings = exports.ThematicDisplaySensor = exports.ThematicGradientSettings = exports.ThematicGradientColorScheme = exports.ThematicGradientMode = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
 const core_geometry_1 = require("@itwin/core-geometry");
 const ColorDef_1 = require("./ColorDef");
 const Gradient_1 = require("./Gradient");
@@ -105,6 +106,31 @@ class ThematicGradientSettings {
         }
         return true;
     }
+    /** Compares two sets of thematic gradient settings.
+     * @param lhs First set of thematic gradient settings to compare
+     * @param rhs Second set of thematic gradient settings to compare
+     * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.
+     */
+    static compare(lhs, rhs) {
+        let diff = 0;
+        if ((diff = (0, core_bentley_1.compareNumbers)(lhs.mode, rhs.mode)) !== 0)
+            return diff;
+        if ((diff = (0, core_bentley_1.compareNumbers)(lhs.stepCount, rhs.stepCount)) !== 0)
+            return diff;
+        if ((diff = (0, core_bentley_1.compareNumbers)(lhs.marginColor.tbgr, rhs.marginColor.tbgr)) !== 0)
+            return diff;
+        if ((diff = (0, core_bentley_1.compareNumbers)(lhs.colorScheme, rhs.colorScheme)) !== 0)
+            return diff;
+        if ((diff = (0, core_bentley_1.compareNumbers)(lhs.colorMix, rhs.colorMix)) !== 0)
+            return diff;
+        if ((diff = (0, core_bentley_1.compareNumbers)(lhs.customKeys.length, rhs.customKeys.length)) !== 0)
+            return diff;
+        for (let i = 0; i < lhs.customKeys.length; i++) {
+            if ((diff = (0, core_bentley_1.compareNumbers)(lhs.customKeys[i].color.tbgr, rhs.customKeys[i].color.tbgr)) !== 0)
+                return diff;
+        }
+        return diff;
+    }
     static fromJSON(json) {
         return json ? new ThematicGradientSettings(json) : this.defaults;
     }

package/lib/cjs/ThematicDisplay.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThematicDisplay.js","sourceRoot":"","sources":["../../src/ThematicDisplay.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAA0F;AAC1F,yCAAqD;AACrD,yCAAsC;AAEtC;;;GAGG;AACH,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,kDAAkD;IAClD,mEAAU,CAAA;IACV,mDAAmD;IACnD,qEAAW,CAAA;IACX,yJAAyJ;IACzJ,+FAAwB,CAAA;IACxB,uIAAuI;IACvI,uEAAY,CAAA;AACd,CAAC,EATW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAS/B;AAED;;;aAGa;AACb,IAAY,2BAeX;AAfD,WAAY,2BAA2B;IACrC,uEAAuE;IACvE,mFAAW,CAAA;IACX,uEAAuE;IACvE,mFAAW,CAAA;IACX,uFAAuF;IACvF,yFAAc,CAAA;IACd,kEAAkE;IAClE,2FAAe,CAAA;IACf,mEAAmE;IACnE,2FAAe,CAAA;IACf;;OAEG;IACH,iFAAU,CAAA;AACZ,CAAC,EAfW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAetC;AAwBD;;GAEG;AACH,MAAa,wBAAwB;IAgDnC,YAAoB,IAAoC;;QACtD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,CAAC;YACxC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,mBAAQ,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,OAAO,CAAC;YACvD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;SACrB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC;YACtG,IAAI,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,QAAQ;gBACtF,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,CAAC;YAE1C,IAAI,CAAC,SAAS,GAAG,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC;gBACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;YAErB,IAAI,CAAC,WAAW,GAAG,mBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEvD,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,2BAA2B,CAAC,OAAO,CAAC;YAC1I,IAAI,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,MAAM;gBACjH,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,OAAO,CAAC;YAEzD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI;gBAC3D,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAErF,qDAAqD;YACrD,IAAI,IAAI,CAAC,WAAW,KAAK,2BAA2B,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzF,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;gBACrB,KAAK,MAAM,QAAQ,IAAI,wBAAwB,CAAC,kBAAkB;oBAChE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,mBAAQ,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACzJ;YAED,IAAI,CAAC,QAAQ,GAAG,MAAA,IAAI,CAAC,QAAQ,mCAAI,GAAG,CAAC;SACtC;IACH,CAAC;IAjEM,MAAM,KAAK,MAAM,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC,CAAI,2DAA2D;IAC3G,MAAM,KAAK,YAAY,KAAa,OAAO,GAAG,GAAG,GAAG,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IACzF,MAAM,KAAK,UAAU,KAAa,OAAO,GAAG,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAMjF,MAAM,CAAC,KAA+B;QAC3C,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC1B,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YACpC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,MAAM;YACpD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAClC,OAAO,KAAK,CAAC;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI,CAAC,mBAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACnE,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAuCM,MAAM,CAAC,QAAQ,CAAC,IAAoC;QACzD,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACnE,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAkC,EAAG,CAAC;QACjD,IAAI,oBAAoB,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI;YAC3C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAEzB,IAAI,EAAE,KAAK,IAAI,CAAC,SAAS;YACvB,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,CAAC,KAAK,WAAW;YACnB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAElC,IAAI,2BAA2B,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW;YAC1D,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ;YACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAC5B,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/G,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA4C;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAE1D,MAAM,KAAK,GAAkC;YAC3C,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,SAAS,EAAE,SAAS,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;YACzF,WAAW,EAAE,SAAS,KAAK,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI;YACtG,WAAW,EAAE,SAAS,KAAK,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW;YACjG,UAAU,EAAE,SAAS,KAAK,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACzJ,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ;SACtF,CAAC;QAEF,OAAO,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;;AAnIH,4DAoIC;AA9GwB,iCAAQ,GAAG,IAAI,wBAAwB,CAAC,EAAG,CAAC,CAAC;AAErD,2CAAkB,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAwH7E;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAAiC;QACnD,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,QAAQ,GAAG,uBAAO,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAChB;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChD,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/D,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;gBAChB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;iBACZ,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;gBACrB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAClB;IACH,CAAC;IAEM,MAAM,CAAC,KAA4B;QACxC,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACrF,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAiC;QACtD,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM;QACX,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;CACF;AAlCD,sDAkCC;AAgBD;;GAEG;AACH,MAAa,6BAA6B;IAUxC,YAAoB,IAAyC;QAC3D,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;gBACvD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aACrG;YACD,IAAI,CAAC,cAAc,GAAG,CAAC,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3F;aAAM;YACL,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;SACzB;IACH,CAAC;IAEM,MAAM,CAAC,KAAoC;QAChD,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;YAC9C,OAAO,KAAK,CAAC;QAEf,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC;QACjC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;QAEnC,IAAI,WAAW,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;YAC5C,OAAO,KAAK,CAAC;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBACzC,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAyC;QAC9D,OAAO,IAAI,6BAA6B,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAEM,MAAM;QACX,MAAM,IAAI,GAAuC,EAAE,CAAC;QAEpD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,OAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtDD,sEAsDC;AAED;;GAEG;AACH,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC7B,8GAA8G;IAC9G,iEAAU,CAAA;IACV;;OAEG;IACH,iHAAkC,CAAA;IAClC;;OAEG;IACH,+DAAS,CAAA;IACT;;OAEG;IACH,uEAAa,CAAA;AACf,CAAC,EAfW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAe9B;AA0BD;;;;;GAKG;AACH,MAAa,eAAe;IAqC1B,YAAoB,IAA2B;QAC7C,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAAC;YAC9C,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,EAAE,CAAC;YAC5D,IAAI,CAAC,IAAI,GAAG,wBAAQ,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,YAAY,GAAG,wBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,6BAA6B,CAAC,QAAQ,EAAE,CAAC;SAChE;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC;YACjI,IAAI,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,SAAS;gBACnG,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAAC;YAChD,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACjF,IAAI,CAAC,IAAI,GAAG,wBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,CAAC,YAAY,GAAG,wBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzD,IAAI,CAAC,cAAc,GAAG,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACnF;QACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE;YACnD,4FAA4F;YAC5F,IAAI,oBAAoB,CAAC,QAAQ,KAAK,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,oBAAoB,CAAC,oBAAoB,KAAK,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE;gBAC5I,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC5D,oBAAoB,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,CAAC;gBACxD,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;aACjF;YACD,IAAI,mBAAmB,CAAC,KAAK,KAAK,IAAI,CAAC,WAAW,EAAE;gBAClD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG;oBACtB,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;aAC1B;SACF;IACH,CAAC;IAjDM,MAAM,CAAC,KAAsB;QAClC,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;YACnD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAoCM,MAAM,CAAC,QAAQ,CAAC,IAA2B;QAChD,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM;QACX,MAAM,IAAI,GAAyB;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAChD,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;SAC3B,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAErD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAzFD,0CAyFC","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 Symbology\r\n */\r\n\r\nimport { Point3d, Range1d, Range1dProps, Vector3d, XYZProps } from \"@itwin/core-geometry\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { Gradient } from \"./Gradient\";\r\n\r\n/** A thematic gradient mode used to generate and apply a thematic effect to a scene.\r\n * @see [[ThematicGradientSettings.mode]]\r\n * @public\r\n */\r\nexport enum ThematicGradientMode {\r\n  /** Apply a smooth color gradient to the scene. */\r\n  Smooth = 0,\r\n  /** Apply a stepped color gradient to the scene. */\r\n  Stepped = 1,\r\n  /** Apply a stepped color gradient to the scene with delimiters (lines between the color steps). Can only be used with [[ThematicDisplayMode.Height]]. */\r\n  SteppedWithDelimiter = 2,\r\n  /** Apply isolines to the scene to achieve an effect similar to a contour map. Can only be used with [[ThematicDisplayMode.Height]]. */\r\n  IsoLines = 3,\r\n}\r\n\r\n/** A color scheme used to generate the colors of a thematic gradient within an applied range.\r\n * @see [[ThematicGradientSettings.colorScheme]]\r\n * @see [[ThematicDisplay.range]]\r\n * @public */\r\nexport enum ThematicGradientColorScheme {\r\n  /** A color gradient scheme that represents a blue-to-red gradation. */\r\n  BlueRed = 0,\r\n  /** A color gradient scheme that represents a red-to-blue gradation. */\r\n  RedBlue = 1,\r\n  /** A color gradient scheme that represents a monochrome (black-to-white) gradation. */\r\n  Monochrome = 2,\r\n  /** A color gradient scheme that suits a topographic gradation. */\r\n  Topographic = 3,\r\n  /** A color gradient scheme that suits a sea-mountain gradation. */\r\n  SeaMountain = 4,\r\n  /** A custom color gradient scheme configured by the user.\r\n   * @see [[ThematicGradientSettings.customKeys]]\r\n   */\r\n  Custom = 5,\r\n}\r\n\r\n/** JSON representation of a [[ThematicGradientSettings]].\r\n * @public\r\n **/\r\nexport interface ThematicGradientSettingsProps {\r\n  /** The thematic image mode used to generate and apply the thematic gradient. Defaults to [[ThematicGradientMode.Smooth]]. */\r\n  mode?: ThematicGradientMode;\r\n  /** The step count value used for [[ThematicGradientMode.Stepped]], [[ThematicGradientMode.SteppedWithDelimiter]], and [[ThematicGradientMode.IsoLines]]. Defaults to 10. Cannot be less than 2. */\r\n  stepCount?: number;\r\n  /** The margin color used at the extremes of the gradient, when outside the applied range. Defaults to a black color using [[ColorDef.fromJSON]] with no arguments. */\r\n  marginColor?: ColorDefProps;\r\n  /** The color scheme used to generate the colors of the gradient within the applied range. Defaults to [[ThematicGradientColorScheme.BlueRed]]. */\r\n  colorScheme?: ThematicGradientColorScheme;\r\n  /** The key color values that must be provided when using a custom thematic color scheme.\r\n   * Defaults to empty, unless using a custom thematic color scheme. In that case, this defaults to two key colors going from white to black.\r\n   * When using a custom thematic color scheme, there must be at least two entries in here. If there are not, it will revert to the default settings.\r\n   */\r\n  customKeys?: Gradient.KeyColorProps[];\r\n  /** The percentage to mix in the original color with the thematic display gradient color (0-1).\r\n   * Applies to background map terrain and point clouds only.  Defaults to 0. */\r\n  colorMix?: number;\r\n}\r\n\r\n/** Thematic settings specific to creating a color gradient used by [[ThematicDisplay]].\r\n * @public\r\n */\r\nexport class ThematicGradientSettings {\r\n  /** The thematic image mode used to generate the gradient. Defaults to [[ThematicGradientMode.Smooth]]. */\r\n  public readonly mode: ThematicGradientMode;\r\n  /** The step count value used for [[ThematicGradientMode.Stepped]], [[ThematicGradientMode.SteppedWithDelimiter]], and [[ThematicGradientMode.IsoLines]]. Defaults to 10. Cannot be less than 2. */\r\n  public readonly stepCount: number;\r\n  /** The margin color used at the extremes of the gradient, when outside the applied range. Defaults to a black color using [[ColorDef.fromJSON]] with no arguments. */\r\n  public readonly marginColor: ColorDef;\r\n  /** The color scheme used to generate the colors of the gradient color within the applied range. Defaults to [[ThematicGradientColorScheme.BlueRed]]. */\r\n  public readonly colorScheme: ThematicGradientColorScheme;\r\n  /** The key color values that must be provided when using a custom thematic color scheme.\r\n   * Defaults to empty, unless using a custom thematic color scheme. In that case, this defaults to two key colors going from white to black.\r\n   * When using a custom thematic color scheme, there must be at least two entries in here. If there are not, it will revert to the default settings.\r\n   */\r\n  public readonly customKeys: Gradient.KeyColor[];\r\n  /** The percentage to mix in the original color with the thematic display gradient color (0-1).\r\n   * Applies to background map terrain and point clouds only.  Defaults to 0. */\r\n  public readonly colorMix: number;\r\n\r\n  public static get margin(): number { return .001; }    // A fixed portion of the gradient for out of range values.\r\n  public static get contentRange(): number { return 1.0 - 2.0 * ThematicGradientSettings.margin; }\r\n  public static get contentMax(): number { return 1.0 - ThematicGradientSettings.margin; }\r\n\r\n  public static readonly defaults = new ThematicGradientSettings({ });\r\n\r\n  private static _defaultCustomKeys = [[0.0, 255, 255, 255], [1.0, 0, 0, 0]];\r\n\r\n  public equals(other: ThematicGradientSettings): boolean {\r\n    if (this.mode !== other.mode)\r\n      return false;\r\n    if (this.stepCount !== other.stepCount)\r\n      return false;\r\n    if (!this.marginColor.equals(other.marginColor))\r\n      return false;\r\n    if (this.colorScheme !== other.colorScheme)\r\n      return false;\r\n    if (this.customKeys.length !== other.customKeys.length)\r\n      return false;\r\n    if (this.colorMix !== other.colorMix)\r\n      return false;\r\n\r\n    for (let i = 0; i < this.customKeys.length; i++) {\r\n      if (!Gradient.keyColorEquals(this.customKeys[i], other.customKeys[i]))\r\n        return false;\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  private constructor(json?: ThematicGradientSettingsProps) {\r\n    this.customKeys = [];\r\n    if (undefined === json) {\r\n      this.mode = ThematicGradientMode.Smooth;\r\n      this.stepCount = 10;\r\n      this.marginColor = ColorDef.fromJSON();\r\n      this.colorScheme = ThematicGradientColorScheme.BlueRed;\r\n      this.colorMix = 0.0;\r\n    } else {\r\n      this.mode = (json.mode !== undefined && json.mode !== null) ? json.mode : ThematicGradientMode.Smooth;\r\n      if (this.mode < ThematicGradientMode.Smooth || this.mode > ThematicGradientMode.IsoLines)\r\n        this.mode = ThematicGradientMode.Smooth;\r\n\r\n      this.stepCount = (typeof json.stepCount === \"number\") ? json.stepCount : 10;\r\n      if (this.stepCount < 2)\r\n        this.stepCount = 2;\r\n\r\n      this.marginColor = ColorDef.fromJSON(json.marginColor);\r\n\r\n      this.colorScheme = (json.colorScheme !== undefined && json.colorScheme !== null) ? json.colorScheme : ThematicGradientColorScheme.BlueRed;\r\n      if (this.colorScheme < ThematicGradientColorScheme.BlueRed || this.colorScheme > ThematicGradientColorScheme.Custom)\r\n        this.colorScheme = ThematicGradientColorScheme.BlueRed;\r\n\r\n      if (json.customKeys !== undefined && json.customKeys !== null)\r\n        json.customKeys.forEach((key) => this.customKeys.push(new Gradient.KeyColor(key)));\r\n\r\n      // Enforce 2 entries in custom color keys if violated\r\n      if (this.colorScheme === ThematicGradientColorScheme.Custom && this.customKeys.length < 2) {\r\n        this.customKeys = [];\r\n        for (const keyValue of ThematicGradientSettings._defaultCustomKeys)\r\n          this.customKeys.push(new Gradient.KeyColor({ value: keyValue[0], color: ColorDef.computeTbgrFromComponents(keyValue[1], keyValue[3], keyValue[2]) }));\r\n      }\r\n\r\n      this.colorMix = json.colorMix ?? 0.0;\r\n    }\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicGradientSettingsProps) {\r\n    return json ? new ThematicGradientSettings(json) : this.defaults;\r\n  }\r\n\r\n  public toJSON(): ThematicGradientSettingsProps {\r\n    const props: ThematicGradientSettingsProps = { };\r\n    if (ThematicGradientMode.Smooth !== this.mode)\r\n      props.mode = this.mode;\r\n\r\n    if (10 !== this.stepCount)\r\n      props.stepCount = this.stepCount;\r\n\r\n    const marginColor = this.marginColor.toJSON();\r\n    if (0 !== marginColor)\r\n      props.marginColor = marginColor;\r\n\r\n    if (ThematicGradientColorScheme.BlueRed !== this.colorScheme)\r\n      props.colorScheme = this.colorScheme;\r\n\r\n    if (0 !== this.colorMix)\r\n      props.colorMix = this.colorMix;\r\n\r\n    if (this.customKeys.length > 0)\r\n      props.customKeys = this.customKeys.map((key) => { return { value: key.value, color: key.color.toJSON() }; });\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this ThematicGradientSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A ThematicGradientSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: ThematicGradientSettingsProps): ThematicGradientSettings {\r\n    if (undefined === changedProps)\r\n      return ThematicGradientSettings.fromJSON(this.toJSON());\r\n\r\n    const props: ThematicGradientSettingsProps = {\r\n      mode: undefined !== changedProps.mode ? changedProps.mode : this.mode,\r\n      stepCount: undefined !== changedProps.stepCount ? changedProps.stepCount : this.stepCount,\r\n      marginColor: undefined !== changedProps.marginColor ? changedProps.marginColor : this.marginColor.tbgr,\r\n      colorScheme: undefined !== changedProps.colorScheme ? changedProps.colorScheme : this.colorScheme,\r\n      customKeys: undefined !== changedProps.customKeys ? changedProps.customKeys : this.customKeys.map((key) => ({ value: key.value, color: key.color.tbgr })),\r\n      colorMix: undefined !== changedProps.colorMix ? changedProps.colorMix : this.colorMix,\r\n    };\r\n\r\n    return ThematicGradientSettings.fromJSON(props);\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[ThematicDisplaySensor]].\r\n * @public\r\n */\r\nexport interface ThematicDisplaySensorProps {\r\n  /** The world position of the sensor in X, Y, and Z. Defaults to {0,0,0}. */\r\n  position?: XYZProps;\r\n  /** The value of the sensor used when accessing the thematic gradient texture; expected range is 0 to 1. Defaults to 0. */\r\n  value?: number;\r\n}\r\n\r\n/** A sensor in world space, used for [[ThematicDisplayMode.InverseDistanceWeightedSensors]].\r\n * @public\r\n */\r\nexport class ThematicDisplaySensor {\r\n  /** The world position of the sensor in X, Y, and Z. Defaults to {0,0,0}. */\r\n  public position: Readonly<Point3d>;\r\n  /** The value of the sensor used when accessing the thematic gradient texture; expected range is 0 to 1. Defaults to 0. */\r\n  public readonly value: number;\r\n\r\n  private constructor(json?: ThematicDisplaySensorProps) {\r\n    if (undefined === json) {\r\n      this.position = Point3d.fromJSON();\r\n      this.value = 0;\r\n    } else {\r\n      this.position = Point3d.fromJSON(json.position);\r\n      this.value = (typeof json.value !== \"number\") ? 0 : json.value;\r\n      if (this.value < 0)\r\n        this.value = 0;\r\n      else if (this.value > 1)\r\n        this.value = 1;\r\n    }\r\n  }\r\n\r\n  public equals(other: ThematicDisplaySensor): boolean {\r\n    return (this.value === other.value) && this.position.isAlmostEqual(other.position);\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicDisplaySensorProps) {\r\n    return new ThematicDisplaySensor(json);\r\n  }\r\n\r\n  public toJSON(): ThematicDisplaySensorProps {\r\n    return {\r\n      position: this.position.toJSON(),\r\n      value: this.value,\r\n    };\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[ThematicDisplaySensorSettings]] for [[ThematicDisplayMode.InverseDistanceWeightedSensors]].\r\n * @public\r\n */\r\nexport interface ThematicDisplaySensorSettingsProps {\r\n  /** This is the list of sensors. Defaults to an empty array. */\r\n  sensors?: ThematicDisplaySensorProps[];\r\n  /** This is the distance cutoff in meters. For a position on screen to be affected by a sensor, it must be at least this close to the sensor.\r\n   * If this is zero or negative, then no distance cutoff is applied (all sensors affect all positions regardless of nearness).\r\n   * Defaults to zero.\r\n   * @note Using a suitable distance cutoff imparts a significant performance benefit. The larger this value becomes, performance will degrade.\r\n   */\r\n  distanceCutoff?: number;\r\n}\r\n\r\n/** Settings for sensor-based thematic display for [[ThematicDisplayMode.InverseDistanceWeightedSensors]].\r\n * @public\r\n */\r\nexport class ThematicDisplaySensorSettings {\r\n  /** This is the list of sensors. Defaults to an empty array. */\r\n  public readonly sensors: ThematicDisplaySensor[];\r\n  /** This is the distance cutoff in meters. For a position on screen to be affected by a sensor, it must be at least this close to the sensor.\r\n   * If this is zero or negative, then no distance cutoff is applied (all sensors affect all positions regardless of nearness).\r\n   * Defaults to zero.\r\n   * @note Using a suitable distance cutoff imparts a significant performance benefit. The larger this value becomes, performance will degrade.\r\n   */\r\n  public readonly distanceCutoff: number;\r\n\r\n  private constructor(json?: ThematicDisplaySensorSettingsProps) {\r\n    this.sensors = [];\r\n    if (undefined !== json) {\r\n      if (json.sensors !== undefined && json.sensors !== null) {\r\n        json.sensors.forEach((sensorJSON) => this.sensors.push(ThematicDisplaySensor.fromJSON(sensorJSON)));\r\n      }\r\n      this.distanceCutoff = (typeof json.distanceCutoff === \"number\") ? json.distanceCutoff : 0;\r\n    } else {\r\n      this.distanceCutoff = 0;\r\n    }\r\n  }\r\n\r\n  public equals(other: ThematicDisplaySensorSettings): boolean {\r\n    if (this.distanceCutoff !== other.distanceCutoff)\r\n      return false;\r\n\r\n    const thisSensors = this.sensors;\r\n    const otherSensors = other.sensors;\r\n\r\n    if (thisSensors.length !== otherSensors.length)\r\n      return false;\r\n\r\n    for (let i = 0; i < thisSensors.length; i++) {\r\n      if (!thisSensors[i].equals(otherSensors[i]))\r\n        return false;\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicDisplaySensorSettingsProps) {\r\n    return new ThematicDisplaySensorSettings(json);\r\n  }\r\n\r\n  public toJSON(): ThematicDisplaySensorSettingsProps {\r\n    const json: ThematicDisplaySensorSettingsProps = {};\r\n\r\n    json.sensors = [];\r\n    this.sensors.forEach((sensor) => json.sensors!.push(sensor.toJSON()));\r\n\r\n    json.distanceCutoff = this.distanceCutoff;\r\n\r\n    return json;\r\n  }\r\n}\r\n\r\n/** The thematic display mode. This determines how to apply the thematic color gradient to the geometry.\r\n * @public\r\n */\r\nexport enum ThematicDisplayMode {\r\n  /** The color gradient will be mapped to surface geometry and point clouds based on world height in meters. */\r\n  Height = 0,\r\n  /** The color gradient will be mapped to surface geometry and point clouds using inverse distance weighting based on world positions and corresponding values from a list of sensors.\r\n   * @note Performance will decrease as more sensors are added.\r\n   */\r\n  InverseDistanceWeightedSensors = 1,\r\n  /** The color gradient will be mapped to surface geometry based on the slope of the surface. The slope value is calculated based on the angle between the surface and the axis specified in the associated [[ThematicDisplay]] object.\r\n   * @note This display mode does not affect point clouds.\r\n   */\r\n  Slope = 2,\r\n  /** The color gradient will be mapped to surface geometry based on the direction of a sun shining on the surface.\r\n   * @note This display mode does not affect point clouds.\r\n   */\r\n  HillShade = 3,\r\n}\r\n\r\n/** JSON representation of the thematic display setup of a [[DisplayStyle3d]].\r\n * @public\r\n */\r\nexport interface ThematicDisplayProps {\r\n  /** The thematic display mode. This determines how to apply the thematic color gradient to the geometry. Defaults to [[ThematicDisplayMode.Height]]. */\r\n  displayMode?: ThematicDisplayMode;\r\n  /** The settings used to create a color gradient applied to the geometry. Defaults to an instantiation using [[ThematicGradientSettings.fromJSON]] with no arguments. */\r\n  gradientSettings?: ThematicGradientSettingsProps;\r\n  /** The range to use when applying the thematic gradient for height and slope mode.\r\n   * For [[ThematicDisplayMode.Height]], this is world space in meters and represents the range in which to apply the gradient along the specified axis.\r\n   * For [[ThematicDisplayMode.Slope]], this is a range in degrees with a minimum low value of 0 degrees and a maximum high value of 90 degrees.\r\n   * Defaults to a null range.\r\n   */\r\n  range?: Range1dProps;\r\n  /** For [[ThematicDisplayMode.Height]], this is the axis along which to apply the thematic gradient in the scene. For [[ThematicDisplayMode.Slope]], calculating the slope of a surface is done in relation to the axis. Defaults to {0,0,0}. */\r\n  axis?: XYZProps;\r\n  /** For [[ThematicDisplayMode.HillShade]], this is the direction of the sun in world space. Defaults to {0,0,0}. */\r\n  sunDirection?: XYZProps;\r\n  /** For [[ThematicDisplayMode.InverseDistanceWeightedSensors]], these are the settings that control the sensors. Defaults to an instantiation using [[ThematicDisplaySensorSettings.fromJSON]] with no arguments.\r\n   * @public\r\n   */\r\n  sensorSettings?: ThematicDisplaySensorSettingsProps;\r\n}\r\n\r\n/** The thematic display setup of a [[DisplayStyle3d]].\r\n * Thematic display allows a user to colorize a scene using a color gradient in a way that provides a visual cue about certain attributes of the rendered geometry. This scene colorization will be done based on certain geometric attributes like height, surface slope, position of surfaces relative to a sun position, or geometric position relative to a list of sensors.\r\n * The documentation for [[ThematicDisplayMode]] describes how each mode colorizes the scene.\r\n * @note Applying thematic display to geometry prevents shadows from applying to the same geometry.\r\n * @public\r\n */\r\nexport class ThematicDisplay {\r\n  /** The thematic display mode. This determines how to apply the thematic color gradient to the geometry. Defaults to [[ThematicDisplayMode.Height]]. */\r\n  public readonly displayMode: ThematicDisplayMode;\r\n  /** The settings used to create a color gradient applied to the geometry. Defaults to an instantiation using [[ThematicGradientSettings.fromJSON]] with no arguments. */\r\n  public readonly gradientSettings: ThematicGradientSettings;\r\n  /** The range to use when applying the thematic gradient for height and slope mode.\r\n   * For [[ThematicDisplayMode.Height]], this is world space in meters and represents the range in which to apply the gradient along the specified axis.\r\n   * For [[ThematicDisplayMode.Slope]], this is a range in radians with a minimum low value of 0 degrees and a maximum high value of 90 degrees.\r\n   * Defaults to a null range.\r\n   */\r\n  public readonly range: Range1d;\r\n  /** For [[ThematicDisplayMode.Height]], this is the axis along which to apply the thematic gradient in the scene. For [[ThematicDisplayMode.Slope]], the slope of a surface is calculated in relation to this axis. Defaults to {0,0,0}. */\r\n  public readonly axis: Vector3d;\r\n  /** For [[ThematicDisplayMode.HillShade]], this is the direction of the sun in world space. Defaults to {0,0,0}. */\r\n  public readonly sunDirection: Vector3d;\r\n  /** For [[ThematicDisplayMode.InverseDistanceWeightedSensors]], these are the settings that control the sensors. Defaults to an instantiation using [[ThematicDisplaySensorSettings.fromJSON]] with no arguments.\r\n   * @public\r\n   */\r\n  public readonly sensorSettings: ThematicDisplaySensorSettings;\r\n\r\n  public equals(other: ThematicDisplay): boolean {\r\n    if (this.displayMode !== other.displayMode)\r\n      return false;\r\n    if (!this.gradientSettings.equals(other.gradientSettings))\r\n      return false;\r\n    if (!this.range.isAlmostEqual(other.range))\r\n      return false;\r\n    if (!this.axis.isAlmostEqual(other.axis))\r\n      return false;\r\n    if (!this.sunDirection.isAlmostEqual(other.sunDirection))\r\n      return false;\r\n    if (!this.sensorSettings.equals(other.sensorSettings))\r\n      return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  private constructor(json?: ThematicDisplayProps) {\r\n    if (undefined === json) {\r\n      this.displayMode = ThematicDisplayMode.Height;\r\n      this.gradientSettings = ThematicGradientSettings.fromJSON();\r\n      this.axis = Vector3d.fromJSON();\r\n      this.range = Range1d.fromJSON();\r\n      this.sunDirection = Vector3d.fromJSON();\r\n      this.sensorSettings = ThematicDisplaySensorSettings.fromJSON();\r\n    } else {\r\n      this.displayMode = (json.displayMode !== undefined && json.displayMode !== null) ? json.displayMode : ThematicDisplayMode.Height;\r\n      if (this.displayMode < ThematicDisplayMode.Height || this.displayMode > ThematicDisplayMode.HillShade)\r\n        this.displayMode = ThematicDisplayMode.Height;\r\n      this.gradientSettings = ThematicGradientSettings.fromJSON(json.gradientSettings);\r\n      this.axis = Vector3d.fromJSON(json.axis);\r\n      this.range = Range1d.fromJSON(json.range);\r\n      this.sunDirection = Vector3d.fromJSON(json.sunDirection);\r\n      this.sensorSettings = ThematicDisplaySensorSettings.fromJSON(json.sensorSettings);\r\n    }\r\n    if (ThematicDisplayMode.Height !== this.displayMode) {\r\n      // Disallow isoline and stepped-with-delimiter gradient modes in any mode other than height.\r\n      if (ThematicGradientMode.IsoLines === this.gradientSettings.mode || ThematicGradientMode.SteppedWithDelimiter === this.gradientSettings.mode) {\r\n        const gradientSettingsJSON = this.gradientSettings.toJSON();\r\n        gradientSettingsJSON.mode = ThematicGradientMode.Smooth;\r\n        this.gradientSettings = ThematicGradientSettings.fromJSON(gradientSettingsJSON);\r\n      }\r\n      if (ThematicDisplayMode.Slope === this.displayMode) {\r\n        if (this.range.low < 0.0)\r\n          this.range.low = 0.0;\r\n        if (this.range.high > 90.0)\r\n          this.range.high = 90.0;\r\n      }\r\n    }\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicDisplayProps) {\r\n    return new ThematicDisplay(json);\r\n  }\r\n\r\n  public toJSON(): ThematicDisplayProps {\r\n    const json: ThematicDisplayProps = {\r\n      displayMode: this.displayMode,\r\n      gradientSettings: this.gradientSettings.toJSON(),\r\n      axis: this.axis.toJSON(),\r\n      sunDirection: this.sunDirection.toJSON(),\r\n      range: this.range.toJSON(),\r\n    };\r\n\r\n    if (this.sensorSettings.sensors.length > 0)\r\n      json.sensorSettings = this.sensorSettings.toJSON();\r\n\r\n    return json;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ThematicDisplay.js","sourceRoot":"","sources":["../../src/ThematicDisplay.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqD;AACrD,wDAA0F;AAC1F,yCAAqD;AACrD,yCAAsC;AAEtC;;;GAGG;AACH,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,kDAAkD;IAClD,mEAAU,CAAA;IACV,mDAAmD;IACnD,qEAAW,CAAA;IACX,yJAAyJ;IACzJ,+FAAwB,CAAA;IACxB,uIAAuI;IACvI,uEAAY,CAAA;AACd,CAAC,EATW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAS/B;AAED;;;aAGa;AACb,IAAY,2BAeX;AAfD,WAAY,2BAA2B;IACrC,uEAAuE;IACvE,mFAAW,CAAA;IACX,uEAAuE;IACvE,mFAAW,CAAA;IACX,uFAAuF;IACvF,yFAAc,CAAA;IACd,kEAAkE;IAClE,2FAAe,CAAA;IACf,mEAAmE;IACnE,2FAAe,CAAA;IACf;;OAEG;IACH,iFAAU,CAAA;AACZ,CAAC,EAfW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAetC;AAwBD;;GAEG;AACH,MAAa,wBAAwB;IA4EnC,YAAoB,IAAoC;;QACtD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,CAAC;YACxC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,mBAAQ,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,OAAO,CAAC;YACvD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;SACrB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC;YACtG,IAAI,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,QAAQ;gBACtF,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,CAAC;YAE1C,IAAI,CAAC,SAAS,GAAG,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC;gBACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;YAErB,IAAI,CAAC,WAAW,GAAG,mBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEvD,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,2BAA2B,CAAC,OAAO,CAAC;YAC1I,IAAI,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,MAAM;gBACjH,IAAI,CAAC,WAAW,GAAG,2BAA2B,CAAC,OAAO,CAAC;YAEzD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI;gBAC3D,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAErF,qDAAqD;YACrD,IAAI,IAAI,CAAC,WAAW,KAAK,2BAA2B,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzF,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;gBACrB,KAAK,MAAM,QAAQ,IAAI,wBAAwB,CAAC,kBAAkB;oBAChE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,mBAAQ,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACzJ;YAED,IAAI,CAAC,QAAQ,GAAG,MAAA,IAAI,CAAC,QAAQ,mCAAI,GAAG,CAAC;SACtC;IACH,CAAC;IA7FM,MAAM,KAAK,MAAM,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC,CAAI,2DAA2D;IAC3G,MAAM,KAAK,YAAY,KAAa,OAAO,GAAG,GAAG,GAAG,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IACzF,MAAM,KAAK,UAAU,KAAa,OAAO,GAAG,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAMjF,MAAM,CAAC,KAA+B;QAC3C,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC1B,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YACpC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,MAAM;YACpD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAClC,OAAO,KAAK,CAAC;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI,CAAC,mBAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACnE,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAA6B,EAAE,GAA6B;QAChF,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC;YAC7D,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;YAC3E,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;YACjE,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC;YAC3D,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC;YAC7E,OAAO,IAAI,CAAC;QAEd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC9C,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;gBAC3F,OAAO,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAuCM,MAAM,CAAC,QAAQ,CAAC,IAAoC;QACzD,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACnE,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAkC,EAAG,CAAC;QACjD,IAAI,oBAAoB,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI;YAC3C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAEzB,IAAI,EAAE,KAAK,IAAI,CAAC,SAAS;YACvB,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,CAAC,KAAK,WAAW;YACnB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAElC,IAAI,2BAA2B,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW;YAC1D,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ;YACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAC5B,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/G,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA4C;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAE1D,MAAM,KAAK,GAAkC;YAC3C,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,SAAS,EAAE,SAAS,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;YACzF,WAAW,EAAE,SAAS,KAAK,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI;YACtG,WAAW,EAAE,SAAS,KAAK,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW;YACjG,UAAU,EAAE,SAAS,KAAK,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACzJ,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ;SACtF,CAAC;QAEF,OAAO,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;;AA/JH,4DAgKC;AA1IwB,iCAAQ,GAAG,IAAI,wBAAwB,CAAC,EAAG,CAAC,CAAC;AAErD,2CAAkB,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAoJ7E;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAAiC;QACnD,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,QAAQ,GAAG,uBAAO,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAChB;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChD,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/D,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;gBAChB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;iBACZ,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;gBACrB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAClB;IACH,CAAC;IAEM,MAAM,CAAC,KAA4B;QACxC,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACrF,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAiC;QACtD,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM;QACX,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;CACF;AAlCD,sDAkCC;AAgBD;;GAEG;AACH,MAAa,6BAA6B;IAUxC,YAAoB,IAAyC;QAC3D,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;gBACvD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aACrG;YACD,IAAI,CAAC,cAAc,GAAG,CAAC,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3F;aAAM;YACL,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;SACzB;IACH,CAAC;IAEM,MAAM,CAAC,KAAoC;QAChD,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;YAC9C,OAAO,KAAK,CAAC;QAEf,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC;QACjC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;QAEnC,IAAI,WAAW,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;YAC5C,OAAO,KAAK,CAAC;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBACzC,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAyC;QAC9D,OAAO,IAAI,6BAA6B,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAEM,MAAM;QACX,MAAM,IAAI,GAAuC,EAAE,CAAC;QAEpD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,OAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtDD,sEAsDC;AAED;;GAEG;AACH,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC7B,8GAA8G;IAC9G,iEAAU,CAAA;IACV;;OAEG;IACH,iHAAkC,CAAA;IAClC;;OAEG;IACH,+DAAS,CAAA;IACT;;OAEG;IACH,uEAAa,CAAA;AACf,CAAC,EAfW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAe9B;AA0BD;;;;;GAKG;AACH,MAAa,eAAe;IAqC1B,YAAoB,IAA2B;QAC7C,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAAC;YAC9C,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,EAAE,CAAC;YAC5D,IAAI,CAAC,IAAI,GAAG,wBAAQ,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,YAAY,GAAG,wBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,6BAA6B,CAAC,QAAQ,EAAE,CAAC;SAChE;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC;YACjI,IAAI,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,SAAS;gBACnG,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAAC;YAChD,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACjF,IAAI,CAAC,IAAI,GAAG,wBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,CAAC,YAAY,GAAG,wBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzD,IAAI,CAAC,cAAc,GAAG,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACnF;QACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE;YACnD,4FAA4F;YAC5F,IAAI,oBAAoB,CAAC,QAAQ,KAAK,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,oBAAoB,CAAC,oBAAoB,KAAK,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE;gBAC5I,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC5D,oBAAoB,CAAC,IAAI,GAAG,oBAAoB,CAAC,MAAM,CAAC;gBACxD,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;aACjF;YACD,IAAI,mBAAmB,CAAC,KAAK,KAAK,IAAI,CAAC,WAAW,EAAE;gBAClD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG;oBACtB,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;aAC1B;SACF;IACH,CAAC;IAjDM,MAAM,CAAC,KAAsB;QAClC,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;YACnD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAoCM,MAAM,CAAC,QAAQ,CAAC,IAA2B;QAChD,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM;QACX,MAAM,IAAI,GAAyB;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAChD,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;SAC3B,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAErD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAzFD,0CAyFC","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 Symbology\r\n */\r\n\r\nimport { compareNumbers } from \"@itwin/core-bentley\";\r\nimport { Point3d, Range1d, Range1dProps, Vector3d, XYZProps } from \"@itwin/core-geometry\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { Gradient } from \"./Gradient\";\r\n\r\n/** A thematic gradient mode used to generate and apply a thematic effect to a scene.\r\n * @see [[ThematicGradientSettings.mode]]\r\n * @public\r\n */\r\nexport enum ThematicGradientMode {\r\n  /** Apply a smooth color gradient to the scene. */\r\n  Smooth = 0,\r\n  /** Apply a stepped color gradient to the scene. */\r\n  Stepped = 1,\r\n  /** Apply a stepped color gradient to the scene with delimiters (lines between the color steps). Can only be used with [[ThematicDisplayMode.Height]]. */\r\n  SteppedWithDelimiter = 2,\r\n  /** Apply isolines to the scene to achieve an effect similar to a contour map. Can only be used with [[ThematicDisplayMode.Height]]. */\r\n  IsoLines = 3,\r\n}\r\n\r\n/** A color scheme used to generate the colors of a thematic gradient within an applied range.\r\n * @see [[ThematicGradientSettings.colorScheme]]\r\n * @see [[ThematicDisplay.range]]\r\n * @public */\r\nexport enum ThematicGradientColorScheme {\r\n  /** A color gradient scheme that represents a blue-to-red gradation. */\r\n  BlueRed = 0,\r\n  /** A color gradient scheme that represents a red-to-blue gradation. */\r\n  RedBlue = 1,\r\n  /** A color gradient scheme that represents a monochrome (black-to-white) gradation. */\r\n  Monochrome = 2,\r\n  /** A color gradient scheme that suits a topographic gradation. */\r\n  Topographic = 3,\r\n  /** A color gradient scheme that suits a sea-mountain gradation. */\r\n  SeaMountain = 4,\r\n  /** A custom color gradient scheme configured by the user.\r\n   * @see [[ThematicGradientSettings.customKeys]]\r\n   */\r\n  Custom = 5,\r\n}\r\n\r\n/** JSON representation of a [[ThematicGradientSettings]].\r\n * @public\r\n **/\r\nexport interface ThematicGradientSettingsProps {\r\n  /** The thematic image mode used to generate and apply the thematic gradient. Defaults to [[ThematicGradientMode.Smooth]]. */\r\n  mode?: ThematicGradientMode;\r\n  /** The step count value used for [[ThematicGradientMode.Stepped]], [[ThematicGradientMode.SteppedWithDelimiter]], and [[ThematicGradientMode.IsoLines]]. Defaults to 10. Cannot be less than 2. */\r\n  stepCount?: number;\r\n  /** The margin color used at the extremes of the gradient, when outside the applied range. Defaults to a black color using [[ColorDef.fromJSON]] with no arguments. */\r\n  marginColor?: ColorDefProps;\r\n  /** The color scheme used to generate the colors of the gradient within the applied range. Defaults to [[ThematicGradientColorScheme.BlueRed]]. */\r\n  colorScheme?: ThematicGradientColorScheme;\r\n  /** The key color values that must be provided when using a custom thematic color scheme.\r\n   * Defaults to empty, unless using a custom thematic color scheme. In that case, this defaults to two key colors going from white to black.\r\n   * When using a custom thematic color scheme, there must be at least two entries in here. If there are not, it will revert to the default settings.\r\n   */\r\n  customKeys?: Gradient.KeyColorProps[];\r\n  /** The percentage to mix in the original color with the thematic display gradient color (0-1).\r\n   * Applies to background map terrain and point clouds only.  Defaults to 0. */\r\n  colorMix?: number;\r\n}\r\n\r\n/** Thematic settings specific to creating a color gradient used by [[ThematicDisplay]].\r\n * @public\r\n */\r\nexport class ThematicGradientSettings {\r\n  /** The thematic image mode used to generate the gradient. Defaults to [[ThematicGradientMode.Smooth]]. */\r\n  public readonly mode: ThematicGradientMode;\r\n  /** The step count value used for [[ThematicGradientMode.Stepped]], [[ThematicGradientMode.SteppedWithDelimiter]], and [[ThematicGradientMode.IsoLines]]. Defaults to 10. Cannot be less than 2. */\r\n  public readonly stepCount: number;\r\n  /** The margin color used at the extremes of the gradient, when outside the applied range. Defaults to a black color using [[ColorDef.fromJSON]] with no arguments. */\r\n  public readonly marginColor: ColorDef;\r\n  /** The color scheme used to generate the colors of the gradient color within the applied range. Defaults to [[ThematicGradientColorScheme.BlueRed]]. */\r\n  public readonly colorScheme: ThematicGradientColorScheme;\r\n  /** The key color values that must be provided when using a custom thematic color scheme.\r\n   * Defaults to empty, unless using a custom thematic color scheme. In that case, this defaults to two key colors going from white to black.\r\n   * When using a custom thematic color scheme, there must be at least two entries in here. If there are not, it will revert to the default settings.\r\n   */\r\n  public readonly customKeys: Gradient.KeyColor[];\r\n  /** The percentage to mix in the original color with the thematic display gradient color (0-1).\r\n   * Applies to background map terrain and point clouds only.  Defaults to 0. */\r\n  public readonly colorMix: number;\r\n\r\n  public static get margin(): number { return .001; }    // A fixed portion of the gradient for out of range values.\r\n  public static get contentRange(): number { return 1.0 - 2.0 * ThematicGradientSettings.margin; }\r\n  public static get contentMax(): number { return 1.0 - ThematicGradientSettings.margin; }\r\n\r\n  public static readonly defaults = new ThematicGradientSettings({ });\r\n\r\n  private static _defaultCustomKeys = [[0.0, 255, 255, 255], [1.0, 0, 0, 0]];\r\n\r\n  public equals(other: ThematicGradientSettings): boolean {\r\n    if (this.mode !== other.mode)\r\n      return false;\r\n    if (this.stepCount !== other.stepCount)\r\n      return false;\r\n    if (!this.marginColor.equals(other.marginColor))\r\n      return false;\r\n    if (this.colorScheme !== other.colorScheme)\r\n      return false;\r\n    if (this.customKeys.length !== other.customKeys.length)\r\n      return false;\r\n    if (this.colorMix !== other.colorMix)\r\n      return false;\r\n\r\n    for (let i = 0; i < this.customKeys.length; i++) {\r\n      if (!Gradient.keyColorEquals(this.customKeys[i], other.customKeys[i]))\r\n        return false;\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Compares two sets of thematic gradient settings.\r\n   * @param lhs First set of thematic gradient settings to compare\r\n   * @param rhs Second set of thematic gradient settings to compare\r\n   * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.\r\n   */\r\n  public static compare(lhs: ThematicGradientSettings, rhs: ThematicGradientSettings): number {\r\n    let diff = 0;\r\n    if ((diff = compareNumbers(lhs.mode, rhs.mode)) !== 0)\r\n      return diff;\r\n    if ((diff = compareNumbers(lhs.stepCount, rhs.stepCount)) !== 0)\r\n      return diff;\r\n    if ((diff = compareNumbers(lhs.marginColor.tbgr, rhs.marginColor.tbgr)) !== 0)\r\n      return diff;\r\n    if ((diff = compareNumbers(lhs.colorScheme, rhs.colorScheme)) !== 0)\r\n      return diff;\r\n    if ((diff = compareNumbers(lhs.colorMix, rhs.colorMix)) !== 0)\r\n      return diff;\r\n    if ((diff = compareNumbers(lhs.customKeys.length, rhs.customKeys.length)) !== 0)\r\n      return diff;\r\n\r\n    for (let i = 0; i < lhs.customKeys.length; i++) {\r\n      if ((diff = compareNumbers(lhs.customKeys[i].color.tbgr, rhs.customKeys[i].color.tbgr)) !== 0)\r\n        return diff;\r\n    }\r\n\r\n    return diff;\r\n  }\r\n\r\n  private constructor(json?: ThematicGradientSettingsProps) {\r\n    this.customKeys = [];\r\n    if (undefined === json) {\r\n      this.mode = ThematicGradientMode.Smooth;\r\n      this.stepCount = 10;\r\n      this.marginColor = ColorDef.fromJSON();\r\n      this.colorScheme = ThematicGradientColorScheme.BlueRed;\r\n      this.colorMix = 0.0;\r\n    } else {\r\n      this.mode = (json.mode !== undefined && json.mode !== null) ? json.mode : ThematicGradientMode.Smooth;\r\n      if (this.mode < ThematicGradientMode.Smooth || this.mode > ThematicGradientMode.IsoLines)\r\n        this.mode = ThematicGradientMode.Smooth;\r\n\r\n      this.stepCount = (typeof json.stepCount === \"number\") ? json.stepCount : 10;\r\n      if (this.stepCount < 2)\r\n        this.stepCount = 2;\r\n\r\n      this.marginColor = ColorDef.fromJSON(json.marginColor);\r\n\r\n      this.colorScheme = (json.colorScheme !== undefined && json.colorScheme !== null) ? json.colorScheme : ThematicGradientColorScheme.BlueRed;\r\n      if (this.colorScheme < ThematicGradientColorScheme.BlueRed || this.colorScheme > ThematicGradientColorScheme.Custom)\r\n        this.colorScheme = ThematicGradientColorScheme.BlueRed;\r\n\r\n      if (json.customKeys !== undefined && json.customKeys !== null)\r\n        json.customKeys.forEach((key) => this.customKeys.push(new Gradient.KeyColor(key)));\r\n\r\n      // Enforce 2 entries in custom color keys if violated\r\n      if (this.colorScheme === ThematicGradientColorScheme.Custom && this.customKeys.length < 2) {\r\n        this.customKeys = [];\r\n        for (const keyValue of ThematicGradientSettings._defaultCustomKeys)\r\n          this.customKeys.push(new Gradient.KeyColor({ value: keyValue[0], color: ColorDef.computeTbgrFromComponents(keyValue[1], keyValue[3], keyValue[2]) }));\r\n      }\r\n\r\n      this.colorMix = json.colorMix ?? 0.0;\r\n    }\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicGradientSettingsProps) {\r\n    return json ? new ThematicGradientSettings(json) : this.defaults;\r\n  }\r\n\r\n  public toJSON(): ThematicGradientSettingsProps {\r\n    const props: ThematicGradientSettingsProps = { };\r\n    if (ThematicGradientMode.Smooth !== this.mode)\r\n      props.mode = this.mode;\r\n\r\n    if (10 !== this.stepCount)\r\n      props.stepCount = this.stepCount;\r\n\r\n    const marginColor = this.marginColor.toJSON();\r\n    if (0 !== marginColor)\r\n      props.marginColor = marginColor;\r\n\r\n    if (ThematicGradientColorScheme.BlueRed !== this.colorScheme)\r\n      props.colorScheme = this.colorScheme;\r\n\r\n    if (0 !== this.colorMix)\r\n      props.colorMix = this.colorMix;\r\n\r\n    if (this.customKeys.length > 0)\r\n      props.customKeys = this.customKeys.map((key) => { return { value: key.value, color: key.color.toJSON() }; });\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this ThematicGradientSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A ThematicGradientSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: ThematicGradientSettingsProps): ThematicGradientSettings {\r\n    if (undefined === changedProps)\r\n      return ThematicGradientSettings.fromJSON(this.toJSON());\r\n\r\n    const props: ThematicGradientSettingsProps = {\r\n      mode: undefined !== changedProps.mode ? changedProps.mode : this.mode,\r\n      stepCount: undefined !== changedProps.stepCount ? changedProps.stepCount : this.stepCount,\r\n      marginColor: undefined !== changedProps.marginColor ? changedProps.marginColor : this.marginColor.tbgr,\r\n      colorScheme: undefined !== changedProps.colorScheme ? changedProps.colorScheme : this.colorScheme,\r\n      customKeys: undefined !== changedProps.customKeys ? changedProps.customKeys : this.customKeys.map((key) => ({ value: key.value, color: key.color.tbgr })),\r\n      colorMix: undefined !== changedProps.colorMix ? changedProps.colorMix : this.colorMix,\r\n    };\r\n\r\n    return ThematicGradientSettings.fromJSON(props);\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[ThematicDisplaySensor]].\r\n * @public\r\n */\r\nexport interface ThematicDisplaySensorProps {\r\n  /** The world position of the sensor in X, Y, and Z. Defaults to {0,0,0}. */\r\n  position?: XYZProps;\r\n  /** The value of the sensor used when accessing the thematic gradient texture; expected range is 0 to 1. Defaults to 0. */\r\n  value?: number;\r\n}\r\n\r\n/** A sensor in world space, used for [[ThematicDisplayMode.InverseDistanceWeightedSensors]].\r\n * @public\r\n */\r\nexport class ThematicDisplaySensor {\r\n  /** The world position of the sensor in X, Y, and Z. Defaults to {0,0,0}. */\r\n  public position: Readonly<Point3d>;\r\n  /** The value of the sensor used when accessing the thematic gradient texture; expected range is 0 to 1. Defaults to 0. */\r\n  public readonly value: number;\r\n\r\n  private constructor(json?: ThematicDisplaySensorProps) {\r\n    if (undefined === json) {\r\n      this.position = Point3d.fromJSON();\r\n      this.value = 0;\r\n    } else {\r\n      this.position = Point3d.fromJSON(json.position);\r\n      this.value = (typeof json.value !== \"number\") ? 0 : json.value;\r\n      if (this.value < 0)\r\n        this.value = 0;\r\n      else if (this.value > 1)\r\n        this.value = 1;\r\n    }\r\n  }\r\n\r\n  public equals(other: ThematicDisplaySensor): boolean {\r\n    return (this.value === other.value) && this.position.isAlmostEqual(other.position);\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicDisplaySensorProps) {\r\n    return new ThematicDisplaySensor(json);\r\n  }\r\n\r\n  public toJSON(): ThematicDisplaySensorProps {\r\n    return {\r\n      position: this.position.toJSON(),\r\n      value: this.value,\r\n    };\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[ThematicDisplaySensorSettings]] for [[ThematicDisplayMode.InverseDistanceWeightedSensors]].\r\n * @public\r\n */\r\nexport interface ThematicDisplaySensorSettingsProps {\r\n  /** This is the list of sensors. Defaults to an empty array. */\r\n  sensors?: ThematicDisplaySensorProps[];\r\n  /** This is the distance cutoff in meters. For a position on screen to be affected by a sensor, it must be at least this close to the sensor.\r\n   * If this is zero or negative, then no distance cutoff is applied (all sensors affect all positions regardless of nearness).\r\n   * Defaults to zero.\r\n   * @note Using a suitable distance cutoff imparts a significant performance benefit. The larger this value becomes, performance will degrade.\r\n   */\r\n  distanceCutoff?: number;\r\n}\r\n\r\n/** Settings for sensor-based thematic display for [[ThematicDisplayMode.InverseDistanceWeightedSensors]].\r\n * @public\r\n */\r\nexport class ThematicDisplaySensorSettings {\r\n  /** This is the list of sensors. Defaults to an empty array. */\r\n  public readonly sensors: ThematicDisplaySensor[];\r\n  /** This is the distance cutoff in meters. For a position on screen to be affected by a sensor, it must be at least this close to the sensor.\r\n   * If this is zero or negative, then no distance cutoff is applied (all sensors affect all positions regardless of nearness).\r\n   * Defaults to zero.\r\n   * @note Using a suitable distance cutoff imparts a significant performance benefit. The larger this value becomes, performance will degrade.\r\n   */\r\n  public readonly distanceCutoff: number;\r\n\r\n  private constructor(json?: ThematicDisplaySensorSettingsProps) {\r\n    this.sensors = [];\r\n    if (undefined !== json) {\r\n      if (json.sensors !== undefined && json.sensors !== null) {\r\n        json.sensors.forEach((sensorJSON) => this.sensors.push(ThematicDisplaySensor.fromJSON(sensorJSON)));\r\n      }\r\n      this.distanceCutoff = (typeof json.distanceCutoff === \"number\") ? json.distanceCutoff : 0;\r\n    } else {\r\n      this.distanceCutoff = 0;\r\n    }\r\n  }\r\n\r\n  public equals(other: ThematicDisplaySensorSettings): boolean {\r\n    if (this.distanceCutoff !== other.distanceCutoff)\r\n      return false;\r\n\r\n    const thisSensors = this.sensors;\r\n    const otherSensors = other.sensors;\r\n\r\n    if (thisSensors.length !== otherSensors.length)\r\n      return false;\r\n\r\n    for (let i = 0; i < thisSensors.length; i++) {\r\n      if (!thisSensors[i].equals(otherSensors[i]))\r\n        return false;\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicDisplaySensorSettingsProps) {\r\n    return new ThematicDisplaySensorSettings(json);\r\n  }\r\n\r\n  public toJSON(): ThematicDisplaySensorSettingsProps {\r\n    const json: ThematicDisplaySensorSettingsProps = {};\r\n\r\n    json.sensors = [];\r\n    this.sensors.forEach((sensor) => json.sensors!.push(sensor.toJSON()));\r\n\r\n    json.distanceCutoff = this.distanceCutoff;\r\n\r\n    return json;\r\n  }\r\n}\r\n\r\n/** The thematic display mode. This determines how to apply the thematic color gradient to the geometry.\r\n * @public\r\n */\r\nexport enum ThematicDisplayMode {\r\n  /** The color gradient will be mapped to surface geometry and point clouds based on world height in meters. */\r\n  Height = 0,\r\n  /** The color gradient will be mapped to surface geometry and point clouds using inverse distance weighting based on world positions and corresponding values from a list of sensors.\r\n   * @note Performance will decrease as more sensors are added.\r\n   */\r\n  InverseDistanceWeightedSensors = 1,\r\n  /** The color gradient will be mapped to surface geometry based on the slope of the surface. The slope value is calculated based on the angle between the surface and the axis specified in the associated [[ThematicDisplay]] object.\r\n   * @note This display mode does not affect point clouds.\r\n   */\r\n  Slope = 2,\r\n  /** The color gradient will be mapped to surface geometry based on the direction of a sun shining on the surface.\r\n   * @note This display mode does not affect point clouds.\r\n   */\r\n  HillShade = 3,\r\n}\r\n\r\n/** JSON representation of the thematic display setup of a [[DisplayStyle3d]].\r\n * @public\r\n */\r\nexport interface ThematicDisplayProps {\r\n  /** The thematic display mode. This determines how to apply the thematic color gradient to the geometry. Defaults to [[ThematicDisplayMode.Height]]. */\r\n  displayMode?: ThematicDisplayMode;\r\n  /** The settings used to create a color gradient applied to the geometry. Defaults to an instantiation using [[ThematicGradientSettings.fromJSON]] with no arguments. */\r\n  gradientSettings?: ThematicGradientSettingsProps;\r\n  /** The range to use when applying the thematic gradient for height and slope mode.\r\n   * For [[ThematicDisplayMode.Height]], this is world space in meters and represents the range in which to apply the gradient along the specified axis.\r\n   * For [[ThematicDisplayMode.Slope]], this is a range in degrees with a minimum low value of 0 degrees and a maximum high value of 90 degrees.\r\n   * Defaults to a null range.\r\n   */\r\n  range?: Range1dProps;\r\n  /** For [[ThematicDisplayMode.Height]], this is the axis along which to apply the thematic gradient in the scene. For [[ThematicDisplayMode.Slope]], calculating the slope of a surface is done in relation to the axis. Defaults to {0,0,0}. */\r\n  axis?: XYZProps;\r\n  /** For [[ThematicDisplayMode.HillShade]], this is the direction of the sun in world space. Defaults to {0,0,0}. */\r\n  sunDirection?: XYZProps;\r\n  /** For [[ThematicDisplayMode.InverseDistanceWeightedSensors]], these are the settings that control the sensors. Defaults to an instantiation using [[ThematicDisplaySensorSettings.fromJSON]] with no arguments.\r\n   * @public\r\n   */\r\n  sensorSettings?: ThematicDisplaySensorSettingsProps;\r\n}\r\n\r\n/** The thematic display setup of a [[DisplayStyle3d]].\r\n * Thematic display allows a user to colorize a scene using a color gradient in a way that provides a visual cue about certain attributes of the rendered geometry. This scene colorization will be done based on certain geometric attributes like height, surface slope, position of surfaces relative to a sun position, or geometric position relative to a list of sensors.\r\n * The documentation for [[ThematicDisplayMode]] describes how each mode colorizes the scene.\r\n * @note Applying thematic display to geometry prevents shadows from applying to the same geometry.\r\n * @public\r\n */\r\nexport class ThematicDisplay {\r\n  /** The thematic display mode. This determines how to apply the thematic color gradient to the geometry. Defaults to [[ThematicDisplayMode.Height]]. */\r\n  public readonly displayMode: ThematicDisplayMode;\r\n  /** The settings used to create a color gradient applied to the geometry. Defaults to an instantiation using [[ThematicGradientSettings.fromJSON]] with no arguments. */\r\n  public readonly gradientSettings: ThematicGradientSettings;\r\n  /** The range to use when applying the thematic gradient for height and slope mode.\r\n   * For [[ThematicDisplayMode.Height]], this is world space in meters and represents the range in which to apply the gradient along the specified axis.\r\n   * For [[ThematicDisplayMode.Slope]], this is a range in radians with a minimum low value of 0 degrees and a maximum high value of 90 degrees.\r\n   * Defaults to a null range.\r\n   */\r\n  public readonly range: Range1d;\r\n  /** For [[ThematicDisplayMode.Height]], this is the axis along which to apply the thematic gradient in the scene. For [[ThematicDisplayMode.Slope]], the slope of a surface is calculated in relation to this axis. Defaults to {0,0,0}. */\r\n  public readonly axis: Vector3d;\r\n  /** For [[ThematicDisplayMode.HillShade]], this is the direction of the sun in world space. Defaults to {0,0,0}. */\r\n  public readonly sunDirection: Vector3d;\r\n  /** For [[ThematicDisplayMode.InverseDistanceWeightedSensors]], these are the settings that control the sensors. Defaults to an instantiation using [[ThematicDisplaySensorSettings.fromJSON]] with no arguments.\r\n   * @public\r\n   */\r\n  public readonly sensorSettings: ThematicDisplaySensorSettings;\r\n\r\n  public equals(other: ThematicDisplay): boolean {\r\n    if (this.displayMode !== other.displayMode)\r\n      return false;\r\n    if (!this.gradientSettings.equals(other.gradientSettings))\r\n      return false;\r\n    if (!this.range.isAlmostEqual(other.range))\r\n      return false;\r\n    if (!this.axis.isAlmostEqual(other.axis))\r\n      return false;\r\n    if (!this.sunDirection.isAlmostEqual(other.sunDirection))\r\n      return false;\r\n    if (!this.sensorSettings.equals(other.sensorSettings))\r\n      return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  private constructor(json?: ThematicDisplayProps) {\r\n    if (undefined === json) {\r\n      this.displayMode = ThematicDisplayMode.Height;\r\n      this.gradientSettings = ThematicGradientSettings.fromJSON();\r\n      this.axis = Vector3d.fromJSON();\r\n      this.range = Range1d.fromJSON();\r\n      this.sunDirection = Vector3d.fromJSON();\r\n      this.sensorSettings = ThematicDisplaySensorSettings.fromJSON();\r\n    } else {\r\n      this.displayMode = (json.displayMode !== undefined && json.displayMode !== null) ? json.displayMode : ThematicDisplayMode.Height;\r\n      if (this.displayMode < ThematicDisplayMode.Height || this.displayMode > ThematicDisplayMode.HillShade)\r\n        this.displayMode = ThematicDisplayMode.Height;\r\n      this.gradientSettings = ThematicGradientSettings.fromJSON(json.gradientSettings);\r\n      this.axis = Vector3d.fromJSON(json.axis);\r\n      this.range = Range1d.fromJSON(json.range);\r\n      this.sunDirection = Vector3d.fromJSON(json.sunDirection);\r\n      this.sensorSettings = ThematicDisplaySensorSettings.fromJSON(json.sensorSettings);\r\n    }\r\n    if (ThematicDisplayMode.Height !== this.displayMode) {\r\n      // Disallow isoline and stepped-with-delimiter gradient modes in any mode other than height.\r\n      if (ThematicGradientMode.IsoLines === this.gradientSettings.mode || ThematicGradientMode.SteppedWithDelimiter === this.gradientSettings.mode) {\r\n        const gradientSettingsJSON = this.gradientSettings.toJSON();\r\n        gradientSettingsJSON.mode = ThematicGradientMode.Smooth;\r\n        this.gradientSettings = ThematicGradientSettings.fromJSON(gradientSettingsJSON);\r\n      }\r\n      if (ThematicDisplayMode.Slope === this.displayMode) {\r\n        if (this.range.low < 0.0)\r\n          this.range.low = 0.0;\r\n        if (this.range.high > 90.0)\r\n          this.range.high = 90.0;\r\n      }\r\n    }\r\n  }\r\n\r\n  public static fromJSON(json?: ThematicDisplayProps) {\r\n    return new ThematicDisplay(json);\r\n  }\r\n\r\n  public toJSON(): ThematicDisplayProps {\r\n    const json: ThematicDisplayProps = {\r\n      displayMode: this.displayMode,\r\n      gradientSettings: this.gradientSettings.toJSON(),\r\n      axis: this.axis.toJSON(),\r\n      sunDirection: this.sunDirection.toJSON(),\r\n      range: this.range.toJSON(),\r\n    };\r\n\r\n    if (this.sensorSettings.sensors.length > 0)\r\n      json.sensorSettings = this.sensorSettings.toJSON();\r\n\r\n    return json;\r\n  }\r\n}\r\n"]}

package/lib/cjs/TileProps.d.ts

@@ -47,6 +47,12 @@ export interface IModelTileTreeProps extends TileTreeProps {
     maxInitialTilesToSkip?: number;
     /** Optionally specifies the maximum tile format version supported. */
     formatVersion?: number;
+    /** Size of each tile in pixels. Defaults to 512. Will be 2048 if TileAdmin.useLargerTiles is true. */
+    tileScreenSize?: number;
+    /** For a tile tree produced for a [[RenderTimeline.Script]], the bounding ranges for each transform node in the script. */
+    transformNodeRanges?: Array<Range3dProps & {
+        id: number;
+    }>;
 }
 /** Metadata describing the version/format of the tiles supplied by the backend.
  * @see [[TileAdmin.queryVersionInfo]].

package/lib/cjs/TileProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TileProps.d.ts","sourceRoot":"","sources":["../../src/TileProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,KAAK,EAAE,YAAY,CAAC;IACpB,4FAA4F;IAC5F,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,gMAAgM;IAChM,WAAW,EAAE,MAAM,CAAC;IACpB,iGAAiG;IACjG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,gDAAgD;IAChD,QAAQ,EAAE,SAAS,CAAC;IACpB,8DAA8D;IAC9D,QAAQ,EAAE,cAAc,CAAC;IACzB,8GAA8G;IAC9G,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kKAAkK;IAClK,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,uFAAuF;IACvF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,0JAA0J;IAC1J,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,4GAA4G;IAC5G,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,OAAO,IAAI;IACX,aAAa,IAAI;CAClB"}
+{"version":3,"file":"TileProps.d.ts","sourceRoot":"","sources":["../../src/TileProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,KAAK,EAAE,YAAY,CAAC;IACpB,4FAA4F;IAC5F,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,gMAAgM;IAChM,WAAW,EAAE,MAAM,CAAC;IACpB,iGAAiG;IACjG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,gDAAgD;IAChD,QAAQ,EAAE,SAAS,CAAC;IACpB,8DAA8D;IAC9D,QAAQ,EAAE,cAAc,CAAC;IACzB,8GAA8G;IAC9G,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kKAAkK;IAClK,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,uFAAuF;IACvF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,0JAA0J;IAC1J,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,4GAA4G;IAC5G,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2HAA2H;IAC3H,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,OAAO,IAAI;IACX,aAAa,IAAI;CAClB"}

package/lib/cjs/TileProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"TileProps.js","sourceRoot":"","sources":["../../src/TileProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAmEH;;GAEG;AACH,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,+DAAW,CAAA;IACX,2EAAiB,CAAA;AACnB,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B","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 Tile\r\n */\r\n\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { Range3dProps, TransformProps } from \"@itwin/core-geometry\";\r\n\r\n/** Wire format describing an [IModelTile]($frontend)\r\n * @internal\r\n */\r\nexport interface TileProps {\r\n  /** The unique identifier of the tile's content */\r\n  contentId: string;\r\n  /** The volume of space represented by this tile. */\r\n  range: Range3dProps;\r\n  /** Optional volume within the tile's range which more tightly encloses the tile geometry */\r\n  contentRange?: Range3dProps;\r\n  /** The maximum size in pixels at which the tile should be drawn on the screen. Excludes the optional sizeMultiplier which is applied separately. 0.0 indicates this tile is not displayable. */\r\n  maximumSize: number;\r\n  /** Optional scaling factor applied to this tile's maximum size. Defaults to 1.0 if undefined. */\r\n  sizeMultiplier?: number;\r\n  /** Optional boolean indicating this tile has no children. Defaults to false if undefined. */\r\n  isLeaf?: boolean;\r\n}\r\n\r\n/** Wire format describing a [TileTree]($frontend)\r\n * @internal\r\n */\r\nexport interface TileTreeProps {\r\n  /** The unique identifier of this TileTree within the iModel */\r\n  id: string;\r\n  /** Metadata describing the tree's root Tile. */\r\n  rootTile: TileProps;\r\n  /** Transform tile coordinates to iModel world coordinates. */\r\n  location: TransformProps;\r\n  /** If defined, limits the number of child tiles which can be skipped in selecting tiles of appropriate LOD */\r\n  maxTilesToSkip?: number;\r\n  /** Optional volume within which content of all tiles' contents are guaranteed to be contained - never larger than `rootTile.range` and sometimes much smaller. */\r\n  contentRange?: Range3dProps;\r\n}\r\n\r\n/** Wire format describing an [IModelTileTree]($frontend).\r\n * @internal\r\n */\r\nexport interface IModelTileTreeProps extends TileTreeProps {\r\n  /** Optional namespace applied to tile content Ids for tiles belonging to this tree. */\r\n  contentIdQualifier?: string;\r\n  /** The geometry guid used as a baseline for tile content. May not match the model's current geometry guid during a [GraphicalEditingScope]($frontend). */\r\n  geometryGuid?: GuidString;\r\n  /** If defined, specifies the number of levels of the tile tree that can be skipped when selecting tiles. */\r\n  maxInitialTilesToSkip?: number;\r\n  /** Optionally specifies the maximum tile format version supported. */\r\n  formatVersion?: number;\r\n}\r\n\r\n/** Metadata describing the version/format of the tiles supplied by the backend.\r\n * @see [[TileAdmin.queryVersionInfo]].\r\n * @public\r\n */\r\nexport interface TileVersionInfo {\r\n  /** The exact version of the \"iMdl\" tile format used by the backend when generating tile content.\r\n   * Newer versions of the tile format remain backwards-compatible, but may fix bugs from previous versions and add new features.\r\n   * A frontend can request tiles of an earlier version than this, but should not of newer versions.\r\n   * @note The version is represented as a 32-bit integer combining the 16-bit major and minor version numbers.\r\n   * @see [[CurrentImdlVersion]] to obtain the current version used by the frontend or backend.\r\n   */\r\n  formatVersion: number;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport enum TileContentSource {\r\n  Backend = 0,\r\n  ExternalCache = 1,\r\n}\r\n"]}
+{"version":3,"file":"TileProps.js","sourceRoot":"","sources":["../../src/TileProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAuEH;;GAEG;AACH,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,+DAAW,CAAA;IACX,2EAAiB,CAAA;AACnB,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B","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 Tile\r\n */\r\n\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { Range3dProps, TransformProps } from \"@itwin/core-geometry\";\r\n\r\n/** Wire format describing an [IModelTile]($frontend)\r\n * @internal\r\n */\r\nexport interface TileProps {\r\n  /** The unique identifier of the tile's content */\r\n  contentId: string;\r\n  /** The volume of space represented by this tile. */\r\n  range: Range3dProps;\r\n  /** Optional volume within the tile's range which more tightly encloses the tile geometry */\r\n  contentRange?: Range3dProps;\r\n  /** The maximum size in pixels at which the tile should be drawn on the screen. Excludes the optional sizeMultiplier which is applied separately. 0.0 indicates this tile is not displayable. */\r\n  maximumSize: number;\r\n  /** Optional scaling factor applied to this tile's maximum size. Defaults to 1.0 if undefined. */\r\n  sizeMultiplier?: number;\r\n  /** Optional boolean indicating this tile has no children. Defaults to false if undefined. */\r\n  isLeaf?: boolean;\r\n}\r\n\r\n/** Wire format describing a [TileTree]($frontend)\r\n * @internal\r\n */\r\nexport interface TileTreeProps {\r\n  /** The unique identifier of this TileTree within the iModel */\r\n  id: string;\r\n  /** Metadata describing the tree's root Tile. */\r\n  rootTile: TileProps;\r\n  /** Transform tile coordinates to iModel world coordinates. */\r\n  location: TransformProps;\r\n  /** If defined, limits the number of child tiles which can be skipped in selecting tiles of appropriate LOD */\r\n  maxTilesToSkip?: number;\r\n  /** Optional volume within which content of all tiles' contents are guaranteed to be contained - never larger than `rootTile.range` and sometimes much smaller. */\r\n  contentRange?: Range3dProps;\r\n}\r\n\r\n/** Wire format describing an [IModelTileTree]($frontend).\r\n * @internal\r\n */\r\nexport interface IModelTileTreeProps extends TileTreeProps {\r\n  /** Optional namespace applied to tile content Ids for tiles belonging to this tree. */\r\n  contentIdQualifier?: string;\r\n  /** The geometry guid used as a baseline for tile content. May not match the model's current geometry guid during a [GraphicalEditingScope]($frontend). */\r\n  geometryGuid?: GuidString;\r\n  /** If defined, specifies the number of levels of the tile tree that can be skipped when selecting tiles. */\r\n  maxInitialTilesToSkip?: number;\r\n  /** Optionally specifies the maximum tile format version supported. */\r\n  formatVersion?: number;\r\n  /** Size of each tile in pixels. Defaults to 512. Will be 2048 if TileAdmin.useLargerTiles is true. */\r\n  tileScreenSize?: number;\r\n  /** For a tile tree produced for a [[RenderTimeline.Script]], the bounding ranges for each transform node in the script. */\r\n  transformNodeRanges?: Array<Range3dProps & { id: number }>;\r\n}\r\n\r\n/** Metadata describing the version/format of the tiles supplied by the backend.\r\n * @see [[TileAdmin.queryVersionInfo]].\r\n * @public\r\n */\r\nexport interface TileVersionInfo {\r\n  /** The exact version of the \"iMdl\" tile format used by the backend when generating tile content.\r\n   * Newer versions of the tile format remain backwards-compatible, but may fix bugs from previous versions and add new features.\r\n   * A frontend can request tiles of an earlier version than this, but should not of newer versions.\r\n   * @note The version is represented as a 32-bit integer combining the 16-bit major and minor version numbers.\r\n   * @see [[CurrentImdlVersion]] to obtain the current version used by the frontend or backend.\r\n   */\r\n  formatVersion: number;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport enum TileContentSource {\r\n  Backend = 0,\r\n  ExternalCache = 1,\r\n}\r\n"]}

package/lib/cjs/ViewFlags.d.ts

@@ -88,6 +88,10 @@ export interface ViewFlagProps {
     ambientOcclusion?: boolean;
     /** If true, apply [[ThematicDisplay]]. */
     thematicDisplay?: boolean;
+    /** If true, overlay surfaces with wiremesh to reveal their triangulation.
+     * @beta
+     */
+    wiremesh?: boolean;
     /** Controls whether surface discard is always applied regardless of other ViewFlags.
      * Surface shaders contain complicated logic to ensure that the edges of a surface always draw in front of the surface, and that planar surfaces sketched coincident with
      * non-planar surfaces always draw in front of those non-planar surfaces.
@@ -186,6 +190,10 @@ export declare class ViewFlags {
     readonly ambientOcclusion: boolean;
     /** Whether to apply [[ThematicDisplay]]. Default: false. */
     readonly thematicDisplay: boolean;
+    /** If true, overlay surfaces with wiremesh to reveal their triangulation.
+     * @beta
+     */
+    readonly wiremesh: boolean;
     /** Controls whether surface discard is always applied regardless of other ViewFlags.
      * Surface shaders contain complicated logic to ensure that the edges of a surface always draw in front of the surface, and that planar surfaces sketched coincident with
      * non-planar surfaces always draw in front of those non-planar surfaces.

package/lib/cjs/ViewFlags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewFlags.d.ts","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;GAGG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,SAAS,IAAI;IACb;;;;OAIG;IACH,WAAW,IAAI;IACf;;;;;OAKG;IACH,SAAS,IAAI;IACb;;;OAGG;IACH,UAAU,IAAI;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iHAAiH;IACjH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,uFAAuF;IACvF,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,qFAAqF;IACrF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,sIAAsI;IACtI,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,qIAAqI;IACrI,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,qGAAqG;IACrG,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,sGAAsG;IACtG,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,4FAA4F;IAC5F,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,4DAA4D;IAC5D,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC;;;;;OAKG;IACH,SAAgB,mBAAmB,EAAE,OAAO,CAAC;IAC7C;;;;OAIG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;gBACgB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IA0BvD;;;;;OAKG;IACI,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIlE;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAanE;;;;;;OAMG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAS3F;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,SAAS,IAAI,SAAS;IAoB7B,gBAAgB;IACT,kBAAkB,IAAI,OAAO;IAWpC,wHAAwH;IACjH,aAAa,IAAI,OAAO;IAI/B,sCAAsC;IAC/B,MAAM,IAAI,aAAa;IA6B9B;;OAEG;IACI,kBAAkB,IAAI,QAAQ,CAAC,aAAa,CAAC;IA8BpD,kFAAkF;IAClF,gBAAuB,QAAQ,YAAmB;IAElD;;OAEG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIrE;;;;;;;OAOG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS;IAyCvD,yDAAyD;IAClD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,OAAO;CA4B7D;AAED;;;GAGG;AACH,oBAAY,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;AAE9E;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC"}
+{"version":3,"file":"ViewFlags.d.ts","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;GAGG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,SAAS,IAAI;IACb;;;;OAIG;IACH,WAAW,IAAI;IACf;;;;;OAKG;IACH,SAAS,IAAI;IACb;;;OAGG;IACH,UAAU,IAAI;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iHAAiH;IACjH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,uFAAuF;IACvF,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,qFAAqF;IACrF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,sIAAsI;IACtI,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,qIAAqI;IACrI,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,qGAAqG;IACrG,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,sGAAsG;IACtG,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,4FAA4F;IAC5F,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,4DAA4D;IAC5D,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC;;OAEG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,SAAgB,mBAAmB,EAAE,OAAO,CAAC;IAC7C;;;;OAIG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;gBACgB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IA2BvD;;;;;OAKG;IACI,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIlE;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IA4BnE;;;;;;OAMG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAS3F;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,SAAS,IAAI,SAAS;IAoB7B,gBAAgB;IACT,kBAAkB,IAAI,OAAO;IAWpC,wHAAwH;IACjH,aAAa,IAAI,OAAO;IAI/B,sCAAsC;IAC/B,MAAM,IAAI,aAAa;IA8B9B;;OAEG;IACI,kBAAkB,IAAI,QAAQ,CAAC,aAAa,CAAC;IA+BpD,kFAAkF;IAClF,gBAAuB,QAAQ,YAAmB;IAElD;;OAEG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIrE;;;;;;;OAOG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS;IA0CvD,yDAAyD;IAClD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,OAAO;CA6B7D;AAED;;;GAGG;AACH,oBAAY,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;AAE9E;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC"}

package/lib/cjs/ViewFlags.js

@@ -71,7 +71,7 @@ class ViewFlags {
      * @param flags The properties to initialize. Any properties not specified are initialized to their default values.
      */
     constructor(flags) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
         this.renderMode = (_a = flags === null || flags === void 0 ? void 0 : flags.renderMode) !== null && _a !== void 0 ? _a : RenderMode.Wireframe;
         this.dimensions = (_b = flags === null || flags === void 0 ? void 0 : flags.dimensions) !== null && _b !== void 0 ? _b : true;
         this.patterns = (_c = flags === null || flags === void 0 ? void 0 : flags.patterns) !== null && _c !== void 0 ? _c : true;
@@ -92,9 +92,10 @@ class ViewFlags {
         this.backgroundMap = (_t = flags === null || flags === void 0 ? void 0 : flags.backgroundMap) !== null && _t !== void 0 ? _t : false;
         this.ambientOcclusion = (_u = flags === null || flags === void 0 ? void 0 : flags.ambientOcclusion) !== null && _u !== void 0 ? _u : false;
         this.thematicDisplay = (_v = flags === null || flags === void 0 ? void 0 : flags.thematicDisplay) !== null && _v !== void 0 ? _v : false;
-        this.forceSurfaceDiscard = (_w = flags === null || flags === void 0 ? void 0 : flags.forceSurfaceDiscard) !== null && _w !== void 0 ? _w : false;
-        this.whiteOnWhiteReversal = (_x = flags === null || flags === void 0 ? void 0 : flags.whiteOnWhiteReversal) !== null && _x !== void 0 ? _x : true;
-        this.lighting = (_y = flags === null || flags === void 0 ? void 0 : flags.lighting) !== null && _y !== void 0 ? _y : false;
+        this.wiremesh = (_w = flags === null || flags === void 0 ? void 0 : flags.wiremesh) !== null && _w !== void 0 ? _w : false;
+        this.forceSurfaceDiscard = (_x = flags === null || flags === void 0 ? void 0 : flags.forceSurfaceDiscard) !== null && _x !== void 0 ? _x : false;
+        this.whiteOnWhiteReversal = (_y = flags === null || flags === void 0 ? void 0 : flags.whiteOnWhiteReversal) !== null && _y !== void 0 ? _y : true;
+        this.lighting = (_z = flags === null || flags === void 0 ? void 0 : flags.lighting) !== null && _z !== void 0 ? _z : false;
     }
     /** Produce a copy of these ViewFlags with some modified properties. Any properties not explicitly specified by `changedFlags` will retain their current values.
      * @param changedFlags Properties to modify.
@@ -111,15 +112,29 @@ class ViewFlags {
      * @see [[copy]] to have `undefined` properties reset to their default values.
      */
     override(overrides) {
-        // Create a copy of the input with all undefined ViewFlags properties removed.
-        // Note we use the keys of `ViewFlags.defaults` instead of those of the input to avoid processing additional unrelated properties that may be present on input.
-        overrides = { ...overrides };
-        for (const propName of Object.keys(ViewFlags.defaults)) {
+        // This method can get called very frequently when a RenderTimeline script is applied to the view. Often `overrides` will be an empty object.
+        // To optimize:
+        //  - Bail as quickly as possible if nothing is actually overridden, without allocating a new ViewFlags.
+        //  - Only make a copy of the input if at least one property is explicitly `undefined`.
+        let copied = false;
+        let anyOverridden = false;
+        for (const propName of Object.keys(overrides)) {
             const key = propName;
-            if (undefined === overrides[key])
+            const overrideValue = overrides[key];
+            if (undefined === overrideValue) {
+                if (!copied) {
+                    // Don't modify input...
+                    overrides = { ...overrides };
+                    copied = true;
+                }
+                // `undefined` means "retain existing value".
                 delete overrides[key];
+            }
+            else if (overrideValue !== this[key]) {
+                anyOverridden = true;
+            }
         }
-        return this.copy(overrides);
+        return anyOverridden ? this.copy(overrides) : this;
     }
     /** Produce a copy of these ViewFlags with a single boolean property changed.
      * @param flag The name of the property.
@@ -222,6 +237,8 @@ class ViewFlags {
             out.ambientOcclusion = true;
         if (this.thematicDisplay)
             out.thematicDisplay = true;
+        if (this.wiremesh)
+            out.wiremesh = true;
         if (this.forceSurfaceDiscard)
             out.forceSurfaceDiscard = true;
         if (!this.whiteOnWhiteReversal)
@@ -257,6 +274,7 @@ class ViewFlags {
             backgroundMap: this.backgroundMap,
             ambientOcclusion: this.ambientOcclusion,
             thematicDisplay: this.thematicDisplay,
+            wiremesh: this.wiremesh,
             forceSurfaceDiscard: this.forceSurfaceDiscard,
             noWhiteOnWhiteReversal: !this.whiteOnWhiteReversal,
         };
@@ -309,6 +327,7 @@ class ViewFlags {
             backgroundMap: core_bentley_1.JsonUtils.asBool(json.backgroundMap),
             ambientOcclusion: core_bentley_1.JsonUtils.asBool(json.ambientOcclusion),
             thematicDisplay: core_bentley_1.JsonUtils.asBool(json.thematicDisplay),
+            wiremesh: core_bentley_1.JsonUtils.asBool(json.wiremesh),
             forceSurfaceDiscard: core_bentley_1.JsonUtils.asBool(json.forceSurfaceDiscard),
             whiteOnWhiteReversal: !core_bentley_1.JsonUtils.asBool(json.noWhiteOnWhiteReversal),
         });
@@ -338,6 +357,7 @@ class ViewFlags {
             && this.backgroundMap === other.backgroundMap
             && this.ambientOcclusion === other.ambientOcclusion
             && this.thematicDisplay === other.thematicDisplay
+            && this.wiremesh === other.wiremesh
             && this.forceSurfaceDiscard === other.forceSurfaceDiscard
             && this.whiteOnWhiteReversal === other.whiteOnWhiteReversal;
     }