@itwin/core-common 5.1.0-dev.4 → 5.1.0-dev.40

package/lib/cjs/GeometryParams.js

@@ -22,7 +22,9 @@ var FillDisplay;
     FillDisplay[FillDisplay["ByView"] = 1] = "ByView";
     /** always fill, even if the fill attribute is off for the viewport */
     FillDisplay[FillDisplay["Always"] = 2] = "Always";
-    /** always fill, fill will always be behind other geometry */
+    /** always fill, fill will always be behind other geometry belonging to the same element.
+     * @note Edge geometry is not produced for shapes with this fill type. If you want an outline, add it as separate geometry.
+     */
     FillDisplay[FillDisplay["Blanking"] = 3] = "Blanking";
 })(FillDisplay || (exports.FillDisplay = FillDisplay = {}));
 /** Describes how a view's background color affects the interior area of a closed region.

package/lib/cjs/GeometryParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeometryParams.js","sourceRoot":"","sources":["../../src/GeometryParams.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AAKvD,qCAAkC;AAElC;;;GAGG;AACH,IAAY,WASX;AATD,WAAY,WAAW;IACrB,gEAAgE;IAChE,+CAAS,CAAA;IACT,wDAAwD;IACxD,iDAAU,CAAA;IACV,sEAAsE;IACtE,iDAAU,CAAA;IACV,6DAA6D;IAC7D,qDAAY,CAAA;AACd,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AAED;;;GAGG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,kGAAkG;IAClG,mDAAQ,CAAA;IACR,8EAA8E;IAC9E,qDAAS,CAAA;IACT,gGAAgG;IAChG,yDAAW,CAAA;AACb,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAED;;;;;;GAMG;AACH,IAAY,aASX;AATD,WAAY,aAAa;IACvB,kGAAkG;IAClG,uDAAW,CAAA;IACX,qHAAqH;IACrH,iEAAgB,CAAA;IAChB,mFAAmF;IACnF,2DAAa,CAAA;IACb,mGAAmG;IACnG,uDAAW,CAAA;AACb,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AAED;;;GAGG;AACH,MAAa,cAAc;IA+DN;IAA+B;IA9DlD;;OAEG;IACI,UAAU,CAAc;IAC/B;;OAEG;IACI,WAAW,CAAU;IAC5B;;OAEG;IACI,MAAM,CAAU;IACvB;;OAEG;IACI,SAAS,CAAY;IAC5B;;;OAGG;IACI,SAAS,CAAY;IAC5B;;OAEG;IACI,cAAc,CAAkB;IACvC;;;OAGG;IACI,WAAW,CAAe;IACjC;;;OAGG;IACI,eAAe,CAAU;IAChC;;;OAGG;IACI,gBAAgB,CAAU;IACjC;;OAEG;IACI,aAAa,CAAiB;IACrC;;OAEG;IACI,SAAS,CAAkB;IAClC;;OAEG;IACI,QAAQ,CAAiB;IAChC;;OAEG;IACI,OAAO,CAAsB;IAEpC;;;;OAIG;IACH,YAAmB,UAAsB,EAAS,gBAAgB,mBAAI,CAAC,OAAO;QAA3D,eAAU,GAAV,UAAU,CAAY;QAAS,kBAAa,GAAb,aAAa,CAAe;QAC5E,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,aAAa,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,eAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACpC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC9C,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACpE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,wGAAwG;IACjG,eAAe;QACpB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3B,CAAC;IAED,6JAA6J;IACtJ,YAAY,CAAC,KAAqB;QACvC,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC,CAAC,eAAe;QAE9B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACtC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;YAChD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;YAClD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC9B,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAW;YAC1D,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7E,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC;gBAClE,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC;gBACzD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;gBAC9C,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBACrF,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;oBACpE,OAAO,KAAK,CAAC;gBACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;oBAC5D,OAAO,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAQ,CAAC;YACtD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oLAAoL;IAC7K,aAAa,CAAC,UAAsB,EAAE,wBAAwB,GAAG,IAAI;QAC1E,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,eAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAED,gHAAgH;IACzG,gBAAgB,CAAC,aAAyB,EAAE,wBAAwB,GAAG,IAAI;QAChF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;CACF;AApLD,wCAoLC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { AreaPattern } from \"./geometry/AreaPattern\";\nimport { LineStyle } from \"./geometry/LineStyle\";\nimport { Gradient } from \"./Gradient\";\nimport { IModel } from \"./IModel\";\n\n/** Whether a closed region should be drawn for wireframe display with its internal area filled or not.\n * @public\n * @extensions\n */\nexport enum FillDisplay {\n  /** don't fill, even if fill attribute is on for the viewport */\n  Never = 0,\n  /** fill if the fill attribute is on for the viewport */\n  ByView = 1,\n  /** always fill, even if the fill attribute is off for the viewport */\n  Always = 2,\n  /** always fill, fill will always be behind other geometry */\n  Blanking = 3,\n}\n\n/** Describes how a view's background color affects the interior area of a closed region.\n * @public\n * @extensions\n */\nexport enum BackgroundFill {\n  /** single color fill uses the fill color and line color to draw either a solid or outline fill */\n  None = 0,\n  /** single color fill uses the view's background color to draw a solid fill */\n  Solid = 1,\n  /** single color fill uses the view's background color and line color to draw an outline fill */\n  Outline = 2,\n}\n\n/** Categorizes a piece of geometry within a GeometryStream. Visibility of classes of geometry can be toggled\n * within a view using [[ViewFlags]].\n * @see [[GeometryStreamProps]].\n * @see [[Feature]].\n * @public\n * @extensions\n */\nexport enum GeometryClass {\n  /** Used to classify the \"real\" geometry within a model. Most geometry falls within this class. */\n  Primary = 0,\n  /** Used to classify geometry used as a drawing aid in constructing the Primary geometry. For example, grid lines. */\n  Construction = 1,\n  /** Used to classify annotations which dimension (measure) the Primary geometry. */\n  Dimension = 2,\n  /** Used to classify geometry used to fill planar regions with a 2d pattern (e.g., hatch lines). */\n  Pattern = 3,\n}\n\n/** Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from [[SubCategoryAppearance]].\n * @see [[GeometryStreamProps]].\n * @public\n */\nexport class GeometryParams {\n  /** Optional render material to override [[SubCategoryAppearance.materialId]].\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.materialId]] with no material.\n   */\n  public materialId?: Id64String;\n  /** Optional display priority added to [[SubCategoryAppearance.priority]].\n   * The net display priority value is used to control z ordering when drawing to 2d views.\n   */\n  public elmPriority?: number;\n  /** Optional line weight to override [[SubCategoryAppearance.weight]].\n   * The weight is an integer in the range of [0,31] that by default corresponds to a pixel width of weight+1.\n   */\n  public weight?: number;\n  /** Optional line color to override [[SubCategoryAppearance.color]].\n   * The transparency component is ignored and should instead be specified using [[elmTransparency]].\n   */\n  public lineColor?: ColorDef;\n  /** Optional fill color for region interiors. Set the same as [[lineColor]] for an opaque fill.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]], [[gradient]] is undefined, and [[backgroundFill]] is [[BackgroundFill.None]].\n   * The transparency component is ignored and should instead be specified using [[fillTransparency]].\n   */\n  public fillColor?: ColorDef;\n  /** Optional fill using the current view background color for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]] and [[gradient]] is undefined. Default is [[BackgroundFill.None]].\n   */\n  public backgroundFill?: BackgroundFill;\n  /** Optional fill specification that determines when and if a region interior will display using [[gradient]], [[backgroundFill]], or [[fillColor]] in that order of preference.\n   * Fill only applies to [[RenderMode.Wireframe]] views. In a [[RenderMode.SmoothShade]] or [[RenderMode.SolidFill]] view, regions will always display as surfaces preferring [[fillColor]] when present over [[lineColor]].\n   * Default is [[FillDisplay.Never]].\n   */\n  public fillDisplay?: FillDisplay;\n  /** Optional line color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent element on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque and 1.0 for completely transparent.\n   */\n  public elmTransparency?: number;\n  /** Optional fill color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent fill on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque, 1.0 for completely transparent, or leave undefined to use [[elmTransparency]].\n   */\n  public fillTransparency?: number;\n  /** Optional geometry classification that can be toggled off with a [[ViewFlags]] independent of [[SubCategoryAppearance.invisible]].\n   * Default is [[GeometryClass.Primary]].\n   */\n  public geometryClass?: GeometryClass;\n  /** Optional line style to override [[SubCategoryAppearance.styleId]] plus modifiers to override the line style definition.\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.styleId]] with a solid line.\n   */\n  public styleInfo?: LineStyle.Info;\n  /** Optional gradient fill settings for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]].\n   */\n  public gradient?: Gradient.Symb;\n  /** Optional area pattern settings for region interiors.\n   * Independent of fill, a region can have both fill and pattern.\n   */\n  public pattern?: AreaPattern.Params;\n\n  /** Create a GeometryParams given a [[Category]] Id for a [[GeometricElement]] and optional [[SubCategory]] Id. The [[SubCategory.appearance]] establishes the non-overriden display properties of\n   * graphics in a GeometricElement's [[GeometryStreamProps]]. A GeometricElement refers to a single Category through [[GeometricElement.category]], while it's graphics can appear on multiple SubCategories\n   * by adding a [[GeometryAppearanceProps]] with a SubCategory change to the GeometryStream.\n   * @note If a valid SubCategory Id is not supplied, the default SubCategory for the parent Category is used. To be considered valid, [[SubCategory.getCategoryId]] must refer to the specified Category Id.\n   */\n  constructor(public categoryId: Id64String, public subCategoryId = Id64.invalid) {\n    if (!Id64.isValid(subCategoryId))\n      this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n  }\n\n  public clone(): GeometryParams {\n    const retVal = new GeometryParams(this.categoryId, this.subCategoryId);\n    retVal.materialId = this.materialId;\n    retVal.elmPriority = this.elmPriority;\n    retVal.weight = this.weight;\n    retVal.lineColor = this.lineColor;\n    retVal.fillColor = this.fillColor;\n    retVal.backgroundFill = this.backgroundFill;\n    retVal.fillDisplay = this.fillDisplay;\n    retVal.elmTransparency = this.elmTransparency;\n    retVal.fillTransparency = this.fillTransparency;\n    retVal.geometryClass = this.geometryClass;\n    retVal.styleInfo = this.styleInfo ? this.styleInfo.clone() : undefined;\n    retVal.gradient = this.gradient ? this.gradient.clone() : undefined;\n    retVal.pattern = this.pattern ? this.pattern.clone() : undefined;\n    return retVal;\n  }\n\n  /** Clears [[SubCategoryAppearance]] overrides while preserving [[categoryId]] and [[subCategoryId]]. */\n  public resetAppearance() {\n    this.materialId = undefined;\n    this.elmPriority = undefined;\n    this.weight = undefined;\n    this.lineColor = undefined;\n    this.fillColor = undefined;\n    this.backgroundFill = undefined;\n    this.fillDisplay = undefined;\n    this.elmTransparency = undefined;\n    this.fillTransparency = undefined;\n    this.geometryClass = undefined;\n    this.styleInfo = undefined;\n    this.gradient = undefined;\n    this.pattern = undefined;\n  }\n\n  /** Compare two [[GeometryParams]] for equivalence, i.e. both values are undefined and inherited from [[SubCategoryAppearance]] or have the same override. */\n  public isEquivalent(other: GeometryParams): boolean {\n    if (this === other)\n      return true; // Same pointer\n\n    if (this.categoryId !== other.categoryId)\n      return false;\n    if (this.subCategoryId !== other.subCategoryId)\n      return false;\n    if (this.geometryClass !== other.geometryClass)\n      return false;\n\n    if (this.elmPriority !== other.elmPriority)\n      return false;\n    if (this.elmTransparency !== other.elmTransparency)\n      return false;\n    if (this.fillTransparency !== other.fillTransparency)\n      return false;\n\n    if ((this.lineColor === undefined) !== (other.lineColor === undefined))\n      return false;\n    if (this.lineColor && !this.lineColor.equals(other.lineColor!))\n      return false;\n\n    if (this.weight !== other.weight)\n      return false;\n\n    if ((this.materialId === undefined) !== (other.materialId === undefined))\n      return false;\n    if (this.materialId && this.materialId !== other.materialId!)\n      return false;\n\n    if ((this.styleInfo === undefined) !== (other.styleInfo === undefined))\n      return false;\n    if (this.styleInfo && !this.styleInfo.equals(other.styleInfo!))\n      return false;\n\n    if (this.fillDisplay !== other.fillDisplay)\n      return false;\n\n    if (this.fillDisplay !== undefined && this.fillDisplay !== FillDisplay.Never) {\n      if ((this.gradient === undefined) !== (other.gradient === undefined))\n        return false;\n      if (this.gradient && !this.gradient.equals(other.gradient!))\n        return false;\n      if (this.backgroundFill !== other.backgroundFill)\n        return false;\n      if (this.backgroundFill === undefined || this.backgroundFill === BackgroundFill.None) {\n        if ((this.fillColor === undefined) !== (other.fillColor === undefined))\n          return false;\n        if (this.fillColor && !this.fillColor.equals(other.fillColor!))\n          return false;\n      }\n    }\n\n    if ((this.pattern === undefined) !== (other.pattern === undefined))\n      return false;\n    if (this.pattern && !this.pattern.equals(other.pattern!))\n      return false;\n\n    return true;\n  }\n\n  /** Change [[categoryId]] to the supplied id, [[subCategoryId]] to the supplied category's the default subCategory, and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setCategoryId(categoryId: Id64String, clearAppearanceOverrides = true) {\n    this.categoryId = categoryId;\n    this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n\n  /** Change [[subCategoryId]] to the supplied id and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setSubCategoryId(subCategoryId: Id64String, clearAppearanceOverrides = true) {\n    this.subCategoryId = subCategoryId;\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n}\n"]}
+{"version":3,"file":"GeometryParams.js","sourceRoot":"","sources":["../../src/GeometryParams.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AAKvD,qCAAkC;AAElC;;;GAGG;AACH,IAAY,WAWX;AAXD,WAAY,WAAW;IACrB,gEAAgE;IAChE,+CAAS,CAAA;IACT,wDAAwD;IACxD,iDAAU,CAAA;IACV,sEAAsE;IACtE,iDAAU,CAAA;IACV;;OAEG;IACH,qDAAY,CAAA;AACd,CAAC,EAXW,WAAW,2BAAX,WAAW,QAWtB;AAED;;;GAGG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,kGAAkG;IAClG,mDAAQ,CAAA;IACR,8EAA8E;IAC9E,qDAAS,CAAA;IACT,gGAAgG;IAChG,yDAAW,CAAA;AACb,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAED;;;;;;GAMG;AACH,IAAY,aASX;AATD,WAAY,aAAa;IACvB,kGAAkG;IAClG,uDAAW,CAAA;IACX,qHAAqH;IACrH,iEAAgB,CAAA;IAChB,mFAAmF;IACnF,2DAAa,CAAA;IACb,mGAAmG;IACnG,uDAAW,CAAA;AACb,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AAED;;;GAGG;AACH,MAAa,cAAc;IA+DN;IAA+B;IA9DlD;;OAEG;IACI,UAAU,CAAc;IAC/B;;OAEG;IACI,WAAW,CAAU;IAC5B;;OAEG;IACI,MAAM,CAAU;IACvB;;OAEG;IACI,SAAS,CAAY;IAC5B;;;OAGG;IACI,SAAS,CAAY;IAC5B;;OAEG;IACI,cAAc,CAAkB;IACvC;;;OAGG;IACI,WAAW,CAAe;IACjC;;;OAGG;IACI,eAAe,CAAU;IAChC;;;OAGG;IACI,gBAAgB,CAAU;IACjC;;OAEG;IACI,aAAa,CAAiB;IACrC;;OAEG;IACI,SAAS,CAAkB;IAClC;;OAEG;IACI,QAAQ,CAAiB;IAChC;;OAEG;IACI,OAAO,CAAsB;IAEpC;;;;OAIG;IACH,YAAmB,UAAsB,EAAS,gBAAgB,mBAAI,CAAC,OAAO;QAA3D,eAAU,GAAV,UAAU,CAAY;QAAS,kBAAa,GAAb,aAAa,CAAe;QAC5E,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,aAAa,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,eAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACpC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACtC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC9C,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACpE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,wGAAwG;IACjG,eAAe;QACpB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3B,CAAC;IAED,6JAA6J;IACtJ,YAAY,CAAC,KAAqB;QACvC,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC,CAAC,eAAe;QAE9B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;YACtC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;YAC5C,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;YAChD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;YAClD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC9B,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAW;YAC1D,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;YAC5D,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;YACxC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7E,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC;gBAClE,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC;gBACzD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;gBAC9C,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBACrF,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;oBACpE,OAAO,KAAK,CAAC;gBACf,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAU,CAAC;oBAC5D,OAAO,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAQ,CAAC;YACtD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oLAAoL;IAC7K,aAAa,CAAC,UAAsB,EAAE,wBAAwB,GAAG,IAAI;QAC1E,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,eAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAED,gHAAgH;IACzG,gBAAgB,CAAC,aAAyB,EAAE,wBAAwB,GAAG,IAAI;QAChF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,wBAAwB;YAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;CACF;AApLD,wCAoLC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { AreaPattern } from \"./geometry/AreaPattern\";\nimport { LineStyle } from \"./geometry/LineStyle\";\nimport { Gradient } from \"./Gradient\";\nimport { IModel } from \"./IModel\";\n\n/** Whether a closed region should be drawn for wireframe display with its internal area filled or not.\n * @public\n * @extensions\n */\nexport enum FillDisplay {\n  /** don't fill, even if fill attribute is on for the viewport */\n  Never = 0,\n  /** fill if the fill attribute is on for the viewport */\n  ByView = 1,\n  /** always fill, even if the fill attribute is off for the viewport */\n  Always = 2,\n  /** always fill, fill will always be behind other geometry belonging to the same element.\n   * @note Edge geometry is not produced for shapes with this fill type. If you want an outline, add it as separate geometry.\n   */\n  Blanking = 3,\n}\n\n/** Describes how a view's background color affects the interior area of a closed region.\n * @public\n * @extensions\n */\nexport enum BackgroundFill {\n  /** single color fill uses the fill color and line color to draw either a solid or outline fill */\n  None = 0,\n  /** single color fill uses the view's background color to draw a solid fill */\n  Solid = 1,\n  /** single color fill uses the view's background color and line color to draw an outline fill */\n  Outline = 2,\n}\n\n/** Categorizes a piece of geometry within a GeometryStream. Visibility of classes of geometry can be toggled\n * within a view using [[ViewFlags]].\n * @see [[GeometryStreamProps]].\n * @see [[Feature]].\n * @public\n * @extensions\n */\nexport enum GeometryClass {\n  /** Used to classify the \"real\" geometry within a model. Most geometry falls within this class. */\n  Primary = 0,\n  /** Used to classify geometry used as a drawing aid in constructing the Primary geometry. For example, grid lines. */\n  Construction = 1,\n  /** Used to classify annotations which dimension (measure) the Primary geometry. */\n  Dimension = 2,\n  /** Used to classify geometry used to fill planar regions with a 2d pattern (e.g., hatch lines). */\n  Pattern = 3,\n}\n\n/** Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from [[SubCategoryAppearance]].\n * @see [[GeometryStreamProps]].\n * @public\n */\nexport class GeometryParams {\n  /** Optional render material to override [[SubCategoryAppearance.materialId]].\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.materialId]] with no material.\n   */\n  public materialId?: Id64String;\n  /** Optional display priority added to [[SubCategoryAppearance.priority]].\n   * The net display priority value is used to control z ordering when drawing to 2d views.\n   */\n  public elmPriority?: number;\n  /** Optional line weight to override [[SubCategoryAppearance.weight]].\n   * The weight is an integer in the range of [0,31] that by default corresponds to a pixel width of weight+1.\n   */\n  public weight?: number;\n  /** Optional line color to override [[SubCategoryAppearance.color]].\n   * The transparency component is ignored and should instead be specified using [[elmTransparency]].\n   */\n  public lineColor?: ColorDef;\n  /** Optional fill color for region interiors. Set the same as [[lineColor]] for an opaque fill.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]], [[gradient]] is undefined, and [[backgroundFill]] is [[BackgroundFill.None]].\n   * The transparency component is ignored and should instead be specified using [[fillTransparency]].\n   */\n  public fillColor?: ColorDef;\n  /** Optional fill using the current view background color for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]] and [[gradient]] is undefined. Default is [[BackgroundFill.None]].\n   */\n  public backgroundFill?: BackgroundFill;\n  /** Optional fill specification that determines when and if a region interior will display using [[gradient]], [[backgroundFill]], or [[fillColor]] in that order of preference.\n   * Fill only applies to [[RenderMode.Wireframe]] views. In a [[RenderMode.SmoothShade]] or [[RenderMode.SolidFill]] view, regions will always display as surfaces preferring [[fillColor]] when present over [[lineColor]].\n   * Default is [[FillDisplay.Never]].\n   */\n  public fillDisplay?: FillDisplay;\n  /** Optional line color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent element on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque and 1.0 for completely transparent.\n   */\n  public elmTransparency?: number;\n  /** Optional fill color transparency to combine with [[SubCategoryAppearance.transparency]].\n   * Transparency values are combined by multiplying the opaqueness. A 50% transparent fill on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).\n   * Value range is [0.0,1.0]. Pass 0.0 for completely opaque, 1.0 for completely transparent, or leave undefined to use [[elmTransparency]].\n   */\n  public fillTransparency?: number;\n  /** Optional geometry classification that can be toggled off with a [[ViewFlags]] independent of [[SubCategoryAppearance.invisible]].\n   * Default is [[GeometryClass.Primary]].\n   */\n  public geometryClass?: GeometryClass;\n  /** Optional line style to override [[SubCategoryAppearance.styleId]] plus modifiers to override the line style definition.\n   * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.styleId]] with a solid line.\n   */\n  public styleInfo?: LineStyle.Info;\n  /** Optional gradient fill settings for region interiors.\n   * Valid when [[fillDisplay]] is not [[FillDisplay.Never]].\n   */\n  public gradient?: Gradient.Symb;\n  /** Optional area pattern settings for region interiors.\n   * Independent of fill, a region can have both fill and pattern.\n   */\n  public pattern?: AreaPattern.Params;\n\n  /** Create a GeometryParams given a [[Category]] Id for a [[GeometricElement]] and optional [[SubCategory]] Id. The [[SubCategory.appearance]] establishes the non-overriden display properties of\n   * graphics in a GeometricElement's [[GeometryStreamProps]]. A GeometricElement refers to a single Category through [[GeometricElement.category]], while it's graphics can appear on multiple SubCategories\n   * by adding a [[GeometryAppearanceProps]] with a SubCategory change to the GeometryStream.\n   * @note If a valid SubCategory Id is not supplied, the default SubCategory for the parent Category is used. To be considered valid, [[SubCategory.getCategoryId]] must refer to the specified Category Id.\n   */\n  constructor(public categoryId: Id64String, public subCategoryId = Id64.invalid) {\n    if (!Id64.isValid(subCategoryId))\n      this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n  }\n\n  public clone(): GeometryParams {\n    const retVal = new GeometryParams(this.categoryId, this.subCategoryId);\n    retVal.materialId = this.materialId;\n    retVal.elmPriority = this.elmPriority;\n    retVal.weight = this.weight;\n    retVal.lineColor = this.lineColor;\n    retVal.fillColor = this.fillColor;\n    retVal.backgroundFill = this.backgroundFill;\n    retVal.fillDisplay = this.fillDisplay;\n    retVal.elmTransparency = this.elmTransparency;\n    retVal.fillTransparency = this.fillTransparency;\n    retVal.geometryClass = this.geometryClass;\n    retVal.styleInfo = this.styleInfo ? this.styleInfo.clone() : undefined;\n    retVal.gradient = this.gradient ? this.gradient.clone() : undefined;\n    retVal.pattern = this.pattern ? this.pattern.clone() : undefined;\n    return retVal;\n  }\n\n  /** Clears [[SubCategoryAppearance]] overrides while preserving [[categoryId]] and [[subCategoryId]]. */\n  public resetAppearance() {\n    this.materialId = undefined;\n    this.elmPriority = undefined;\n    this.weight = undefined;\n    this.lineColor = undefined;\n    this.fillColor = undefined;\n    this.backgroundFill = undefined;\n    this.fillDisplay = undefined;\n    this.elmTransparency = undefined;\n    this.fillTransparency = undefined;\n    this.geometryClass = undefined;\n    this.styleInfo = undefined;\n    this.gradient = undefined;\n    this.pattern = undefined;\n  }\n\n  /** Compare two [[GeometryParams]] for equivalence, i.e. both values are undefined and inherited from [[SubCategoryAppearance]] or have the same override. */\n  public isEquivalent(other: GeometryParams): boolean {\n    if (this === other)\n      return true; // Same pointer\n\n    if (this.categoryId !== other.categoryId)\n      return false;\n    if (this.subCategoryId !== other.subCategoryId)\n      return false;\n    if (this.geometryClass !== other.geometryClass)\n      return false;\n\n    if (this.elmPriority !== other.elmPriority)\n      return false;\n    if (this.elmTransparency !== other.elmTransparency)\n      return false;\n    if (this.fillTransparency !== other.fillTransparency)\n      return false;\n\n    if ((this.lineColor === undefined) !== (other.lineColor === undefined))\n      return false;\n    if (this.lineColor && !this.lineColor.equals(other.lineColor!))\n      return false;\n\n    if (this.weight !== other.weight)\n      return false;\n\n    if ((this.materialId === undefined) !== (other.materialId === undefined))\n      return false;\n    if (this.materialId && this.materialId !== other.materialId!)\n      return false;\n\n    if ((this.styleInfo === undefined) !== (other.styleInfo === undefined))\n      return false;\n    if (this.styleInfo && !this.styleInfo.equals(other.styleInfo!))\n      return false;\n\n    if (this.fillDisplay !== other.fillDisplay)\n      return false;\n\n    if (this.fillDisplay !== undefined && this.fillDisplay !== FillDisplay.Never) {\n      if ((this.gradient === undefined) !== (other.gradient === undefined))\n        return false;\n      if (this.gradient && !this.gradient.equals(other.gradient!))\n        return false;\n      if (this.backgroundFill !== other.backgroundFill)\n        return false;\n      if (this.backgroundFill === undefined || this.backgroundFill === BackgroundFill.None) {\n        if ((this.fillColor === undefined) !== (other.fillColor === undefined))\n          return false;\n        if (this.fillColor && !this.fillColor.equals(other.fillColor!))\n          return false;\n      }\n    }\n\n    if ((this.pattern === undefined) !== (other.pattern === undefined))\n      return false;\n    if (this.pattern && !this.pattern.equals(other.pattern!))\n      return false;\n\n    return true;\n  }\n\n  /** Change [[categoryId]] to the supplied id, [[subCategoryId]] to the supplied category's the default subCategory, and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setCategoryId(categoryId: Id64String, clearAppearanceOverrides = true) {\n    this.categoryId = categoryId;\n    this.subCategoryId = IModel.getDefaultSubCategoryId(categoryId);\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n\n  /** Change [[subCategoryId]] to the supplied id and optionally clear any [[SubCategoryAppearance]] overrides. */\n  public setSubCategoryId(subCategoryId: Id64String, clearAppearanceOverrides = true) {\n    this.subCategoryId = subCategoryId;\n    if (clearAppearanceOverrides)\n      this.resetAppearance();\n  }\n}\n"]}

package/lib/cjs/GraphicParams.d.ts

@@ -18,6 +18,7 @@ export declare enum FillFlags {
     Always = 2,
     /** Render the fill behind other geometry belonging to the same element.
      * For example if an element's geometry contains text with background fill, the text always renders in front of the fill.
+     * @note [GraphicBuilder]($frontend) will not produce edge geometry for shapes with this fill flag. If you want an outline, add it separately.
      */
     Behind = 4,
     /** Combines Behind and Always flags. */

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

@@ -1 +1 @@
-{"version":3,"file":"GraphicParams.d.ts","sourceRoot":"","sources":["../../src/GraphicParams.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,oBAAY,SAAS;IACnB,cAAc;IACd,IAAI,IAAI;IACR,qFAAqF;IACrF,MAAM,IAAS;IACf,2FAA2F;IAC3F,MAAM,IAAS;IACf;;OAEG;IACH,MAAM,IAAS;IACf,wCAAwC;IACxC,QAAQ,IAAkB;IAC1B,2EAA2E;IAC3E,UAAU,IAAS;CACpB;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,yEAAyE;IAClE,SAAS,YAAkB;IAClC,oDAAoD;IAC7C,UAAU,aAAoB;IACrC,gGAAgG;IACzF,WAAW,SAAK;IACvB,qCAAqC;IAC9B,SAAS,WAAkB;IAClC,6BAA6B;IACtB,SAAS,WAAkB;IAClC,oCAAoC;IAC7B,QAAQ,CAAC,EAAE,cAAc,CAAC;IACjC,yCAAyC;IAClC,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEhC,6FAA6F;IACtF,mBAAmB,CAAC,YAAY,EAAE,MAAM;IAE/C,6FAA6F;IACtF,mBAAmB,CAAC,YAAY,EAAE,MAAM;IAExC,KAAK,CAAC,GAAG,CAAC,EAAE,aAAa,GAAG,aAAa;IAchD,6EAA6E;WAC/D,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,aAAmB,GAAG,aAAa;IAStI;;OAEG;WACW,gBAAgB,CAAC,SAAS,EAAE,QAAQ,GAAG,aAAa;CAMnE"}
+{"version":3,"file":"GraphicParams.d.ts","sourceRoot":"","sources":["../../src/GraphicParams.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,oBAAY,SAAS;IACnB,cAAc;IACd,IAAI,IAAI;IACR,qFAAqF;IACrF,MAAM,IAAS;IACf,2FAA2F;IAC3F,MAAM,IAAS;IACf;;;OAGG;IACH,MAAM,IAAS;IACf,wCAAwC;IACxC,QAAQ,IAAkB;IAC1B,2EAA2E;IAC3E,UAAU,IAAS;CACpB;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,yEAAyE;IAClE,SAAS,YAAkB;IAClC,oDAAoD;IAC7C,UAAU,aAAoB;IACrC,gGAAgG;IACzF,WAAW,SAAK;IACvB,qCAAqC;IAC9B,SAAS,WAAkB;IAClC,6BAA6B;IACtB,SAAS,WAAkB;IAClC,oCAAoC;IAC7B,QAAQ,CAAC,EAAE,cAAc,CAAC;IACjC,yCAAyC;IAClC,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEhC,6FAA6F;IACtF,mBAAmB,CAAC,YAAY,EAAE,MAAM;IAE/C,6FAA6F;IACtF,mBAAmB,CAAC,YAAY,EAAE,MAAM;IAExC,KAAK,CAAC,GAAG,CAAC,EAAE,aAAa,GAAG,aAAa;IAchD,6EAA6E;WAC/D,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,aAAmB,GAAG,aAAa;IAStI;;OAEG;WACW,gBAAgB,CAAC,SAAS,EAAE,QAAQ,GAAG,aAAa;CAMnE"}

package/lib/cjs/GraphicParams.js

@@ -24,6 +24,7 @@ var FillFlags;
     FillFlags[FillFlags["Always"] = 2] = "Always";
     /** Render the fill behind other geometry belonging to the same element.
      * For example if an element's geometry contains text with background fill, the text always renders in front of the fill.
+     * @note [GraphicBuilder]($frontend) will not produce edge geometry for shapes with this fill flag. If you want an outline, add it separately.
      */
     FillFlags[FillFlags["Behind"] = 4] = "Behind";
     /** Combines Behind and Always flags. */

package/lib/cjs/GraphicParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicParams.js","sourceRoot":"","sources":["../../src/GraphicParams.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yCAAsC;AAEtC,6CAA0C;AAG1C;;;GAGG;AACH,IAAY,SAeX;AAfD,WAAY,SAAS;IACnB,cAAc;IACd,yCAAQ,CAAA;IACR,qFAAqF;IACrF,6CAAe,CAAA;IACf,2FAA2F;IAC3F,6CAAe,CAAA;IACf;;OAEG;IACH,6CAAe,CAAA;IACf,wCAAwC;IACxC,iDAA0B,CAAA;IAC1B,2EAA2E;IAC3E,qDAAmB,CAAA;AACrB,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB;AAED;;;GAGG;AACH,MAAa,aAAa;IACxB,yEAAyE;IAClE,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC;IAClC,oDAAoD;IAC7C,UAAU,GAAG,uBAAU,CAAC,KAAK,CAAC;IACrC,gGAAgG;IACzF,WAAW,GAAG,CAAC,CAAC;IACvB,qCAAqC;IAC9B,SAAS,GAAG,mBAAQ,CAAC,KAAK,CAAC;IAClC,6BAA6B;IACtB,SAAS,GAAG,mBAAQ,CAAC,KAAK,CAAC;IAClC,oCAAoC;IAC7B,QAAQ,CAAkB;IACjC,yCAAyC;IAClC,QAAQ,CAAiB;IAEhC,6FAA6F;IACtF,mBAAmB,CAAC,YAAoB,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAEpH,6FAA6F;IACtF,mBAAmB,CAAC,YAAoB,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAE7G,KAAK,CAAC,GAAmB;QAC9B,GAAG,GAAG,GAAG,IAAI,IAAI,aAAa,EAAE,CAAC;QAEjC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACjC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,6EAA6E;IACtE,MAAM,CAAC,aAAa,CAAC,SAAmB,EAAE,SAAmB,EAAE,SAAiB,EAAE,UAAU,GAAG,uBAAU,CAAC,KAAK;QACpH,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC;QACpC,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC;QACpC,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC;QACtC,aAAa,CAAC,UAAU,GAAG,UAAU,CAAC;QACtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,SAAmB;QAChD,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC;QACpC,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC;QAC7C,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAvDD,sCAuDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { ColorDef } from \"./ColorDef\";\nimport { Gradient } from \"./Gradient\";\nimport { LinePixels } from \"./LinePixels\";\nimport { RenderMaterial } from \"./RenderMaterial\";\n\n/** Flags indicating whether and how the interiors of closed planar regions is displayed within a view.\n * @public\n * @extensions\n */\nexport enum FillFlags {\n  /** No fill */\n  None = 0,\n  /** Use the element's fill color when fill is enabled in the view's [[ViewFlags]]. */\n  ByView = 1 << 0,\n  /** Use the element's fill color even when fill is disabled in the view's [[ViewFlags]]. */\n  Always = 1 << 1,\n  /** Render the fill behind other geometry belonging to the same element.\n   * For example if an element's geometry contains text with background fill, the text always renders in front of the fill.\n   */\n  Behind = 1 << 2,\n  /** Combines Behind and Always flags. */\n  Blanking = Behind | Always,\n  /** Use the view's background color instead of the element's fill color. */\n  Background = 1 << 3,\n}\n\n/** The \"cooked\" material and symbology for a [[RenderGraphic]]. This determines the appearance\n * (e.g. texture, color, width, linestyle, etc.) used to draw Geometry.\n * @public\n */\nexport class GraphicParams {\n  /** Describes how fill is applied to planar regions in wireframe mode. */\n  public fillFlags = FillFlags.None;\n  /** The line pattern applied to curves and edges. */\n  public linePixels = LinePixels.Solid;\n  /** The width, in pixels, of curves and edges. Values are clamped to [1..31] at display time. */\n  public rasterWidth = 1;\n  /** The color of curves and edges. */\n  public lineColor = ColorDef.black;\n  /** The color of surfaces. */\n  public fillColor = ColorDef.black;\n  /** Material applied to surfaces. */\n  public material?: RenderMaterial;\n  /** Gradient fill applied to surfaces. */\n  public gradient?: Gradient.Symb;\n\n  /** Set the transparency of the line color, where 0=fully opaque and 255=full transparent. */\n  public setLineTransparency(transparency: number) { this.lineColor = this.lineColor.withTransparency(transparency); }\n\n  /** Set the transparency of the fill color, where 0=fully opaque and 255=full transparent. */\n  public setFillTransparency(transparency: number) { this.fillColor = this.fillColor.withTransparency(transparency); }\n\n  public clone(out?: GraphicParams): GraphicParams {\n    out = out ?? new GraphicParams();\n\n    out.fillFlags = this.fillFlags;\n    out.linePixels = this.linePixels;\n    out.rasterWidth = this.rasterWidth;\n    out.lineColor = this.lineColor;\n    out.fillColor = this.fillColor;\n    out.material = this.material;\n    out.gradient = this.gradient;\n\n    return out;\n  }\n\n  /** Conveniently create a GraphicParams the most commonly-used properties. */\n  public static fromSymbology(lineColor: ColorDef, fillColor: ColorDef, lineWidth: number, linePixels = LinePixels.Solid): GraphicParams {\n    const graphicParams = new GraphicParams();\n    graphicParams.lineColor = lineColor;\n    graphicParams.fillColor = fillColor;\n    graphicParams.rasterWidth = lineWidth;\n    graphicParams.linePixels = linePixels;\n    return graphicParams;\n  }\n\n  /** Create a GraphicParams with blanking fill of the specified color.\n   * @see [[FillFlags.Blanking]].\n   */\n  public static fromBlankingFill(fillColor: ColorDef): GraphicParams {\n    const graphicParams = new GraphicParams();\n    graphicParams.fillColor = fillColor;\n    graphicParams.fillFlags = FillFlags.Blanking;\n    return graphicParams;\n  }\n}\n"]}
+{"version":3,"file":"GraphicParams.js","sourceRoot":"","sources":["../../src/GraphicParams.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yCAAsC;AAEtC,6CAA0C;AAG1C;;;GAGG;AACH,IAAY,SAgBX;AAhBD,WAAY,SAAS;IACnB,cAAc;IACd,yCAAQ,CAAA;IACR,qFAAqF;IACrF,6CAAe,CAAA;IACf,2FAA2F;IAC3F,6CAAe,CAAA;IACf;;;OAGG;IACH,6CAAe,CAAA;IACf,wCAAwC;IACxC,iDAA0B,CAAA;IAC1B,2EAA2E;IAC3E,qDAAmB,CAAA;AACrB,CAAC,EAhBW,SAAS,yBAAT,SAAS,QAgBpB;AAED;;;GAGG;AACH,MAAa,aAAa;IACxB,yEAAyE;IAClE,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC;IAClC,oDAAoD;IAC7C,UAAU,GAAG,uBAAU,CAAC,KAAK,CAAC;IACrC,gGAAgG;IACzF,WAAW,GAAG,CAAC,CAAC;IACvB,qCAAqC;IAC9B,SAAS,GAAG,mBAAQ,CAAC,KAAK,CAAC;IAClC,6BAA6B;IACtB,SAAS,GAAG,mBAAQ,CAAC,KAAK,CAAC;IAClC,oCAAoC;IAC7B,QAAQ,CAAkB;IACjC,yCAAyC;IAClC,QAAQ,CAAiB;IAEhC,6FAA6F;IACtF,mBAAmB,CAAC,YAAoB,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAEpH,6FAA6F;IACtF,mBAAmB,CAAC,YAAoB,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAE7G,KAAK,CAAC,GAAmB;QAC9B,GAAG,GAAG,GAAG,IAAI,IAAI,aAAa,EAAE,CAAC;QAEjC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACjC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,6EAA6E;IACtE,MAAM,CAAC,aAAa,CAAC,SAAmB,EAAE,SAAmB,EAAE,SAAiB,EAAE,UAAU,GAAG,uBAAU,CAAC,KAAK;QACpH,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC;QACpC,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC;QACpC,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC;QACtC,aAAa,CAAC,UAAU,GAAG,UAAU,CAAC;QACtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,SAAmB;QAChD,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC;QACpC,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC;QAC7C,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAvDD,sCAuDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Symbology\n */\n\nimport { ColorDef } from \"./ColorDef\";\nimport { Gradient } from \"./Gradient\";\nimport { LinePixels } from \"./LinePixels\";\nimport { RenderMaterial } from \"./RenderMaterial\";\n\n/** Flags indicating whether and how the interiors of closed planar regions is displayed within a view.\n * @public\n * @extensions\n */\nexport enum FillFlags {\n  /** No fill */\n  None = 0,\n  /** Use the element's fill color when fill is enabled in the view's [[ViewFlags]]. */\n  ByView = 1 << 0,\n  /** Use the element's fill color even when fill is disabled in the view's [[ViewFlags]]. */\n  Always = 1 << 1,\n  /** Render the fill behind other geometry belonging to the same element.\n   * For example if an element's geometry contains text with background fill, the text always renders in front of the fill.\n   * @note [GraphicBuilder]($frontend) will not produce edge geometry for shapes with this fill flag. If you want an outline, add it separately.\n   */\n  Behind = 1 << 2,\n  /** Combines Behind and Always flags. */\n  Blanking = Behind | Always,\n  /** Use the view's background color instead of the element's fill color. */\n  Background = 1 << 3,\n}\n\n/** The \"cooked\" material and symbology for a [[RenderGraphic]]. This determines the appearance\n * (e.g. texture, color, width, linestyle, etc.) used to draw Geometry.\n * @public\n */\nexport class GraphicParams {\n  /** Describes how fill is applied to planar regions in wireframe mode. */\n  public fillFlags = FillFlags.None;\n  /** The line pattern applied to curves and edges. */\n  public linePixels = LinePixels.Solid;\n  /** The width, in pixels, of curves and edges. Values are clamped to [1..31] at display time. */\n  public rasterWidth = 1;\n  /** The color of curves and edges. */\n  public lineColor = ColorDef.black;\n  /** The color of surfaces. */\n  public fillColor = ColorDef.black;\n  /** Material applied to surfaces. */\n  public material?: RenderMaterial;\n  /** Gradient fill applied to surfaces. */\n  public gradient?: Gradient.Symb;\n\n  /** Set the transparency of the line color, where 0=fully opaque and 255=full transparent. */\n  public setLineTransparency(transparency: number) { this.lineColor = this.lineColor.withTransparency(transparency); }\n\n  /** Set the transparency of the fill color, where 0=fully opaque and 255=full transparent. */\n  public setFillTransparency(transparency: number) { this.fillColor = this.fillColor.withTransparency(transparency); }\n\n  public clone(out?: GraphicParams): GraphicParams {\n    out = out ?? new GraphicParams();\n\n    out.fillFlags = this.fillFlags;\n    out.linePixels = this.linePixels;\n    out.rasterWidth = this.rasterWidth;\n    out.lineColor = this.lineColor;\n    out.fillColor = this.fillColor;\n    out.material = this.material;\n    out.gradient = this.gradient;\n\n    return out;\n  }\n\n  /** Conveniently create a GraphicParams the most commonly-used properties. */\n  public static fromSymbology(lineColor: ColorDef, fillColor: ColorDef, lineWidth: number, linePixels = LinePixels.Solid): GraphicParams {\n    const graphicParams = new GraphicParams();\n    graphicParams.lineColor = lineColor;\n    graphicParams.fillColor = fillColor;\n    graphicParams.rasterWidth = lineWidth;\n    graphicParams.linePixels = linePixels;\n    return graphicParams;\n  }\n\n  /** Create a GraphicParams with blanking fill of the specified color.\n   * @see [[FillFlags.Blanking]].\n   */\n  public static fromBlankingFill(fillColor: ColorDef): GraphicParams {\n    const graphicParams = new GraphicParams();\n    graphicParams.fillColor = fillColor;\n    graphicParams.fillFlags = FillFlags.Blanking;\n    return graphicParams;\n  }\n}\n"]}

package/lib/cjs/ITwinCoreErrors.d.ts

@@ -63,7 +63,7 @@ export interface ViewStoreError extends ITwinError {
 /** @beta */
 export declare namespace ViewStoreError {
     const scope = "itwin-ViewStore";
-    type Key = "invalid-value" | "invalid-member" | "no-owner" | "not-found" | "not-unique" | "group-error";
+    type Key = "invalid-value" | "invalid-member" | "no-owner" | "not-found" | "not-unique" | "no-viewstore" | "group-error";
     /** Determine whether an error object is a ViewStoreError */
     function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T;
     /** Instantiate and throw a ViewStoreError */

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

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF"}
+{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF"}

package/lib/cjs/ITwinCoreErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AAWjD,YAAY;AACZ,IAAiB,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,yBAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,2BAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,IAAiB,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,yBAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,gCAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,IAAiB,cAAc,CAmB9B;AAnBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IASvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,yBAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAnBgB,cAAc,8BAAd,cAAc,QAmB9B;AAED;;;GAGG;AACH,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAWD,YAAY;AACZ,IAAiB,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,yBAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,mCAAnB,mBAAmB,QAqBnC","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 iModels\n */\n\nimport { ITwinError } from \"@itwin/core-bentley\";\n\n/**\n * An error originating from the [SQLiteDb]($backend) API.\n * @beta\n */\nexport interface SqliteError extends ITwinError {\n  /** The name of the database for this problem. */\n  dbName: string;\n}\n\n/** @beta */\nexport namespace SqliteError {\n  export const scope = \"itwin-Sqlite\";\n  export type Key =\n    \"already-open\" |\n    \"incompatible-version\" |\n    \"invalid-versions-property\" |\n    \"readonly\";\n\n  /** Determine whether an error object is a SqliteError */\n  export function isError(error: unknown, key?: Key): error is SqliteError {\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\n  }\n\n  /** Instantiate and throw a SqliteError */\n  export function throwError(key: Key, message: string, dbName: string): never {\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\n  }\n}\n\n/**\n * An error originating from the [CloudSqlite]($backend) API.\n * @beta\n */\nexport interface CloudSqliteError extends ITwinError {\n  /** The name of the database that generated the error */\n  readonly dbName?: string;\n  /** The name of the container associated with the error */\n  readonly containerId?: string;\n}\n\n/** @beta */\nexport namespace CloudSqliteError {\n  export const scope = \"itwin-CloudSqlite\";\n  export type Key =\n    \"already-published\" |\n    \"copy-error\" |\n    \"invalid-name\" |\n    \"no-version-available\" |\n    \"not-a-function\" |\n    \"service-not-available\" |\n    /** The write lock cannot be acquired because it is currently held by somebody else.\n     * @see WriteLockHeld for details\n     */\n    \"write-lock-held\" |\n    /** The write lock on a container is not held, but is required for this operation */\n    \"write-lock-not-held\";\n\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\n  export interface WriteLockHeld extends CloudSqliteError {\n    /** @internal */\n    errorNumber: number;\n    /** moniker of user currently holding container's lock */\n    lockedBy: string;\n    /** time the lock expires */\n    expires: string;\n  }\n\n  /** Determine whether an error object is a CloudSqliteError */\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CloudSqliteError */\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** Errors thrown by the [ViewStore]($backend) API.\n * @beta\n */\nexport interface ViewStoreError extends ITwinError {\n  /** The name of the ViewStore that generated the error */\n  viewStoreName?: string;\n}\n\n/** @beta */\nexport namespace ViewStoreError {\n  export const scope = \"itwin-ViewStore\";\n  export type Key =\n    \"invalid-value\" |\n    \"invalid-member\" |\n    \"no-owner\" |\n    \"not-found\" |\n    \"not-unique\" |\n    \"group-error\";\n\n  /** Determine whether an error object is a ViewStoreError */\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a ViewStoreError */\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/**\n * Errors thrown by the [Workspace]($backend) APIs.\n * @beta\n */\nexport namespace WorkspaceError {\n  export const scope = \"itwin-Workspace\";\n  export type Key =\n    \"already-exists\" |\n    \"container-exists\" |\n    \"does-not-exist\" |\n    \"invalid-name\" |\n    \"no-cloud-container\" |\n    \"load-error\" |\n    \"load-errors\" |\n    \"resource-exists\" |\n    \"too-large\" |\n    \"write-error\";\n\n  /** Determine whether an error object is a WorkspaceError */\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\n  }\n}\n\n\n/** Errors originating from the [ChannelControl]($backend) interface.\n * @beta\n */\nexport interface ChannelControlError extends ITwinError {\n  /** The channel key that caused the error. */\n  readonly channelKey: string;\n}\n\n/** @beta */\nexport namespace ChannelControlError {\n  /** the ITwinError scope for `ChannelControlError`s. */\n  export const scope = \"itwin-ChannelControl\";\n\n  /** Keys that identify `ChannelControlError`s */\n  export type Key =\n    /** an attempt to create a channel within an existing channel */\n    \"may-not-nest\" |\n    /** an attempt to use a channel that was not \"allowed\" */\n    \"not-allowed\" |\n    /** the root channel already exists */\n    \"root-exists\";\n\n  /** Instantiate and throw a ChannelControlError */\n  export function throwError(key: Key, message: string, channelKey: string): never {\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\n  }\n  /** Determine whether an error object is a ChannelControlError */\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\n  }\n}\n"]}
+{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AAWjD,YAAY;AACZ,IAAiB,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,yBAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,2BAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,IAAiB,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,yBAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,gCAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,IAAiB,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,yBAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,8BAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAWD,YAAY;AACZ,IAAiB,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,yBAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,mCAAnB,mBAAmB,QAqBnC","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 iModels\n */\n\nimport { ITwinError } from \"@itwin/core-bentley\";\n\n/**\n * An error originating from the [SQLiteDb]($backend) API.\n * @beta\n */\nexport interface SqliteError extends ITwinError {\n  /** The name of the database for this problem. */\n  dbName: string;\n}\n\n/** @beta */\nexport namespace SqliteError {\n  export const scope = \"itwin-Sqlite\";\n  export type Key =\n    \"already-open\" |\n    \"incompatible-version\" |\n    \"invalid-versions-property\" |\n    \"readonly\";\n\n  /** Determine whether an error object is a SqliteError */\n  export function isError(error: unknown, key?: Key): error is SqliteError {\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\n  }\n\n  /** Instantiate and throw a SqliteError */\n  export function throwError(key: Key, message: string, dbName: string): never {\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\n  }\n}\n\n/**\n * An error originating from the [CloudSqlite]($backend) API.\n * @beta\n */\nexport interface CloudSqliteError extends ITwinError {\n  /** The name of the database that generated the error */\n  readonly dbName?: string;\n  /** The name of the container associated with the error */\n  readonly containerId?: string;\n}\n\n/** @beta */\nexport namespace CloudSqliteError {\n  export const scope = \"itwin-CloudSqlite\";\n  export type Key =\n    \"already-published\" |\n    \"copy-error\" |\n    \"invalid-name\" |\n    \"no-version-available\" |\n    \"not-a-function\" |\n    \"service-not-available\" |\n    /** The write lock cannot be acquired because it is currently held by somebody else.\n     * @see WriteLockHeld for details\n     */\n    \"write-lock-held\" |\n    /** The write lock on a container is not held, but is required for this operation */\n    \"write-lock-not-held\";\n\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\n  export interface WriteLockHeld extends CloudSqliteError {\n    /** @internal */\n    errorNumber: number;\n    /** moniker of user currently holding container's lock */\n    lockedBy: string;\n    /** time the lock expires */\n    expires: string;\n  }\n\n  /** Determine whether an error object is a CloudSqliteError */\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CloudSqliteError */\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** Errors thrown by the [ViewStore]($backend) API.\n * @beta\n */\nexport interface ViewStoreError extends ITwinError {\n  /** The name of the ViewStore that generated the error */\n  viewStoreName?: string;\n}\n\n/** @beta */\nexport namespace ViewStoreError {\n  export const scope = \"itwin-ViewStore\";\n  export type Key =\n    \"invalid-value\" |\n    \"invalid-member\" |\n    \"no-owner\" |\n    \"not-found\" |\n    \"not-unique\" |\n    \"no-viewstore\" |\n    \"group-error\";\n\n  /** Determine whether an error object is a ViewStoreError */\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a ViewStoreError */\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/**\n * Errors thrown by the [Workspace]($backend) APIs.\n * @beta\n */\nexport namespace WorkspaceError {\n  export const scope = \"itwin-Workspace\";\n  export type Key =\n    \"already-exists\" |\n    \"container-exists\" |\n    \"does-not-exist\" |\n    \"invalid-name\" |\n    \"no-cloud-container\" |\n    \"load-error\" |\n    \"load-errors\" |\n    \"resource-exists\" |\n    \"too-large\" |\n    \"write-error\";\n\n  /** Determine whether an error object is a WorkspaceError */\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\n  }\n}\n\n\n/** Errors originating from the [ChannelControl]($backend) interface.\n * @beta\n */\nexport interface ChannelControlError extends ITwinError {\n  /** The channel key that caused the error. */\n  readonly channelKey: string;\n}\n\n/** @beta */\nexport namespace ChannelControlError {\n  /** the ITwinError scope for `ChannelControlError`s. */\n  export const scope = \"itwin-ChannelControl\";\n\n  /** Keys that identify `ChannelControlError`s */\n  export type Key =\n    /** an attempt to create a channel within an existing channel */\n    \"may-not-nest\" |\n    /** an attempt to use a channel that was not \"allowed\" */\n    \"not-allowed\" |\n    /** the root channel already exists */\n    \"root-exists\";\n\n  /** Instantiate and throw a ChannelControlError */\n  export function throwError(key: Key, message: string, channelKey: string): never {\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\n  }\n  /** Determine whether an error object is a ChannelControlError */\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\n  }\n}\n"]}

package/lib/cjs/MassProperties.d.ts

@@ -25,7 +25,7 @@ export interface MassPropertiesRequestProps {
 }
 /** Information required to request mass properties for each element separately from the front end to the back end.
  * @public
- * @deprecated in 4.11. Use [[MassPropertiesRequestProps]].
+ * @deprecated in 4.11 - might be removed in next major version. Use [[MassPropertiesRequestProps]].
  */
 export interface MassPropertiesPerCandidateRequestProps {
     operations: MassPropertiesOperation[];
@@ -59,7 +59,7 @@ export interface MassPropertiesResponseProps {
 }
 /** Information returned from the back end to the front end holding the result of the mass properties calculation for a single candidate.
  * @public
- * @deprecated in 4.11. Use [[MassPropertiesResponseProps]].
+ * @deprecated in 4.11 - might be removed in next major version. Use [[MassPropertiesResponseProps]].
  */
 export interface MassPropertiesPerCandidateResponseProps extends MassPropertiesResponseProps {
     candidate: Id64String;

package/lib/cjs/MassProperties.js.map

@@ -1 +1 @@
-{"version":3,"file":"MassProperties.js","sourceRoot":"","sources":["../../src/MassProperties.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,wDAAwD;IACxD,+FAAqB,CAAA;IACrB,kEAAkE;IAClE,2FAAmB,CAAA;IACnB,mDAAmD;IACnD,+FAAqB,CAAA;AACvB,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC","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 Geometry\n */\n\nimport { BentleyStatus, CompressedId64Set, Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport { XYZProps } from \"@itwin/core-geometry\";\n\n/** Specify whether to accumulate volumes, areas, or lengths for the supplied elements.\n * @public\n * @extensions\n */\nexport enum MassPropertiesOperation {\n  /** Return lengths for open paths and planar regions. */\n  AccumulateLengths = 0,\n  /** Return areas and perimeters for solid and surface geometry. */\n  AccumulateAreas = 1,\n  /** Return volumes and areas for solid geometry. */\n  AccumulateVolumes = 2,\n}\n\n/** Information required to request mass properties for elements from the front end to the back end.\n * @public\n * @extensions\n */\nexport interface MassPropertiesRequestProps {\n  operation: MassPropertiesOperation;\n  candidates?: Id64Array;\n}\n\n/** Information required to request mass properties for each element separately from the front end to the back end.\n * @public\n * @deprecated in 4.11. Use [[MassPropertiesRequestProps]].\n */\nexport interface MassPropertiesPerCandidateRequestProps {\n  operations: MassPropertiesOperation[];\n  candidates: CompressedId64Set;\n}\n\n/** Information returned from the back end to the front end holding the result of the mass properties calculation.\n * @public\n * @extensions\n */\nexport interface MassPropertiesResponseProps {\n  /** Success if requested [[MassPropertiesOperation]] could be evaluated for the specified elements */\n  status: BentleyStatus;\n  /** Volume of solids when [[MassPropertiesOperation.AccumulateVolumes]] requested */\n  volume?: number;\n  /** Surface area of solids and surfaces when [[MassPropertiesOperation.AccumulateVolumes]] or [[MassPropertiesOperation.AccumulateAreas]] requested */\n  area?: number;\n  /** Perimeter of surfaces and planar regions when [[MassPropertiesOperation.AccumulateAreas]] requested */\n  perimeter?: number;\n  /** Length of curves or perimeter of planar regions when [[MassPropertiesOperation.AccumulateAreas]] or [[MassPropertiesOperation.AccumulateLength]] requested */\n  length?: number;\n  /** Centroid of geometry */\n  centroid?: XYZProps;\n  /** Product of inertia with respect to xy plane */\n  ixy?: number;\n  /** Product of inertia with respect to xz plane */\n  ixz?: number;\n  /** Product of inertia with respect to yz plane */\n  iyz?: number;\n  /** Moments of inertia */\n  moments?: XYZProps;\n}\n\n/** Information returned from the back end to the front end holding the result of the mass properties calculation for a single candidate.\n * @public\n * @deprecated in 4.11. Use [[MassPropertiesResponseProps]].\n */\nexport interface MassPropertiesPerCandidateResponseProps extends MassPropertiesResponseProps {\n  candidate: Id64String;\n}\n"]}
+{"version":3,"file":"MassProperties.js","sourceRoot":"","sources":["../../src/MassProperties.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,wDAAwD;IACxD,+FAAqB,CAAA;IACrB,kEAAkE;IAClE,2FAAmB,CAAA;IACnB,mDAAmD;IACnD,+FAAqB,CAAA;AACvB,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC","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 Geometry\n */\n\nimport { BentleyStatus, CompressedId64Set, Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport { XYZProps } from \"@itwin/core-geometry\";\n\n/** Specify whether to accumulate volumes, areas, or lengths for the supplied elements.\n * @public\n * @extensions\n */\nexport enum MassPropertiesOperation {\n  /** Return lengths for open paths and planar regions. */\n  AccumulateLengths = 0,\n  /** Return areas and perimeters for solid and surface geometry. */\n  AccumulateAreas = 1,\n  /** Return volumes and areas for solid geometry. */\n  AccumulateVolumes = 2,\n}\n\n/** Information required to request mass properties for elements from the front end to the back end.\n * @public\n * @extensions\n */\nexport interface MassPropertiesRequestProps {\n  operation: MassPropertiesOperation;\n  candidates?: Id64Array;\n}\n\n/** Information required to request mass properties for each element separately from the front end to the back end.\n * @public\n * @deprecated in 4.11 - might be removed in next major version. Use [[MassPropertiesRequestProps]].\n */\nexport interface MassPropertiesPerCandidateRequestProps {\n  operations: MassPropertiesOperation[];\n  candidates: CompressedId64Set;\n}\n\n/** Information returned from the back end to the front end holding the result of the mass properties calculation.\n * @public\n * @extensions\n */\nexport interface MassPropertiesResponseProps {\n  /** Success if requested [[MassPropertiesOperation]] could be evaluated for the specified elements */\n  status: BentleyStatus;\n  /** Volume of solids when [[MassPropertiesOperation.AccumulateVolumes]] requested */\n  volume?: number;\n  /** Surface area of solids and surfaces when [[MassPropertiesOperation.AccumulateVolumes]] or [[MassPropertiesOperation.AccumulateAreas]] requested */\n  area?: number;\n  /** Perimeter of surfaces and planar regions when [[MassPropertiesOperation.AccumulateAreas]] requested */\n  perimeter?: number;\n  /** Length of curves or perimeter of planar regions when [[MassPropertiesOperation.AccumulateAreas]] or [[MassPropertiesOperation.AccumulateLength]] requested */\n  length?: number;\n  /** Centroid of geometry */\n  centroid?: XYZProps;\n  /** Product of inertia with respect to xy plane */\n  ixy?: number;\n  /** Product of inertia with respect to xz plane */\n  ixz?: number;\n  /** Product of inertia with respect to yz plane */\n  iyz?: number;\n  /** Moments of inertia */\n  moments?: XYZProps;\n}\n\n/** Information returned from the back end to the front end holding the result of the mass properties calculation for a single candidate.\n * @public\n * @deprecated in 4.11 - might be removed in next major version. Use [[MassPropertiesResponseProps]].\n */\nexport interface MassPropertiesPerCandidateResponseProps extends MassPropertiesResponseProps {\n  candidate: Id64String;\n}\n"]}

package/lib/cjs/MaterialProps.d.ts

@@ -52,7 +52,7 @@ export interface TextureMapProps {
     /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */
     pattern_weight?: number;
     /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false.
-     * @deprecated in 4.4. It never functioned properly - use [[pattern_useconstantlod]] instead.
+     * @deprecated in 4.4 - might be removed in next major version. It never functioned properly - use [[pattern_useconstantlod]] instead.
      */
     pattern_useConstantLod?: boolean;
     /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false. */

package/lib/cjs/MaterialProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;GAGG;AACH,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AA4CD;;GAEG;AACH,IAAY,cASX;AATD,WAAY,cAAc;IACxB,wBAAwB;IACxB,mDAAQ,CAAA;IACR;;OAEG;IACH,yDAAgB,CAAA;IAChB,uFAAuF;IACvF,uEAAuB,CAAA;AACzB,CAAC,EATW,cAAc,8BAAd,cAAc,QASzB","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 { Id64String } from \"@itwin/core-bentley\";\nimport { DefinitionElementProps } from \"./ElementProps\";\nimport { TextureMapping } from \"./TextureMapping\";\n\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\n * the second to green, and the third to blue.\n * @see usage in [[RenderMaterialAssetProps]].\n * @public\n * @extensions\n */\nexport type RgbFactorProps = number[];\n\n/** A 2d point specified as an array of 2 numbers [x, y].\n * @see usage in [[TextureMapProps]].\n * @public\n * @extensions\n */\nexport type Point2dProps = number[];\n\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\n * @public\n * @extensions\n */\nexport enum TextureMapUnits {\n  /** Indicates the scale has no units. */\n  Relative = 0,\n  Meters = 3,\n  Millimeters = 4,\n  Feet = 5,\n  Inches = 6,\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\n * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.\n * @public\n * @extensions\n */\nexport interface TextureMapProps {\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\n  pattern_angle?: number;\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\n  pattern_u_flip?: boolean;\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\n  pattern_flip?: boolean;\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\n  pattern_scale?: Point2dProps;\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\n  pattern_offset?: Point2dProps;\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\n  pattern_scalemode?: TextureMapUnits;\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\n  pattern_mapping?: TextureMapping.Mode;\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\n  pattern_weight?: number;\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false.\n   * @deprecated in 4.4. It never functioned properly - use [[pattern_useconstantlod]] instead.\n   */\n  pattern_useConstantLod?: boolean;\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false. */\n  pattern_useconstantlod?: boolean;\n  /** The number of times the texture is repeated if pattern_useconstantlod is true.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1.*/\n  pattern_constantlod_repetitions?: number;\n  /** An offset in world units used to shift the texture when pattern_useconstantlod is true. Defaults to (0, 0). */\n  pattern_constantlod_offset?: Point2dProps;\n  /** The minimum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 1. */\n  pattern_constantlod_mindistanceclamp?: number;\n  /** The maximum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 2^32. */\n  pattern_constantlod_maxdistanceclamp?: number;\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\n  TextureId: Id64String;\n}\n\n/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.\n * @public\n */\nexport enum NormalMapFlags {\n  /** No special flags. */\n  None = 0,\n  /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should\n   * be negated. By default it points downward.\n   */\n  GreenUp = 1 << 0,\n  /** If true, override the mapping mode with constant LOD mapping for the normal map. */\n  UseConstantLod = 1 << 1,\n}\n\n/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.\n * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].\n * @public\n */\nexport interface NormalMapProps extends TextureMapProps {\n  /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */\n  NormalFlags?: NormalMapFlags;\n}\n\n/** Describes different types of textures to be applied to a surface material to alter its appearance.\n * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice\n * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.\n * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.\n * @public\n */\nexport interface RenderMaterialAssetMapsProps {\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Pattern?: TextureMapProps;\n  /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are\n   * present in the surface's geometry.\n   */\n  Normal?: NormalMapProps;\n  /** Maps an image describing detailed minor height variation of the surface geometry. */\n  Bump?: TextureMapProps;\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Diffuse?: TextureMapProps;\n  /** Maps an image describing the glossiness of the surface's finish */\n  Finish?: TextureMapProps;\n  /** Maps an image describing glowing parts of the surface */\n  GlowColor?: TextureMapProps;\n  /** Maps an image describing the reflectiveness of the surface */\n  Reflect?: TextureMapProps;\n  /** Maps an image describing the specular component of the surface */\n  Specular?: TextureMapProps;\n  /** Maps an image describing the translucency of the surface, how much light comes out the back of the surface */\n  TranslucencyColor?: TextureMapProps;\n  /** Maps an image describing the transparency of the surface, how visible objects behind this object are */\n  TransparentColor?: TextureMapProps;\n  /** Maps an image describing the displacement of the surface geometry */\n  Displacement?: TextureMapProps;\n}\n\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\n * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.\n * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.\n * @public\n * @extensions\n */\nexport interface RenderMaterialAssetProps {\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\n  HasBaseColor?: boolean;\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\n  color?: RgbFactorProps;\n  /** If true, this material has a specular color; if undefined, defaults to false */\n  HasSpecularColor?: boolean;\n  /** Surface color used for specular illumination; if undefined, defaults to black */\n  specular_color?: RgbFactorProps;\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\n  HasFinish?: boolean;\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */\n  finish?: number;\n  /** If true, this material has surface transparency; if undefined, defaults to false */\n  HasTransmit?: boolean;\n  /** Surface transparency; if undefined, defaults to 0.0 */\n  transmit?: number;\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\n  HasDiffuse?: boolean;\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\n  diffuse?: number;\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\n  HasSpecular?: boolean;\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\n  specular?: number;\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\n  HasReflect?: boolean;\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\n  reflect?: number;\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\n  HasReflectColor?: boolean;\n  /** Surface reflectance color; if undefined, defaults to black */\n  reflect_color?: RgbFactorProps;\n  /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.\n   * Default: 1.0\n   */\n  pbr_normal?: number;\n  /** An optional set of texture maps associated with this material. */\n  Map?: RenderMaterialAssetMapsProps;\n}\n\n/** Properties that define a [RenderMaterialElement]($backend).\n * @see [[RenderMaterial]] for the representation used by the display system.\n * @public\n * @extensions\n */\nexport interface RenderMaterialProps extends DefinitionElementProps {\n  /** The name of a palette that can be used to categorize multiple materials. */\n  paletteName: string;\n  /** An optional description of the material. */\n  description?: string;\n  jsonProperties?: {\n    /** A container for various \"assets\" describing aspects of the material. */\n    materialAssets?: {\n      /** Properties of the material describing how it is displayed. */\n      renderMaterial?: RenderMaterialAssetProps;\n    };\n  };\n}\n"]}
+{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;GAGG;AACH,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AA4CD;;GAEG;AACH,IAAY,cASX;AATD,WAAY,cAAc;IACxB,wBAAwB;IACxB,mDAAQ,CAAA;IACR;;OAEG;IACH,yDAAgB,CAAA;IAChB,uFAAuF;IACvF,uEAAuB,CAAA;AACzB,CAAC,EATW,cAAc,8BAAd,cAAc,QASzB","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 { Id64String } from \"@itwin/core-bentley\";\nimport { DefinitionElementProps } from \"./ElementProps\";\nimport { TextureMapping } from \"./TextureMapping\";\n\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\n * the second to green, and the third to blue.\n * @see usage in [[RenderMaterialAssetProps]].\n * @public\n * @extensions\n */\nexport type RgbFactorProps = number[];\n\n/** A 2d point specified as an array of 2 numbers [x, y].\n * @see usage in [[TextureMapProps]].\n * @public\n * @extensions\n */\nexport type Point2dProps = number[];\n\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\n * @public\n * @extensions\n */\nexport enum TextureMapUnits {\n  /** Indicates the scale has no units. */\n  Relative = 0,\n  Meters = 3,\n  Millimeters = 4,\n  Feet = 5,\n  Inches = 6,\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\n * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.\n * @public\n * @extensions\n */\nexport interface TextureMapProps {\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\n  pattern_angle?: number;\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\n  pattern_u_flip?: boolean;\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\n  pattern_flip?: boolean;\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\n  pattern_scale?: Point2dProps;\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\n  pattern_offset?: Point2dProps;\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\n  pattern_scalemode?: TextureMapUnits;\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\n  pattern_mapping?: TextureMapping.Mode;\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\n  pattern_weight?: number;\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false.\n   * @deprecated in 4.4 - might be removed in next major version. It never functioned properly - use [[pattern_useconstantlod]] instead.\n   */\n  pattern_useConstantLod?: boolean;\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false. */\n  pattern_useconstantlod?: boolean;\n  /** The number of times the texture is repeated if pattern_useconstantlod is true.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1.*/\n  pattern_constantlod_repetitions?: number;\n  /** An offset in world units used to shift the texture when pattern_useconstantlod is true. Defaults to (0, 0). */\n  pattern_constantlod_offset?: Point2dProps;\n  /** The minimum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 1. */\n  pattern_constantlod_mindistanceclamp?: number;\n  /** The maximum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 2^32. */\n  pattern_constantlod_maxdistanceclamp?: number;\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\n  TextureId: Id64String;\n}\n\n/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.\n * @public\n */\nexport enum NormalMapFlags {\n  /** No special flags. */\n  None = 0,\n  /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should\n   * be negated. By default it points downward.\n   */\n  GreenUp = 1 << 0,\n  /** If true, override the mapping mode with constant LOD mapping for the normal map. */\n  UseConstantLod = 1 << 1,\n}\n\n/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.\n * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].\n * @public\n */\nexport interface NormalMapProps extends TextureMapProps {\n  /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */\n  NormalFlags?: NormalMapFlags;\n}\n\n/** Describes different types of textures to be applied to a surface material to alter its appearance.\n * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice\n * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.\n * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.\n * @public\n */\nexport interface RenderMaterialAssetMapsProps {\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Pattern?: TextureMapProps;\n  /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are\n   * present in the surface's geometry.\n   */\n  Normal?: NormalMapProps;\n  /** Maps an image describing detailed minor height variation of the surface geometry. */\n  Bump?: TextureMapProps;\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Diffuse?: TextureMapProps;\n  /** Maps an image describing the glossiness of the surface's finish */\n  Finish?: TextureMapProps;\n  /** Maps an image describing glowing parts of the surface */\n  GlowColor?: TextureMapProps;\n  /** Maps an image describing the reflectiveness of the surface */\n  Reflect?: TextureMapProps;\n  /** Maps an image describing the specular component of the surface */\n  Specular?: TextureMapProps;\n  /** Maps an image describing the translucency of the surface, how much light comes out the back of the surface */\n  TranslucencyColor?: TextureMapProps;\n  /** Maps an image describing the transparency of the surface, how visible objects behind this object are */\n  TransparentColor?: TextureMapProps;\n  /** Maps an image describing the displacement of the surface geometry */\n  Displacement?: TextureMapProps;\n}\n\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\n * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.\n * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.\n * @public\n * @extensions\n */\nexport interface RenderMaterialAssetProps {\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\n  HasBaseColor?: boolean;\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\n  color?: RgbFactorProps;\n  /** If true, this material has a specular color; if undefined, defaults to false */\n  HasSpecularColor?: boolean;\n  /** Surface color used for specular illumination; if undefined, defaults to black */\n  specular_color?: RgbFactorProps;\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\n  HasFinish?: boolean;\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */\n  finish?: number;\n  /** If true, this material has surface transparency; if undefined, defaults to false */\n  HasTransmit?: boolean;\n  /** Surface transparency; if undefined, defaults to 0.0 */\n  transmit?: number;\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\n  HasDiffuse?: boolean;\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\n  diffuse?: number;\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\n  HasSpecular?: boolean;\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\n  specular?: number;\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\n  HasReflect?: boolean;\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\n  reflect?: number;\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\n  HasReflectColor?: boolean;\n  /** Surface reflectance color; if undefined, defaults to black */\n  reflect_color?: RgbFactorProps;\n  /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.\n   * Default: 1.0\n   */\n  pbr_normal?: number;\n  /** An optional set of texture maps associated with this material. */\n  Map?: RenderMaterialAssetMapsProps;\n}\n\n/** Properties that define a [RenderMaterialElement]($backend).\n * @see [[RenderMaterial]] for the representation used by the display system.\n * @public\n * @extensions\n */\nexport interface RenderMaterialProps extends DefinitionElementProps {\n  /** The name of a palette that can be used to categorize multiple materials. */\n  paletteName: string;\n  /** An optional description of the material. */\n  description?: string;\n  jsonProperties?: {\n    /** A container for various \"assets\" describing aspects of the material. */\n    materialAssets?: {\n      /** Properties of the material describing how it is displayed. */\n      renderMaterial?: RenderMaterialAssetProps;\n    };\n  };\n}\n"]}

package/lib/cjs/TerrainSettings.d.ts

@@ -73,7 +73,7 @@ export declare class TerrainSettings {
      * @internal
      */
     get nonLocatable(): true | undefined;
-    /** @deprecated in 4.5.x. Use the overload that takes [[TerrainProps]]. */
+    /** @deprecated in 4.5.x - might be removed in next major version. Use the overload that takes [[TerrainProps]]. */
     constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);
     constructor(props?: TerrainProps);
     static fromJSON(json?: TerrainProps): TerrainSettings;

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

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

package/lib/cjs/TerrainSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"TerrainSettings.js","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,uDAAyD;AAkCzD;;;;GAIG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,sHAAsH;IACtH,6EAAY,CAAA;IACZ,0GAA0G;IAC1G,uEAAS,CAAA;IACT,yGAAyG;IACzG,yEAAU,CAAA;AACZ,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AAED;;GAEG;AACH,MAAa,eAAe;IAClB,aAAa,CAAmB;IACxC;;OAEG;IACa,YAAY,CAAS;IACrC;;;;OAIG;IACa,UAAU,CAAS;IACnC,qIAAqI;IACrH,YAAY,CAAS;IACrC,+FAA+F;IAC/E,aAAa,CAAU;IACvC,yHAAyH;IACzG,YAAY,CAAS;IACrC,mGAAmG;IACnF,gBAAgB,CAA0B;IAC1D;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAOD,gBAAgB;IAChB,YAAY,mBAAsD,EAAE,YAAqB,EAAE,aAAuB,EAAE,YAAqB,EAAE,gBAA0C;QACnL,IAAI,YAAY,CAAC;QACjB,IAAI,UAAU,CAAC;QACf,IAAI,YAAY,CAAC;QACjB,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YAC5C,YAAY,GAAG,mBAAmB,CAAC;QACrC,CAAC;aAAM,IAAI,mBAAmB,EAAE,CAAC;YAC/B,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAClI,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,oBAAoB,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,KAAK,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;QAExC,IAAI,IAAI,KAAK,YAAY;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,QAAQ,gBAAgB,EAAE,CAAC;YACzB,KAAK,uBAAuB,CAAC,MAAM,CAAC;YACpC,KAAK,uBAAuB,CAAC,KAAK;gBAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ,CAAC;gBACzD,MAAM;QACV,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB,sCAAoB,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\";\nimport { CesiumTerrainAssetId } from \"./CesiumIonAssets\";\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;;;AAGH,uDAAyD;AAkCzD;;;;GAIG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,sHAAsH;IACtH,6EAAY,CAAA;IACZ,0GAA0G;IAC1G,uEAAS,CAAA;IACT,yGAAyG;IACzG,yEAAU,CAAA;AACZ,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AAED;;GAEG;AACH,MAAa,eAAe;IAClB,aAAa,CAAmB;IACxC;;OAEG;IACa,YAAY,CAAS;IACrC;;;;OAIG;IACa,UAAU,CAAS;IACnC,qIAAqI;IACrH,YAAY,CAAS;IACrC,+FAA+F;IAC/E,aAAa,CAAU;IACvC,yHAAyH;IACzG,YAAY,CAAS;IACrC,mGAAmG;IACnF,gBAAgB,CAA0B;IAC1D;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAOD,gBAAgB;IAChB,YAAY,mBAAsD,EAAE,YAAqB,EAAE,aAAuB,EAAE,YAAqB,EAAE,gBAA0C;QACnL,IAAI,YAAY,CAAC;QACjB,IAAI,UAAU,CAAC;QACf,IAAI,YAAY,CAAC;QACjB,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YAC5C,YAAY,GAAG,mBAAmB,CAAC;QACrC,CAAC;aAAM,IAAI,mBAAmB,EAAE,CAAC;YAC/B,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAClI,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,oBAAoB,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,KAAK,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;QAExC,IAAI,IAAI,KAAK,YAAY;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,QAAQ,gBAAgB,EAAE,CAAC;YACzB,KAAK,uBAAuB,CAAC,MAAM,CAAC;YACpC,KAAK,uBAAuB,CAAC,KAAK;gBAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ,CAAC;gBACzD,MAAM;QACV,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB,sCAAoB,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\";\nimport { CesiumTerrainAssetId } from \"./CesiumIonAssets\";\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 - might be removed in next major version. Use the overload that takes [[TerrainProps]]. */\n  constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);\n\n  constructor(props?: TerrainProps);\n\n  /** @internal */\n  constructor(providerNameOrProps: string | TerrainProps | undefined, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode) {\n    let providerName;\n    let dataSource;\n    let nonLocatable;\n    if (typeof providerNameOrProps === \"string\") {\n      providerName = providerNameOrProps;\n    } else if (providerNameOrProps) {\n      ({ providerName, dataSource, exaggeration, applyLighting, heightOrigin, heightOriginMode, nonLocatable } = providerNameOrProps);\n    }\n\n    this.providerName = providerName ?? \"CesiumWorldTerrain\";\n    this.dataSource = dataSource ?? \"\";\n    this.exaggeration = Math.min(100, Math.max(0.1, exaggeration ?? 1.0));\n    this.applyLighting = applyLighting ?? false;\n    this.heightOrigin = heightOrigin ?? 0.0;\n\n    if (true === nonLocatable)\n      this._nonLocatable = true;\n\n    switch (heightOriginMode) {\n      case TerrainHeightOriginMode.Ground:\n      case TerrainHeightOriginMode.Geoid:\n        this.heightOriginMode = heightOriginMode;\n        break;\n      default:\n        this.heightOriginMode = TerrainHeightOriginMode.Geodetic;\n        break;\n    }\n  }\n\n  public static fromJSON(json?: TerrainProps) {\n    return new TerrainSettings(json);\n  }\n\n  /** Create settings that obtain terrain from a [Cesium ION asset](https://cesium.com/platform/cesium-ion/content/) such as\n   * one of those defined by [[CesiumTerrainAssetId]].\n   * @note You must ensure your Cesium ION account has access to the specified asset.\n   */\n  public static fromCesiumIonAsset(assetId: string = CesiumTerrainAssetId.Default, options?: Omit<TerrainProps, \"providerName\" | \"dataSource\">): TerrainSettings {\n    return TerrainSettings.fromJSON({\n      ...options,\n      dataSource: assetId,\n    });\n  }\n\n  public toJSON(): TerrainProps {\n    const props: TerrainProps = { heightOriginMode: this.heightOriginMode };\n    if (\"CesiumWorldTerrain\" !== this.providerName)\n      props.providerName = this.providerName;\n    if (this.dataSource)\n      props.dataSource = this.dataSource;\n    if (1 !== this.exaggeration)\n      props.exaggeration = this.exaggeration;\n    if (this.nonLocatable)\n      props.nonLocatable = true;\n    if (this.applyLighting)\n      props.applyLighting = true;\n    if (0 !== this.heightOrigin)\n      props.heightOrigin = this.heightOrigin;\n\n    return props;\n  }\n\n  public equals(other: TerrainSettings): boolean {\n    return this.providerName === other.providerName && this.dataSource === other.dataSource && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting\n      && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(TerrainSettings.fromJSON(json));\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: TerrainProps): TerrainSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      providerName: changedProps.providerName ?? this.providerName,\n      dataSource: changedProps.dataSource ?? this.dataSource,\n      exaggeration: changedProps.exaggeration ?? this.exaggeration,\n      nonLocatable: changedProps.nonLocatable ?? this.nonLocatable,\n      applyLighting: changedProps.applyLighting ?? this.applyLighting,\n      heightOrigin: changedProps.heightOrigin ?? this.heightOrigin,\n      heightOriginMode: changedProps.heightOriginMode ?? this.heightOriginMode,\n    };\n\n    return TerrainSettings.fromJSON(props);\n  }\n}\n"]}

package/lib/cjs/annotation/TextAnnotation.d.ts

@@ -3,6 +3,7 @@
  */
 import { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
 import { TextBlock, TextBlockProps } from "./TextBlock";
+import { TextStyleColor } from "./TextStyle";
 /** Describes how to compute the "anchor point" for a [[TextAnnotation]].
  * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].
  * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point
@@ -27,6 +28,31 @@ export interface TextAnnotationAnchor {
      */
     horizontal: "left" | "center" | "right";
 }
+/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+export type TextAnnotationFrameShape = "none" | "line" | "rectangle" | "circle" | "equilateralTriangle" | "diamond" | "square" | "pentagon" | "hexagon" | "octagon" | "capsule" | "roundedRectangle";
+/**
+ * Describes what color to use when filling the frame around a [[TextBlock]].
+ * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.
+ * @beta
+ */
+export type TextAnnotationFillColor = TextStyleColor | "background";
+/**
+ * Describes how to draw the frame around a [[TextBlock]].
+ * The frame can be a simple line, a filled shape, or both.
+ * @beta
+ */
+export interface TextFrameStyleProps {
+    /** Shape of the frame. Default: "rectangle" */
+    shape?: TextAnnotationFrameShape;
+    /** The color to fill the shape of the text frame. This fill will is applied using [[FillDisplay.Blanking]]. Default: no fill */
+    fill?: TextAnnotationFillColor;
+    /** The color of the text frame's outline. Default: black */
+    border?: TextStyleColor;
+    /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */
+    borderWeight?: number;
+}
 /**
  * JSON representation of a [[TextAnnotation]].
  * @beta
@@ -40,6 +66,8 @@ export interface TextAnnotationProps {
     textBlock?: TextBlockProps;
     /** See [[TextAnnotation.anchor]]. Default: top-left. */
     anchor?: TextAnnotationAnchor;
+    /** See [[TextAnnotation.frame]]. Default: no frame */
+    frame?: TextFrameStyleProps;
 }
 /** Arguments supplied to [[TextAnnotation.create]].
  * @beta
@@ -53,6 +81,8 @@ export interface TextAnnotationCreateArgs {
     textBlock?: TextBlock;
     /** See [[TextAnnotation.anchor]]. Default: top-left. */
     anchor?: TextAnnotationAnchor;
+    /** See [[TextAnnotation.frame]]. Default: no frame */
+    frame?: TextFrameStyleProps;
 }
 /**
  * Represents a formatted block of text positioned in 2d or 3d space.
@@ -64,7 +94,7 @@ export interface TextAnnotationCreateArgs {
  * edges, or in the center of the box.
  * - The [[orientation]] is applied to rotate the box around the anchor point.
  * - Finally, the [[offset]] is added to the anchor point to apply translation.
- * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].
+ * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].
  * @beta
  */
 export declare class TextAnnotation {
@@ -78,6 +108,8 @@ export declare class TextAnnotation {
     anchor: TextAnnotationAnchor;
     /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */
     offset: Point3d;
+    /** The frame settings of the text annotation. */
+    frame?: TextFrameStyleProps;
     private constructor();
     /** Creates a new TextAnnotation. */
     static create(args?: TextAnnotationCreateArgs): TextAnnotation;

package/lib/cjs/annotation/TextAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAExD;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IAEvB,OAAO;IAOP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IASrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAS9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAsBpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAK9C"}
+{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,qBAAqB,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAGrM;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,gIAAgI;IAChI,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAA;CAC5B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IACvB,iDAAiD;IAC1C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAEnC,OAAO;IAQP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IAYrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAU9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAyBpC;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;IAUxD;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAW9C"}

package/lib/cjs/annotation/TextAnnotation.js

@@ -20,7 +20,7 @@ const TextBlock_1 = require("./TextBlock");
  * edges, or in the center of the box.
  * - The [[orientation]] is applied to rotate the box around the anchor point.
  * - Finally, the [[offset]] is added to the anchor point to apply translation.
- * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].
+ * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].
  * @beta
  */
 class TextAnnotation {
@@ -34,11 +34,14 @@ class TextAnnotation {
     anchor;
     /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */
     offset;
-    constructor(offset, angles, textBlock, anchor) {
+    /** The frame settings of the text annotation. */
+    frame;
+    constructor(offset, angles, textBlock, anchor, frame) {
         this.offset = offset;
         this.orientation = angles;
         this.textBlock = textBlock;
         this.anchor = anchor;
+        this.frame = frame;
     }
     /** Creates a new TextAnnotation. */
     static create(args) {
@@ -46,7 +49,10 @@ class TextAnnotation {
         const angles = args?.orientation ?? new core_geometry_1.YawPitchRollAngles();
         const textBlock = args?.textBlock ?? TextBlock_1.TextBlock.createEmpty();
         const anchor = args?.anchor ?? { vertical: "top", horizontal: "left" };
-        return new TextAnnotation(offset, angles, textBlock, anchor);
+        // If the user supplies a frame, but doesn't supply a shape, default the shape to "rectangle"
+        const shape = args?.frame?.shape ?? "rectangle";
+        const frame = args?.frame ? { shape, ...args.frame } : undefined;
+        return new TextAnnotation(offset, angles, textBlock, anchor, frame);
     }
     /**
      * Creates a new TextAnnotation instance from its JSON representation.
@@ -57,6 +63,7 @@ class TextAnnotation {
             orientation: props?.orientation ? core_geometry_1.YawPitchRollAngles.fromJSON(props.orientation) : undefined,
             textBlock: props?.textBlock ? TextBlock_1.TextBlock.create(props.textBlock) : undefined,
             anchor: props?.anchor ? { ...props.anchor } : undefined,
+            frame: props?.frame ? { shape: "rectangle", ...props.frame } : undefined,
         });
     }
     /**
@@ -76,6 +83,8 @@ class TextAnnotation {
         if (this.anchor.vertical !== "top" || this.anchor.horizontal !== "left") {
             props.anchor = { ...this.anchor };
         }
+        // Default frame to "none"
+        props.frame = this.frame ? { ...this.frame } : undefined;
         return props;
     }
     /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.
@@ -121,9 +130,14 @@ class TextAnnotation {
     }
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other) {
+        const framesMatch = this.frame?.shape === other.frame?.shape
+            && this.frame?.fill === other.frame?.fill
+            && this.frame?.border === other.frame?.border
+            && this.frame?.borderWeight === other.frame?.borderWeight;
         return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical
             && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)
-            && this.textBlock.equals(other.textBlock);
+            && this.textBlock.equals(other.textBlock)
+            && framesMatch;
     }
 }
 exports.TextAnnotation = TextAnnotation;