@itwin/core-common 5.1.0-dev.9 → 5.2.0-dev.2

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.0 - will not be removed until after 2026-06-13. 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 { TextStyleSettingsProps } 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,71 @@ export interface TextAnnotationAnchor {
      */
     horizontal: "left" | "center" | "right";
 }
+/**
+ * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].
+ * Leader can be attached using one of the three modes:
+ * - KeyPoint: attach to a point on the frame specified by the given curveIndex and fractional position.
+ * - TextPoint: attach to a point that is projected on to the frame from the point on a particular line of text specified by [[LeaderTextPointOptions]].
+ * - Nearest: attach to the point on frame that is nearest to [[TextAnnotationLeader.startPoint]].
+ * @beta
+ */
+export type LeaderAttachment = {
+    mode: "KeyPoint";
+    curveIndex: number;
+    fraction: number;
+} | {
+    mode: "TextPoint";
+    position: LeaderTextPointOptions;
+} | {
+    mode: "Nearest";
+};
+/**
+ * Specifies the possible positions to attach a leader on the frame around a [[TextBlock]]
+ * when [[TextAnnotationLeader.attachment.mode]] is set to TextPoint.
+ * TopLeft : attach to a point projected onto the frame from the point on the left side of the first line of text.
+ * TopRight : attach to a point projected onto the frame from the point on the right side of the first line of text.
+ * BottomLeft : attach to a point projected onto the frame from the point on the left side of the last line of text.
+ * BottomRight : attach to a point projected onto the frame from the point on the right side of the last line of text.
+ * @beta
+ */
+export type LeaderTextPointOptions = "TopLeft" | "TopRight" | "BottomLeft" | "BottomRight";
+/**
+ * A line that connects a [[TextAnnotation]] to a point in space relative to another element in the iModel.
+ * A leader is always attached to the frame around the annotation's [[TextBlock]].
+ * If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.
+ * @see [[TextAnnotation.leaders]] for the leaders associated with an annotation.
+ * @see [[TextStyleSettings.leader]] and [[styleOverrides]] to customize the appearance of leaders.
+ * @beta
+*/
+export interface TextAnnotationLeader {
+    /** The point where the leader starts.
+     * This is the point on another element where the leader points to */
+    startPoint: Point3d;
+    /** Describes how to attach the leader to the frame around [[textBlock]].*/
+    attachment: LeaderAttachment;
+    /** Optional intermediate points that the leader should pass through.
+     * If not specified, the leader will be a straight line from startPoint to the point on the frame.
+     * For now, intermediate points are a set of points which create additional LineSegments in the leader, but there could be intermediate shapes instead of straight LineSegments in future*/
+    intermediatePoints?: Point3d[];
+    /** Optional style overrides for the leader. If not specified, the leader will use the style defined by [[TextBlock.styleName]] as it is.
+     * If specified, these overrides will be applied to the style.
+     */
+    styleOverrides?: TextStyleSettingsProps;
+}
+/**
+ * JSON representation of a [[TextAnnotationLeader]].
+ * @beta
+ */
+export interface TextAnnotationLeaderProps {
+    /** See [[TextAnnotationLeader.startPoint]]. */
+    startPoint: XYZProps;
+    /** See [[TextAnnotationLeader.attachment]]. */
+    attachment: LeaderAttachment;
+    /** See [[TextAnnotationLeader.intermediatePoints]]. Default: no intermediate points. */
+    intermediatePoints?: XYZProps[];
+    /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */
+    styleOverrides?: TextStyleSettingsProps;
+}
 /**
  * JSON representation of a [[TextAnnotation]].
  * @beta
@@ -40,6 +106,8 @@ export interface TextAnnotationProps {
     textBlock?: TextBlockProps;
     /** See [[TextAnnotation.anchor]]. Default: top-left. */
     anchor?: TextAnnotationAnchor;
+    /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
+    leaders?: TextAnnotationLeaderProps[];
 }
 /** Arguments supplied to [[TextAnnotation.create]].
  * @beta
@@ -53,6 +121,8 @@ export interface TextAnnotationCreateArgs {
     textBlock?: TextBlock;
     /** See [[TextAnnotation.anchor]]. Default: top-left. */
     anchor?: TextAnnotationAnchor;
+    /** See [[TextAnnotation.leader]]. Default: an empty leader array  */
+    leaders?: TextAnnotationLeader[];
 }
 /**
  * Represents a formatted block of text positioned in 2d or 3d space.
@@ -64,7 +134,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 +148,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 leaders of the text annotation. */
+    leaders?: TextAnnotationLeader[];
     private constructor();
     /** Creates a new TextAnnotation. */
     static create(args?: TextAnnotationCreateArgs): TextAnnotation;
@@ -94,16 +166,20 @@ export declare class TextAnnotation {
      * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.
      * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].
      * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.
+     * If a scale factor is specified, the transform will also scale the annotation by that factor. Usually, this should come from the [[Drawing]] containing the annotation.
      * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.
+     * @param scaleFactor A factor by which to scale the annotation. Default: 1 (no scaling).
      * @see [[computeAnchorPoint]] to compute the transform's anchor point.
      * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.
      */
-    computeTransform(boundingBox: Range2d): Transform;
+    computeTransform(boundingBox: Range2d, scaleFactor?: number): Transform;
     /** Compute the anchor point of this annotation as specified by [[anchor]].
      * @param boundingBox A box fully containing the [[textBlock]].
      * @see [[computeTransform]] to compute the transform relative to the anchor point.
      */
     computeAnchorPoint(boundingBox: Range2d): Point3d;
+    /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */
+    private areLeadersEqual;
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other: TextAnnotation): boolean;
 }

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,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;;;;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;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,aAAa,CAAA;AAE1F;;;;;;;EAOE;AACF,MAAM,WAAW,oBAAoB;IACnC;yEACqE;IACrE,UAAU,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,UAAU,EAAE,gBAAgB,CAAC;IAC7B;;+LAE2L;IAC3L,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,QAAQ,CAAC;IACrB,+CAA+C;IAC/C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChC,gFAAgF;IAChF,cAAc,CAAC,EAAE,sBAAsB,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;IAC9B,qEAAqE;IACrE,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACvC;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,qEAAqE;IACrE,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAClC;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,0CAA0C;IACnC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExC,OAAO;IAQP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IASrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAe9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IA6BpC;;;;;;;;;;OAUG;IACI,gBAAgB,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,GAAE,MAAU,GAAG,SAAS;IAcjF;;;OAGG;IACI,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAyBxD,0FAA0F;IAC1F,OAAO,CAAC,eAAe;IAsBvB,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 leaders of the text annotation. */
+    leaders;
+    constructor(offset, angles, textBlock, anchor, leaders) {
         this.offset = offset;
         this.orientation = angles;
         this.textBlock = textBlock;
         this.anchor = anchor;
+        this.leaders = leaders;
     }
     /** Creates a new TextAnnotation. */
     static create(args) {
@@ -46,7 +49,8 @@ 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);
+        const leaders = args?.leaders ?? undefined;
+        return new TextAnnotation(offset, angles, textBlock, anchor, leaders);
     }
     /**
      * Creates a new TextAnnotation instance from its JSON representation.
@@ -57,6 +61,12 @@ 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,
+            leaders: props?.leaders ? props.leaders.map((leader) => ({
+                startPoint: core_geometry_1.Point3d.fromJSON(leader.startPoint),
+                attachment: leader.attachment,
+                styleOverrides: leader.styleOverrides ?? undefined,
+                intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => core_geometry_1.Point3d.fromJSON(point)) : undefined,
+            })) : undefined,
         });
     }
     /**
@@ -64,7 +74,7 @@ class TextAnnotation {
      */
     toJSON() {
         const props = {};
-        // Even if the text block is empty, we want to record its style name and overrides, e.g.,
+        // Even if the text block is empty, we want to record its style ID and overrides, e.g.,
         // so the user can pick up where they left off editing it next time.
         props.textBlock = this.textBlock.toJSON();
         if (!this.offset.isZero) {
@@ -76,6 +86,12 @@ class TextAnnotation {
         if (this.anchor.vertical !== "top" || this.anchor.horizontal !== "left") {
             props.anchor = { ...this.anchor };
         }
+        props.leaders = this.leaders?.map((leader) => ({
+            startPoint: leader.startPoint.toJSON(),
+            attachment: leader.attachment,
+            styleOverrides: leader.styleOverrides ?? undefined,
+            intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => point.toJSON()) : undefined,
+        })) ?? 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.
@@ -83,16 +99,23 @@ class TextAnnotation {
      * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.
      * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].
      * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.
+     * If a scale factor is specified, the transform will also scale the annotation by that factor. Usually, this should come from the [[Drawing]] containing the annotation.
      * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.
+     * @param scaleFactor A factor by which to scale the annotation. Default: 1 (no scaling).
      * @see [[computeAnchorPoint]] to compute the transform's anchor point.
      * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.
      */
-    computeTransform(boundingBox) {
+    computeTransform(boundingBox, scaleFactor = 1) {
         const anchorPt = this.computeAnchorPoint(boundingBox);
         const matrix = this.orientation.toMatrix3d();
-        const rotation = core_geometry_1.Transform.createFixedPointAndMatrix(anchorPt, matrix);
+        const transform = core_geometry_1.Transform.createIdentity();
         const translation = core_geometry_1.Transform.createTranslation(this.offset.minus(anchorPt));
-        return translation.multiplyTransformTransform(rotation, rotation);
+        const scaleTransform = core_geometry_1.Transform.createScaleAboutPoint(anchorPt, scaleFactor);
+        const rotation = core_geometry_1.Transform.createFixedPointAndMatrix(anchorPt, matrix);
+        transform.multiplyTransformTransform(translation, transform);
+        transform.multiplyTransformTransform(scaleTransform, transform);
+        transform.multiplyTransformTransform(rotation, transform);
+        return transform;
     }
     /** Compute the anchor point of this annotation as specified by [[anchor]].
      * @param boundingBox A box fully containing the [[textBlock]].
@@ -119,11 +142,41 @@ class TextAnnotation {
         }
         return new core_geometry_1.Point3d(x, y, 0);
     }
+    /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */
+    areLeadersEqual(leadersA, leadersB) {
+        if (leadersA === leadersB)
+            return true;
+        if (!leadersA || !leadersB || leadersA.length !== leadersB.length)
+            return false;
+        for (let i = 0; i < leadersA.length; ++i) {
+            const a = leadersA[i];
+            const b = leadersB[i];
+            if (!a.startPoint.isAlmostEqual(b.startPoint))
+                return false;
+            if (JSON.stringify(a.attachment) !== JSON.stringify(b.attachment))
+                return false;
+            if (JSON.stringify(a.styleOverrides) !== JSON.stringify(b.styleOverrides))
+                return false;
+            const pointsA = a.intermediatePoints ?? [];
+            const pointsB = b.intermediatePoints ?? [];
+            if (pointsA.length !== pointsB.length)
+                return false;
+            for (let j = 0; j < pointsA.length; ++j) {
+                if (!pointsA[j].isAlmostEqual(pointsB[j]))
+                    return false;
+            }
+        }
+        return true;
+    }
     /** Returns true if this annotation is logically equivalent to `other`. */
     equals(other) {
-        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);
+        if (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))
+            return false;
+        return this.areLeadersEqual(this.leaders, other.leaders);
     }
 }
 exports.TextAnnotation = TextAnnotation;

package/lib/cjs/annotation/TextAnnotation.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAoH;AACpH,2CAAwD;AAyDxD;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IAEvB,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B;QACjH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,uBAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kCAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,qBAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QAEvE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kCAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SACxD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,yFAAyF;QACzF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,WAAoB;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,yBAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,yBAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE7E,OAAO,WAAW,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,WAAoB;QAC5C,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3B,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,uBAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;eACtG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;eAC5F,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;CACF;AAxHD,wCAwHC","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 Annotation\n */\n\nimport { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\n\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\n * [[TextAnnotation.computeTransform]] will align the anchor point with (0, 0).\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\n * @beta\n */\nexport interface TextAnnotationAnchor {\n  /**\n   * The vertical alignment of the anchor point.\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\n   */\n  vertical: \"top\" | \"middle\" | \"bottom\";\n\n  /**\n   * The horizontal alignment of the anchor point.\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\n   */\n  horizontal: \"left\" | \"center\" | \"right\";\n}\n\n/**\n * JSON representation of a [[TextAnnotation]].\n * @beta\n */\nexport interface TextAnnotationProps {\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\n  offset?: XYZProps;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollProps;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlockProps;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n}\n\n/** Arguments supplied to [[TextAnnotation.create]].\n * @beta\n */\nexport interface TextAnnotationCreateArgs {\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\n  offset?: Point3d;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollAngles;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlock;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n}\n\n/**\n * Represents a formatted block of text positioned in 2d or 3d space.\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\n * - First, a bounding box is computed enclosing the contents of the [[textBlock].\n * - Then, an \"anchor point\" is computed based on the bounding box and the [[anchor]] property. The anchor point can be at one of the four corners of the box, in the middle of one of its four\n * edges, or in the center of the box.\n * - The [[orientation]] is applied to rotate the box around the anchor point.\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\n * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].\n * @beta\n */\nexport class TextAnnotation {\n  /** The rotation of the annotation.\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\n   */\n  public orientation: YawPitchRollAngles;\n  /** The formatted document. */\n  public textBlock: TextBlock;\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\n  public anchor: TextAnnotationAnchor;\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\n  public offset: Point3d;\n\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\n  }\n\n  /** Creates a new TextAnnotation. */\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\n    const offset = args?.offset ?? new Point3d();\n    const angles = args?.orientation ?? new YawPitchRollAngles();\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\n\n    return new TextAnnotation(offset, angles, textBlock, anchor);\n  }\n\n  /**\n   * Creates a new TextAnnotation instance from its JSON representation.\n   */\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\n    return TextAnnotation.create({\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\n    });\n  }\n\n  /**\n   * Converts this annotation to its JSON representation.\n   */\n  public toJSON(): TextAnnotationProps {\n    const props: TextAnnotationProps = {};\n\n    // Even if the text block is empty, we want to record its style name and overrides, e.g.,\n    // so the user can pick up where they left off editing it next time.\n    props.textBlock = this.textBlock.toJSON();\n\n    if (!this.offset.isZero) {\n      props.offset = this.offset.toJSON();\n    }\n\n    if (!this.orientation.isIdentity()) {\n      props.orientation = this.orientation.toJSON();\n    }\n\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\n      props.anchor = { ...this.anchor };\n    }\n\n    return props;\n  }\n\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].\n   * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.\n   * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\n   * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n   */\n  public computeTransform(boundingBox: Range2d): Transform {\n    const anchorPt = this.computeAnchorPoint(boundingBox);\n    const matrix = this.orientation.toMatrix3d();\n\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\n    const translation = Transform.createTranslation(this.offset.minus(anchorPt));\n\n    return translation.multiplyTransformTransform(rotation, rotation);\n  }\n\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\n   * @param boundingBox A box fully containing the [[textBlock]].\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\n   */\n  public computeAnchorPoint(boundingBox: Range2d): Point3d {\n    let x = boundingBox.low.x;\n    let y = boundingBox.high.y;\n\n    switch (this.anchor.horizontal) {\n      case \"center\":\n        x += boundingBox.xLength() / 2;\n        break;\n      case \"right\":\n        x += boundingBox.xLength();\n        break;\n    }\n\n    switch (this.anchor.vertical) {\n      case \"middle\":\n        y -= boundingBox.yLength() / 2;\n        break;\n      case \"bottom\":\n        y -= boundingBox.yLength();\n        break;\n    }\n\n    return new Point3d(x, y, 0);\n  }\n\n  /** Returns true if this annotation is logically equivalent to `other`. */\n  public equals(other: TextAnnotation): boolean {\n    return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical\n      && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)\n      && this.textBlock.equals(other.textBlock);\n  }\n}\n"]}
+{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAoH;AACpH,2CAAwD;AA4HxD;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,WAAW,CAAqB;IACvC,8BAA8B;IACvB,SAAS,CAAY;IAC5B,iEAAiE;IAC1D,MAAM,CAAuB;IACpC,8IAA8I;IACvI,MAAM,CAAU;IACvB,0CAA0C;IACnC,OAAO,CAA0B;IAExC,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B,EAAE,OAAgC;QACnJ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,uBAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kCAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,qBAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACvE,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,SAAS,CAAC;QAC3C,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kCAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;YACvD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvD,UAAU,EAAE,uBAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC/C,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,SAAS;gBAClD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;aAC9H,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,uFAAuF;QACvF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC7C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,SAAS;YAClD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;SACrH,CAAC,CAAC,IAAI,SAAS,CAAC;QAEjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACI,gBAAgB,CAAC,WAAoB,EAAE,cAAsB,CAAC;QACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,SAAS,GAAG,yBAAS,CAAC,cAAc,EAAE,CAAC;QAC7C,MAAM,WAAW,GAAG,yBAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC7E,MAAM,cAAc,GAAG,yBAAS,CAAC,qBAAqB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,yBAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,SAAS,CAAC,0BAA0B,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC7D,SAAS,CAAC,0BAA0B,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAChE,SAAS,CAAC,0BAA0B,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,WAAoB;QAC5C,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3B,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,uBAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0FAA0F;IAClF,eAAe,CAAC,QAAiC,EAAE,QAAiC;QAC1F,IAAI,QAAQ,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACvC,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAEhF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAEtB,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC5D,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YAChF,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC;gBAAE,OAAO,KAAK,CAAC;YAExF,MAAM,OAAO,GAAG,CAAC,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,CAAC,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBAAE,OAAO,KAAK,CAAC;YAC1D,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU;YACpD,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;YAC9C,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAClD,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;YACxC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YACvC,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3D,CAAC;CACF;AA3KD,wCA2KC","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 Annotation\n */\n\nimport { Point3d, Range2d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\nimport { TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\n * [[TextAnnotation.computeTransform]] will align the anchor point with (0, 0).\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\n * @beta\n */\nexport interface TextAnnotationAnchor {\n  /**\n   * The vertical alignment of the anchor point.\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\n   */\n  vertical: \"top\" | \"middle\" | \"bottom\";\n\n  /**\n   * The horizontal alignment of the anchor point.\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\n   */\n  horizontal: \"left\" | \"center\" | \"right\";\n}\n\n/**\n * Describes how to attach a [[TextAnnotationLeader]] to the frame around a [[TextBlock]].\n * Leader can be attached using one of the three modes:\n * - KeyPoint: attach to a point on the frame specified by the given curveIndex and fractional position.\n * - TextPoint: attach to a point that is projected on to the frame from the point on a particular line of text specified by [[LeaderTextPointOptions]].\n * - Nearest: attach to the point on frame that is nearest to [[TextAnnotationLeader.startPoint]].\n * @beta\n */\nexport type LeaderAttachment =\n  | { mode: \"KeyPoint\"; curveIndex: number; fraction: number }\n  | { mode: \"TextPoint\"; position: LeaderTextPointOptions }\n  | { mode: \"Nearest\" };\n\n/**\n * Specifies the possible positions to attach a leader on the frame around a [[TextBlock]]\n * when [[TextAnnotationLeader.attachment.mode]] is set to TextPoint.\n * TopLeft : attach to a point projected onto the frame from the point on the left side of the first line of text.\n * TopRight : attach to a point projected onto the frame from the point on the right side of the first line of text.\n * BottomLeft : attach to a point projected onto the frame from the point on the left side of the last line of text.\n * BottomRight : attach to a point projected onto the frame from the point on the right side of the last line of text.\n * @beta\n */\nexport type LeaderTextPointOptions = \"TopLeft\" | \"TopRight\" | \"BottomLeft\" | \"BottomRight\"\n\n/**\n * A line that connects a [[TextAnnotation]] to a point in space relative to another element in the iModel.\n * A leader is always attached to the frame around the annotation's [[TextBlock]].\n * If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.\n * @see [[TextAnnotation.leaders]] for the leaders associated with an annotation.\n * @see [[TextStyleSettings.leader]] and [[styleOverrides]] to customize the appearance of leaders.\n * @beta\n*/\nexport interface TextAnnotationLeader {\n  /** The point where the leader starts.\n   * This is the point on another element where the leader points to */\n  startPoint: Point3d;\n  /** Describes how to attach the leader to the frame around [[textBlock]].*/\n  attachment: LeaderAttachment;\n  /** Optional intermediate points that the leader should pass through.\n   * If not specified, the leader will be a straight line from startPoint to the point on the frame.\n   * For now, intermediate points are a set of points which create additional LineSegments in the leader, but there could be intermediate shapes instead of straight LineSegments in future*/\n  intermediatePoints?: Point3d[];\n  /** Optional style overrides for the leader. If not specified, the leader will use the style defined by [[TextBlock.styleName]] as it is.\n   * If specified, these overrides will be applied to the style.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n/**\n * JSON representation of a [[TextAnnotationLeader]].\n * @beta\n */\nexport interface TextAnnotationLeaderProps {\n  /** See [[TextAnnotationLeader.startPoint]]. */\n  startPoint: XYZProps;\n  /** See [[TextAnnotationLeader.attachment]]. */\n  attachment: LeaderAttachment;\n  /** See [[TextAnnotationLeader.intermediatePoints]]. Default: no intermediate points. */\n  intermediatePoints?: XYZProps[];\n  /** See [[TextAnnotationLeader.styleOverrides]]. Default: no style overrides. */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/**\n * JSON representation of a [[TextAnnotation]].\n * @beta\n */\nexport interface TextAnnotationProps {\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\n  offset?: XYZProps;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollProps;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlockProps;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.leader]]. Default: an empty leader array  */\n  leaders?: TextAnnotationLeaderProps[];\n}\n\n/** Arguments supplied to [[TextAnnotation.create]].\n * @beta\n */\nexport interface TextAnnotationCreateArgs {\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\n  offset?: Point3d;\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\n  orientation?: YawPitchRollAngles;\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\n  textBlock?: TextBlock;\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\n  anchor?: TextAnnotationAnchor;\n  /** See [[TextAnnotation.leader]]. Default: an empty leader array  */\n  leaders?: TextAnnotationLeader[];\n}\n\n/**\n * Represents a formatted block of text positioned in 2d or 3d space.\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\n * - First, a bounding box is computed enclosing the contents of the [[textBlock].\n * - Then, an \"anchor point\" is computed based on the bounding box and the [[anchor]] property. The anchor point can be at one of the four corners of the box, in the middle of one of its four\n * edges, or in the center of the box.\n * - The [[orientation]] is applied to rotate the box around the anchor point.\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\n * @see [appendTextAnnotationGeometry]($backend) to construct the geometry and append it to an [[ElementGeometry.Builder]].\n * @beta\n */\nexport class TextAnnotation {\n  /** The rotation of the annotation.\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\n   */\n  public orientation: YawPitchRollAngles;\n  /** The formatted document. */\n  public textBlock: TextBlock;\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\n  public anchor: TextAnnotationAnchor;\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\n  public offset: Point3d;\n  /** The leaders of the text annotation. */\n  public leaders?: TextAnnotationLeader[];\n\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor, leaders?: TextAnnotationLeader[]) {\n    this.offset = offset;\n    this.orientation = angles;\n    this.textBlock = textBlock;\n    this.anchor = anchor;\n    this.leaders = leaders;\n  }\n\n  /** Creates a new TextAnnotation. */\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\n    const offset = args?.offset ?? new Point3d();\n    const angles = args?.orientation ?? new YawPitchRollAngles();\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\n    const leaders = args?.leaders ?? undefined;\n    return new TextAnnotation(offset, angles, textBlock, anchor, leaders);\n  }\n\n  /**\n   * Creates a new TextAnnotation instance from its JSON representation.\n   */\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\n    return TextAnnotation.create({\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\n      leaders: props?.leaders ? props.leaders.map((leader) => ({\n        startPoint: Point3d.fromJSON(leader.startPoint),\n        attachment: leader.attachment,\n        styleOverrides: leader.styleOverrides ?? undefined,\n        intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => Point3d.fromJSON(point)) : undefined,\n      })) : undefined,\n    });\n  }\n\n  /**\n   * Converts this annotation to its JSON representation.\n   */\n  public toJSON(): TextAnnotationProps {\n    const props: TextAnnotationProps = {};\n\n    // Even if the text block is empty, we want to record its style ID and overrides, e.g.,\n    // so the user can pick up where they left off editing it next time.\n    props.textBlock = this.textBlock.toJSON();\n\n    if (!this.offset.isZero) {\n      props.offset = this.offset.toJSON();\n    }\n\n    if (!this.orientation.isIdentity()) {\n      props.orientation = this.orientation.toJSON();\n    }\n\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\n      props.anchor = { ...this.anchor };\n    }\n\n    props.leaders = this.leaders?.map((leader) => ({\n      startPoint: leader.startPoint.toJSON(),\n      attachment: leader.attachment,\n      styleOverrides: leader.styleOverrides ?? undefined,\n      intermediatePoints: leader.intermediatePoints ? leader.intermediatePoints.map((point) => point.toJSON()) : undefined,\n    })) ?? undefined;\n\n    return props;\n  }\n\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then translated by [[offset]].\n   * The anchor point will coincide with (0, 0, 0) unless an [[offset]] is present.\n   * If a scale factor is specified, the transform will also scale the annotation by that factor. Usually, this should come from the [[Drawing]] containing the annotation.\n   * @param boundingBox A box fully containing the [[textBlock]]. This range should include the margins.\n   * @param scaleFactor A factor by which to scale the annotation. Default: 1 (no scaling).\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\n   * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n   */\n  public computeTransform(boundingBox: Range2d, scaleFactor: number = 1): Transform {\n    const anchorPt = this.computeAnchorPoint(boundingBox);\n    const matrix = this.orientation.toMatrix3d();\n\n    const transform = Transform.createIdentity();\n    const translation = Transform.createTranslation(this.offset.minus(anchorPt));\n    const scaleTransform = Transform.createScaleAboutPoint(anchorPt, scaleFactor);\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\n    transform.multiplyTransformTransform(translation, transform);\n    transform.multiplyTransformTransform(scaleTransform, transform);\n    transform.multiplyTransformTransform(rotation, transform);\n    return transform;\n  }\n\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\n   * @param boundingBox A box fully containing the [[textBlock]].\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\n   */\n  public computeAnchorPoint(boundingBox: Range2d): Point3d {\n    let x = boundingBox.low.x;\n    let y = boundingBox.high.y;\n\n    switch (this.anchor.horizontal) {\n      case \"center\":\n        x += boundingBox.xLength() / 2;\n        break;\n      case \"right\":\n        x += boundingBox.xLength();\n        break;\n    }\n\n    switch (this.anchor.vertical) {\n      case \"middle\":\n        y -= boundingBox.yLength() / 2;\n        break;\n      case \"bottom\":\n        y -= boundingBox.yLength();\n        break;\n    }\n\n    return new Point3d(x, y, 0);\n  }\n\n  /** Returns true if the leaders of this annotation are equal to the leaders of `other`. */\n  private areLeadersEqual(leadersA?: TextAnnotationLeader[], leadersB?: TextAnnotationLeader[]): boolean {\n    if (leadersA === leadersB) return true;\n    if (!leadersA || !leadersB || leadersA.length !== leadersB.length) return false;\n\n    for (let i = 0; i < leadersA.length; ++i) {\n      const a = leadersA[i];\n      const b = leadersB[i];\n\n      if (!a.startPoint.isAlmostEqual(b.startPoint)) return false;\n      if (JSON.stringify(a.attachment) !== JSON.stringify(b.attachment)) return false;\n      if (JSON.stringify(a.styleOverrides) !== JSON.stringify(b.styleOverrides)) return false;\n\n      const pointsA = a.intermediatePoints ?? [];\n      const pointsB = b.intermediatePoints ?? [];\n      if (pointsA.length !== pointsB.length) return false;\n      for (let j = 0; j < pointsA.length; ++j) {\n        if (!pointsA[j].isAlmostEqual(pointsB[j])) return false;\n      }\n    }\n    return true;\n  }\n\n  /** Returns true if this annotation is logically equivalent to `other`. */\n  public equals(other: TextAnnotation): boolean {\n    if (this.anchor.horizontal !== other.anchor.horizontal ||\n      this.anchor.vertical !== other.anchor.vertical ||\n      !this.orientation.isAlmostEqual(other.orientation) ||\n      !this.offset.isAlmostEqual(other.offset) ||\n      !this.textBlock.equals(other.textBlock))\n      return false;\n\n    return this.areLeadersEqual(this.leaders, other.leaders);\n\n  }\n}"]}