@itwin/core-common 5.0.0-dev.56 → 5.0.0-dev.58

package/lib/cjs/SubCategoryAppearance.js.map

@@ -1 +1 @@
-{"version":3,"file":"SubCategoryAppearance.js","sourceRoot":"","sources":["../../src/SubCategoryAppearance.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,yCAAqD;AAErD;;;;GAIG;AACH,MAAa,qBAAqB;IAoChC;;;OAGG;IACH,IAAW,SAAS,KAAe,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3G,qJAAqJ;IACrJ,IAAW,gBAAgB,KAAa,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAErI,YAAY,KAAmC;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,GAAG,mBAAQ,CAAC,KAAK,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACzE,IAAI,CAAC,OAAO,GAAG,mBAAI,CAAC,OAAO,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC,IAAI;YACZ,IAAI,CAAC,UAAU,GAAG,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,UAAU;YAClB,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAEM,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YACvC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACpC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC9B,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;YAC9B,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACpC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YACtC,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM;QACX,MAAM,GAAG,GAAgC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;QACxE,IAAI,IAAI,CAAC,SAAS;YAChB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QAEvB,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAExB,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ;YACrB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;YAC5B,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QAE3B,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;YAC/B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;QAEjC,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY;YAC3B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;QAEjC,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAEtC,IAAI,IAAI,CAAC,iBAAiB;YACxB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAE1C,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,KAA4B,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;aAE5E,aAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;;AAhIvD,sDAiIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\n\n/** Parameters that define the way geometry on a [[SubCategory]] appears.\n * SubCategoryAppearance describes the intrinsic appearance of geometry belonging to that SubCategory, independent of a particular [[ViewState]].\n * Aspects of a SubCategory's appearance can be overridden in the context of a particular [[ViewState]] through the use of [[SubCategoryOverride]]s.\n * @public\n */\nexport class SubCategoryAppearance {\n  /** The color of the geometry.\n   * @note The transparency component of the color is ignored.\n   * @see [[SubCategoryAppearance.transparency]].\n   */\n  public readonly color: ColorDef;\n  /** The line width, in pixels.\n   * @note The renderer will clamp values to the integer range [1, 32].\n   */\n  public readonly weight: number;\n  /** The display priority used to control which geometry draws in front of other geometry within a 2D view.\n   * The priority is a number in the range [-8388576,8388576].\n   * Where two pieces of geometry overlap, the one with the larger priority value draws on top of the one with the smaller priority.\n   * If they have equal priorities, the order in which they draw is undefined, and z-fighting may result.\n   * @note This property has no effect in 3D views unless [[PlanProjectionSettings]] are in effect.\n   */\n  public readonly priority: number;\n  /** A value in the range [0, 1] indicating the transparency of the geometry where 0.0 means \"fully opaque\" and 1.0 means \"fully transparent\". */\n  public readonly transparency: number;\n  /** If true, geometry belonging to this SubCategory is not drawn. */\n  public readonly invisible: boolean;\n  /** @internal */\n  public readonly dontPlot: boolean;\n  /** @internal */\n  public readonly dontSnap: boolean;\n  /** @internal */\n  public readonly dontLocate: boolean;\n  /** The element ID of the line style used to draw curves, or an invalid ID if no line style is specified. */\n  public readonly styleId: Id64String;\n  /** The element ID of the material applied to surfaces, or an invalid ID if no material is specified. */\n  public readonly materialId: Id64String;\n  /** @internal */\n  protected readonly _fillColor?: ColorDef;\n  /** @internal */\n  protected readonly _fillTransparency?: number;\n\n  /** The fill color of geometry marked as being filled.\n   * @note The transparency component of the fill color is ignored.\n   * @see [[SubCategoryAppearance.fillTransparency]].\n   */\n  public get fillColor(): ColorDef { return (undefined !== this._fillColor ? this._fillColor : this.color); }\n  /** A value in the range [0, 1] indicating the fill transparency of the geometry where 0.0 means \"fully opaque\" and 1.0 means \"fully transparent\". */\n  public get fillTransparency(): number { return (undefined !== this._fillTransparency ? this._fillTransparency : this.transparency); }\n\n  constructor(props?: SubCategoryAppearance.Props) {\n    if (!props) {\n      this.color = ColorDef.black;\n      this.weight = 0;\n      this.priority = 0;\n      this.transparency = 0;\n      this.invisible = this.dontPlot = this.dontSnap = this.dontLocate = false;\n      this.styleId = Id64.invalid;\n      this.materialId = Id64.invalid;\n      return;\n    }\n\n    this.invisible = JsonUtils.asBool(props.invisible);\n    this.dontSnap = JsonUtils.asBool(props.dontSnap);\n    this.dontLocate = JsonUtils.asBool(props.dontLocate);\n    this.dontPlot = JsonUtils.asBool(props.dontPlot);\n    this.color = ColorDef.fromJSON(props.color);\n    this.weight = JsonUtils.asInt(props.weight);\n    this.styleId = Id64.fromJSON(props.style);\n    this.priority = JsonUtils.asInt(props.priority);\n    this.materialId = Id64.fromJSON(props.material);\n    this.transparency = JsonUtils.asDouble(props.transp);\n    if (props.fill)\n      this._fillColor = ColorDef.fromJSON(props.fill);\n    if (props.transpFill)\n      this._fillTransparency = JsonUtils.asDouble(props.transpFill);\n  }\n\n  public equals(other: SubCategoryAppearance): boolean {\n    return this.invisible === other.invisible &&\n      this.dontPlot === other.dontPlot &&\n      this.dontSnap === other.dontSnap &&\n      this.dontLocate === other.dontLocate &&\n      this.color.equals(other.color) &&\n      this.weight === other.weight &&\n      this.priority === other.priority &&\n      this.styleId === other.styleId &&\n      this.materialId === other.materialId &&\n      this.transparency === other.transparency &&\n      this.fillColor.equals(other.fillColor) &&\n      this.fillTransparency === other.fillTransparency;\n  }\n\n  /** @internal */\n  public toJSON(): SubCategoryAppearance.Props {\n    const val: SubCategoryAppearance.Props = { color: this.color.toJSON() };\n    if (this.invisible)\n      val.invisible = true;\n\n    if (this.dontPlot)\n      val.dontPlot = true;\n\n    if (this.dontSnap)\n      val.dontSnap = true;\n\n    if (this.dontLocate)\n      val.dontLocate = true;\n\n    if (0 !== this.weight)\n      val.weight = this.weight;\n\n    if (0 !== this.priority)\n      val.priority = this.priority;\n\n    if (Id64.isValid(this.styleId))\n      val.style = this.styleId;\n\n    if (Id64.isValid(this.materialId))\n      val.material = this.materialId;\n\n    if (0.0 !== this.transparency)\n      val.transp = this.transparency;\n\n    if (this._fillColor)\n      val.fill = this._fillColor.toJSON();\n\n    if (this._fillTransparency)\n      val.transpFill = this._fillTransparency;\n\n    return val;\n  }\n\n  public clone(): SubCategoryAppearance { return new SubCategoryAppearance(this.toJSON()); }\n\n  public static defaults = new SubCategoryAppearance();\n}\n\n/** @public */\nexport namespace SubCategoryAppearance {\n  /** Properties used to create a SubCategoryAppearance\n   * See [[SubCategoryAppearance]]\n   */\n  export interface Props {\n    /** See [[SubCategoryAppearance.color]]. Defaults to black. */\n    color?: ColorDefProps;\n    /** See [[SubCategoryAppearance.fillColor]]. Defaults to [[SubCategoryAppearance.color]]. */\n    fill?: ColorDefProps;\n    /** See [[SubCategoryAppearance.invisible]]. Defaults to false. */\n    invisible?: boolean;\n    /** @internal */\n    dontPlot?: boolean;\n    /** @internal */\n    dontSnap?: boolean;\n    /** @internal */\n    dontLocate?: boolean;\n    /** See [[SubCategoryAppearance.weight]]. Defaults to 0. */\n    weight?: number;\n    /** See [[SubCategoryAppearance.styleId]]. Defaults to an invalid ID indicating \"no line style\". */\n    style?: Id64String;\n    /** See [[SubCategoryAppearance.priority]]. Defaults to 0. */\n    priority?: number;\n    /** See [[SubCategoryAppearance.materialId]]. Defaults to an invalid ID indicating \"no material\". */\n    material?: Id64String;\n    /** See [[SubCategoryAppearance.transparency]]. Defaults to 0. */\n    transp?: number;\n    /** See [[SubCategoryAppearance.fillTransparency]]. Defaults to [[SubCategoryAppearance.transparency]]. */\n    transpFill?: number;\n  }\n}\n"]}
+{"version":3,"file":"SubCategoryAppearance.js","sourceRoot":"","sources":["../../src/SubCategoryAppearance.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,yCAAqD;AAErD;;;;GAIG;AACH,MAAa,qBAAqB;IAChC;;;OAGG;IACa,KAAK,CAAW;IAChC;;OAEG;IACa,MAAM,CAAS;IAC/B;;;;;OAKG;IACa,QAAQ,CAAS;IACjC,gJAAgJ;IAChI,YAAY,CAAS;IACrC,oEAAoE;IACpD,SAAS,CAAU;IACnC,gBAAgB;IACA,QAAQ,CAAU;IAClC,gBAAgB;IACA,QAAQ,CAAU;IAClC,gBAAgB;IACA,UAAU,CAAU;IACpC,4GAA4G;IAC5F,OAAO,CAAa;IACpC,wGAAwG;IACxF,UAAU,CAAa;IACvC,gBAAgB;IACG,UAAU,CAAY;IACzC,gBAAgB;IACG,iBAAiB,CAAU;IAE9C;;;OAGG;IACH,IAAW,SAAS,KAAe,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3G,qJAAqJ;IACrJ,IAAW,gBAAgB,KAAa,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAErI,YAAY,KAAmC;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,GAAG,mBAAQ,CAAC,KAAK,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACzE,IAAI,CAAC,OAAO,GAAG,mBAAI,CAAC,OAAO,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC,IAAI;YACZ,IAAI,CAAC,UAAU,GAAG,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,UAAU;YAClB,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAEM,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YACvC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACpC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC9B,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;YAC9B,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACpC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YACtC,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM;QACX,MAAM,GAAG,GAAgC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;QACxE,IAAI,IAAI,CAAC,SAAS;YAChB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QAEvB,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAExB,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ;YACrB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;YAC5B,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QAE3B,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;YAC/B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;QAEjC,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY;YAC3B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;QAEjC,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAEtC,IAAI,IAAI,CAAC,iBAAiB;YACxB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAE1C,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,KAA4B,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAEnF,MAAM,CAAC,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;;AAhIvD,sDAiIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\n\n/** Parameters that define the way geometry on a [[SubCategory]] appears.\n * SubCategoryAppearance describes the intrinsic appearance of geometry belonging to that SubCategory, independent of a particular [[ViewState]].\n * Aspects of a SubCategory's appearance can be overridden in the context of a particular [[ViewState]] through the use of [[SubCategoryOverride]]s.\n * @public\n */\nexport class SubCategoryAppearance {\n  /** The color of the geometry.\n   * @note The transparency component of the color is ignored.\n   * @see [[SubCategoryAppearance.transparency]].\n   */\n  public readonly color: ColorDef;\n  /** The line width, in pixels.\n   * @note The renderer will clamp values to the integer range [1, 32].\n   */\n  public readonly weight: number;\n  /** The display priority used to control which geometry draws in front of other geometry within a 2D view.\n   * The priority is a number in the range [-8388576,8388576].\n   * Where two pieces of geometry overlap, the one with the larger priority value draws on top of the one with the smaller priority.\n   * If they have equal priorities, the order in which they draw is undefined, and z-fighting may result.\n   * @note This property has no effect in 3D views unless [[PlanProjectionSettings]] are in effect.\n   */\n  public readonly priority: number;\n  /** A value in the range [0, 1] indicating the transparency of the geometry where 0.0 means \"fully opaque\" and 1.0 means \"fully transparent\". */\n  public readonly transparency: number;\n  /** If true, geometry belonging to this SubCategory is not drawn. */\n  public readonly invisible: boolean;\n  /** @internal */\n  public readonly dontPlot: boolean;\n  /** @internal */\n  public readonly dontSnap: boolean;\n  /** @internal */\n  public readonly dontLocate: boolean;\n  /** The element ID of the line style used to draw curves, or an invalid ID if no line style is specified. */\n  public readonly styleId: Id64String;\n  /** The element ID of the material applied to surfaces, or an invalid ID if no material is specified. */\n  public readonly materialId: Id64String;\n  /** @internal */\n  protected readonly _fillColor?: ColorDef;\n  /** @internal */\n  protected readonly _fillTransparency?: number;\n\n  /** The fill color of geometry marked as being filled.\n   * @note The transparency component of the fill color is ignored.\n   * @see [[SubCategoryAppearance.fillTransparency]].\n   */\n  public get fillColor(): ColorDef { return (undefined !== this._fillColor ? this._fillColor : this.color); }\n  /** A value in the range [0, 1] indicating the fill transparency of the geometry where 0.0 means \"fully opaque\" and 1.0 means \"fully transparent\". */\n  public get fillTransparency(): number { return (undefined !== this._fillTransparency ? this._fillTransparency : this.transparency); }\n\n  constructor(props?: SubCategoryAppearance.Props) {\n    if (!props) {\n      this.color = ColorDef.black;\n      this.weight = 0;\n      this.priority = 0;\n      this.transparency = 0;\n      this.invisible = this.dontPlot = this.dontSnap = this.dontLocate = false;\n      this.styleId = Id64.invalid;\n      this.materialId = Id64.invalid;\n      return;\n    }\n\n    this.invisible = JsonUtils.asBool(props.invisible);\n    this.dontSnap = JsonUtils.asBool(props.dontSnap);\n    this.dontLocate = JsonUtils.asBool(props.dontLocate);\n    this.dontPlot = JsonUtils.asBool(props.dontPlot);\n    this.color = ColorDef.fromJSON(props.color);\n    this.weight = JsonUtils.asInt(props.weight);\n    this.styleId = Id64.fromJSON(props.style);\n    this.priority = JsonUtils.asInt(props.priority);\n    this.materialId = Id64.fromJSON(props.material);\n    this.transparency = JsonUtils.asDouble(props.transp);\n    if (props.fill)\n      this._fillColor = ColorDef.fromJSON(props.fill);\n    if (props.transpFill)\n      this._fillTransparency = JsonUtils.asDouble(props.transpFill);\n  }\n\n  public equals(other: SubCategoryAppearance): boolean {\n    return this.invisible === other.invisible &&\n      this.dontPlot === other.dontPlot &&\n      this.dontSnap === other.dontSnap &&\n      this.dontLocate === other.dontLocate &&\n      this.color.equals(other.color) &&\n      this.weight === other.weight &&\n      this.priority === other.priority &&\n      this.styleId === other.styleId &&\n      this.materialId === other.materialId &&\n      this.transparency === other.transparency &&\n      this.fillColor.equals(other.fillColor) &&\n      this.fillTransparency === other.fillTransparency;\n  }\n\n  /** @internal */\n  public toJSON(): SubCategoryAppearance.Props {\n    const val: SubCategoryAppearance.Props = { color: this.color.toJSON() };\n    if (this.invisible)\n      val.invisible = true;\n\n    if (this.dontPlot)\n      val.dontPlot = true;\n\n    if (this.dontSnap)\n      val.dontSnap = true;\n\n    if (this.dontLocate)\n      val.dontLocate = true;\n\n    if (0 !== this.weight)\n      val.weight = this.weight;\n\n    if (0 !== this.priority)\n      val.priority = this.priority;\n\n    if (Id64.isValid(this.styleId))\n      val.style = this.styleId;\n\n    if (Id64.isValid(this.materialId))\n      val.material = this.materialId;\n\n    if (0.0 !== this.transparency)\n      val.transp = this.transparency;\n\n    if (this._fillColor)\n      val.fill = this._fillColor.toJSON();\n\n    if (this._fillTransparency)\n      val.transpFill = this._fillTransparency;\n\n    return val;\n  }\n\n  public clone(): SubCategoryAppearance { return new SubCategoryAppearance(this.toJSON()); }\n\n  public static defaults = new SubCategoryAppearance();\n}\n\n/** @public */\nexport namespace SubCategoryAppearance {\n  /** Properties used to create a SubCategoryAppearance\n   * See [[SubCategoryAppearance]]\n   */\n  export interface Props {\n    /** See [[SubCategoryAppearance.color]]. Defaults to black. */\n    color?: ColorDefProps;\n    /** See [[SubCategoryAppearance.fillColor]]. Defaults to [[SubCategoryAppearance.color]]. */\n    fill?: ColorDefProps;\n    /** See [[SubCategoryAppearance.invisible]]. Defaults to false. */\n    invisible?: boolean;\n    /** @internal */\n    dontPlot?: boolean;\n    /** @internal */\n    dontSnap?: boolean;\n    /** @internal */\n    dontLocate?: boolean;\n    /** See [[SubCategoryAppearance.weight]]. Defaults to 0. */\n    weight?: number;\n    /** See [[SubCategoryAppearance.styleId]]. Defaults to an invalid ID indicating \"no line style\". */\n    style?: Id64String;\n    /** See [[SubCategoryAppearance.priority]]. Defaults to 0. */\n    priority?: number;\n    /** See [[SubCategoryAppearance.materialId]]. Defaults to an invalid ID indicating \"no material\". */\n    material?: Id64String;\n    /** See [[SubCategoryAppearance.transparency]]. Defaults to 0. */\n    transp?: number;\n    /** See [[SubCategoryAppearance.fillTransparency]]. Defaults to [[SubCategoryAppearance.transparency]]. */\n    transpFill?: number;\n  }\n}\n"]}

package/lib/cjs/SubCategoryOverride.js

@@ -21,6 +21,20 @@ const SubCategoryAppearance_1 = require("./SubCategoryAppearance");
  * @public
  */
 class SubCategoryOverride {
+    /** See [[SubCategoryAppearance.color]] */
+    color;
+    /** See [[SubCategoryAppearance.invisible]] */
+    invisible;
+    /** See [[SubCategoryAppearance.weight]] */
+    weight;
+    /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */
+    style;
+    /** See [[SubCategoryAppearance.priority]] */
+    priority;
+    /** See [[SubCategoryAppearance.materialId]] */
+    material;
+    /** See [[SubCategoryAppearance.transparency]] */
+    transparency;
     /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */
     get anyOverridden() {
         return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;
@@ -99,7 +113,7 @@ class SubCategoryOverride {
             this.transparency = core_bentley_1.JsonUtils.asDouble(props.transp);
     }
     /** A default SubCategoryOverride which overrides nothing. */
-    static { this.defaults = new SubCategoryOverride({}); }
+    static defaults = new SubCategoryOverride({});
 }
 exports.SubCategoryOverride = SubCategoryOverride;
 //# sourceMappingURL=SubCategoryOverride.js.map

package/lib/cjs/SubCategoryOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"SubCategoryOverride.js","sourceRoot":"","sources":["../../src/SubCategoryOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,yCAAsC;AACtC,mEAAgE;AAEhE;;;;;;;;GAQG;AACH,MAAa,mBAAmB;IAgB9B,yGAAyG;IACzG,IAAW,aAAa;QACtB,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC;IAC5N,CAAC;IAED,8GAA8G;IACvG,QAAQ,CAAC,UAAiC;QAC/C,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,OAAO,UAAU,CAAC;QAEpB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS;YAClC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAE/B,OAAO,IAAI,6CAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAgC,EAAE,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,KAA0B;QACtC,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;eAC/F,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACnH,OAAO,KAAK,CAAC;QAEf,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YACvD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;;YAE5C,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC;IACjE,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,QAAQ,CAAC,IAAkC;QACvD,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5E,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;YAC/B,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,MAAM,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,YAAY,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,6DAA6D;aAC/C,aAAQ,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;;AA9GvD,kDA+GC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\n\n/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].\n * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:\n *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.\n *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.\n *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.\n * An aspect is overridden by virtue of not being set to \"undefined\" in the SubCategoryOverride.\n * @see [[DisplayStyleState.overrideSubCategory]]\n * @public\n */\nexport class SubCategoryOverride {\n  /** See [[SubCategoryAppearance.color]] */\n  public readonly color?: ColorDef;\n  /** See [[SubCategoryAppearance.invisible]] */\n  public readonly invisible?: boolean;\n  /** See [[SubCategoryAppearance.weight]] */\n  public readonly weight?: number;\n  /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */\n  public readonly style?: Id64String;\n  /** See [[SubCategoryAppearance.priority]] */\n  public readonly priority?: number;\n  /** See [[SubCategoryAppearance.materialId]] */\n  public readonly material?: Id64String;\n  /** See [[SubCategoryAppearance.transparency]] */\n  public readonly transparency?: number;\n\n  /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */\n  public get anyOverridden(): boolean {\n    return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;\n  }\n\n  /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */\n  public override(appearance: SubCategoryAppearance): SubCategoryAppearance {\n    if (!this.anyOverridden)\n      return appearance;\n\n    const props = appearance.toJSON();\n    const ovrProps = this.toJSON();\n    if (undefined !== ovrProps.invisible)\n      props.invisible = ovrProps.invisible;\n    if (undefined !== ovrProps.weight)\n      props.weight = ovrProps.weight;\n    if (undefined !== ovrProps.style)\n      props.style = ovrProps.style;\n    if (undefined !== ovrProps.material)\n      props.material = ovrProps.material;\n    if (undefined !== ovrProps.priority)\n      props.priority = ovrProps.priority;\n    if (undefined !== ovrProps.transp)\n      props.transp = ovrProps.transp;\n    if (undefined !== ovrProps.color)\n      props.color = ovrProps.color;\n\n    return new SubCategoryAppearance(props);\n  }\n\n  /** Convert this SubCategoryOverride to a JSON object\n   * @internal\n   */\n  public toJSON(): SubCategoryAppearance.Props {\n    const props: SubCategoryAppearance.Props = {};\n    if (undefined !== this.invisible)\n      props.invisible = this.invisible;\n\n    if (undefined !== this.weight)\n      props.weight = this.weight;\n\n    if (undefined !== this.style)\n      props.style = this.style;\n\n    if (undefined !== this.material)\n      props.material = this.material;\n\n    if (undefined !== this.priority)\n      props.priority = this.priority;\n\n    if (undefined !== this.transparency)\n      props.transp = this.transparency;\n\n    if (undefined !== this.color)\n      props.color = this.color.toJSON();\n\n    return props;\n  }\n\n  /** Perform equality comparison against another SubCategoryOverride. */\n  public equals(other: SubCategoryOverride): boolean {\n    if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style\n      || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)\n      return false;\n\n    if (undefined !== this.color && undefined !== other.color)\n      return this.color.tbgr === other.color.tbgr;\n    else\n      return undefined === this.color && undefined === other.color;\n  }\n\n  /** Create a new SubCategoryOverride from a JSON object */\n  public static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride {\n    return undefined !== json ? new SubCategoryOverride(json) : this.defaults;\n  }\n\n  private constructor(props: SubCategoryAppearance.Props) {\n    if (undefined !== props.invisible)\n      this.invisible = JsonUtils.asBool(props.invisible);\n    if (undefined !== props.color)\n      this.color = ColorDef.fromJSON(props.color);\n    if (undefined !== props.weight)\n      this.weight = JsonUtils.asInt(props.weight);\n    if (undefined !== props.style)\n      this.style = Id64.fromJSON(props.style);\n    if (undefined !== props.material)\n      this.material = Id64.fromJSON(props.material);\n    if (undefined !== props.priority)\n      this.priority = JsonUtils.asInt(props.priority);\n    if (undefined !== props.transp)\n      this.transparency = JsonUtils.asDouble(props.transp);\n  }\n\n  /** A default SubCategoryOverride which overrides nothing. */\n  public static defaults = new SubCategoryOverride({});\n}\n"]}
+{"version":3,"file":"SubCategoryOverride.js","sourceRoot":"","sources":["../../src/SubCategoryOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,yCAAsC;AACtC,mEAAgE;AAEhE;;;;;;;;GAQG;AACH,MAAa,mBAAmB;IAC9B,0CAA0C;IAC1B,KAAK,CAAY;IACjC,8CAA8C;IAC9B,SAAS,CAAW;IACpC,2CAA2C;IAC3B,MAAM,CAAU;IAChC,yHAAyH;IACzG,KAAK,CAAc;IACnC,6CAA6C;IAC7B,QAAQ,CAAU;IAClC,+CAA+C;IAC/B,QAAQ,CAAc;IACtC,iDAAiD;IACjC,YAAY,CAAU;IAEtC,yGAAyG;IACzG,IAAW,aAAa;QACtB,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC;IAC5N,CAAC;IAED,8GAA8G;IACvG,QAAQ,CAAC,UAAiC;QAC/C,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,OAAO,UAAU,CAAC;QAEpB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS;YAClC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAE/B,OAAO,IAAI,6CAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAgC,EAAE,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,KAA0B;QACtC,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;eAC/F,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACnH,OAAO,KAAK,CAAC;QAEf,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YACvD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;;YAE5C,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC;IACjE,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,QAAQ,CAAC,IAAkC;QACvD,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5E,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;YAC/B,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,MAAM,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,YAAY,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,QAAQ,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;;AA9GvD,kDA+GC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\n\n/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].\n * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:\n *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.\n *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.\n *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.\n * An aspect is overridden by virtue of not being set to \"undefined\" in the SubCategoryOverride.\n * @see [[DisplayStyleState.overrideSubCategory]]\n * @public\n */\nexport class SubCategoryOverride {\n  /** See [[SubCategoryAppearance.color]] */\n  public readonly color?: ColorDef;\n  /** See [[SubCategoryAppearance.invisible]] */\n  public readonly invisible?: boolean;\n  /** See [[SubCategoryAppearance.weight]] */\n  public readonly weight?: number;\n  /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */\n  public readonly style?: Id64String;\n  /** See [[SubCategoryAppearance.priority]] */\n  public readonly priority?: number;\n  /** See [[SubCategoryAppearance.materialId]] */\n  public readonly material?: Id64String;\n  /** See [[SubCategoryAppearance.transparency]] */\n  public readonly transparency?: number;\n\n  /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */\n  public get anyOverridden(): boolean {\n    return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;\n  }\n\n  /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */\n  public override(appearance: SubCategoryAppearance): SubCategoryAppearance {\n    if (!this.anyOverridden)\n      return appearance;\n\n    const props = appearance.toJSON();\n    const ovrProps = this.toJSON();\n    if (undefined !== ovrProps.invisible)\n      props.invisible = ovrProps.invisible;\n    if (undefined !== ovrProps.weight)\n      props.weight = ovrProps.weight;\n    if (undefined !== ovrProps.style)\n      props.style = ovrProps.style;\n    if (undefined !== ovrProps.material)\n      props.material = ovrProps.material;\n    if (undefined !== ovrProps.priority)\n      props.priority = ovrProps.priority;\n    if (undefined !== ovrProps.transp)\n      props.transp = ovrProps.transp;\n    if (undefined !== ovrProps.color)\n      props.color = ovrProps.color;\n\n    return new SubCategoryAppearance(props);\n  }\n\n  /** Convert this SubCategoryOverride to a JSON object\n   * @internal\n   */\n  public toJSON(): SubCategoryAppearance.Props {\n    const props: SubCategoryAppearance.Props = {};\n    if (undefined !== this.invisible)\n      props.invisible = this.invisible;\n\n    if (undefined !== this.weight)\n      props.weight = this.weight;\n\n    if (undefined !== this.style)\n      props.style = this.style;\n\n    if (undefined !== this.material)\n      props.material = this.material;\n\n    if (undefined !== this.priority)\n      props.priority = this.priority;\n\n    if (undefined !== this.transparency)\n      props.transp = this.transparency;\n\n    if (undefined !== this.color)\n      props.color = this.color.toJSON();\n\n    return props;\n  }\n\n  /** Perform equality comparison against another SubCategoryOverride. */\n  public equals(other: SubCategoryOverride): boolean {\n    if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style\n      || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)\n      return false;\n\n    if (undefined !== this.color && undefined !== other.color)\n      return this.color.tbgr === other.color.tbgr;\n    else\n      return undefined === this.color && undefined === other.color;\n  }\n\n  /** Create a new SubCategoryOverride from a JSON object */\n  public static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride {\n    return undefined !== json ? new SubCategoryOverride(json) : this.defaults;\n  }\n\n  private constructor(props: SubCategoryAppearance.Props) {\n    if (undefined !== props.invisible)\n      this.invisible = JsonUtils.asBool(props.invisible);\n    if (undefined !== props.color)\n      this.color = ColorDef.fromJSON(props.color);\n    if (undefined !== props.weight)\n      this.weight = JsonUtils.asInt(props.weight);\n    if (undefined !== props.style)\n      this.style = Id64.fromJSON(props.style);\n    if (undefined !== props.material)\n      this.material = Id64.fromJSON(props.material);\n    if (undefined !== props.priority)\n      this.priority = JsonUtils.asInt(props.priority);\n    if (undefined !== props.transp)\n      this.transparency = JsonUtils.asDouble(props.transp);\n  }\n\n  /** A default SubCategoryOverride which overrides nothing. */\n  public static defaults = new SubCategoryOverride({});\n}\n"]}

package/lib/cjs/TerrainSettings.d.ts

@@ -2,13 +2,6 @@
  * @module DisplayStyles
  */
 import { BackgroundMapProps } from "./BackgroundMapSettings";
-/** Identifies a [TerrainProvider]($frontend).
- * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].
- * @public
- * @extensions
- * @deprecated in 3.x. Use string instead.
- */
-export type TerrainProviderName = string;
 /** Ids of [Cesium ION assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
  * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
  * You may alternatively use the Id of any ION asset to which you have access.

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

@@ -1 +1 @@
-{"version":3,"file":"TerrainSettings.d.ts","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,yGAAyG;IACzG,OAAO,MAAM;IACb,gJAAgJ;IAChJ,UAAU,YAAY;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0HAA0H;IAC1H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mGAAmG;IACnG,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,sHAAsH;IACtH,QAAQ,IAAI;IACZ,0GAA0G;IAC1G,KAAK,IAAI;IACT,yGAAyG;IACzG,MAAM,IAAI;CACX;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAmB;IACxC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,qIAAqI;IACrI,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,+FAA+F;IAC/F,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,yHAAyH;IACzH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,mGAAmG;IACnG,SAAgB,gBAAgB,EAAE,uBAAuB,CAAC;IAC1D;;;OAGG;IACH,IAAW,YAAY,IAAI,IAAI,GAAG,SAAS,CAE1C;IAED,0EAA0E;gBAC9D,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,uBAAuB;gBAExI,KAAK,CAAC,EAAE,YAAY;WAiClB,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;IAI1C;;;OAGG;WACW,kBAAkB,CAAC,OAAO,GAAE,MAAqC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,cAAc,GAAG,YAAY,CAAC,GAAG,eAAe;IAOvJ,MAAM,IAAI,YAAY;IAkBtB,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAK9C,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe;CAgB3D"}
+{"version":3,"file":"TerrainSettings.d.ts","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,yGAAyG;IACzG,OAAO,MAAM;IACb,gJAAgJ;IAChJ,UAAU,YAAY;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0HAA0H;IAC1H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mGAAmG;IACnG,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,sHAAsH;IACtH,QAAQ,IAAI;IACZ,0GAA0G;IAC1G,KAAK,IAAI;IACT,yGAAyG;IACzG,MAAM,IAAI;CACX;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAmB;IACxC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,qIAAqI;IACrI,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,+FAA+F;IAC/F,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,yHAAyH;IACzH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,mGAAmG;IACnG,SAAgB,gBAAgB,EAAE,uBAAuB,CAAC;IAC1D;;;OAGG;IACH,IAAW,YAAY,IAAI,IAAI,GAAG,SAAS,CAE1C;IAED,0EAA0E;gBAC9D,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,uBAAuB;gBAExI,KAAK,CAAC,EAAE,YAAY;WAiClB,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;IAI1C;;;OAGG;WACW,kBAAkB,CAAC,OAAO,GAAE,MAAqC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,cAAc,GAAG,YAAY,CAAC,GAAG,eAAe;IAOvJ,MAAM,IAAI,YAAY;IAkBtB,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAK9C,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe;CAgB3D"}

package/lib/cjs/TerrainSettings.js

@@ -39,6 +39,25 @@ var TerrainHeightOriginMode;
  * @public
  */
 class TerrainSettings {
+    _nonLocatable;
+    /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.
+     * Defaults to "CesiumWorldTerrain".
+     */
+    providerName;
+    /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],
+     * for those providers that support multiple data sources.
+     * For example, the "CesiumWorldTerrain" provider uses this field to store a [[CesiumTerrainAssetId]].
+     * Default value: an empty string.
+     */
+    dataSource;
+    /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */
+    exaggeration;
+    /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */
+    applyLighting;
+    /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */
+    heightOrigin;
+    /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */
+    heightOriginMode;
     /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.
      * @see [[TerrainProps.nonLocatable]].
      * @internal

package/lib/cjs/TerrainSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"TerrainSettings.js","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAYH;;;;;GAKG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,yGAAyG;IACzG,qCAAa,CAAA;IACb,gJAAgJ;IAChJ,8CAAsB,CAAA;AACxB,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAiCD;;;;GAIG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,sHAAsH;IACtH,6EAAY,CAAA;IACZ,0GAA0G;IAC1G,uEAAS,CAAA;IACT,yGAAyG;IACzG,yEAAU,CAAA;AACZ,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AAED;;GAEG;AACH,MAAa,eAAe;IAoB1B;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAOD,gBAAgB;IAChB,YAAY,mBAAsD,EAAE,YAAqB,EAAE,aAAuB,EAAE,YAAqB,EAAE,gBAA0C;QACnL,IAAI,YAAY,CAAC;QACjB,IAAI,UAAU,CAAC;QACf,IAAI,YAAY,CAAC;QACjB,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YAC5C,YAAY,GAAG,mBAAmB,CAAC;QACrC,CAAC;aAAM,IAAI,mBAAmB,EAAE,CAAC;YAC/B,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAClI,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,oBAAoB,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,KAAK,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;QAExC,IAAI,IAAI,KAAK,YAAY;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,QAAQ,gBAAgB,EAAE,CAAC;YACzB,KAAK,uBAAuB,CAAC,MAAM,CAAC;YACpC,KAAK,uBAAuB,CAAC,KAAK;gBAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ,CAAC;gBACzD,MAAM;QACV,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB,oBAAoB,CAAC,OAAO,EAAE,OAA2D;QAC1I,OAAO,eAAe,CAAC,QAAQ,CAAC;YAC9B,GAAG,OAAO;YACV,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAiB,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxE,IAAI,oBAAoB,KAAK,IAAI,CAAC,YAAY;YAC5C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU;YACjB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAsB;QAClC,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eAC5K,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAChJ,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA2B;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,UAAU,EAAE,YAAY,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,aAAa,EAAE,YAAY,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa;YAC/D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,gBAAgB,EAAE,YAAY,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB;SACzE,CAAC;QAEF,OAAO,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AA/HD,0CA+HC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Identifies a [TerrainProvider]($frontend).\n * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].\n * @public\n * @extensions\n * @deprecated in 3.x. Use string instead.\n */\nexport type TerrainProviderName = string;\n\n/** Ids of [Cesium ION assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.\n * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to \"CesiumWorldTerrain\".\n * You may alternatively use the Id of any ION asset to which you have access.\n * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ION asset.\n * @public\n */\nexport enum CesiumTerrainAssetId {\n  /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */\n  Default = \"1\",\n  /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */\n  Bathymetry = \"2426648\",\n}\n\n/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].\n * @see [[DisplayStyleSettingsProps]]\n * @see [[BackgroundMapProps]]\n * @public\n * @extensions\n */\nexport interface TerrainProps {\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\n   * If omitted, it defaults to \"CesiumWorldTerrain\".\n   */\n  providerName?: string;\n  /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],\n   * for those providers that support multiple data sources.\n   * For example, the \"CesiumWorldTerrain\" provider uses this field to store a [[CesiumTerrainAssetId]].\n   * Default value: an empty string.\n   */\n  dataSource?: string;\n  /** A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration. Default value: 1.0 */\n  exaggeration?: number;\n  /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */\n  applyLighting?: boolean;\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */\n  heightOrigin?: number;\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\n  heightOriginMode?: TerrainHeightOriginMode;\n  /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.\n   * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.\n   */\n  nonLocatable?: boolean;\n}\n\n/** Correction modes for terrain height\n * @see [[TerrainProps]]\n * @public\n * @extensions\n */\nexport enum TerrainHeightOriginMode {\n  /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */\n  Geodetic = 0,\n  /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */\n  Geoid = 1,\n  /** Height value indicates the height of the IModel origin relative to ground level at project center. */\n  Ground = 2,\n}\n\n/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.\n * @public\n */\nexport class TerrainSettings {\n  private _nonLocatable: true | undefined;\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\n   * Defaults to \"CesiumWorldTerrain\".\n   */\n  public readonly providerName: string;\n  /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],\n   * for those providers that support multiple data sources.\n   * For example, the \"CesiumWorldTerrain\" provider uses this field to store a [[CesiumTerrainAssetId]].\n   * Default value: an empty string.\n   */\n  public readonly dataSource: string;\n  /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */\n  public readonly exaggeration: number;\n  /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */\n  public readonly applyLighting: boolean;\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */\n  public readonly heightOrigin: number;\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\n  public readonly heightOriginMode: TerrainHeightOriginMode;\n  /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.\n   * @see [[TerrainProps.nonLocatable]].\n   * @internal\n   */\n  public get nonLocatable(): true | undefined {\n    return this._nonLocatable;\n  }\n\n  /** @deprecated in 4.5.x. Use the overload that takes [[TerrainProps]]. */\n  constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);\n\n  constructor(props?: TerrainProps);\n\n  /** @internal */\n  constructor(providerNameOrProps: string | TerrainProps | undefined, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode) {\n    let providerName;\n    let dataSource;\n    let nonLocatable;\n    if (typeof providerNameOrProps === \"string\") {\n      providerName = providerNameOrProps;\n    } else if (providerNameOrProps) {\n      ({ providerName, dataSource, exaggeration, applyLighting, heightOrigin, heightOriginMode, nonLocatable } = providerNameOrProps);\n    }\n\n    this.providerName = providerName ?? \"CesiumWorldTerrain\";\n    this.dataSource = dataSource ?? \"\";\n    this.exaggeration = Math.min(100, Math.max(0.1, exaggeration ?? 1.0));\n    this.applyLighting = applyLighting ?? false;\n    this.heightOrigin = heightOrigin ?? 0.0;\n\n    if (true === nonLocatable)\n      this._nonLocatable = true;\n\n    switch (heightOriginMode) {\n      case TerrainHeightOriginMode.Ground:\n      case TerrainHeightOriginMode.Geoid:\n        this.heightOriginMode = heightOriginMode;\n        break;\n      default:\n        this.heightOriginMode = TerrainHeightOriginMode.Geodetic;\n        break;\n    }\n  }\n\n  public static fromJSON(json?: TerrainProps) {\n    return new TerrainSettings(json);\n  }\n\n  /** Create settings that obtain terrain from a [Cesium ION asset](https://cesium.com/platform/cesium-ion/content/) such as\n   * one of those defined by [[CesiumTerrainAssetId]].\n   * @note You must ensure your Cesium ION account has access to the specified asset.\n   */\n  public static fromCesiumIonAsset(assetId: string = CesiumTerrainAssetId.Default, options?: Omit<TerrainProps, \"providerName\" | \"dataSource\">): TerrainSettings {\n    return TerrainSettings.fromJSON({\n      ...options,\n      dataSource: assetId,\n    });\n  }\n\n  public toJSON(): TerrainProps {\n    const props: TerrainProps = { heightOriginMode: this.heightOriginMode };\n    if (\"CesiumWorldTerrain\" !== this.providerName)\n      props.providerName = this.providerName;\n    if (this.dataSource)\n      props.dataSource = this.dataSource;\n    if (1 !== this.exaggeration)\n      props.exaggeration = this.exaggeration;\n    if (this.nonLocatable)\n      props.nonLocatable = true;\n    if (this.applyLighting)\n      props.applyLighting = true;\n    if (0 !== this.heightOrigin)\n      props.heightOrigin = this.heightOrigin;\n\n    return props;\n  }\n\n  public equals(other: TerrainSettings): boolean {\n    return this.providerName === other.providerName && this.dataSource === other.dataSource && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting\n      && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(TerrainSettings.fromJSON(json));\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: TerrainProps): TerrainSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      providerName: changedProps.providerName ?? this.providerName,\n      dataSource: changedProps.dataSource ?? this.dataSource,\n      exaggeration: changedProps.exaggeration ?? this.exaggeration,\n      nonLocatable: changedProps.nonLocatable ?? this.nonLocatable,\n      applyLighting: changedProps.applyLighting ?? this.applyLighting,\n      heightOrigin: changedProps.heightOrigin ?? this.heightOrigin,\n      heightOriginMode: changedProps.heightOriginMode ?? this.heightOriginMode,\n    };\n\n    return TerrainSettings.fromJSON(props);\n  }\n}\n"]}
+{"version":3,"file":"TerrainSettings.js","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;GAKG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,yGAAyG;IACzG,qCAAa,CAAA;IACb,gJAAgJ;IAChJ,8CAAsB,CAAA;AACxB,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAiCD;;;;GAIG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,sHAAsH;IACtH,6EAAY,CAAA;IACZ,0GAA0G;IAC1G,uEAAS,CAAA;IACT,yGAAyG;IACzG,yEAAU,CAAA;AACZ,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AAED;;GAEG;AACH,MAAa,eAAe;IAClB,aAAa,CAAmB;IACxC;;OAEG;IACa,YAAY,CAAS;IACrC;;;;OAIG;IACa,UAAU,CAAS;IACnC,qIAAqI;IACrH,YAAY,CAAS;IACrC,+FAA+F;IAC/E,aAAa,CAAU;IACvC,yHAAyH;IACzG,YAAY,CAAS;IACrC,mGAAmG;IACnF,gBAAgB,CAA0B;IAC1D;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAOD,gBAAgB;IAChB,YAAY,mBAAsD,EAAE,YAAqB,EAAE,aAAuB,EAAE,YAAqB,EAAE,gBAA0C;QACnL,IAAI,YAAY,CAAC;QACjB,IAAI,UAAU,CAAC;QACf,IAAI,YAAY,CAAC;QACjB,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YAC5C,YAAY,GAAG,mBAAmB,CAAC;QACrC,CAAC;aAAM,IAAI,mBAAmB,EAAE,CAAC;YAC/B,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAClI,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,oBAAoB,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,KAAK,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;QAExC,IAAI,IAAI,KAAK,YAAY;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,QAAQ,gBAAgB,EAAE,CAAC;YACzB,KAAK,uBAAuB,CAAC,MAAM,CAAC;YACpC,KAAK,uBAAuB,CAAC,KAAK;gBAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ,CAAC;gBACzD,MAAM;QACV,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB,oBAAoB,CAAC,OAAO,EAAE,OAA2D;QAC1I,OAAO,eAAe,CAAC,QAAQ,CAAC;YAC9B,GAAG,OAAO;YACV,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAiB,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxE,IAAI,oBAAoB,KAAK,IAAI,CAAC,YAAY;YAC5C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU;YACjB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAsB;QAClC,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eAC5K,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAChJ,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA2B;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,UAAU,EAAE,YAAY,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,aAAa,EAAE,YAAY,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa;YAC/D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,gBAAgB,EAAE,YAAY,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB;SACzE,CAAC;QAEF,OAAO,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AA/HD,0CA+HC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Ids of [Cesium ION assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.\n * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to \"CesiumWorldTerrain\".\n * You may alternatively use the Id of any ION asset to which you have access.\n * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ION asset.\n * @public\n */\nexport enum CesiumTerrainAssetId {\n  /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */\n  Default = \"1\",\n  /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */\n  Bathymetry = \"2426648\",\n}\n\n/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].\n * @see [[DisplayStyleSettingsProps]]\n * @see [[BackgroundMapProps]]\n * @public\n * @extensions\n */\nexport interface TerrainProps {\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\n   * If omitted, it defaults to \"CesiumWorldTerrain\".\n   */\n  providerName?: string;\n  /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],\n   * for those providers that support multiple data sources.\n   * For example, the \"CesiumWorldTerrain\" provider uses this field to store a [[CesiumTerrainAssetId]].\n   * Default value: an empty string.\n   */\n  dataSource?: string;\n  /** A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration. Default value: 1.0 */\n  exaggeration?: number;\n  /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */\n  applyLighting?: boolean;\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */\n  heightOrigin?: number;\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\n  heightOriginMode?: TerrainHeightOriginMode;\n  /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.\n   * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.\n   */\n  nonLocatable?: boolean;\n}\n\n/** Correction modes for terrain height\n * @see [[TerrainProps]]\n * @public\n * @extensions\n */\nexport enum TerrainHeightOriginMode {\n  /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */\n  Geodetic = 0,\n  /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */\n  Geoid = 1,\n  /** Height value indicates the height of the IModel origin relative to ground level at project center. */\n  Ground = 2,\n}\n\n/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.\n * @public\n */\nexport class TerrainSettings {\n  private _nonLocatable: true | undefined;\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\n   * Defaults to \"CesiumWorldTerrain\".\n   */\n  public readonly providerName: string;\n  /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],\n   * for those providers that support multiple data sources.\n   * For example, the \"CesiumWorldTerrain\" provider uses this field to store a [[CesiumTerrainAssetId]].\n   * Default value: an empty string.\n   */\n  public readonly dataSource: string;\n  /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */\n  public readonly exaggeration: number;\n  /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */\n  public readonly applyLighting: boolean;\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */\n  public readonly heightOrigin: number;\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\n  public readonly heightOriginMode: TerrainHeightOriginMode;\n  /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.\n   * @see [[TerrainProps.nonLocatable]].\n   * @internal\n   */\n  public get nonLocatable(): true | undefined {\n    return this._nonLocatable;\n  }\n\n  /** @deprecated in 4.5.x. Use the overload that takes [[TerrainProps]]. */\n  constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);\n\n  constructor(props?: TerrainProps);\n\n  /** @internal */\n  constructor(providerNameOrProps: string | TerrainProps | undefined, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode) {\n    let providerName;\n    let dataSource;\n    let nonLocatable;\n    if (typeof providerNameOrProps === \"string\") {\n      providerName = providerNameOrProps;\n    } else if (providerNameOrProps) {\n      ({ providerName, dataSource, exaggeration, applyLighting, heightOrigin, heightOriginMode, nonLocatable } = providerNameOrProps);\n    }\n\n    this.providerName = providerName ?? \"CesiumWorldTerrain\";\n    this.dataSource = dataSource ?? \"\";\n    this.exaggeration = Math.min(100, Math.max(0.1, exaggeration ?? 1.0));\n    this.applyLighting = applyLighting ?? false;\n    this.heightOrigin = heightOrigin ?? 0.0;\n\n    if (true === nonLocatable)\n      this._nonLocatable = true;\n\n    switch (heightOriginMode) {\n      case TerrainHeightOriginMode.Ground:\n      case TerrainHeightOriginMode.Geoid:\n        this.heightOriginMode = heightOriginMode;\n        break;\n      default:\n        this.heightOriginMode = TerrainHeightOriginMode.Geodetic;\n        break;\n    }\n  }\n\n  public static fromJSON(json?: TerrainProps) {\n    return new TerrainSettings(json);\n  }\n\n  /** Create settings that obtain terrain from a [Cesium ION asset](https://cesium.com/platform/cesium-ion/content/) such as\n   * one of those defined by [[CesiumTerrainAssetId]].\n   * @note You must ensure your Cesium ION account has access to the specified asset.\n   */\n  public static fromCesiumIonAsset(assetId: string = CesiumTerrainAssetId.Default, options?: Omit<TerrainProps, \"providerName\" | \"dataSource\">): TerrainSettings {\n    return TerrainSettings.fromJSON({\n      ...options,\n      dataSource: assetId,\n    });\n  }\n\n  public toJSON(): TerrainProps {\n    const props: TerrainProps = { heightOriginMode: this.heightOriginMode };\n    if (\"CesiumWorldTerrain\" !== this.providerName)\n      props.providerName = this.providerName;\n    if (this.dataSource)\n      props.dataSource = this.dataSource;\n    if (1 !== this.exaggeration)\n      props.exaggeration = this.exaggeration;\n    if (this.nonLocatable)\n      props.nonLocatable = true;\n    if (this.applyLighting)\n      props.applyLighting = true;\n    if (0 !== this.heightOrigin)\n      props.heightOrigin = this.heightOrigin;\n\n    return props;\n  }\n\n  public equals(other: TerrainSettings): boolean {\n    return this.providerName === other.providerName && this.dataSource === other.dataSource && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting\n      && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(TerrainSettings.fromJSON(json));\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: TerrainProps): TerrainSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      providerName: changedProps.providerName ?? this.providerName,\n      dataSource: changedProps.dataSource ?? this.dataSource,\n      exaggeration: changedProps.exaggeration ?? this.exaggeration,\n      nonLocatable: changedProps.nonLocatable ?? this.nonLocatable,\n      applyLighting: changedProps.applyLighting ?? this.applyLighting,\n      heightOrigin: changedProps.heightOrigin ?? this.heightOrigin,\n      heightOriginMode: changedProps.heightOriginMode ?? this.heightOriginMode,\n    };\n\n    return TerrainSettings.fromJSON(props);\n  }\n}\n"]}

package/lib/cjs/TextureMapping.js

@@ -19,6 +19,14 @@ function compareNormalMapParams(lhs, rhs) {
  * @public
  */
 class TextureMapping {
+    /** The texture to be mapped to the surface. If normalMapParams is present but does not contain a normal map, then texture is used as a normal map rather than a pattern map. */
+    texture;
+    /** The parameters for normal mapping.
+     * @beta
+     */
+    normalMapParams;
+    /** The parameters describing how the textures are mapped to the surface. */
+    params;
     constructor(tx, params) {
         this.texture = tx;
         this.params = params;
@@ -65,6 +73,8 @@ exports.TextureMapping = TextureMapping;
     })(Mode = TextureMapping.Mode || (TextureMapping.Mode = {}));
     /** A 2x3 matrix for mapping a texture image to a surface. */
     class Trans2x3 {
+        /** The 3x4 transform produced from the 2x3 matrix. */
+        transform;
         /** Construct from the two rows of the matrix:
          * ```
          *  | m00 m01 originX |
@@ -83,7 +93,7 @@ exports.TextureMapping = TextureMapping;
             this.transform = core_geometry_1.Transform.createRefs(origin, matrix);
         }
         /** An immutable 2x3 identity matrix. */
-        static { this.identity = new Trans2x3(); }
+        static identity = new Trans2x3();
         /** An [OrderedComparator]($bentley) that compares this Trans2x3 against `other`. */
         compare(other) {
             if (this === other) {
@@ -109,6 +119,19 @@ exports.TextureMapping = TextureMapping;
     }
     /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */
     class Params {
+        /** The matrix used to map the image to a surface. */
+        textureMatrix;
+        /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.
+         * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.
+         */
+        weight;
+        /** The mode by which to map the image to a surface. */
+        mode;
+        worldMapping;
+        /** True if want to use constant LOD texture mapping for the surface texture. */
+        useConstantLod;
+        /** Parameters for constantLod mapping mode. */
+        constantLodParams;
         constructor(props) {
             this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;
             this.weight = props?.textureWeight ?? 1;

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,wDAAuI;AAEvI,sDAAuJ;AAkBvJ,SAAS,sBAAsB,CAAC,GAAoB,EAAE,GAAoB;IACxE,OAAO,IAAA,uCAAwB,EAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC;WACpF,IAAA,yCAA0B,EAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,IAAA,wCAAyB,EAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;WACvG,IAAA,yCAA0B,EAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;AAC1E,CAAC;AAED;;GAEG;AACH,MAAa,cAAc;IAUzB,YAAmB,EAAiB,EAAE,MAA6B;QACjE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,OAAwB,EAAE,eAA0B,yBAAS,CAAC,cAAc,EAAE;QACnG,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC;IAED,mFAAmF;IAC5E,OAAO,CAAC,KAAqB;QAClC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;eAC1E,IAAA,uCAAwB,EAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACzH,CAAC;CACF;AAjCD,wCAiCC;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,6BAA6B;QAC7B,uDAAoB,CAAA;QACpB,6BAA6B;QAC7B,iCAAS,CAAA;QACT,6BAA6B;QAC7B,yCAAa,CAAA;QACb,6BAA6B;QAC7B,6CAAe,CAAA;QACf,6BAA6B;QAC7B,iCAAS,CAAA;QACT,6BAA6B;QAC7B,+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;QAED,wCAAwC;iBACjB,aAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAEjD,oFAAoF;QAC7E,OAAO,CAAC,KAAe;YAC5B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnB,OAAO,CAAC,CAAC;YACX,CAAC;YAED,MAAM,UAAU,GAAG,IAAA,6BAAc,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAA,6BAAc,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1J,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,IAAA,6BAAc,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChG,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;oBAClB,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC;;IA5CU,uBAAQ,WA6CpB,CAAA;IA2BD,SAAS,wBAAwB,CAAC,GAAsB,EAAE,GAAsB;QAC9E,OAAO,IAAA,6BAAc,EAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;eAC9I,IAAA,6BAAc,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAChH,CAAC;IAuBD,oFAAoF;IACpF,MAAa,MAAM;QAejB,YAAmB,KAAiC;YAClD,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,QAAQ,CAAC,QAAQ,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC;YAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;YACjD,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,cAAc,IAAI,KAAK,CAAC;YACrD,IAAI,CAAC,iBAAiB,GAAG;gBACvB,WAAW,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,IAAI,CAAC;gBACtD,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBACzD,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,IAAI,CAAC;gBACxD,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,IAAI,IAAI,GAAG,IAAI,GAAG,IAAI;aAC1E,CAAC;QACJ,CAAC;QAED,mFAAmF;QAC5E,OAAO,CAAC,KAAa;YAC1B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnB,OAAO,CAAC,CAAC;YACX,CAAC;YAED,OAAO,IAAA,6BAAc,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,IAAA,6BAAc,EAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,8BAAe,EAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;mBAC9I,IAAA,8BAAe,EAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;mBAC7G,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACjF,CAAC;QAEH;;;;WAIG;QACM,eAAe,CAAC,OAA+B,EAAE,eAA0B,yBAAS,CAAC,cAAc,EAAE;YAC1G,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,QAAQ,CAAE,6CAA6C;gBACvD,KAAK,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;oBACpC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACnG,CAAC;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;oBAChC,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,CAAC;wBAClJ,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBACnG,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;oBAC3E,CAAC;gBACH,CAAC;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;oBACxC,OAAO,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gBACjG,CAAC;YACH,CAAC;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,CAAC;gBACnD,IAAI,KAAK,GAAG,uBAAO,CAAC,MAAM,EAAE,CAAC;gBAE7B,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;oBAClE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;wBACjD,wGAAwG;wBACxG,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;YAClD,CAAC;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,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrB,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC1B,CAAC;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,CAAC;gBAClC,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;YACpD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+HAA+H;QACvH,6BAA6B,CAAC,OAA+B,EAAE,WAAsB,EAAE,YAAwB;YACrH,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,CAAC;gBAClC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,YAAY,KAAK,SAAS;oBAC5B,YAAY,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAE7C,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;YACpD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IAtJY,qBAAM,SAsJlB,CAAA;AACH,CAAC,EAhRgB,cAAc,8BAAd,cAAc,QAgR9B;AAED,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Rendering\n */\n\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d, XAndY } from \"@itwin/core-geometry\";\nimport { RenderTexture } from \"./RenderTexture\";\nimport { compareBooleans, compareBooleansOrUndefined, compareNumbers, compareNumbersOrUndefined, comparePossiblyUndefined } from \"@itwin/core-bentley\";\n\n/** Defines normal map parameters.\n * @beta\n */\nexport interface NormalMapParams {\n  /** The texture to use as a normal map. If not present then the pattern map texture will be used as a normal map. */\n  normalMap?: RenderTexture;\n  /** True if the Y component stored in the green channel should be negated. By default, positive Y points downward, but some\n   * normal maps are created with positive Y pointing upward.\n   */\n  greenUp?: boolean;\n  /** Scale factor by which to multiply the components of the normal extracted from [[normalMap]]. */\n  scale?: number;\n  /** True if want to use constant LOD texture mapping for the normal map texture. */\n  useConstantLod?: boolean;\n}\n\nfunction compareNormalMapParams(lhs: NormalMapParams, rhs: NormalMapParams): number {\n  return comparePossiblyUndefined((lh, rh) => lh.compare(rh), lhs.normalMap, rhs.normalMap)\n    || compareBooleansOrUndefined(lhs.greenUp, rhs.greenUp) || compareNumbersOrUndefined(lhs.scale, rhs.scale)\n    || compareBooleansOrUndefined(lhs.useConstantLod, rhs.useConstantLod);\n}\n\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\n * @public\n */\nexport class TextureMapping {\n  /** The texture to be mapped to the surface. If normalMapParams is present but does not contain a normal map, then texture is used as a normal map rather than a pattern map. */\n  public readonly texture: RenderTexture;\n  /** The parameters for normal mapping.\n   * @beta\n   */\n  public normalMapParams?: NormalMapParams;\n  /** The parameters describing how the textures are mapped to the surface. */\n  public readonly params: TextureMapping.Params;\n\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\n    this.texture = tx;\n    this.params = params;\n  }\n\n  /** Compute texture coordinates for a polyface.\n   * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.\n   * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].\n   * @returns the texture coordinates, or undefined if computation failed.\n   */\n  public computeUVParams(visitor: PolyfaceVisitor, localToWorld: Transform = Transform.createIdentity()): Point2d[] | undefined {\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, localToWorld);\n  }\n\n  /** An [OrderedComparator]($bentley) that compares this mapping against `other`. */\n  public compare(other: TextureMapping): number {\n    if (this === other) {\n      return 0;\n    }\n\n    return this.texture.compare(other.texture) || this.params.compare(other.params)\n      || comparePossiblyUndefined((lh, rh) => compareNormalMapParams(lh, rh), this.normalMapParams, other.normalMapParams);\n  }\n}\n\n/** @public */\nexport namespace TextureMapping {\n  /** Enumerates the possible texture mapping modes. */\n  export enum Mode {\n    None = -1,\n    Parametric = 0,\n    ElevationDrape = 1,\n    Planar = 2,\n    /** Currently unsupported. */\n    DirectionalDrape = 3,\n    /** Currently unsupported. */\n    Cubic = 4,\n    /** Currently unsupported. */\n    Spherical = 5,\n    /** Currently unsupported. */\n    Cylindrical = 6,\n    /** Currently unsupported. */\n    Solid = 7,\n    /** Currently unsupported. */\n    FrontProject = 8,\n  }\n\n  /** A 2x3 matrix for mapping a texture image to a surface. */\n  export class Trans2x3 {\n    /** The 3x4 transform produced from the 2x3 matrix. */\n    public readonly transform: Transform;\n\n    /** Construct from the two rows of the matrix:\n     * ```\n     *  | m00 m01 originX |\n     *  | m10 m11 originY |\n     * ```\n     * Producing the [Transform]($core-geometry):\n     * ```\n     *  | m00 m01 0 originX |\n     *  | m10 m11 0 originY |\n     *  | 0   0   1 0       |\n     * ```\n     */\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\n      const origin = new Point3d(originX, originY, 0);\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\n      this.transform = Transform.createRefs(origin, matrix);\n    }\n\n    /** An immutable 2x3 identity matrix. */\n    public static readonly identity = new Trans2x3();\n\n    /** An [OrderedComparator]($bentley) that compares this Trans2x3 against `other`. */\n    public compare(other: Trans2x3): number {\n      if (this === other) {\n        return 0;\n      }\n\n      const originDiff = compareNumbers(this.transform.origin.x, other.transform.origin.x) || compareNumbers(this.transform.origin.y, other.transform.origin.y);\n      if (originDiff !== 0) {\n        return originDiff;\n      }\n\n      for (const i of [0, 1, 3, 4]) {\n        const matDiff = compareNumbers(this.transform.matrix.coffs[i], other.transform.matrix.coffs[i]);\n        if (matDiff !== 0) {\n          return matDiff;\n        }\n      }\n\n      return 0;\n    }\n  }\n\n  /** Properties used to construct a [[TextureMapping.ConstantLodParams]]. */\n  export interface ConstantLodParamProps {\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1. */\n    repetitions?: number;\n    /** An offset in world units used to shift the texture. Defaults to (0, 0). */\n    offset?: XAndY;\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. Defaults to 1.*/\n    minDistClamp?: number;\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. Defaults to 2^32. */\n    maxDistClamp?: number;\n  }\n\n  /** Parameters to define constant level of detail mapping mode, a mode of texture coordinate generation which dynamically creates\n   * texture cooprdinates so that the level of detail of the texture in the rendered image remains somewhat constant. */\n  export interface ConstantLodParams {\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. */\n    repetitions: number;\n    /** An offset in world units used to shift the texture. */\n    offset: XAndY;\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. */\n    minDistClamp: number;\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. */\n    maxDistClamp: number;\n  }\n\n  function compareConstantLodParams(lhs: ConstantLodParams, rhs: ConstantLodParams): number {\n    return compareNumbers(lhs.repetitions, rhs.repetitions) || compareNumbers(lhs.offset.x, rhs.offset.x) || compareNumbers(lhs.offset.y, rhs.offset.y)\n      || compareNumbers(lhs.minDistClamp, rhs.minDistClamp) || compareNumbers(lhs.maxDistClamp, rhs.maxDistClamp);\n  }\n\n  /** Properties used to construct a [[TextureMapping.Params]]. */\n  export interface ParamProps {\n    /** The matrix used to map the image to a surface. */\n    textureMat2x3?: TextureMapping.Trans2x3;\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\n     * @note Defaults to 1.0\n     */\n    textureWeight?: number;\n    /** The mode by which to map the image to a surface.\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\n     */\n    mapMode?: TextureMapping.Mode;\n    worldMapping?: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    useConstantLod?: boolean;\n    /** Parameters for constantLod mapping mode. */\n    constantLodProps?: ConstantLodParamProps;\n  }\n\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\n  export class Params {\n    /** The matrix used to map the image to a surface. */\n    public textureMatrix: TextureMapping.Trans2x3;\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\n     */\n    public weight: number;\n    /** The mode by which to map the image to a surface. */\n    public mode: TextureMapping.Mode;\n    public worldMapping: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    public useConstantLod: boolean;\n    /** Parameters for constantLod mapping mode. */\n    public constantLodParams: ConstantLodParams;\n\n    public constructor(props?: TextureMapping.ParamProps) {\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\n      this.weight = props?.textureWeight ?? 1;\n      this.mode = props?.mapMode ?? Mode.Parametric;\n      this.worldMapping = props?.worldMapping ?? false;\n      this.useConstantLod = props?.useConstantLod ?? false;\n      this.constantLodParams = {\n        repetitions: props?.constantLodProps?.repetitions ?? 1,\n        offset: props?.constantLodProps?.offset ?? { x: 0, y: 0 },\n        minDistClamp: props?.constantLodProps?.minDistClamp ?? 1,\n        maxDistClamp: props?.constantLodProps?.maxDistClamp ?? 4096 * 1024 * 1024,\n      };\n    }\n\n    /** An [OrderedComparator]($bentley) that compares these Params against `other`. */\n    public compare(other: Params): number {\n      if (this === other) {\n        return 0;\n      }\n\n      return compareNumbers(this.weight, other.weight) || compareNumbers(this.mode, other.mode) || compareBooleans(this.worldMapping, other.worldMapping)\n        || compareBooleans(this.useConstantLod, other.useConstantLod) || this.textureMatrix.compare(other.textureMatrix)\n        || compareConstantLodParams(this.constantLodParams, other.constantLodParams);\n    }\n\n  /** Compute texture coordinates for a polyface.\n   * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.\n   * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].\n   * @returns the texture coordinates, or undefined if computation failed.\n   */\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, localToWorld: Transform = Transform.createIdentity()): Point2d[] | undefined {\n      switch (this.mode) {\n        default:  // Fall through to parametric in default case\n        case TextureMapping.Mode.Parametric: {\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n        }\n        case TextureMapping.Mode.Planar: {\n          const normalIndices = visitor.normalIndex;\n          if (!normalIndices)\n            return undefined;\n\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n          } else {\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\n          }\n        }\n        case TextureMapping.Mode.ElevationDrape: {\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, localToWorld);\n        }\n      }\n    }\n\n    /** Computes UV parameters given a texture mapping mode of parametric. */\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\n      const params: Point2d[] = [];\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\n        let param = Point2d.create();\n\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\n            param = visitor.getParam(i)!;\n          }\n        }\n\n        params.push(uvTransform.multiplyPoint2d(param));\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\n      const params: Point2d[] = [];\n      const points = visitor.point;\n      let normal: Vector3d;\n\n      if (visitor.normal === undefined)\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\n      else\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\n\n      if (!normal.normalize(normal))\n        return undefined;\n\n      // adjust U texture coordinate to be a continuous length starting at the\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\n\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\n      normal.scale(-1.0, normal);\n\n      // pick the first vertex normal\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\n\n      // if the magnitude of the normal is near zero, the real normal points\n      // almost straighten up.. In this case, use Y as the up vector to match QV\n\n      const magnitude = sideVector.magnitude();\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\n\n      if (magnitude < 1e-3) {\n        normal.set(0, 0, -1);\n        sideVector.set(1, 0, 0);\n      }\n\n      const upVector = sideVector.crossProduct(normal).normalize();\n      if (!upVector)\n        return undefined;\n\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\n\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, localToWorld?: Transform): Point2d[] {\n      const params: Point2d[] = [];\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\n\n        if (localToWorld !== undefined)\n          localToWorld.multiplyPoint3d(point, point);\n\n        params.push(Point2d.createFrom(point));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n  }\n}\n\nObject.freeze(TextureMapping.Trans2x3.identity);\n"]}
+{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAuI;AAEvI,sDAAuJ;AAkBvJ,SAAS,sBAAsB,CAAC,GAAoB,EAAE,GAAoB;IACxE,OAAO,IAAA,uCAAwB,EAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC;WACpF,IAAA,yCAA0B,EAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,IAAA,wCAAyB,EAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;WACvG,IAAA,yCAA0B,EAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;AAC1E,CAAC;AAED;;GAEG;AACH,MAAa,cAAc;IACzB,gLAAgL;IAChK,OAAO,CAAgB;IACvC;;OAEG;IACI,eAAe,CAAmB;IACzC,4EAA4E;IAC5D,MAAM,CAAwB;IAE9C,YAAmB,EAAiB,EAAE,MAA6B;QACjE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,OAAwB,EAAE,eAA0B,yBAAS,CAAC,cAAc,EAAE;QACnG,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC;IAED,mFAAmF;IAC5E,OAAO,CAAC,KAAqB;QAClC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;eAC1E,IAAA,uCAAwB,EAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACzH,CAAC;CACF;AAjCD,wCAiCC;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,6BAA6B;QAC7B,uDAAoB,CAAA;QACpB,6BAA6B;QAC7B,iCAAS,CAAA;QACT,6BAA6B;QAC7B,yCAAa,CAAA;QACb,6BAA6B;QAC7B,6CAAe,CAAA;QACf,6BAA6B;QAC7B,iCAAS,CAAA;QACT,6BAA6B;QAC7B,+CAAgB,CAAA;IAClB,CAAC,EAjBW,IAAI,GAAJ,mBAAI,KAAJ,mBAAI,QAiBf;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QACnB,sDAAsD;QACtC,SAAS,CAAY;QAErC;;;;;;;;;;;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;QAED,wCAAwC;QACjC,MAAM,CAAU,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAEjD,oFAAoF;QAC7E,OAAO,CAAC,KAAe;YAC5B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnB,OAAO,CAAC,CAAC;YACX,CAAC;YAED,MAAM,UAAU,GAAG,IAAA,6BAAc,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAA,6BAAc,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1J,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,IAAA,6BAAc,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChG,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;oBAClB,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC;;IA5CU,uBAAQ,WA6CpB,CAAA;IA2BD,SAAS,wBAAwB,CAAC,GAAsB,EAAE,GAAsB;QAC9E,OAAO,IAAA,6BAAc,EAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;eAC9I,IAAA,6BAAc,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAChH,CAAC;IAuBD,oFAAoF;IACpF,MAAa,MAAM;QACjB,qDAAqD;QAC9C,aAAa,CAA0B;QAC9C;;WAEG;QACI,MAAM,CAAS;QACtB,uDAAuD;QAChD,IAAI,CAAsB;QAC1B,YAAY,CAAU;QAC7B,gFAAgF;QACzE,cAAc,CAAU;QAC/B,+CAA+C;QACxC,iBAAiB,CAAoB;QAE5C,YAAmB,KAAiC;YAClD,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,QAAQ,CAAC,QAAQ,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC;YAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;YACjD,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,cAAc,IAAI,KAAK,CAAC;YACrD,IAAI,CAAC,iBAAiB,GAAG;gBACvB,WAAW,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,IAAI,CAAC;gBACtD,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBACzD,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,IAAI,CAAC;gBACxD,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,IAAI,IAAI,GAAG,IAAI,GAAG,IAAI;aAC1E,CAAC;QACJ,CAAC;QAED,mFAAmF;QAC5E,OAAO,CAAC,KAAa;YAC1B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnB,OAAO,CAAC,CAAC;YACX,CAAC;YAED,OAAO,IAAA,6BAAc,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,IAAA,6BAAc,EAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,8BAAe,EAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;mBAC9I,IAAA,8BAAe,EAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;mBAC7G,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACjF,CAAC;QAEH;;;;WAIG;QACM,eAAe,CAAC,OAA+B,EAAE,eAA0B,yBAAS,CAAC,cAAc,EAAE;YAC1G,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,QAAQ,CAAE,6CAA6C;gBACvD,KAAK,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;oBACpC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACnG,CAAC;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;oBAChC,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,CAAC;wBAClJ,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBACnG,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;oBAC3E,CAAC;gBACH,CAAC;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;oBACxC,OAAO,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gBACjG,CAAC;YACH,CAAC;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,CAAC;gBACnD,IAAI,KAAK,GAAG,uBAAO,CAAC,MAAM,EAAE,CAAC;gBAE7B,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;oBAClE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;wBACjD,wGAAwG;wBACxG,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;YAClD,CAAC;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,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrB,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC1B,CAAC;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,CAAC;gBAClC,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;YACpD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+HAA+H;QACvH,6BAA6B,CAAC,OAA+B,EAAE,WAAsB,EAAE,YAAwB;YACrH,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,CAAC;gBAClC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,YAAY,KAAK,SAAS;oBAC5B,YAAY,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAE7C,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;YACpD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IAtJY,qBAAM,SAsJlB,CAAA;AACH,CAAC,EAhRgB,cAAc,8BAAd,cAAc,QAgR9B;AAED,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Rendering\n */\n\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d, XAndY } from \"@itwin/core-geometry\";\nimport { RenderTexture } from \"./RenderTexture\";\nimport { compareBooleans, compareBooleansOrUndefined, compareNumbers, compareNumbersOrUndefined, comparePossiblyUndefined } from \"@itwin/core-bentley\";\n\n/** Defines normal map parameters.\n * @beta\n */\nexport interface NormalMapParams {\n  /** The texture to use as a normal map. If not present then the pattern map texture will be used as a normal map. */\n  normalMap?: RenderTexture;\n  /** True if the Y component stored in the green channel should be negated. By default, positive Y points downward, but some\n   * normal maps are created with positive Y pointing upward.\n   */\n  greenUp?: boolean;\n  /** Scale factor by which to multiply the components of the normal extracted from [[normalMap]]. */\n  scale?: number;\n  /** True if want to use constant LOD texture mapping for the normal map texture. */\n  useConstantLod?: boolean;\n}\n\nfunction compareNormalMapParams(lhs: NormalMapParams, rhs: NormalMapParams): number {\n  return comparePossiblyUndefined((lh, rh) => lh.compare(rh), lhs.normalMap, rhs.normalMap)\n    || compareBooleansOrUndefined(lhs.greenUp, rhs.greenUp) || compareNumbersOrUndefined(lhs.scale, rhs.scale)\n    || compareBooleansOrUndefined(lhs.useConstantLod, rhs.useConstantLod);\n}\n\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\n * @public\n */\nexport class TextureMapping {\n  /** The texture to be mapped to the surface. If normalMapParams is present but does not contain a normal map, then texture is used as a normal map rather than a pattern map. */\n  public readonly texture: RenderTexture;\n  /** The parameters for normal mapping.\n   * @beta\n   */\n  public normalMapParams?: NormalMapParams;\n  /** The parameters describing how the textures are mapped to the surface. */\n  public readonly params: TextureMapping.Params;\n\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\n    this.texture = tx;\n    this.params = params;\n  }\n\n  /** Compute texture coordinates for a polyface.\n   * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.\n   * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].\n   * @returns the texture coordinates, or undefined if computation failed.\n   */\n  public computeUVParams(visitor: PolyfaceVisitor, localToWorld: Transform = Transform.createIdentity()): Point2d[] | undefined {\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, localToWorld);\n  }\n\n  /** An [OrderedComparator]($bentley) that compares this mapping against `other`. */\n  public compare(other: TextureMapping): number {\n    if (this === other) {\n      return 0;\n    }\n\n    return this.texture.compare(other.texture) || this.params.compare(other.params)\n      || comparePossiblyUndefined((lh, rh) => compareNormalMapParams(lh, rh), this.normalMapParams, other.normalMapParams);\n  }\n}\n\n/** @public */\nexport namespace TextureMapping {\n  /** Enumerates the possible texture mapping modes. */\n  export enum Mode {\n    None = -1,\n    Parametric = 0,\n    ElevationDrape = 1,\n    Planar = 2,\n    /** Currently unsupported. */\n    DirectionalDrape = 3,\n    /** Currently unsupported. */\n    Cubic = 4,\n    /** Currently unsupported. */\n    Spherical = 5,\n    /** Currently unsupported. */\n    Cylindrical = 6,\n    /** Currently unsupported. */\n    Solid = 7,\n    /** Currently unsupported. */\n    FrontProject = 8,\n  }\n\n  /** A 2x3 matrix for mapping a texture image to a surface. */\n  export class Trans2x3 {\n    /** The 3x4 transform produced from the 2x3 matrix. */\n    public readonly transform: Transform;\n\n    /** Construct from the two rows of the matrix:\n     * ```\n     *  | m00 m01 originX |\n     *  | m10 m11 originY |\n     * ```\n     * Producing the [Transform]($core-geometry):\n     * ```\n     *  | m00 m01 0 originX |\n     *  | m10 m11 0 originY |\n     *  | 0   0   1 0       |\n     * ```\n     */\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\n      const origin = new Point3d(originX, originY, 0);\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\n      this.transform = Transform.createRefs(origin, matrix);\n    }\n\n    /** An immutable 2x3 identity matrix. */\n    public static readonly identity = new Trans2x3();\n\n    /** An [OrderedComparator]($bentley) that compares this Trans2x3 against `other`. */\n    public compare(other: Trans2x3): number {\n      if (this === other) {\n        return 0;\n      }\n\n      const originDiff = compareNumbers(this.transform.origin.x, other.transform.origin.x) || compareNumbers(this.transform.origin.y, other.transform.origin.y);\n      if (originDiff !== 0) {\n        return originDiff;\n      }\n\n      for (const i of [0, 1, 3, 4]) {\n        const matDiff = compareNumbers(this.transform.matrix.coffs[i], other.transform.matrix.coffs[i]);\n        if (matDiff !== 0) {\n          return matDiff;\n        }\n      }\n\n      return 0;\n    }\n  }\n\n  /** Properties used to construct a [[TextureMapping.ConstantLodParams]]. */\n  export interface ConstantLodParamProps {\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1. */\n    repetitions?: number;\n    /** An offset in world units used to shift the texture. Defaults to (0, 0). */\n    offset?: XAndY;\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. Defaults to 1.*/\n    minDistClamp?: number;\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. Defaults to 2^32. */\n    maxDistClamp?: number;\n  }\n\n  /** Parameters to define constant level of detail mapping mode, a mode of texture coordinate generation which dynamically creates\n   * texture cooprdinates so that the level of detail of the texture in the rendered image remains somewhat constant. */\n  export interface ConstantLodParams {\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. */\n    repetitions: number;\n    /** An offset in world units used to shift the texture. */\n    offset: XAndY;\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. */\n    minDistClamp: number;\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. */\n    maxDistClamp: number;\n  }\n\n  function compareConstantLodParams(lhs: ConstantLodParams, rhs: ConstantLodParams): number {\n    return compareNumbers(lhs.repetitions, rhs.repetitions) || compareNumbers(lhs.offset.x, rhs.offset.x) || compareNumbers(lhs.offset.y, rhs.offset.y)\n      || compareNumbers(lhs.minDistClamp, rhs.minDistClamp) || compareNumbers(lhs.maxDistClamp, rhs.maxDistClamp);\n  }\n\n  /** Properties used to construct a [[TextureMapping.Params]]. */\n  export interface ParamProps {\n    /** The matrix used to map the image to a surface. */\n    textureMat2x3?: TextureMapping.Trans2x3;\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\n     * @note Defaults to 1.0\n     */\n    textureWeight?: number;\n    /** The mode by which to map the image to a surface.\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\n     */\n    mapMode?: TextureMapping.Mode;\n    worldMapping?: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    useConstantLod?: boolean;\n    /** Parameters for constantLod mapping mode. */\n    constantLodProps?: ConstantLodParamProps;\n  }\n\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\n  export class Params {\n    /** The matrix used to map the image to a surface. */\n    public textureMatrix: TextureMapping.Trans2x3;\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\n     */\n    public weight: number;\n    /** The mode by which to map the image to a surface. */\n    public mode: TextureMapping.Mode;\n    public worldMapping: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    public useConstantLod: boolean;\n    /** Parameters for constantLod mapping mode. */\n    public constantLodParams: ConstantLodParams;\n\n    public constructor(props?: TextureMapping.ParamProps) {\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\n      this.weight = props?.textureWeight ?? 1;\n      this.mode = props?.mapMode ?? Mode.Parametric;\n      this.worldMapping = props?.worldMapping ?? false;\n      this.useConstantLod = props?.useConstantLod ?? false;\n      this.constantLodParams = {\n        repetitions: props?.constantLodProps?.repetitions ?? 1,\n        offset: props?.constantLodProps?.offset ?? { x: 0, y: 0 },\n        minDistClamp: props?.constantLodProps?.minDistClamp ?? 1,\n        maxDistClamp: props?.constantLodProps?.maxDistClamp ?? 4096 * 1024 * 1024,\n      };\n    }\n\n    /** An [OrderedComparator]($bentley) that compares these Params against `other`. */\n    public compare(other: Params): number {\n      if (this === other) {\n        return 0;\n      }\n\n      return compareNumbers(this.weight, other.weight) || compareNumbers(this.mode, other.mode) || compareBooleans(this.worldMapping, other.worldMapping)\n        || compareBooleans(this.useConstantLod, other.useConstantLod) || this.textureMatrix.compare(other.textureMatrix)\n        || compareConstantLodParams(this.constantLodParams, other.constantLodParams);\n    }\n\n  /** Compute texture coordinates for a polyface.\n   * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.\n   * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].\n   * @returns the texture coordinates, or undefined if computation failed.\n   */\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, localToWorld: Transform = Transform.createIdentity()): Point2d[] | undefined {\n      switch (this.mode) {\n        default:  // Fall through to parametric in default case\n        case TextureMapping.Mode.Parametric: {\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n        }\n        case TextureMapping.Mode.Planar: {\n          const normalIndices = visitor.normalIndex;\n          if (!normalIndices)\n            return undefined;\n\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n          } else {\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\n          }\n        }\n        case TextureMapping.Mode.ElevationDrape: {\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, localToWorld);\n        }\n      }\n    }\n\n    /** Computes UV parameters given a texture mapping mode of parametric. */\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\n      const params: Point2d[] = [];\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\n        let param = Point2d.create();\n\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\n            param = visitor.getParam(i)!;\n          }\n        }\n\n        params.push(uvTransform.multiplyPoint2d(param));\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\n      const params: Point2d[] = [];\n      const points = visitor.point;\n      let normal: Vector3d;\n\n      if (visitor.normal === undefined)\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\n      else\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\n\n      if (!normal.normalize(normal))\n        return undefined;\n\n      // adjust U texture coordinate to be a continuous length starting at the\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\n\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\n      normal.scale(-1.0, normal);\n\n      // pick the first vertex normal\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\n\n      // if the magnitude of the normal is near zero, the real normal points\n      // almost straighten up.. In this case, use Y as the up vector to match QV\n\n      const magnitude = sideVector.magnitude();\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\n\n      if (magnitude < 1e-3) {\n        normal.set(0, 0, -1);\n        sideVector.set(1, 0, 0);\n      }\n\n      const upVector = sideVector.crossProduct(normal).normalize();\n      if (!upVector)\n        return undefined;\n\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\n\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, localToWorld?: Transform): Point2d[] {\n      const params: Point2d[] = [];\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\n\n        if (localToWorld !== undefined)\n          localToWorld.multiplyPoint3d(point, point);\n\n        params.push(Point2d.createFrom(point));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n  }\n}\n\nObject.freeze(TextureMapping.Trans2x3.identity);\n"]}

package/lib/cjs/ThematicDisplay.js

@@ -74,11 +74,32 @@ var ThematicGradientColorScheme;
  * @public
  */
 class ThematicGradientSettings {
+    /** The thematic image mode used to generate the gradient. Defaults to [[ThematicGradientMode.Smooth]]. */
+    mode;
+    /** The step count value used for [[ThematicGradientMode.Stepped]], [[ThematicGradientMode.SteppedWithDelimiter]], and [[ThematicGradientMode.IsoLines]]. Defaults to 10. Cannot be less than 2. */
+    stepCount;
+    /** 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. */
+    marginColor;
+    /** The color scheme used to generate the colors of the gradient color within the applied range. Defaults to [[ThematicGradientColorScheme.BlueRed]]. */
+    colorScheme;
+    /** The key color values that must be provided when using a custom thematic color scheme.
+     * Defaults to empty, unless using a custom thematic color scheme. In that case, this defaults to two key colors going from white to black.
+     * 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.
+     */
+    customKeys;
+    /** The percentage to mix in the original color with the thematic display gradient color (0-1).
+     * Applies to background map terrain and point clouds only.  Defaults to 0. */
+    colorMix;
+    /** Specifies how the transparency is computed. Defaults to [[ThematicGradientTransparencyMode.SurfaceOnly]].
+     * @note This property is ignored for gradients applied using an [[AnalysisStyle]] via [[AnalysisStyleThematic]] - in that case, only the color and
+     * transparency of the thematic gradient are applied.
+     */
+    transparencyMode;
     static get margin() { return .001; } // A fixed portion of the gradient for out of range values.
     static get contentRange() { return 1.0 - 2.0 * ThematicGradientSettings.margin; }
     static get contentMax() { return 1.0 - ThematicGradientSettings.margin; }
-    static { this.defaults = new ThematicGradientSettings({}); }
-    static { this._defaultCustomKeys = [[0.0, 255, 255, 255], [1.0, 0, 0, 0]]; }
+    static defaults = new ThematicGradientSettings({});
+    static _defaultCustomKeys = [[0.0, 255, 255, 255], [1.0, 0, 0, 0]];
     /** @alpha */
     get textureTransparency() {
         let transp = TextureProps_1.TextureTransparency.Opaque;
@@ -211,6 +232,10 @@ exports.ThematicGradientSettings = ThematicGradientSettings;
  * @public
  */
 class ThematicDisplaySensor {
+    /** The world position of the sensor in X, Y, and Z. Defaults to {0,0,0}. */
+    position;
+    /** The value of the sensor used when accessing the thematic gradient texture; expected range is 0 to 1. Defaults to 0. */
+    value;
     constructor(json) {
         if (undefined === json) {
             this.position = core_geometry_1.Point3d.fromJSON();
@@ -243,6 +268,14 @@ exports.ThematicDisplaySensor = ThematicDisplaySensor;
  * @public
  */
 class ThematicDisplaySensorSettings {
+    /** This is the list of sensors. Defaults to an empty array. */
+    sensors;
+    /** 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.
+     * If this is zero or negative, then no distance cutoff is applied (all sensors affect all positions regardless of nearness).
+     * Defaults to zero.
+     * @note Using a suitable distance cutoff imparts a significant performance benefit. The larger this value becomes, performance will degrade.
+     */
+    distanceCutoff;
     constructor(json) {
         this.sensors = [];
         if (undefined !== json) {
@@ -308,6 +341,24 @@ var ThematicDisplayMode;
  * @public
  */
 class ThematicDisplay {
+    /** The thematic display mode. This determines how to apply the thematic color gradient to the geometry. Defaults to [[ThematicDisplayMode.Height]]. */
+    displayMode;
+    /** The settings used to create a color gradient applied to the geometry. Defaults to an instantiation using [[ThematicGradientSettings.fromJSON]] with no arguments. */
+    gradientSettings;
+    /** The range to use when applying the thematic gradient for height and slope mode.
+     * For [[ThematicDisplayMode.Height]], this is world space in meters and represents the range in which to apply the gradient along the specified axis.
+     * 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.
+     * Defaults to a null range.
+     */
+    range;
+    /** 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}. */
+    axis;
+    /** For [[ThematicDisplayMode.HillShade]], this is the direction of the sun in world space. Defaults to {0,0,0}. */
+    sunDirection;
+    /** For [[ThematicDisplayMode.InverseDistanceWeightedSensors]], these are the settings that control the sensors. Defaults to an instantiation using [[ThematicDisplaySensorSettings.fromJSON]] with no arguments.
+     * @public
+     */
+    sensorSettings;
     equals(other) {
         if (this.displayMode !== other.displayMode)
             return false;