@itwin/core-common 5.0.0-dev.40 → 5.0.0-dev.41

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;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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ColorDef } from \"./ColorDef\";\r\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\r\n\r\n/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].\r\n * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:\r\n *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.\r\n *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.\r\n *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.\r\n * An aspect is overridden by virtue of not being set to \"undefined\" in the SubCategoryOverride.\r\n * @see [[DisplayStyleState.overrideSubCategory]]\r\n * @public\r\n */\r\nexport class SubCategoryOverride {\r\n  /** See [[SubCategoryAppearance.color]] */\r\n  public readonly color?: ColorDef;\r\n  /** See [[SubCategoryAppearance.invisible]] */\r\n  public readonly invisible?: boolean;\r\n  /** See [[SubCategoryAppearance.weight]] */\r\n  public readonly weight?: number;\r\n  /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */\r\n  public readonly style?: Id64String;\r\n  /** See [[SubCategoryAppearance.priority]] */\r\n  public readonly priority?: number;\r\n  /** See [[SubCategoryAppearance.materialId]] */\r\n  public readonly material?: Id64String;\r\n  /** See [[SubCategoryAppearance.transparency]] */\r\n  public readonly transparency?: number;\r\n\r\n  /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */\r\n  public get anyOverridden(): boolean {\r\n    return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;\r\n  }\r\n\r\n  /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */\r\n  public override(appearance: SubCategoryAppearance): SubCategoryAppearance {\r\n    if (!this.anyOverridden)\r\n      return appearance;\r\n\r\n    const props = appearance.toJSON();\r\n    const ovrProps = this.toJSON();\r\n    if (undefined !== ovrProps.invisible)\r\n      props.invisible = ovrProps.invisible;\r\n    if (undefined !== ovrProps.weight)\r\n      props.weight = ovrProps.weight;\r\n    if (undefined !== ovrProps.style)\r\n      props.style = ovrProps.style;\r\n    if (undefined !== ovrProps.material)\r\n      props.material = ovrProps.material;\r\n    if (undefined !== ovrProps.priority)\r\n      props.priority = ovrProps.priority;\r\n    if (undefined !== ovrProps.transp)\r\n      props.transp = ovrProps.transp;\r\n    if (undefined !== ovrProps.color)\r\n      props.color = ovrProps.color;\r\n\r\n    return new SubCategoryAppearance(props);\r\n  }\r\n\r\n  /** Convert this SubCategoryOverride to a JSON object\r\n   * @internal\r\n   */\r\n  public toJSON(): SubCategoryAppearance.Props {\r\n    const props: SubCategoryAppearance.Props = {};\r\n    if (undefined !== this.invisible)\r\n      props.invisible = this.invisible;\r\n\r\n    if (undefined !== this.weight)\r\n      props.weight = this.weight;\r\n\r\n    if (undefined !== this.style)\r\n      props.style = this.style;\r\n\r\n    if (undefined !== this.material)\r\n      props.material = this.material;\r\n\r\n    if (undefined !== this.priority)\r\n      props.priority = this.priority;\r\n\r\n    if (undefined !== this.transparency)\r\n      props.transp = this.transparency;\r\n\r\n    if (undefined !== this.color)\r\n      props.color = this.color.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Perform equality comparison against another SubCategoryOverride. */\r\n  public equals(other: SubCategoryOverride): boolean {\r\n    if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style\r\n      || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)\r\n      return false;\r\n\r\n    if (undefined !== this.color && undefined !== other.color)\r\n      return this.color.tbgr === other.color.tbgr;\r\n    else\r\n      return undefined === this.color && undefined === other.color;\r\n  }\r\n\r\n  /** Create a new SubCategoryOverride from a JSON object */\r\n  public static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride {\r\n    return undefined !== json ? new SubCategoryOverride(json) : this.defaults;\r\n  }\r\n\r\n  private constructor(props: SubCategoryAppearance.Props) {\r\n    if (undefined !== props.invisible)\r\n      this.invisible = JsonUtils.asBool(props.invisible);\r\n    if (undefined !== props.color)\r\n      this.color = ColorDef.fromJSON(props.color);\r\n    if (undefined !== props.weight)\r\n      this.weight = JsonUtils.asInt(props.weight);\r\n    if (undefined !== props.style)\r\n      this.style = Id64.fromJSON(props.style);\r\n    if (undefined !== props.material)\r\n      this.material = Id64.fromJSON(props.material);\r\n    if (undefined !== props.priority)\r\n      this.priority = JsonUtils.asInt(props.priority);\r\n    if (undefined !== props.transp)\r\n      this.transparency = JsonUtils.asDouble(props.transp);\r\n  }\r\n\r\n  /** A default SubCategoryOverride which overrides nothing. */\r\n  public static defaults = new SubCategoryOverride({});\r\n}\r\n"]}

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;;;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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { BackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Identifies a [TerrainProvider]($frontend).\r\n * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].\r\n * @public\r\n * @extensions\r\n * @deprecated in 3.x. Use string instead.\r\n */\r\nexport type TerrainProviderName = string;\r\n\r\n/** Ids of [Cesium ION assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.\r\n * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to \"CesiumWorldTerrain\".\r\n * You may alternatively use the Id of any ION asset to which you have access.\r\n * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ION asset.\r\n * @public\r\n */\r\nexport enum CesiumTerrainAssetId {\r\n  /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */\r\n  Default = \"1\",\r\n  /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */\r\n  Bathymetry = \"2426648\",\r\n}\r\n\r\n/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @see [[BackgroundMapProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport interface TerrainProps {\r\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\r\n   * If omitted, it defaults to \"CesiumWorldTerrain\".\r\n   */\r\n  providerName?: string;\r\n  /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],\r\n   * for those providers that support multiple data sources.\r\n   * For example, the \"CesiumWorldTerrain\" provider uses this field to store a [[CesiumTerrainAssetId]].\r\n   * Default value: an empty string.\r\n   */\r\n  dataSource?: string;\r\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 */\r\n  exaggeration?: number;\r\n  /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */\r\n  applyLighting?: boolean;\r\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */\r\n  heightOrigin?: number;\r\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\r\n  heightOriginMode?: TerrainHeightOriginMode;\r\n  /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.\r\n   * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.\r\n   */\r\n  nonLocatable?: boolean;\r\n}\r\n\r\n/** Correction modes for terrain height\r\n * @see [[TerrainProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TerrainHeightOriginMode {\r\n  /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */\r\n  Geodetic = 0,\r\n  /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */\r\n  Geoid = 1,\r\n  /** Height value indicates the height of the IModel origin relative to ground level at project center. */\r\n  Ground = 2,\r\n}\r\n\r\n/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.\r\n * @public\r\n */\r\nexport class TerrainSettings {\r\n  private _nonLocatable: true | undefined;\r\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\r\n   * Defaults to \"CesiumWorldTerrain\".\r\n   */\r\n  public readonly providerName: string;\r\n  /** Identifies the specific terrain data source to be supplied by the [TerrainProvider]($frontend) identified by [[providerName]],\r\n   * for those providers that support multiple data sources.\r\n   * For example, the \"CesiumWorldTerrain\" provider uses this field to store a [[CesiumTerrainAssetId]].\r\n   * Default value: an empty string.\r\n   */\r\n  public readonly dataSource: string;\r\n  /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */\r\n  public readonly exaggeration: number;\r\n  /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */\r\n  public readonly applyLighting: boolean;\r\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */\r\n  public readonly heightOrigin: number;\r\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\r\n  public readonly heightOriginMode: TerrainHeightOriginMode;\r\n  /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.\r\n   * @see [[TerrainProps.nonLocatable]].\r\n   * @internal\r\n   */\r\n  public get nonLocatable(): true | undefined {\r\n    return this._nonLocatable;\r\n  }\r\n\r\n  /** @deprecated in 4.5.x. Use the overload that takes [[TerrainProps]]. */\r\n  constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);\r\n\r\n  constructor(props?: TerrainProps);\r\n\r\n  /** @internal */\r\n  constructor(providerNameOrProps: string | TerrainProps | undefined, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode) {\r\n    let providerName;\r\n    let dataSource;\r\n    let nonLocatable;\r\n    if (typeof providerNameOrProps === \"string\") {\r\n      providerName = providerNameOrProps;\r\n    } else if (providerNameOrProps) {\r\n      ({ providerName, dataSource, exaggeration, applyLighting, heightOrigin, heightOriginMode, nonLocatable } = providerNameOrProps);\r\n    }\r\n\r\n    this.providerName = providerName ?? \"CesiumWorldTerrain\";\r\n    this.dataSource = dataSource ?? \"\";\r\n    this.exaggeration = Math.min(100, Math.max(0.1, exaggeration ?? 1.0));\r\n    this.applyLighting = applyLighting ?? false;\r\n    this.heightOrigin = heightOrigin ?? 0.0;\r\n\r\n    if (true === nonLocatable)\r\n      this._nonLocatable = true;\r\n\r\n    switch (heightOriginMode) {\r\n      case TerrainHeightOriginMode.Ground:\r\n      case TerrainHeightOriginMode.Geoid:\r\n        this.heightOriginMode = heightOriginMode;\r\n        break;\r\n      default:\r\n        this.heightOriginMode = TerrainHeightOriginMode.Geodetic;\r\n        break;\r\n    }\r\n  }\r\n\r\n  public static fromJSON(json?: TerrainProps) {\r\n    return new TerrainSettings(json);\r\n  }\r\n\r\n  /** Create settings that obtain terrain from a [Cesium ION asset](https://cesium.com/platform/cesium-ion/content/) such as\r\n   * one of those defined by [[CesiumTerrainAssetId]].\r\n   * @note You must ensure your Cesium ION account has access to the specified asset.\r\n   */\r\n  public static fromCesiumIonAsset(assetId: string = CesiumTerrainAssetId.Default, options?: Omit<TerrainProps, \"providerName\" | \"dataSource\">): TerrainSettings {\r\n    return TerrainSettings.fromJSON({\r\n      ...options,\r\n      dataSource: assetId,\r\n    });\r\n  }\r\n\r\n  public toJSON(): TerrainProps {\r\n    const props: TerrainProps = { heightOriginMode: this.heightOriginMode };\r\n    if (\"CesiumWorldTerrain\" !== this.providerName)\r\n      props.providerName = this.providerName;\r\n    if (this.dataSource)\r\n      props.dataSource = this.dataSource;\r\n    if (1 !== this.exaggeration)\r\n      props.exaggeration = this.exaggeration;\r\n    if (this.nonLocatable)\r\n      props.nonLocatable = true;\r\n    if (this.applyLighting)\r\n      props.applyLighting = true;\r\n    if (0 !== this.heightOrigin)\r\n      props.heightOrigin = this.heightOrigin;\r\n\r\n    return props;\r\n  }\r\n\r\n  public equals(other: TerrainSettings): boolean {\r\n    return this.providerName === other.providerName && this.dataSource === other.dataSource && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting\r\n      && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n  public equalsJSON(json?: BackgroundMapProps): boolean {\r\n    return this.equals(TerrainSettings.fromJSON(json));\r\n  }\r\n\r\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: TerrainProps): TerrainSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      providerName: changedProps.providerName ?? this.providerName,\r\n      dataSource: changedProps.dataSource ?? this.dataSource,\r\n      exaggeration: changedProps.exaggeration ?? this.exaggeration,\r\n      nonLocatable: changedProps.nonLocatable ?? this.nonLocatable,\r\n      applyLighting: changedProps.applyLighting ?? this.applyLighting,\r\n      heightOrigin: changedProps.heightOrigin ?? this.heightOrigin,\r\n      heightOriginMode: changedProps.heightOriginMode ?? this.heightOriginMode,\r\n    };\r\n\r\n    return TerrainSettings.fromJSON(props);\r\n  }\r\n}\r\n"]}

package/lib/cjs/TextureMapping.d.ts

@@ -31,8 +31,12 @@ export declare class TextureMapping {
     /** The parameters describing how the textures are mapped to the surface. */
     readonly params: TextureMapping.Params;
     constructor(tx: RenderTexture, params: TextureMapping.Params);
-    /** @internal */
-    computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined;
+    /** Compute texture coordinates for a polyface.
+     * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.
+     * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].
+     * @returns the texture coordinates, or undefined if computation failed.
+     */
+    computeUVParams(visitor: PolyfaceVisitor, localToWorld?: Transform): Point2d[] | undefined;
     /** An [OrderedComparator]($bentley) that compares this mapping against `other`. */
     compare(other: TextureMapping): number;
 }
@@ -44,17 +48,17 @@ export declare namespace TextureMapping {
         Parametric = 0,
         ElevationDrape = 1,
         Planar = 2,
-        /** @internal */
+        /** Currently unsupported. */
         DirectionalDrape = 3,
-        /** @internal */
+        /** Currently unsupported. */
         Cubic = 4,
-        /** @internal */
+        /** Currently unsupported. */
         Spherical = 5,
-        /** @internal */
+        /** Currently unsupported. */
         Cylindrical = 6,
-        /** @internal */
+        /** Currently unsupported. */
         Solid = 7,
-        /** @internal Only valid for lights */
+        /** Currently unsupported. */
         FrontProject = 8
     }
     /** A 2x3 matrix for mapping a texture image to a surface. */
@@ -116,7 +120,6 @@ export declare namespace TextureMapping {
          * @note Defaults to [[TextureMapping.Mode.Parametric]].
          */
         mapMode?: TextureMapping.Mode;
-        /** @internal */
         worldMapping?: boolean;
         /** True if want to use constant LOD texture mapping for the surface texture. */
         useConstantLod?: boolean;
@@ -133,7 +136,6 @@ export declare namespace TextureMapping {
         weight: number;
         /** The mode by which to map the image to a surface. */
         mode: TextureMapping.Mode;
-        /** @internal */
         worldMapping: boolean;
         /** True if want to use constant LOD texture mapping for the surface texture. */
         useConstantLod: boolean;
@@ -142,11 +144,12 @@ export declare namespace TextureMapping {
         constructor(props?: TextureMapping.ParamProps);
         /** An [OrderedComparator]($bentley) that compares these Params against `other`. */
         compare(other: Params): number;
-        /**
-         * Generates UV parameters for textured surfaces. Returns undefined on failure.
-         * @internal
+        /** Compute texture coordinates for a polyface.
+         * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.
+         * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].
+         * @returns the texture coordinates, or undefined if computation failed.
          */
-        computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined;
+        computeUVParams(visitor: IndexedPolyfaceVisitor, localToWorld?: Transform): Point2d[] | undefined;
         /** Computes UV parameters given a texture mapping mode of parametric. */
         private computeParametricUVParams;
         /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */

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

@@ -1 +1 @@
-{"version":3,"file":"TextureMapping.d.ts","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAY,OAAO,EAAW,eAAe,EAAE,SAAS,EAAY,KAAK,EAAE,MAAM,sBAAsB,CAAC;AACvI,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oHAAoH;IACpH,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAQD;;GAEG;AACH,qBAAa,cAAc;IACzB,gLAAgL;IAChL,SAAgB,OAAO,EAAE,aAAa,CAAC;IACvC;;OAEG;IACI,eAAe,CAAC,EAAE,eAAe,CAAC;IACzC,4EAA4E;IAC5E,SAAgB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;gBAE3B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM;IAKnE,gBAAgB;IACT,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS;IAIrG,mFAAmF;IAC5E,OAAO,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;CAQ9C;AAED,cAAc;AACd,yBAAiB,cAAc,CAAC;IAC9B,qDAAqD;IACrD,KAAY,IAAI;QACd,IAAI,KAAK;QACT,UAAU,IAAI;QACd,cAAc,IAAI;QAClB,MAAM,IAAI;QACV,gBAAgB;QAChB,gBAAgB,IAAI;QACpB,gBAAgB;QAChB,KAAK,IAAI;QACT,gBAAgB;QAChB,SAAS,IAAI;QACb,gBAAgB;QAChB,WAAW,IAAI;QACf,gBAAgB;QAChB,KAAK,IAAI;QACT,sCAAsC;QACtC,YAAY,IAAI;KACjB;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QACnB,sDAAsD;QACtD,SAAgB,SAAS,EAAE,SAAS,CAAC;QAErC;;;;;;;;;;;WAWG;oBACgB,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI,EAAE,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI;QAM/E,wCAAwC;QACxC,gBAAuB,QAAQ,WAAkB;QAEjD,oFAAoF;QAC7E,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;KAmBxC;IAED,2EAA2E;IAC3E,UAAiB,qBAAqB;QACpC,oKAAoK;QACpK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,8EAA8E;QAC9E,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,sGAAsG;QACtG,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,0GAA0G;QAC1G,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED;0HACsH;IACtH,UAAiB,iBAAiB;QAChC,qJAAqJ;QACrJ,WAAW,EAAE,MAAM,CAAC;QACpB,0DAA0D;QAC1D,MAAM,EAAE,KAAK,CAAC;QACd,wFAAwF;QACxF,YAAY,EAAE,MAAM,CAAC;QACrB,wFAAwF;QACxF,YAAY,EAAE,MAAM,CAAC;KACtB;IAOD,gEAAgE;IAChE,UAAiB,UAAU;QACzB,qDAAqD;QACrD,aAAa,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC;QACxC;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB;;WAEG;QACH,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;QAC9B,gBAAgB;QAChB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,gFAAgF;QAChF,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,+CAA+C;QAC/C,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;KAC1C;IAED,oFAAoF;IACpF,MAAa,MAAM;QACjB,qDAAqD;QAC9C,aAAa,EAAE,cAAc,CAAC,QAAQ,CAAC;QAC9C;;WAEG;QACI,MAAM,EAAE,MAAM,CAAC;QACtB,uDAAuD;QAChD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;QACjC,gBAAgB;QACT,YAAY,EAAE,OAAO,CAAC;QAC7B,gFAAgF;QACzE,cAAc,EAAE,OAAO,CAAC;QAC/B,+CAA+C;QACxC,iBAAiB,EAAE,iBAAiB,CAAC;oBAEzB,KAAK,CAAC,EAAE,cAAc,CAAC,UAAU;QAcpD,mFAAmF;QAC5E,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;QAUrC;;;WAGG;QACI,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS;QAwB5G,yEAAyE;QACzE,OAAO,CAAC,yBAAyB;QAiBjC,sHAAsH;QACtH,OAAO,CAAC,qBAAqB;QA+C7B,+HAA+H;QAC/H,OAAO,CAAC,6BAA6B;KActC;CACF"}
+{"version":3,"file":"TextureMapping.d.ts","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAY,OAAO,EAAW,eAAe,EAAE,SAAS,EAAY,KAAK,EAAE,MAAM,sBAAsB,CAAC;AACvI,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oHAAoH;IACpH,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAQD;;GAEG;AACH,qBAAa,cAAc;IACzB,gLAAgL;IAChL,SAAgB,OAAO,EAAE,aAAa,CAAC;IACvC;;OAEG;IACI,eAAe,CAAC,EAAE,eAAe,CAAC;IACzC,4EAA4E;IAC5E,SAAgB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;gBAE3B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM;IAKnE;;;;OAIG;IACI,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,YAAY,GAAE,SAAsC,GAAG,OAAO,EAAE,GAAG,SAAS;IAI7H,mFAAmF;IAC5E,OAAO,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;CAQ9C;AAED,cAAc;AACd,yBAAiB,cAAc,CAAC;IAC9B,qDAAqD;IACrD,KAAY,IAAI;QACd,IAAI,KAAK;QACT,UAAU,IAAI;QACd,cAAc,IAAI;QAClB,MAAM,IAAI;QACV,6BAA6B;QAC7B,gBAAgB,IAAI;QACpB,6BAA6B;QAC7B,KAAK,IAAI;QACT,6BAA6B;QAC7B,SAAS,IAAI;QACb,6BAA6B;QAC7B,WAAW,IAAI;QACf,6BAA6B;QAC7B,KAAK,IAAI;QACT,6BAA6B;QAC7B,YAAY,IAAI;KACjB;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QACnB,sDAAsD;QACtD,SAAgB,SAAS,EAAE,SAAS,CAAC;QAErC;;;;;;;;;;;WAWG;oBACgB,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI,EAAE,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI;QAM/E,wCAAwC;QACxC,gBAAuB,QAAQ,WAAkB;QAEjD,oFAAoF;QAC7E,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;KAmBxC;IAED,2EAA2E;IAC3E,UAAiB,qBAAqB;QACpC,oKAAoK;QACpK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,8EAA8E;QAC9E,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,sGAAsG;QACtG,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,0GAA0G;QAC1G,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED;0HACsH;IACtH,UAAiB,iBAAiB;QAChC,qJAAqJ;QACrJ,WAAW,EAAE,MAAM,CAAC;QACpB,0DAA0D;QAC1D,MAAM,EAAE,KAAK,CAAC;QACd,wFAAwF;QACxF,YAAY,EAAE,MAAM,CAAC;QACrB,wFAAwF;QACxF,YAAY,EAAE,MAAM,CAAC;KACtB;IAOD,gEAAgE;IAChE,UAAiB,UAAU;QACzB,qDAAqD;QACrD,aAAa,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC;QACxC;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB;;WAEG;QACH,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;QAC9B,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,gFAAgF;QAChF,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,+CAA+C;QAC/C,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;KAC1C;IAED,oFAAoF;IACpF,MAAa,MAAM;QACjB,qDAAqD;QAC9C,aAAa,EAAE,cAAc,CAAC,QAAQ,CAAC;QAC9C;;WAEG;QACI,MAAM,EAAE,MAAM,CAAC;QACtB,uDAAuD;QAChD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;QAC1B,YAAY,EAAE,OAAO,CAAC;QAC7B,gFAAgF;QACzE,cAAc,EAAE,OAAO,CAAC;QAC/B,+CAA+C;QACxC,iBAAiB,EAAE,iBAAiB,CAAC;oBAEzB,KAAK,CAAC,EAAE,cAAc,CAAC,UAAU;QAcpD,mFAAmF;QAC5E,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;QAUvC;;;;WAIG;QACM,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,YAAY,GAAE,SAAsC,GAAG,OAAO,EAAE,GAAG,SAAS;QAwBpI,yEAAyE;QACzE,OAAO,CAAC,yBAAyB;QAiBjC,sHAAsH;QACtH,OAAO,CAAC,qBAAqB;QA+C7B,+HAA+H;QAC/H,OAAO,CAAC,6BAA6B;KActC;CACF"}

package/lib/cjs/TextureMapping.js

@@ -23,9 +23,13 @@ class TextureMapping {
         this.texture = tx;
         this.params = params;
     }
-    /** @internal */
-    computeUVParams(visitor, transformToImodel) {
-        return this.params.computeUVParams(visitor, transformToImodel);
+    /** Compute texture coordinates for a polyface.
+     * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.
+     * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].
+     * @returns the texture coordinates, or undefined if computation failed.
+     */
+    computeUVParams(visitor, localToWorld = core_geometry_1.Transform.createIdentity()) {
+        return this.params.computeUVParams(visitor, localToWorld);
     }
     /** An [OrderedComparator]($bentley) that compares this mapping against `other`. */
     compare(other) {
@@ -46,17 +50,17 @@ exports.TextureMapping = TextureMapping;
         Mode[Mode["Parametric"] = 0] = "Parametric";
         Mode[Mode["ElevationDrape"] = 1] = "ElevationDrape";
         Mode[Mode["Planar"] = 2] = "Planar";
-        /** @internal */
+        /** Currently unsupported. */
         Mode[Mode["DirectionalDrape"] = 3] = "DirectionalDrape";
-        /** @internal */
+        /** Currently unsupported. */
         Mode[Mode["Cubic"] = 4] = "Cubic";
-        /** @internal */
+        /** Currently unsupported. */
         Mode[Mode["Spherical"] = 5] = "Spherical";
-        /** @internal */
+        /** Currently unsupported. */
         Mode[Mode["Cylindrical"] = 6] = "Cylindrical";
-        /** @internal */
+        /** Currently unsupported. */
         Mode[Mode["Solid"] = 7] = "Solid";
-        /** @internal Only valid for lights */
+        /** Currently unsupported. */
         Mode[Mode["FrontProject"] = 8] = "FrontProject";
     })(Mode = TextureMapping.Mode || (TextureMapping.Mode = {}));
     /** A 2x3 matrix for mapping a texture image to a surface. */
@@ -127,11 +131,12 @@ exports.TextureMapping = TextureMapping;
                 || (0, core_bentley_1.compareBooleans)(this.useConstantLod, other.useConstantLod) || this.textureMatrix.compare(other.textureMatrix)
                 || compareConstantLodParams(this.constantLodParams, other.constantLodParams);
         }
-        /**
-         * Generates UV parameters for textured surfaces. Returns undefined on failure.
-         * @internal
+        /** Compute texture coordinates for a polyface.
+         * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.
+         * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].
+         * @returns the texture coordinates, or undefined if computation failed.
          */
-        computeUVParams(visitor, transformToImodel) {
+        computeUVParams(visitor, localToWorld = core_geometry_1.Transform.createIdentity()) {
             switch (this.mode) {
                 default: // Fall through to parametric in default case
                 case TextureMapping.Mode.Parametric: {
@@ -150,7 +155,7 @@ exports.TextureMapping = TextureMapping;
                     }
                 }
                 case TextureMapping.Mode.ElevationDrape: {
-                    return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);
+                    return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, localToWorld);
                 }
             }
         }
@@ -206,13 +211,13 @@ exports.TextureMapping = TextureMapping;
             return params;
         }
         /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */
-        computeElevationDrapeUVParams(visitor, uvTransform, transformToIModel) {
+        computeElevationDrapeUVParams(visitor, uvTransform, localToWorld) {
             const params = [];
             const numEdges = visitor.numEdgesThisFacet;
             for (let i = 0; i < numEdges; i++) {
                 const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);
-                if (transformToIModel !== undefined)
-                    transformToIModel.multiplyPoint3d(point, point);
+                if (localToWorld !== undefined)
+                    localToWorld.multiplyPoint3d(point, point);
                 params.push(core_geometry_1.Point2d.createFrom(point));
                 uvTransform.multiplyPoint2d(params[i], params[i]);
             }

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,gBAAgB;IACT,eAAe,CAAC,OAAwB,EAAE,iBAA4B;QAC3E,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,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;AA7BD,wCA6BC;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,qDAAqD;IACrD,IAAY,IAiBX;IAjBD,WAAY,IAAI;QACd,gCAAS,CAAA;QACT,2CAAc,CAAA;QACd,mDAAkB,CAAA;QAClB,mCAAU,CAAA;QACV,gBAAgB;QAChB,uDAAoB,CAAA;QACpB,gBAAgB;QAChB,iCAAS,CAAA;QACT,gBAAgB;QAChB,yCAAa,CAAA;QACb,gBAAgB;QAChB,6CAAe,CAAA;QACf,gBAAgB;QAChB,iCAAS,CAAA;QACT,sCAAsC;QACtC,+CAAgB,CAAA;IAClB,CAAC,EAjBW,IAAI,GAAJ,mBAAI,KAAJ,mBAAI,QAiBf;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QAInB;;;;;;;;;;;WAWG;QACH,YAAmB,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC;YAC7E,MAAM,MAAM,GAAG,IAAI,uBAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,wBAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,SAAS,GAAG,yBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;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;IAwBD,oFAAoF;IACpF,MAAa,MAAM;QAgBjB,YAAmB,KAAiC;YAClD,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,QAAQ,CAAC,QAAQ,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC;YAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;YACjD,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,cAAc,IAAI,KAAK,CAAC;YACrD,IAAI,CAAC,iBAAiB,GAAG;gBACvB,WAAW,EAAE,KAAK,EAAE,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;QAED;;;WAGG;QACI,eAAe,CAAC,OAA+B,EAAE,iBAA4B;YAClF,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,iBAAiB,CAAC,CAAC;gBACtG,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,iBAA6B;YAC1H,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,iBAAiB,KAAK,SAAS;oBACjC,iBAAiB,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAElD,MAAM,CAAC,IAAI,CAAC,uBAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IAtJY,qBAAM,SAsJlB,CAAA;AACH,CAAC,EAjRgB,cAAc,8BAAd,cAAc,QAiR9B;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  /** @internal */\n  public computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, transformToImodel);\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    /** @internal */\n    DirectionalDrape = 3,\n    /** @internal */\n    Cubic = 4,\n    /** @internal */\n    Spherical = 5,\n    /** @internal */\n    Cylindrical = 6,\n    /** @internal */\n    Solid = 7,\n    /** @internal Only valid for lights */\n    FrontProject = 8,\n  }\n\n  /** A 2x3 matrix for mapping a texture image to a surface. */\n  export class Trans2x3 {\n    /** The 3x4 transform produced from the 2x3 matrix. */\n    public readonly transform: Transform;\n\n    /** Construct from the two rows of the matrix:\n     * ```\n     *  | m00 m01 originX |\n     *  | m10 m11 originY |\n     * ```\n     * Producing the [Transform]($core-geometry):\n     * ```\n     *  | m00 m01 0 originX |\n     *  | m10 m11 0 originY |\n     *  | 0   0   1 0       |\n     * ```\n     */\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\n      const origin = new Point3d(originX, originY, 0);\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\n      this.transform = Transform.createRefs(origin, matrix);\n    }\n\n    /** An immutable 2x3 identity matrix. */\n    public static readonly identity = new Trans2x3();\n\n    /** 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    /** @internal */\n    worldMapping?: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    useConstantLod?: boolean;\n    /** Parameters for constantLod mapping mode. */\n    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    /** @internal */\n    public worldMapping: boolean;\n    /** True if want to use constant LOD texture mapping for the surface texture. */\n    public useConstantLod: boolean;\n    /** Parameters for constantLod mapping mode. */\n    public constantLodParams: ConstantLodParams;\n\n    public constructor(props?: TextureMapping.ParamProps) {\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\n      this.weight = props?.textureWeight ?? 1;\n      this.mode = props?.mapMode ?? Mode.Parametric;\n      this.worldMapping = props?.worldMapping ?? false;\n      this.useConstantLod = props?.useConstantLod ?? false;\n      this.constantLodParams = {\n        repetitions: props?.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    /**\n     * Generates UV parameters for textured surfaces. Returns undefined on failure.\n     * @internal\n     */\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\n      switch (this.mode) {\n        default:  // Fall through to parametric in default case\n        case TextureMapping.Mode.Parametric: {\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n        }\n        case TextureMapping.Mode.Planar: {\n          const normalIndices = visitor.normalIndex;\n          if (!normalIndices)\n            return undefined;\n\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\n          } else {\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\n          }\n        }\n        case TextureMapping.Mode.ElevationDrape: {\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);\n        }\n      }\n    }\n\n    /** Computes UV parameters given a texture mapping mode of parametric. */\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\n      const params: Point2d[] = [];\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\n        let param = Point2d.create();\n\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\n            param = visitor.getParam(i)!;\n          }\n        }\n\n        params.push(uvTransform.multiplyPoint2d(param));\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\n      const params: Point2d[] = [];\n      const points = visitor.point;\n      let normal: Vector3d;\n\n      if (visitor.normal === undefined)\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\n      else\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\n\n      if (!normal.normalize(normal))\n        return undefined;\n\n      // adjust U texture coordinate to be a continuous length starting at the\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\n\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\n      normal.scale(-1.0, normal);\n\n      // pick the first vertex normal\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\n\n      // if the magnitude of the normal is near zero, the real normal points\n      // almost straighten up.. In this case, use Y as the up vector to match QV\n\n      const magnitude = sideVector.magnitude();\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\n\n      if (magnitude < 1e-3) {\n        normal.set(0, 0, -1);\n        sideVector.set(1, 0, 0);\n      }\n\n      const upVector = sideVector.crossProduct(normal).normalize();\n      if (!upVector)\n        return undefined;\n\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\n\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, transformToIModel?: Transform): Point2d[] {\n      const params: Point2d[] = [];\n      const numEdges = visitor.numEdgesThisFacet;\n      for (let i = 0; i < numEdges; i++) {\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\n\n        if (transformToIModel !== undefined)\n          transformToIModel.multiplyPoint3d(point, point);\n\n        params.push(Point2d.createFrom(point));\n        uvTransform.multiplyPoint2d(params[i], params[i]);\n      }\n      return params;\n    }\n  }\n}\n\nObject.freeze(TextureMapping.Trans2x3.identity);\n"]}
+{"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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d, XAndY } from \"@itwin/core-geometry\";\r\nimport { RenderTexture } from \"./RenderTexture\";\r\nimport { compareBooleans, compareBooleansOrUndefined, compareNumbers, compareNumbersOrUndefined, comparePossiblyUndefined } from \"@itwin/core-bentley\";\r\n\r\n/** Defines normal map parameters.\r\n * @beta\r\n */\r\nexport interface NormalMapParams {\r\n  /** The texture to use as a normal map. If not present then the pattern map texture will be used as a normal map. */\r\n  normalMap?: RenderTexture;\r\n  /** True if the Y component stored in the green channel should be negated. By default, positive Y points downward, but some\r\n   * normal maps are created with positive Y pointing upward.\r\n   */\r\n  greenUp?: boolean;\r\n  /** Scale factor by which to multiply the components of the normal extracted from [[normalMap]]. */\r\n  scale?: number;\r\n  /** True if want to use constant LOD texture mapping for the normal map texture. */\r\n  useConstantLod?: boolean;\r\n}\r\n\r\nfunction compareNormalMapParams(lhs: NormalMapParams, rhs: NormalMapParams): number {\r\n  return comparePossiblyUndefined((lh, rh) => lh.compare(rh), lhs.normalMap, rhs.normalMap)\r\n    || compareBooleansOrUndefined(lhs.greenUp, rhs.greenUp) || compareNumbersOrUndefined(lhs.scale, rhs.scale)\r\n    || compareBooleansOrUndefined(lhs.useConstantLod, rhs.useConstantLod);\r\n}\r\n\r\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\r\n * @public\r\n */\r\nexport class TextureMapping {\r\n  /** The texture to be mapped to the surface. If normalMapParams is present but does not contain a normal map, then texture is used as a normal map rather than a pattern map. */\r\n  public readonly texture: RenderTexture;\r\n  /** The parameters for normal mapping.\r\n   * @beta\r\n   */\r\n  public normalMapParams?: NormalMapParams;\r\n  /** The parameters describing how the textures are mapped to the surface. */\r\n  public readonly params: TextureMapping.Params;\r\n\r\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\r\n    this.texture = tx;\r\n    this.params = params;\r\n  }\r\n\r\n  /** Compute texture coordinates for a polyface.\r\n   * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.\r\n   * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].\r\n   * @returns the texture coordinates, or undefined if computation failed.\r\n   */\r\n  public computeUVParams(visitor: PolyfaceVisitor, localToWorld: Transform = Transform.createIdentity()): Point2d[] | undefined {\r\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, localToWorld);\r\n  }\r\n\r\n  /** An [OrderedComparator]($bentley) that compares this mapping against `other`. */\r\n  public compare(other: TextureMapping): number {\r\n    if (this === other) {\r\n      return 0;\r\n    }\r\n\r\n    return this.texture.compare(other.texture) || this.params.compare(other.params)\r\n      || comparePossiblyUndefined((lh, rh) => compareNormalMapParams(lh, rh), this.normalMapParams, other.normalMapParams);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace TextureMapping {\r\n  /** Enumerates the possible texture mapping modes. */\r\n  export enum Mode {\r\n    None = -1,\r\n    Parametric = 0,\r\n    ElevationDrape = 1,\r\n    Planar = 2,\r\n    /** Currently unsupported. */\r\n    DirectionalDrape = 3,\r\n    /** Currently unsupported. */\r\n    Cubic = 4,\r\n    /** Currently unsupported. */\r\n    Spherical = 5,\r\n    /** Currently unsupported. */\r\n    Cylindrical = 6,\r\n    /** Currently unsupported. */\r\n    Solid = 7,\r\n    /** Currently unsupported. */\r\n    FrontProject = 8,\r\n  }\r\n\r\n  /** A 2x3 matrix for mapping a texture image to a surface. */\r\n  export class Trans2x3 {\r\n    /** The 3x4 transform produced from the 2x3 matrix. */\r\n    public readonly transform: Transform;\r\n\r\n    /** Construct from the two rows of the matrix:\r\n     * ```\r\n     *  | m00 m01 originX |\r\n     *  | m10 m11 originY |\r\n     * ```\r\n     * Producing the [Transform]($core-geometry):\r\n     * ```\r\n     *  | m00 m01 0 originX |\r\n     *  | m10 m11 0 originY |\r\n     *  | 0   0   1 0       |\r\n     * ```\r\n     */\r\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\r\n      const origin = new Point3d(originX, originY, 0);\r\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\r\n      this.transform = Transform.createRefs(origin, matrix);\r\n    }\r\n\r\n    /** An immutable 2x3 identity matrix. */\r\n    public static readonly identity = new Trans2x3();\r\n\r\n    /** An [OrderedComparator]($bentley) that compares this Trans2x3 against `other`. */\r\n    public compare(other: Trans2x3): number {\r\n      if (this === other) {\r\n        return 0;\r\n      }\r\n\r\n      const originDiff = compareNumbers(this.transform.origin.x, other.transform.origin.x) || compareNumbers(this.transform.origin.y, other.transform.origin.y);\r\n      if (originDiff !== 0) {\r\n        return originDiff;\r\n      }\r\n\r\n      for (const i of [0, 1, 3, 4]) {\r\n        const matDiff = compareNumbers(this.transform.matrix.coffs[i], other.transform.matrix.coffs[i]);\r\n        if (matDiff !== 0) {\r\n          return matDiff;\r\n        }\r\n      }\r\n\r\n      return 0;\r\n    }\r\n  }\r\n\r\n  /** Properties used to construct a [[TextureMapping.ConstantLodParams]]. */\r\n  export interface ConstantLodParamProps {\r\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. */\r\n    repetitions?: number;\r\n    /** An offset in world units used to shift the texture. Defaults to (0, 0). */\r\n    offset?: XAndY;\r\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. Defaults to 1.*/\r\n    minDistClamp?: number;\r\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. Defaults to 2^32. */\r\n    maxDistClamp?: number;\r\n  }\r\n\r\n  /** Parameters to define constant level of detail mapping mode, a mode of texture coordinate generation which dynamically creates\r\n   * texture cooprdinates so that the level of detail of the texture in the rendered image remains somewhat constant. */\r\n  export interface ConstantLodParams {\r\n    /** The number of times the texture is repeated.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. */\r\n    repetitions: number;\r\n    /** An offset in world units used to shift the texture. */\r\n    offset: XAndY;\r\n    /** The minimum distance (from the eye to the surface) at which to clamp the texture. */\r\n    minDistClamp: number;\r\n    /** The maximum distance (from the eye to the surface) at which to clamp the texture. */\r\n    maxDistClamp: number;\r\n  }\r\n\r\n  function compareConstantLodParams(lhs: ConstantLodParams, rhs: ConstantLodParams): number {\r\n    return compareNumbers(lhs.repetitions, rhs.repetitions) || compareNumbers(lhs.offset.x, rhs.offset.x) || compareNumbers(lhs.offset.y, rhs.offset.y)\r\n      || compareNumbers(lhs.minDistClamp, rhs.minDistClamp) || compareNumbers(lhs.maxDistClamp, rhs.maxDistClamp);\r\n  }\r\n\r\n  /** Properties used to construct a [[TextureMapping.Params]]. */\r\n  export interface ParamProps {\r\n    /** The matrix used to map the image to a surface. */\r\n    textureMat2x3?: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\r\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\r\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\r\n     * @note Defaults to 1.0\r\n     */\r\n    textureWeight?: number;\r\n    /** The mode by which to map the image to a surface.\r\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\r\n     */\r\n    mapMode?: TextureMapping.Mode;\r\n    worldMapping?: boolean;\r\n    /** True if want to use constant LOD texture mapping for the surface texture. */\r\n    useConstantLod?: boolean;\r\n    /** Parameters for constantLod mapping mode. */\r\n    constantLodProps?: ConstantLodParamProps;\r\n  }\r\n\r\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\r\n  export class Params {\r\n    /** The matrix used to map the image to a surface. */\r\n    public textureMatrix: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\r\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\r\n     */\r\n    public weight: number;\r\n    /** The mode by which to map the image to a surface. */\r\n    public mode: TextureMapping.Mode;\r\n    public worldMapping: boolean;\r\n    /** True if want to use constant LOD texture mapping for the surface texture. */\r\n    public useConstantLod: boolean;\r\n    /** Parameters for constantLod mapping mode. */\r\n    public constantLodParams: ConstantLodParams;\r\n\r\n    public constructor(props?: TextureMapping.ParamProps) {\r\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\r\n      this.weight = props?.textureWeight ?? 1;\r\n      this.mode = props?.mapMode ?? Mode.Parametric;\r\n      this.worldMapping = props?.worldMapping ?? false;\r\n      this.useConstantLod = props?.useConstantLod ?? false;\r\n      this.constantLodParams = {\r\n        repetitions: props?.constantLodProps?.repetitions ?? 1,\r\n        offset: props?.constantLodProps?.offset ?? { x: 0, y: 0 },\r\n        minDistClamp: props?.constantLodProps?.minDistClamp ?? 1,\r\n        maxDistClamp: props?.constantLodProps?.maxDistClamp ?? 4096 * 1024 * 1024,\r\n      };\r\n    }\r\n\r\n    /** An [OrderedComparator]($bentley) that compares these Params against `other`. */\r\n    public compare(other: Params): number {\r\n      if (this === other) {\r\n        return 0;\r\n      }\r\n\r\n      return compareNumbers(this.weight, other.weight) || compareNumbers(this.mode, other.mode) || compareBooleans(this.worldMapping, other.worldMapping)\r\n        || compareBooleans(this.useConstantLod, other.useConstantLod) || this.textureMatrix.compare(other.textureMatrix)\r\n        || compareConstantLodParams(this.constantLodParams, other.constantLodParams);\r\n    }\r\n\r\n  /** Compute texture coordinates for a polyface.\r\n   * @param visitor The polyface for which to compute UV coordinates based on this texture mapping.\r\n   * @param localToWorld The polyface's local-to-world transform, used for [[TextureMapping.Mode.ElevationDrape]].\r\n   * @returns the texture coordinates, or undefined if computation failed.\r\n   */\r\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, localToWorld: Transform = Transform.createIdentity()): Point2d[] | undefined {\r\n      switch (this.mode) {\r\n        default:  // Fall through to parametric in default case\r\n        case TextureMapping.Mode.Parametric: {\r\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n        }\r\n        case TextureMapping.Mode.Planar: {\r\n          const normalIndices = visitor.normalIndex;\r\n          if (!normalIndices)\r\n            return undefined;\r\n\r\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\r\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\r\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n          } else {\r\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\r\n          }\r\n        }\r\n        case TextureMapping.Mode.ElevationDrape: {\r\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, localToWorld);\r\n        }\r\n      }\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of parametric. */\r\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\r\n        let param = Point2d.create();\r\n\r\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\r\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\r\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\r\n            param = visitor.getParam(i)!;\r\n          }\r\n        }\r\n\r\n        params.push(uvTransform.multiplyPoint2d(param));\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\r\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\r\n      const params: Point2d[] = [];\r\n      const points = visitor.point;\r\n      let normal: Vector3d;\r\n\r\n      if (visitor.normal === undefined)\r\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\r\n      else\r\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\r\n\r\n      if (!normal.normalize(normal))\r\n        return undefined;\r\n\r\n      // adjust U texture coordinate to be a continuous length starting at the\r\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\r\n\r\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\r\n      normal.scale(-1.0, normal);\r\n\r\n      // pick the first vertex normal\r\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\r\n\r\n      // if the magnitude of the normal is near zero, the real normal points\r\n      // almost straighten up.. In this case, use Y as the up vector to match QV\r\n\r\n      const magnitude = sideVector.magnitude();\r\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\r\n\r\n      if (magnitude < 1e-3) {\r\n        normal.set(0, 0, -1);\r\n        sideVector.set(1, 0, 0);\r\n      }\r\n\r\n      const upVector = sideVector.crossProduct(normal).normalize();\r\n      if (!upVector)\r\n        return undefined;\r\n\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\r\n\r\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\r\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, localToWorld?: Transform): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\r\n\r\n        if (localToWorld !== undefined)\r\n          localToWorld.multiplyPoint3d(point, point);\r\n\r\n        params.push(Point2d.createFrom(point));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n  }\r\n}\r\n\r\nObject.freeze(TextureMapping.Trans2x3.identity);\r\n"]}

package/lib/cjs/TextureProps.js.map

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