@itwin/core-backend 5.1.0-dev.9 → 5.1.1

package/lib/cjs/annotations/ElementDrivesTextAnnotation.d.ts

@@ -0,0 +1,61 @@
+/** @packageDocumentation
+ * @module Elements
+ */
+import { RelationshipProps, TextBlock } from "@itwin/core-common";
+import { ElementDrivesElement } from "../Relationship";
+import { IModelDb } from "../IModelDb";
+import { Element } from "../Element";
+import { Id64String } from "@itwin/core-bentley";
+/** Describes one of potentially many [TextBlock]($common)s hosted by an [[ITextAnnotation]].
+ * For example, a [[TextAnnotation2d]] hosts only a single text block, but an element representing a table may
+ * host one text block for each cell in the table, in which case it might use the combination of row and column
+ * as the [[id]] for each text block.
+ * @beta
+ */
+export interface TextBlockAndId {
+    /** The text block. */
+    readonly textBlock: TextBlock;
+    /** An opaque identifier that allows the [[ITextAnnotation]] to discern which of its hosted text blocks is being referred to. */
+    readonly id: unknown;
+}
+/** Interface implemented by [[GeometricElement]] subclasses whose schemas declare them to implement the mix-in `BisCore:ITextAnnotation`.
+ * Such elements may host any number of [TextBlock]($common)s. `ITextAnnotation` provides a uniform way to interact with text regardless of
+ * the type of element to which it belongs.
+ * @beta
+ */
+export interface ITextAnnotation {
+    /** Obtain a collection of all of the [TextBlock]($common)s hosted by this element. */
+    getTextBlocks(): Iterable<TextBlockAndId>;
+    /** Update the element to replace the contents of the specified [TextBlock]($common)s. */
+    updateTextBlocks(textBlocks: TextBlockAndId[]): void;
+}
+/** Returns `true` if the specified `element` implements [[ITextAnnotation]].
+ * @beta
+ */
+export declare function isITextAnnotation(element: Element): element is ITextAnnotation & Element;
+/** A relationship in which the source element hosts one or more properties that are displayed by a target [[ITextAnnotation]] element.
+ * This relationship is used to automatically update the [FieldRun]($common)s contained in the target element when the source element is modified.
+ * An [[ITextAnnotation]] element should invoke [[updateFieldDependencies]] from its [[Element.onInserted]] and [[Element.onUpdated]] functions to
+ * establish or update the relationships required for the [FieldRun]($common)s it contains.
+ * @note This relationship was introduced in version 01.00.22 of the BisCore schema. [FieldRun]($common)s created in iModels that have not been upgraded to
+ * that version or newer will not automatically update. Use [[isSupportedForIModel]] to check.
+ * @beta
+ */
+export declare class ElementDrivesTextAnnotation extends ElementDrivesElement {
+    static get className(): string;
+    /** @internal */
+    static onRootChanged(props: RelationshipProps, iModel: IModelDb): void;
+    /** @internal */
+    static onDeletedDependency(props: RelationshipProps, iModel: IModelDb): void;
+    /** Returns true if `iModel` contains a version of the BisCore schema new enough to support this relationship.
+     * If not, the schema should be updated before inserting any [FieldRun]($common)s, or those runs will not
+     * update when the source element changes.
+     */
+    static isSupportedForIModel(iModel: IModelDb): boolean;
+    /** Examines all of the [FieldRun]($common)s within the specified [[ITextAnnotation]] and ensures that the appropriate
+     * `ElementDrivesTextAnnotation` relationships exist between the fields' source elements and this target element.
+     * It also deletes any stale relationships left over from fields that were deleted or whose source elements changed.
+     */
+    static updateFieldDependencies(annotationElementId: Id64String, iModel: IModelDb): void;
+}
+//# sourceMappingURL=ElementDrivesTextAnnotation.d.ts.map

package/lib/cjs/annotations/ElementDrivesTextAnnotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementDrivesTextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotations/ElementDrivesTextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAkB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGjE;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,gIAAgI;IAChI,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;CACtB;AAKD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,sFAAsF;IACtF,aAAa,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC1C,yFAAyF;IACzF,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;CACtD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,eAAe,GAAG,OAAO,CAExF;AAED;;;;;;;GAOG;AACH,qBAAa,2BAA4B,SAAQ,oBAAoB;IACnE,WAA2B,SAAS,IAAI,MAAM,CAA0C;IAExF,gBAAgB;WACO,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAItF,gBAAgB;WACO,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAI5F;;;OAGG;WACW,oBAAoB,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO;IAK7D;;;OAGG;WACW,uBAAuB,CAAC,mBAAmB,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;CA4D/F"}

package/lib/cjs/annotations/ElementDrivesTextAnnotation.js

@@ -0,0 +1,110 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Elements
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ElementDrivesTextAnnotation = void 0;
+exports.isITextAnnotation = isITextAnnotation;
+const Relationship_1 = require("../Relationship");
+const fields_1 = require("../internal/annotations/fields");
+const core_bentley_1 = require("@itwin/core-bentley");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+// ElementDrivesTextAnnotation was introduced in this version of BisCore - iModels with earlier versions cannot support field dependencies.
+const minBisCoreVersion = new ecschema_metadata_1.ECVersion(1, 0, 22);
+/** Returns `true` if the specified `element` implements [[ITextAnnotation]].
+ * @beta
+ */
+function isITextAnnotation(element) {
+    return ["getTextBlocks", "updateTextBlocks"].every((x) => x in element && typeof element[x] === "function");
+}
+/** A relationship in which the source element hosts one or more properties that are displayed by a target [[ITextAnnotation]] element.
+ * This relationship is used to automatically update the [FieldRun]($common)s contained in the target element when the source element is modified.
+ * An [[ITextAnnotation]] element should invoke [[updateFieldDependencies]] from its [[Element.onInserted]] and [[Element.onUpdated]] functions to
+ * establish or update the relationships required for the [FieldRun]($common)s it contains.
+ * @note This relationship was introduced in version 01.00.22 of the BisCore schema. [FieldRun]($common)s created in iModels that have not been upgraded to
+ * that version or newer will not automatically update. Use [[isSupportedForIModel]] to check.
+ * @beta
+ */
+class ElementDrivesTextAnnotation extends Relationship_1.ElementDrivesElement {
+    static get className() { return "ElementDrivesTextAnnotation"; }
+    /** @internal */
+    static onRootChanged(props, iModel) {
+        (0, fields_1.updateElementFields)(props, iModel, false);
+    }
+    /** @internal */
+    static onDeletedDependency(props, iModel) {
+        (0, fields_1.updateElementFields)(props, iModel, true);
+    }
+    /** Returns true if `iModel` contains a version of the BisCore schema new enough to support this relationship.
+     * If not, the schema should be updated before inserting any [FieldRun]($common)s, or those runs will not
+     * update when the source element changes.
+     */
+    static isSupportedForIModel(iModel) {
+        const bisCoreVersion = iModel.querySchemaVersionNumbers("BisCore");
+        return undefined !== bisCoreVersion && bisCoreVersion.compare(minBisCoreVersion) >= 0;
+    }
+    /** Examines all of the [FieldRun]($common)s within the specified [[ITextAnnotation]] and ensures that the appropriate
+     * `ElementDrivesTextAnnotation` relationships exist between the fields' source elements and this target element.
+     * It also deletes any stale relationships left over from fields that were deleted or whose source elements changed.
+     */
+    static updateFieldDependencies(annotationElementId, iModel) {
+        if (!ElementDrivesTextAnnotation.isSupportedForIModel(iModel)) {
+            return;
+        }
+        const annotationElement = iModel.elements.tryGetElement(annotationElementId);
+        if (!annotationElement || !isITextAnnotation(annotationElement)) {
+            return;
+        }
+        // The native layer will allow us to insert relationships to invalid or non-existent source elements...errors will arise later. Prevent it.
+        function isValidSourceId(id) {
+            if (!core_bentley_1.Id64.isValidId64(id)) {
+                return false;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            return iModel.withPreparedStatement("SELECT CodeValue FROM BisCore.Element WHERE ECInstanceId=?", (stmt) => {
+                stmt.bindId(1, id);
+                return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step();
+            });
+        }
+        const sourceToRelationship = new Map();
+        const blocks = annotationElement.getTextBlocks();
+        for (const block of blocks) {
+            for (const paragraph of block.textBlock.paragraphs) {
+                for (const run of paragraph.runs) {
+                    if (run.type === "field" && isValidSourceId(run.propertyHost.elementId)) {
+                        sourceToRelationship.set(run.propertyHost.elementId, null);
+                    }
+                }
+            }
+        }
+        const staleRelationships = new Set();
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        annotationElement.iModel.withPreparedStatement(`SELECT ECInstanceId, SourceECInstanceId FROM BisCore.ElementDrivesTextAnnotation WHERE TargetECInstanceId=${annotationElement.id}`, (stmt) => {
+            while (core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step()) {
+                const relationshipId = stmt.getValue(0).getId();
+                const sourceId = stmt.getValue(1).getId();
+                if (sourceToRelationship.has(sourceId)) {
+                    sourceToRelationship.set(sourceId, relationshipId);
+                }
+                else {
+                    staleRelationships.add(relationshipId);
+                }
+            }
+        });
+        for (const [sourceId, relationshipId] of sourceToRelationship) {
+            if (relationshipId === null) {
+                ElementDrivesTextAnnotation.create(annotationElement.iModel, sourceId, annotationElement.id).insert();
+            }
+        }
+        for (const relationshipId of staleRelationships) {
+            const props = annotationElement.iModel.relationships.getInstanceProps("BisCore.ElementDrivesTextAnnotation", relationshipId);
+            annotationElement.iModel.relationships.deleteInstance(props);
+        }
+    }
+}
+exports.ElementDrivesTextAnnotation = ElementDrivesTextAnnotation;
+//# sourceMappingURL=ElementDrivesTextAnnotation.js.map

package/lib/cjs/annotations/ElementDrivesTextAnnotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementDrivesTextAnnotation.js","sourceRoot":"","sources":["../../../src/annotations/ElementDrivesTextAnnotation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAyCH,8CAEC;AAxCD,kDAAuD;AAGvD,2DAAqE;AACrE,sDAAiE;AACjE,gEAAqD;AAerD,2IAA2I;AAC3I,MAAM,iBAAiB,GAAG,IAAI,6BAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAclD;;GAEG;AACH,SAAgB,iBAAiB,CAAC,OAAgB;IAChD,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,OAAO,IAAI,OAAQ,OAAe,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;AACvH,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,2BAA4B,SAAQ,mCAAoB;IAC5D,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IAExF,gBAAgB;IACT,MAAM,CAAU,aAAa,CAAC,KAAwB,EAAE,MAAgB;QAC7E,IAAA,4BAAmB,EAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,mBAAmB,CAAC,KAAwB,EAAE,MAAgB;QACnF,IAAA,4BAAmB,EAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAAgB;QACjD,MAAM,cAAc,GAAG,MAAM,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,OAAO,SAAS,KAAK,cAAc,IAAI,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,uBAAuB,CAAC,mBAA+B,EAAE,MAAgB;QACrF,IAAI,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAU,mBAAmB,CAAC,CAAC;QACtF,IAAI,CAAC,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChE,OAAO;QACT,CAAC;QAED,2IAA2I;QAC3I,SAAS,eAAe,CAAC,EAAc;YACrC,IAAI,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,OAAO,KAAK,CAAC;YACf,CAAC;YAED,4DAA4D;YAC5D,OAAO,MAAM,CAAC,qBAAqB,CAAC,4DAA4D,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACnB,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAiC,CAAC;QACtE,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,EAAE,CAAC;QACjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;gBACnD,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;oBACjC,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;wBACxE,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;oBAC7D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAc,CAAC;QACjD,4DAA4D;QAC5D,iBAAiB,CAAC,MAAM,CAAC,qBAAqB,CAAC,6GAA6G,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3L,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC1C,IAAI,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,oBAAoB,EAAE,CAAC;YAC9D,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;gBAC5B,2BAA2B,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACxG,CAAC;QACH,CAAC;QAED,KAAK,MAAM,cAAc,IAAI,kBAAkB,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,qCAAqC,EAAE,cAAc,CAAC,CAAC;YAC7H,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;CACF;AAtFD,kEAsFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Elements\r\n */\r\n\r\nimport { RelationshipProps, TextBlock } from \"@itwin/core-common\";\r\nimport { ElementDrivesElement } from \"../Relationship\";\r\nimport { IModelDb } from \"../IModelDb\";\r\nimport { Element } from \"../Element\";\r\nimport { updateElementFields } from \"../internal/annotations/fields\";\r\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { ECVersion } from \"@itwin/ecschema-metadata\";\r\n\r\n/** Describes one of potentially many [TextBlock]($common)s hosted by an [[ITextAnnotation]].\r\n * For example, a [[TextAnnotation2d]] hosts only a single text block, but an element representing a table may\r\n * host one text block for each cell in the table, in which case it might use the combination of row and column\r\n * as the [[id]] for each text block.\r\n * @beta\r\n */\r\nexport interface TextBlockAndId {\r\n  /** The text block. */\r\n  readonly textBlock: TextBlock;\r\n  /** An opaque identifier that allows the [[ITextAnnotation]] to discern which of its hosted text blocks is being referred to. */\r\n  readonly id: unknown;\r\n}\r\n\r\n// ElementDrivesTextAnnotation was introduced in this version of BisCore - iModels with earlier versions cannot support field dependencies.\r\nconst minBisCoreVersion = new ECVersion(1, 0, 22);\r\n\r\n/** Interface implemented by [[GeometricElement]] subclasses whose schemas declare them to implement the mix-in `BisCore:ITextAnnotation`.\r\n * Such elements may host any number of [TextBlock]($common)s. `ITextAnnotation` provides a uniform way to interact with text regardless of\r\n * the type of element to which it belongs.\r\n * @beta\r\n */\r\nexport interface ITextAnnotation {\r\n  /** Obtain a collection of all of the [TextBlock]($common)s hosted by this element. */\r\n  getTextBlocks(): Iterable<TextBlockAndId>;\r\n  /** Update the element to replace the contents of the specified [TextBlock]($common)s. */\r\n  updateTextBlocks(textBlocks: TextBlockAndId[]): void;\r\n}\r\n\r\n/** Returns `true` if the specified `element` implements [[ITextAnnotation]].\r\n * @beta\r\n */\r\nexport function isITextAnnotation(element: Element): element is ITextAnnotation & Element {\r\n  return [\"getTextBlocks\", \"updateTextBlocks\"].every((x) => x in element && typeof (element as any)[x] === \"function\");\r\n}\r\n\r\n/** A relationship in which the source element hosts one or more properties that are displayed by a target [[ITextAnnotation]] element.\r\n * This relationship is used to automatically update the [FieldRun]($common)s contained in the target element when the source element is modified.\r\n * An [[ITextAnnotation]] element should invoke [[updateFieldDependencies]] from its [[Element.onInserted]] and [[Element.onUpdated]] functions to\r\n * establish or update the relationships required for the [FieldRun]($common)s it contains.\r\n * @note This relationship was introduced in version 01.00.22 of the BisCore schema. [FieldRun]($common)s created in iModels that have not been upgraded to\r\n * that version or newer will not automatically update. Use [[isSupportedForIModel]] to check.\r\n * @beta\r\n */\r\nexport class ElementDrivesTextAnnotation extends ElementDrivesElement {\r\n  public static override get className(): string { return \"ElementDrivesTextAnnotation\"; }\r\n  \r\n  /** @internal */\r\n  public static override onRootChanged(props: RelationshipProps, iModel: IModelDb): void {\r\n    updateElementFields(props, iModel, false);\r\n  }\r\n\r\n  /** @internal */\r\n  public static override onDeletedDependency(props: RelationshipProps, iModel: IModelDb): void {\r\n    updateElementFields(props, iModel, true);\r\n  }\r\n\r\n  /** Returns true if `iModel` contains a version of the BisCore schema new enough to support this relationship.\r\n   * If not, the schema should be updated before inserting any [FieldRun]($common)s, or those runs will not\r\n   * update when the source element changes.\r\n   */\r\n  public static isSupportedForIModel(iModel: IModelDb): boolean {\r\n    const bisCoreVersion = iModel.querySchemaVersionNumbers(\"BisCore\");\r\n    return undefined !== bisCoreVersion && bisCoreVersion.compare(minBisCoreVersion) >= 0;\r\n  }\r\n\r\n  /** Examines all of the [FieldRun]($common)s within the specified [[ITextAnnotation]] and ensures that the appropriate\r\n   * `ElementDrivesTextAnnotation` relationships exist between the fields' source elements and this target element.\r\n   * It also deletes any stale relationships left over from fields that were deleted or whose source elements changed.\r\n   */\r\n  public static updateFieldDependencies(annotationElementId: Id64String, iModel: IModelDb): void {\r\n    if (!ElementDrivesTextAnnotation.isSupportedForIModel(iModel)) {\r\n      return;\r\n    }\r\n\r\n    const annotationElement = iModel.elements.tryGetElement<Element>(annotationElementId);\r\n    if (!annotationElement || !isITextAnnotation(annotationElement)) {\r\n      return;\r\n    }\r\n\r\n    // The native layer will allow us to insert relationships to invalid or non-existent source elements...errors will arise later. Prevent it.\r\n    function isValidSourceId(id: Id64String): boolean {\r\n      if (!Id64.isValidId64(id)) {\r\n        return false;\r\n      }\r\n\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      return iModel.withPreparedStatement(\"SELECT CodeValue FROM BisCore.Element WHERE ECInstanceId=?\", (stmt) => {\r\n        stmt.bindId(1, id);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step();\r\n      });\r\n    }\r\n\r\n    const sourceToRelationship = new Map<Id64String, Id64String | null>();\r\n    const blocks = annotationElement.getTextBlocks();\r\n    for (const block of blocks) {\r\n      for (const paragraph of block.textBlock.paragraphs) {\r\n        for (const run of paragraph.runs) {\r\n          if (run.type === \"field\" && isValidSourceId(run.propertyHost.elementId)) {\r\n            sourceToRelationship.set(run.propertyHost.elementId, null);\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    const staleRelationships = new Set<Id64String>();\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    annotationElement.iModel.withPreparedStatement(`SELECT ECInstanceId, SourceECInstanceId FROM BisCore.ElementDrivesTextAnnotation WHERE TargetECInstanceId=${annotationElement.id}`, (stmt) => {\r\n      while (DbResult.BE_SQLITE_ROW === stmt.step()) {\r\n        const relationshipId = stmt.getValue(0).getId();\r\n        const sourceId = stmt.getValue(1).getId();\r\n        if (sourceToRelationship.has(sourceId)) {\r\n          sourceToRelationship.set(sourceId, relationshipId);\r\n        } else {\r\n          staleRelationships.add(relationshipId);\r\n        }\r\n      }\r\n    });\r\n\r\n    for (const [sourceId, relationshipId] of sourceToRelationship) {\r\n      if (relationshipId === null) {\r\n        ElementDrivesTextAnnotation.create(annotationElement.iModel, sourceId, annotationElement.id).insert();\r\n      }\r\n    }\r\n\r\n    for (const relationshipId of staleRelationships) {\r\n      const props = annotationElement.iModel.relationships.getInstanceProps(\"BisCore.ElementDrivesTextAnnotation\", relationshipId);\r\n      annotationElement.iModel.relationships.deleteInstance(props);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/annotations/FrameGeometry.d.ts

@@ -0,0 +1,51 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { ElementGeometry, GeometryParams, TextAnnotationFrameShape, TextFrameStyleProps } from "@itwin/core-common";
+import { Loop, Path, Point3d, Range2d, Transform } from "@itwin/core-geometry";
+/**
+ * Based on the frame style, this method will construct and append [[GeometryParams]] (for line style) and a [[Loop]] (for the frame shape) to the builder.
+ * @param builder that will be appended to in place
+ * @param frame
+ * @param range to enclose with the frame
+ * @param transform that transforms the range to world coordinates
+ * @returns `true` if any geometry was appended to the builder
+* @beta
+ */
+export declare function appendFrameToBuilder(builder: ElementGeometry.Builder, frame: TextFrameStyleProps, range: Range2d, transform: Transform, geomParams: GeometryParams): boolean;
+/**
+ * Arguments for the [[computeFrame]] method.
+ * @beta
+ */
+export interface ComputeFrameArgs {
+    /** Frame shape to be calculated */
+    frame: Exclude<TextAnnotationFrameShape, "none">;
+    /** Range to be enclosed */
+    range: Range2d;
+    /** Transform that translates and rotates the range to world coordinates */
+    transform: Transform;
+}
+/**
+ * Computes the frame geometry based on the provided frame shape and range.
+ * @returns a [Loop]($geometry) or [Path]($geometry) (if it's just a line) that represents the frame geometry
+ * @beta
+ */
+export declare function computeFrame(args: ComputeFrameArgs): Loop | Path;
+/**
+ * Arguments for the [[computeIntervalPoints]] method.
+ * @beta
+ */
+export interface ComputeIntervalPointsArgs extends ComputeFrameArgs {
+    /** A factor applied to divide each straight edge. A value of 1 will place a single point on each vertex. */
+    lineIntervalFactor?: number;
+    /** A factor applied to divide each straight edge. A value of 1 will place a single point on each vertex. */
+    arcIntervalFactor?: number;
+}
+/**
+ * Computes points along the edges of the frame geometry based on the provided frame shape, range, and interval factors.
+ * These can be used for snapping or attaching leaders.
+ * @returns an array of [[Point3d]] that represent the points along the edges of the frame geometry. Returns `undefined` if the loop created by `computeFrame` is empty.
+ * @beta
+ */
+export declare function computeIntervalPoints({ frame, range, transform, lineIntervalFactor, arcIntervalFactor }: ComputeIntervalPointsArgs): Point3d[] | undefined;
+//# sourceMappingURL=FrameGeometry.d.ts.map

package/lib/cjs/annotations/FrameGeometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameGeometry.d.ts","sourceRoot":"","sources":["../../../src/annotations/FrameGeometry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAA4B,eAAe,EAAe,cAAc,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC3J,OAAO,EAA0C,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAY,MAAM,sBAAsB,CAAC;AAEjI;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,GAAG,OAAO,CAsC5K;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mCAAmC;IACnC,KAAK,EAAE,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACjD,2BAA2B;IAC3B,KAAK,EAAE,OAAO,CAAC;IACf,2EAA2E;IAC3E,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,GAAG,IAAI,CAehE;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE,4GAA4G;IAC5G,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,4GAA4G;IAC5G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,kBAAwB,EAAE,iBAAwB,EAAE,EAAE,yBAAyB,GAAG,OAAO,EAAE,GAAG,SAAS,CAWvK"}

package/lib/cjs/annotations/FrameGeometry.js

@@ -0,0 +1,249 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appendFrameToBuilder = appendFrameToBuilder;
+exports.computeFrame = computeFrame;
+exports.computeIntervalPoints = computeIntervalPoints;
+const core_common_1 = require("@itwin/core-common");
+const core_geometry_1 = require("@itwin/core-geometry");
+/**
+ * Based on the frame style, this method will construct and append [[GeometryParams]] (for line style) and a [[Loop]] (for the frame shape) to the builder.
+ * @param builder that will be appended to in place
+ * @param frame
+ * @param range to enclose with the frame
+ * @param transform that transforms the range to world coordinates
+ * @returns `true` if any geometry was appended to the builder
+* @beta
+ */
+function appendFrameToBuilder(builder, frame, range, transform, geomParams) {
+    if (frame.shape === "none" || frame.shape === undefined) {
+        return false;
+    }
+    const params = geomParams.clone();
+    if (frame.fill === "none" || frame.fill === undefined) {
+        params.fillDisplay = core_common_1.FillDisplay.Never;
+    }
+    else if (frame.fill === "background") {
+        params.backgroundFill = core_common_1.BackgroundFill.Solid;
+        params.fillDisplay = core_common_1.FillDisplay.Blanking;
+    }
+    else if (frame.fill !== "subcategory") {
+        params.fillColor = core_common_1.ColorDef.fromJSON(frame.fill);
+        params.lineColor = params.fillColor;
+        params.fillDisplay = core_common_1.FillDisplay.Blanking;
+    }
+    if (frame.border !== "subcategory") {
+        params.lineColor = core_common_1.ColorDef.fromJSON(frame.border);
+        params.weight = frame.borderWeight;
+    }
+    const frameGeometry = computeFrame({ frame: frame.shape, range, transform });
+    if (!builder.appendGeometryParamsChange(params) || !builder.appendGeometryQuery(frameGeometry)) {
+        return false;
+    }
+    // The tile generator does not produce an outline for shapes with blanking fill. We must add the outline separately.
+    if (params.fillDisplay === core_common_1.FillDisplay.Blanking) {
+        const outlineParams = params.clone();
+        outlineParams.fillDisplay = core_common_1.FillDisplay.Never;
+        if (!builder.appendGeometryParamsChange(outlineParams) || !builder.appendGeometryQuery(frameGeometry)) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Computes the frame geometry based on the provided frame shape and range.
+ * @returns a [Loop]($geometry) or [Path]($geometry) (if it's just a line) that represents the frame geometry
+ * @beta
+ */
+function computeFrame(args) {
+    switch (args.frame) {
+        case "line": return computeLine(args.range, args.transform);
+        case "rectangle": return computeRectangle(args.range, args.transform);
+        case "circle": return computeCircle(args.range, args.transform);
+        case "equilateralTriangle": return computeTriangle(args.range, args.transform);
+        case "diamond": return computeDiamond(args.range, args.transform);
+        case "square": return computeSquare(args.range, args.transform);
+        case "pentagon": return computePolygon(5, args.range, args.transform, 90);
+        case "hexagon": return computePolygon(6, args.range, args.transform);
+        case "octagon": return computePolygon(8, args.range, args.transform, 180 / 8); // or pi/8 in radians
+        case "capsule": return computeCapsule(args.range, args.transform);
+        case "roundedRectangle": return computeRoundedRectangle(args.range, args.transform);
+        default: return computeRectangle(args.range, args.transform);
+    }
+}
+/**
+ * Computes points along the edges of the frame geometry based on the provided frame shape, range, and interval factors.
+ * These can be used for snapping or attaching leaders.
+ * @returns an array of [[Point3d]] that represent the points along the edges of the frame geometry. Returns `undefined` if the loop created by `computeFrame` is empty.
+ * @beta
+ */
+function computeIntervalPoints({ frame, range, transform, lineIntervalFactor = 0.5, arcIntervalFactor = 0.25 }) {
+    const points = [];
+    const curves = computeFrame({ frame, range, transform }).collectCurvePrimitives(undefined, false, true);
+    curves.forEach((curve) => {
+        const end = curve instanceof core_geometry_1.Arc3d ? arcIntervalFactor : lineIntervalFactor;
+        for (let interval = 0; interval <= 1; interval += end) {
+            points.push(curve.fractionToPoint(interval));
+        }
+    });
+    return points;
+}
+/** Line - currently just adds an underline. Once we have leaders, this method may change. */
+const computeLine = (range, transform) => {
+    const points = [core_geometry_1.Point3d.create(range.low.x, range.low.y), core_geometry_1.Point3d.create(range.high.x, range.low.y)];
+    const frame = core_geometry_1.LineString3d.createPoints(points);
+    return core_geometry_1.Path.create(frame.cloneTransformed(transform));
+};
+/** Rectangle - simplest frame */
+const computeRectangle = (range, transform) => {
+    const points = range.corners3d(true);
+    const frame = core_geometry_1.LineString3d.createPoints(points);
+    return core_geometry_1.Loop.create(frame.cloneTransformed(transform));
+};
+/** Rounded Rectangle: each corner will be turned into an arc with the radius of the arc being the @param radiusFactor * the height (yLength) of the range */
+const computeRoundedRectangle = (range, transform, radiusFactor = 0.25) => {
+    const radius = range.yLength() * radiusFactor * Math.sqrt(2);
+    // We're going to circumscribe the range with our rounded edges. The corners of the range will fall on 45 degree angles.
+    const radiusOffsetFactor = range.yLength() * radiusFactor;
+    // These values are the origins of the circles
+    const inLeft = range.low.x + radiusOffsetFactor;
+    const inRight = range.high.x - radiusOffsetFactor;
+    const inBottom = range.low.y + radiusOffsetFactor;
+    const inTop = range.high.y - radiusOffsetFactor;
+    // These values exist on the circles
+    const exLeft = inLeft - radius;
+    const exRight = inRight + radius;
+    const exBottom = inBottom - radius;
+    const exTop = inTop + radius;
+    const q1 = core_geometry_1.AngleSweep.createStartEndDegrees(0, 90);
+    const q2 = core_geometry_1.AngleSweep.createStartEndDegrees(90, 180);
+    const q3 = core_geometry_1.AngleSweep.createStartEndDegrees(180, 270);
+    const q4 = core_geometry_1.AngleSweep.createStartEndDegrees(270, 360);
+    const curves = [
+        core_geometry_1.LineString3d.create([core_geometry_1.Point3d.create(inRight, exTop), core_geometry_1.Point3d.create(inLeft, exTop)]), // top
+        core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.create(inLeft, inTop), radius, q2), // top left
+        core_geometry_1.LineString3d.create([core_geometry_1.Point3d.create(exLeft, inTop), core_geometry_1.Point3d.create(exLeft, inBottom)]), // left
+        core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.create(inLeft, inBottom), radius, q3), // bottom left
+        core_geometry_1.LineString3d.create([core_geometry_1.Point3d.create(inLeft, exBottom), core_geometry_1.Point3d.create(inRight, exBottom)]), // bottom
+        core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.create(inRight, inBottom), radius, q4), // bottom right
+        core_geometry_1.LineString3d.create([core_geometry_1.Point3d.create(exRight, inBottom), core_geometry_1.Point3d.create(exRight, inTop)]), // right
+        core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.create(inRight, inTop), radius, q1), // top right
+    ];
+    return core_geometry_1.Loop.createArray(curves.map((curve) => curve.cloneTransformed(transform)));
+};
+/** Circle */
+const computeCircle = (range, transform) => {
+    const radius = range.low.distance(range.high) / 2;
+    const frame = core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.createFrom(range.center), radius);
+    return core_geometry_1.Loop.create(frame.cloneTransformed(transform));
+};
+/** Equilateral Triangle */
+const computeTriangle = (range, transform) => {
+    const xLength = range.xLength();
+    const yLength = range.yLength();
+    const center = range.center;
+    const points = [];
+    const magnitude = (xLength > yLength) ? (xLength * Math.sqrt(3) + yLength) / 2 : (yLength * Math.sqrt(3) + xLength) / 2;
+    const v1 = core_geometry_1.Vector2d.create(0, magnitude);
+    const vectors = [
+        v1, // top
+        v1.rotateXY(core_geometry_1.Angle.createDegrees(120)), // left
+        v1.rotateXY(core_geometry_1.Angle.createDegrees(240)), // right
+        v1 // top
+    ];
+    vectors.forEach((v) => {
+        points.push(core_geometry_1.Point3d.create(center.x + v.x, center.y + v.y));
+    });
+    const frame = core_geometry_1.LineString3d.createPoints(points);
+    return core_geometry_1.Loop.create(frame.cloneTransformed(transform));
+};
+/** Diamond (square rotated 45 degrees) */
+const computeDiamond = (range, transform) => {
+    const offset = (range.xLength() + range.yLength()) / 2;
+    const center = range.center;
+    const points = [
+        core_geometry_1.Point3d.createFrom({ x: center.x, y: center.y + offset }), // top
+        core_geometry_1.Point3d.createFrom({ x: center.x + offset, y: center.y }), // right
+        core_geometry_1.Point3d.createFrom({ x: center.x, y: center.y - offset }), // bottom
+        core_geometry_1.Point3d.createFrom({ x: center.x - offset, y: center.y }), // left
+        core_geometry_1.Point3d.createFrom({ x: center.x, y: center.y + offset }), // top
+    ];
+    const frame = core_geometry_1.LineString3d.createPoints(points);
+    return core_geometry_1.Loop.create(frame.cloneTransformed(transform));
+};
+/** Square */
+const computeSquare = (range, transform) => {
+    // Extend range
+    const xLength = range.xLength() / 2;
+    const yLength = range.yLength() / 2;
+    const center = range.center;
+    if (xLength > yLength) {
+        range.extendPoint({ x: center.x, y: center.y + xLength });
+        range.extendPoint({ x: center.x, y: center.y - xLength });
+    }
+    else {
+        range.extendPoint({ x: center.x + yLength, y: center.y });
+        range.extendPoint({ x: center.x - yLength, y: center.y });
+    }
+    const points = range.corners3d(true);
+    const frame = core_geometry_1.LineString3d.createPoints(points);
+    return core_geometry_1.Loop.create(frame.cloneTransformed(transform));
+};
+/** Capsule (or pill shape) */
+const computeCapsule = (range, transform) => {
+    const height = range.yLength();
+    const radius = height * (Math.sqrt(2) / 2);
+    // We're going to circumscribe the range with our rounded edges. The corners of the range will fall on 45 degree angles.
+    const radiusOffsetFactor = height / 2;
+    // These values are the origins of the circles
+    const inLeft = range.low.x + radiusOffsetFactor;
+    const inRight = range.high.x - radiusOffsetFactor;
+    const inBottom = range.low.y + radiusOffsetFactor;
+    const inTop = range.high.y - radiusOffsetFactor;
+    // These values exist on the circles
+    const exBottom = inBottom - radius;
+    const exTop = inTop + radius;
+    const leftHalfCircle = core_geometry_1.AngleSweep.createStartEndDegrees(90, 270);
+    const rightHalfCircle = core_geometry_1.AngleSweep.createStartEndDegrees(-90, 90);
+    const curves = [
+        core_geometry_1.LineString3d.create([core_geometry_1.Point3d.create(inRight, exTop), core_geometry_1.Point3d.create(inLeft, exTop)]), // top
+        core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.create(inLeft, range.center.y), radius, leftHalfCircle), // left
+        core_geometry_1.LineString3d.create([core_geometry_1.Point3d.create(inLeft, exBottom), core_geometry_1.Point3d.create(inRight, exBottom)]), // bottom
+        core_geometry_1.Arc3d.createXY(core_geometry_1.Point3d.create(inRight, range.center.y), radius, rightHalfCircle), // right
+    ];
+    return core_geometry_1.Loop.createArray(curves.map((curve) => curve.cloneTransformed(transform)));
+};
+/** Regular polygon with n sides: note, this a generic method that can be used to create any polygon, but the frame will not be as tightly encapsulating. */
+const computePolygon = (n, range, transform, angleOffset = 0) => {
+    // These are math terms: cspell:ignore inradius circumradius
+    if (n < 3)
+        throw new Error("A polygon must have at least 3 sides.");
+    // We're assuming the polygon is a regular polygon with `n` sides.
+    // The center of the polygon is the center of the range.
+    const center = range.center;
+    // The inradius is the distance from the center to the midpoint of each side of the polygon. On our range, this coincides with the distance from the center to one of its corners.
+    const inradius = range.low.distance(range.high) / 2;
+    // The circumradius is the distance from the center to each vertex of the polygon.
+    const circumradius = inradius / Math.cos(Math.PI / n);
+    // The exterior angles add up to 360 degrees.
+    const angleIncrement = 360 / n;
+    const vertices = [];
+    // Add a point for each vertex
+    for (let i = 0; i < n; i++) {
+        const angle = core_geometry_1.Angle.createDegrees(i * angleIncrement + angleOffset);
+        const vector = core_geometry_1.Vector2d.createPolar(circumradius, angle);
+        vertices.push(core_geometry_1.Point3d.create(center.x + vector.x, center.y + vector.y));
+    }
+    // Close the polygon
+    vertices.push(vertices[0]);
+    // Finally compute the loop!
+    const frame = core_geometry_1.LineString3d.createPoints(vertices);
+    return core_geometry_1.Loop.create(frame.cloneTransformed(transform));
+};
+//# sourceMappingURL=FrameGeometry.js.map

package/lib/cjs/annotations/FrameGeometry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameGeometry.js","sourceRoot":"","sources":["../../../src/annotations/FrameGeometry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAeH,oDAsCC;AAoBD,oCAeC;AAmBD,sDAWC;AAnHD,oDAA2J;AAC3J,wDAAiI;AAEjI;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAC,OAAgC,EAAE,KAA0B,EAAE,KAAc,EAAE,SAAoB,EAAE,UAA0B;IACjK,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;IAElC,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACtD,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC,KAAK,CAAC;IACzC,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACvC,MAAM,CAAC,cAAc,GAAG,4BAAc,CAAC,KAAK,CAAC;QAC7C,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC,QAAQ,CAAC;IAC5C,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACxC,MAAM,CAAC,SAAS,GAAG,sBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QACpC,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC,QAAQ,CAAC;IAC5C,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,aAAa,EAAE,CAAC;QACnC,MAAM,CAAC,SAAS,GAAG,sBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IACrC,CAAC;IAED,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7E,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/F,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oHAAoH;IACpH,IAAI,MAAM,CAAC,WAAW,KAAK,yBAAW,CAAC,QAAQ,EAAE,CAAC;QAChD,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;QACrC,aAAa,CAAC,WAAW,GAAG,yBAAW,CAAC,KAAK,CAAC;QAC9C,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC;YACtG,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAeD;;;;GAIG;AACH,SAAgB,YAAY,CAAC,IAAsB;IACjD,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,KAAK,MAAM,CAAC,CAAC,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5D,KAAK,WAAW,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACtE,KAAK,QAAQ,CAAC,CAAC,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChE,KAAK,qBAAqB,CAAC,CAAC,OAAO,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/E,KAAK,SAAS,CAAC,CAAC,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAClE,KAAK,QAAQ,CAAC,CAAC,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChE,KAAK,UAAU,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC1E,KAAK,SAAS,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACrE,KAAK,SAAS,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,qBAAqB;QACpG,KAAK,SAAS,CAAC,CAAC,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAClE,KAAK,kBAAkB,CAAC,CAAC,OAAO,uBAAuB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACpF,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAaD;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,kBAAkB,GAAG,GAAG,EAAE,iBAAiB,GAAG,IAAI,EAA6B;IAC9I,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,sBAAsB,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAExG,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,MAAM,GAAG,GAAG,KAAK,YAAY,qBAAK,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,kBAAkB,CAAC;QAC5E,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,IAAI,CAAC,EAAE,QAAQ,IAAI,GAAG,EAAE,CAAC;YACtD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,6FAA6F;AAC7F,MAAM,WAAW,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IACjE,MAAM,MAAM,GAAG,CAAC,uBAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACrG,MAAM,KAAK,GAAG,4BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAEhD,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAED,iCAAiC;AACjC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IACtE,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,4BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAEhD,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAED,6JAA6J;AAC7J,MAAM,uBAAuB,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAE,eAAuB,IAAI,EAAQ,EAAE;IAC1G,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7D,wHAAwH;IACxH,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC;IAE1D,8CAA8C;IAC9C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,kBAAkB,CAAC;IAChD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,kBAAkB,CAAC;IAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,kBAAkB,CAAC;IAClD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,kBAAkB,CAAA;IAE/C,oCAAoC;IACpC,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,MAAM,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;IACjC,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACnC,MAAM,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7B,MAAM,EAAE,GAAG,0BAAU,CAAC,qBAAqB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACnD,MAAM,EAAE,GAAG,0BAAU,CAAC,qBAAqB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACrD,MAAM,EAAE,GAAG,0BAAU,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,EAAE,GAAG,0BAAU,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAGtD,MAAM,MAAM,GAAG;QACb,4BAAY,CAAC,MAAM,CAAC,CAAC,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAU,MAAM;QACpG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAqC,WAAW;QACzG,4BAAY,CAAC,MAAM,CAAC,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAQ,OAAO;QACrG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAkC,cAAc;QAC5G,4BAAY,CAAC,MAAM,CAAC,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAI,SAAS;QACvG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAiC,eAAe;QAC7G,4BAAY,CAAC,MAAM,CAAC,CAAC,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAM,QAAQ;QACtG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAoC,YAAY;KAC3G,CAAC;IAEF,OAAO,oBAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;AACnF,CAAC,CAAA;AAGD,aAAa;AACb,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IACnE,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IACvE,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAED,2BAA2B;AAC3B,MAAM,eAAe,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IAErE,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAChC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,MAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,MAAM,SAAS,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAExH,MAAM,EAAE,GAAG,wBAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG;QACd,EAAE,EAAsC,MAAM;QAC9C,EAAE,CAAC,QAAQ,CAAC,qBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAG,OAAO;QAC/C,EAAE,CAAC,QAAQ,CAAC,qBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAG,QAAQ;QAChD,EAAE,CAAsC,MAAM;KAC/C,CAAC;IAEF,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACpB,MAAM,CAAC,IAAI,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,4BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAEhD,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAED,0CAA0C;AAC1C,MAAM,cAAc,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IACpE,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAE5B,MAAM,MAAM,GAAG;QACb,uBAAO,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,MAAM;QACjE,uBAAO,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ;QACnE,uBAAO,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,SAAS;QACpE,uBAAO,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO;QAClE,uBAAO,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,MAAM;KAClE,CAAC;IAEF,MAAM,KAAK,GAAG,4BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAEhD,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAED,aAAa;AACb,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IAEnE,eAAe;IACf,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,IAAI,OAAO,GAAG,OAAO,EAAE,CAAC;QACtB,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;QAC1D,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1D,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,4BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAEhD,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAED,8BAA8B;AAC9B,MAAM,cAAc,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAQ,EAAE;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAE3C,wHAAwH;IACxH,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,CAAC;IAEtC,8CAA8C;IAC9C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,kBAAkB,CAAC;IAChD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,kBAAkB,CAAC;IAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,kBAAkB,CAAC;IAClD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,kBAAkB,CAAA;IAE/C,oCAAoC;IACpC,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACnC,MAAM,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7B,MAAM,cAAc,GAAG,0BAAU,CAAC,qBAAqB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACjE,MAAM,eAAe,GAAG,0BAAU,CAAC,qBAAqB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAElE,MAAM,MAAM,GAAG;QACb,4BAAY,CAAC,MAAM,CAAC,CAAC,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAQ,MAAM;QAClG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAc,OAAO;QACnG,4BAAY,CAAC,MAAM,CAAC,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS;QACrG,qBAAK,CAAC,QAAQ,CAAC,uBAAO,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAY,QAAQ;KACrG,CAAC;IAEF,OAAO,oBAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACpF,CAAC,CAAA;AAED,4JAA4J;AAC5J,MAAM,cAAc,GAAG,CAAC,CAAS,EAAE,KAAc,EAAE,SAAoB,EAAE,cAAsB,CAAC,EAAQ,EAAE;IACxG,4DAA4D;IAC5D,IAAI,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAEpE,kEAAkE;IAClE,wDAAwD;IACxD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,kLAAkL;IAClL,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,kFAAkF;IAClF,MAAM,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAEtD,6CAA6C;IAC7C,MAAM,cAAc,GAAG,GAAG,GAAG,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,8BAA8B;IAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,qBAAK,CAAC,aAAa,CAAC,CAAC,GAAG,cAAc,GAAG,WAAW,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,wBAAQ,CAAC,WAAW,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACzD,QAAQ,CAAC,IAAI,CAAC,uBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3B,4BAA4B;IAC5B,MAAM,KAAK,GAAG,4BAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAClD,OAAO,oBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ElementGeometry\r\n */\r\n\r\n\r\nimport { BackgroundFill, ColorDef, ElementGeometry, FillDisplay, GeometryParams, TextAnnotationFrameShape, TextFrameStyleProps } from \"@itwin/core-common\";\r\nimport { Angle, AngleSweep, Arc3d, LineString3d, Loop, Path, Point3d, Range2d, Transform, Vector2d } from \"@itwin/core-geometry\";\r\n\r\n/**\r\n * Based on the frame style, this method will construct and append [[GeometryParams]] (for line style) and a [[Loop]] (for the frame shape) to the builder.\r\n * @param builder that will be appended to in place\r\n * @param frame\r\n * @param range to enclose with the frame\r\n * @param transform that transforms the range to world coordinates\r\n * @returns `true` if any geometry was appended to the builder\r\n* @beta\r\n */\r\nexport function appendFrameToBuilder(builder: ElementGeometry.Builder, frame: TextFrameStyleProps, range: Range2d, transform: Transform, geomParams: GeometryParams): boolean {\r\n  if (frame.shape === \"none\" || frame.shape === undefined) {\r\n    return false;\r\n  }\r\n\r\n  const params = geomParams.clone();\r\n\r\n  if (frame.fill === \"none\" || frame.fill === undefined) {\r\n    params.fillDisplay = FillDisplay.Never;\r\n  } else if (frame.fill === \"background\") {\r\n    params.backgroundFill = BackgroundFill.Solid;\r\n    params.fillDisplay = FillDisplay.Blanking;\r\n  } else if (frame.fill !== \"subcategory\") {\r\n    params.fillColor = ColorDef.fromJSON(frame.fill);\r\n    params.lineColor = params.fillColor;\r\n    params.fillDisplay = FillDisplay.Blanking;\r\n  }\r\n\r\n  if (frame.border !== \"subcategory\") {\r\n    params.lineColor = ColorDef.fromJSON(frame.border);\r\n    params.weight = frame.borderWeight;\r\n  }\r\n\r\n  const frameGeometry = computeFrame({ frame: frame.shape, range, transform });\r\n  if (!builder.appendGeometryParamsChange(params) || !builder.appendGeometryQuery(frameGeometry)) {\r\n    return false;\r\n  }\r\n\r\n  // The tile generator does not produce an outline for shapes with blanking fill. We must add the outline separately.\r\n  if (params.fillDisplay === FillDisplay.Blanking) {\r\n    const outlineParams = params.clone();\r\n    outlineParams.fillDisplay = FillDisplay.Never;\r\n    if (!builder.appendGeometryParamsChange(outlineParams) || !builder.appendGeometryQuery(frameGeometry)) {\r\n      return false;\r\n    }\r\n  }\r\n\r\n  return true;\r\n}\r\n\r\n/**\r\n * Arguments for the [[computeFrame]] method.\r\n * @beta\r\n */\r\nexport interface ComputeFrameArgs {\r\n  /** Frame shape to be calculated */\r\n  frame: Exclude<TextAnnotationFrameShape, \"none\">;\r\n  /** Range to be enclosed */\r\n  range: Range2d;\r\n  /** Transform that translates and rotates the range to world coordinates */\r\n  transform: Transform;\r\n}\r\n\r\n/**\r\n * Computes the frame geometry based on the provided frame shape and range.\r\n * @returns a [Loop]($geometry) or [Path]($geometry) (if it's just a line) that represents the frame geometry\r\n * @beta\r\n */\r\nexport function computeFrame(args: ComputeFrameArgs): Loop | Path {\r\n  switch (args.frame) {\r\n    case \"line\": return computeLine(args.range, args.transform);\r\n    case \"rectangle\": return computeRectangle(args.range, args.transform);\r\n    case \"circle\": return computeCircle(args.range, args.transform);\r\n    case \"equilateralTriangle\": return computeTriangle(args.range, args.transform);\r\n    case \"diamond\": return computeDiamond(args.range, args.transform);\r\n    case \"square\": return computeSquare(args.range, args.transform);\r\n    case \"pentagon\": return computePolygon(5, args.range, args.transform, 90);\r\n    case \"hexagon\": return computePolygon(6, args.range, args.transform);\r\n    case \"octagon\": return computePolygon(8, args.range, args.transform, 180 / 8); // or pi/8 in radians\r\n    case \"capsule\": return computeCapsule(args.range, args.transform);\r\n    case \"roundedRectangle\": return computeRoundedRectangle(args.range, args.transform);\r\n    default: return computeRectangle(args.range, args.transform);\r\n  }\r\n}\r\n\r\n/**\r\n * Arguments for the [[computeIntervalPoints]] method.\r\n * @beta\r\n */\r\nexport interface ComputeIntervalPointsArgs extends ComputeFrameArgs {\r\n  /** A factor applied to divide each straight edge. A value of 1 will place a single point on each vertex. */\r\n  lineIntervalFactor?: number;\r\n  /** A factor applied to divide each straight edge. A value of 1 will place a single point on each vertex. */\r\n  arcIntervalFactor?: number;\r\n}\r\n\r\n/**\r\n * Computes points along the edges of the frame geometry based on the provided frame shape, range, and interval factors.\r\n * These can be used for snapping or attaching leaders.\r\n * @returns an array of [[Point3d]] that represent the points along the edges of the frame geometry. Returns `undefined` if the loop created by `computeFrame` is empty.\r\n * @beta\r\n */\r\nexport function computeIntervalPoints({ frame, range, transform, lineIntervalFactor = 0.5, arcIntervalFactor = 0.25 }: ComputeIntervalPointsArgs): Point3d[] | undefined {\r\n  const points: Point3d[] = [];\r\n  const curves = computeFrame({ frame, range, transform }).collectCurvePrimitives(undefined, false, true);\r\n\r\n  curves.forEach((curve) => {\r\n    const end = curve instanceof Arc3d ? arcIntervalFactor : lineIntervalFactor;\r\n    for (let interval = 0; interval <= 1; interval += end) {\r\n      points.push(curve.fractionToPoint(interval));\r\n    }\r\n  });\r\n  return points;\r\n}\r\n\r\n/** Line - currently just adds an underline. Once we have leaders, this method may change. */\r\nconst computeLine = (range: Range2d, transform: Transform): Path => {\r\n  const points = [Point3d.create(range.low.x, range.low.y), Point3d.create(range.high.x, range.low.y)];\r\n  const frame = LineString3d.createPoints(points);\r\n\r\n  return Path.create(frame.cloneTransformed(transform));\r\n}\r\n\r\n/** Rectangle - simplest frame */\r\nconst computeRectangle = (range: Range2d, transform: Transform): Loop => {\r\n  const points = range.corners3d(true);\r\n  const frame = LineString3d.createPoints(points);\r\n\r\n  return Loop.create(frame.cloneTransformed(transform));\r\n}\r\n\r\n/** Rounded Rectangle: each corner will be turned into an arc with the radius of the arc being the @param radiusFactor * the height (yLength) of the range */\r\nconst computeRoundedRectangle = (range: Range2d, transform: Transform, radiusFactor: number = 0.25): Loop => {\r\n  const radius = range.yLength() * radiusFactor * Math.sqrt(2);\r\n  // We're going to circumscribe the range with our rounded edges. The corners of the range will fall on 45 degree angles.\r\n  const radiusOffsetFactor = range.yLength() * radiusFactor;\r\n\r\n  // These values are the origins of the circles\r\n  const inLeft = range.low.x + radiusOffsetFactor;\r\n  const inRight = range.high.x - radiusOffsetFactor;\r\n  const inBottom = range.low.y + radiusOffsetFactor;\r\n  const inTop = range.high.y - radiusOffsetFactor\r\n\r\n  // These values exist on the circles\r\n  const exLeft = inLeft - radius;\r\n  const exRight = inRight + radius;\r\n  const exBottom = inBottom - radius;\r\n  const exTop = inTop + radius;\r\n\r\n  const q1 = AngleSweep.createStartEndDegrees(0, 90);\r\n  const q2 = AngleSweep.createStartEndDegrees(90, 180);\r\n  const q3 = AngleSweep.createStartEndDegrees(180, 270);\r\n  const q4 = AngleSweep.createStartEndDegrees(270, 360);\r\n\r\n\r\n  const curves = [\r\n    LineString3d.create([Point3d.create(inRight, exTop), Point3d.create(inLeft, exTop)]),         // top\r\n    Arc3d.createXY(Point3d.create(inLeft, inTop), radius, q2),                                    // top left\r\n    LineString3d.create([Point3d.create(exLeft, inTop), Point3d.create(exLeft, inBottom)]),       // left\r\n    Arc3d.createXY(Point3d.create(inLeft, inBottom), radius, q3),                                 // bottom left\r\n    LineString3d.create([Point3d.create(inLeft, exBottom), Point3d.create(inRight, exBottom)]),   // bottom\r\n    Arc3d.createXY(Point3d.create(inRight, inBottom), radius, q4),                                // bottom right\r\n    LineString3d.create([Point3d.create(exRight, inBottom), Point3d.create(exRight, inTop)]),     // right\r\n    Arc3d.createXY(Point3d.create(inRight, inTop), radius, q1),                                   // top right\r\n  ];\r\n\r\n  return Loop.createArray(curves.map((curve) => curve.cloneTransformed(transform)))\r\n}\r\n\r\n\r\n/** Circle */\r\nconst computeCircle = (range: Range2d, transform: Transform): Loop => {\r\n  const radius = range.low.distance(range.high) / 2;\r\n  const frame = Arc3d.createXY(Point3d.createFrom(range.center), radius);\r\n  return Loop.create(frame.cloneTransformed(transform));\r\n}\r\n\r\n/** Equilateral Triangle */\r\nconst computeTriangle = (range: Range2d, transform: Transform): Loop => {\r\n\r\n  const xLength = range.xLength();\r\n  const yLength = range.yLength();\r\n  const center = range.center;\r\n  const points: Point3d[] = [];\r\n\r\n  const magnitude = (xLength > yLength) ? (xLength * Math.sqrt(3) + yLength) / 2 : (yLength * Math.sqrt(3) + xLength) / 2;\r\n\r\n  const v1 = Vector2d.create(0, magnitude);\r\n  const vectors = [\r\n    v1,                                     // top\r\n    v1.rotateXY(Angle.createDegrees(120)),  // left\r\n    v1.rotateXY(Angle.createDegrees(240)),  // right\r\n    v1                                      // top\r\n  ];\r\n\r\n  vectors.forEach((v) => {\r\n    points.push(Point3d.create(center.x + v.x, center.y + v.y));\r\n  });\r\n\r\n  const frame = LineString3d.createPoints(points);\r\n\r\n  return Loop.create(frame.cloneTransformed(transform));\r\n}\r\n\r\n/** Diamond (square rotated 45 degrees) */\r\nconst computeDiamond = (range: Range2d, transform: Transform): Loop => {\r\n  const offset = (range.xLength() + range.yLength()) / 2;\r\n  const center = range.center;\r\n\r\n  const points = [\r\n    Point3d.createFrom({ x: center.x, y: center.y + offset }), // top\r\n    Point3d.createFrom({ x: center.x + offset, y: center.y }), // right\r\n    Point3d.createFrom({ x: center.x, y: center.y - offset }), // bottom\r\n    Point3d.createFrom({ x: center.x - offset, y: center.y }), // left\r\n    Point3d.createFrom({ x: center.x, y: center.y + offset }), // top\r\n  ];\r\n\r\n  const frame = LineString3d.createPoints(points);\r\n\r\n  return Loop.create(frame.cloneTransformed(transform));\r\n}\r\n\r\n/** Square */\r\nconst computeSquare = (range: Range2d, transform: Transform): Loop => {\r\n\r\n  // Extend range\r\n  const xLength = range.xLength() / 2;\r\n  const yLength = range.yLength() / 2;\r\n  const center = range.center;\r\n  if (xLength > yLength) {\r\n    range.extendPoint({ x: center.x, y: center.y + xLength });\r\n    range.extendPoint({ x: center.x, y: center.y - xLength });\r\n  } else {\r\n    range.extendPoint({ x: center.x + yLength, y: center.y });\r\n    range.extendPoint({ x: center.x - yLength, y: center.y });\r\n  }\r\n\r\n  const points = range.corners3d(true);\r\n  const frame = LineString3d.createPoints(points);\r\n\r\n  return Loop.create(frame.cloneTransformed(transform));\r\n}\r\n\r\n/** Capsule (or pill shape) */\r\nconst computeCapsule = (range: Range2d, transform: Transform): Loop => {\r\n  const height = range.yLength();\r\n  const radius = height * (Math.sqrt(2) / 2);\r\n\r\n  // We're going to circumscribe the range with our rounded edges. The corners of the range will fall on 45 degree angles.\r\n  const radiusOffsetFactor = height / 2;\r\n\r\n  // These values are the origins of the circles\r\n  const inLeft = range.low.x + radiusOffsetFactor;\r\n  const inRight = range.high.x - radiusOffsetFactor;\r\n  const inBottom = range.low.y + radiusOffsetFactor;\r\n  const inTop = range.high.y - radiusOffsetFactor\r\n\r\n  // These values exist on the circles\r\n  const exBottom = inBottom - radius;\r\n  const exTop = inTop + radius;\r\n\r\n  const leftHalfCircle = AngleSweep.createStartEndDegrees(90, 270);\r\n  const rightHalfCircle = AngleSweep.createStartEndDegrees(-90, 90);\r\n\r\n  const curves = [\r\n    LineString3d.create([Point3d.create(inRight, exTop), Point3d.create(inLeft, exTop)]),       // top\r\n    Arc3d.createXY(Point3d.create(inLeft, range.center.y), radius, leftHalfCircle),             // left\r\n    LineString3d.create([Point3d.create(inLeft, exBottom), Point3d.create(inRight, exBottom)]), // bottom\r\n    Arc3d.createXY(Point3d.create(inRight, range.center.y), radius, rightHalfCircle),           // right\r\n  ];\r\n\r\n  return Loop.createArray(curves.map((curve) => curve.cloneTransformed(transform)));\r\n}\r\n\r\n/** Regular polygon with n sides: note, this a generic method that can be used to create any polygon, but the frame will not be as tightly encapsulating. */\r\nconst computePolygon = (n: number, range: Range2d, transform: Transform, angleOffset: number = 0): Loop => {\r\n  // These are math terms: cspell:ignore inradius circumradius\r\n  if (n < 3) throw new Error(\"A polygon must have at least 3 sides.\");\r\n\r\n  // We're assuming the polygon is a regular polygon with `n` sides.\r\n  // The center of the polygon is the center of the range.\r\n  const center = range.center;\r\n  // The inradius is the distance from the center to the midpoint of each side of the polygon. On our range, this coincides with the distance from the center to one of its corners.\r\n  const inradius = range.low.distance(range.high) / 2;\r\n  // The circumradius is the distance from the center to each vertex of the polygon.\r\n  const circumradius = inradius / Math.cos(Math.PI / n);\r\n\r\n  // The exterior angles add up to 360 degrees.\r\n  const angleIncrement = 360 / n;\r\n  const vertices: Point3d[] = [];\r\n\r\n  // Add a point for each vertex\r\n  for (let i = 0; i < n; i++) {\r\n    const angle = Angle.createDegrees(i * angleIncrement + angleOffset);\r\n    const vector = Vector2d.createPolar(circumradius, angle);\r\n    vertices.push(Point3d.create(center.x + vector.x, center.y + vector.y));\r\n  }\r\n\r\n  // Close the polygon\r\n  vertices.push(vertices[0]);\r\n\r\n  // Finally compute the loop!\r\n  const frame = LineString3d.createPoints(vertices);\r\n  return Loop.create(frame.cloneTransformed(transform));\r\n};"]}

package/lib/cjs/annotations/LeaderGeometry.d.ts

@@ -0,0 +1,53 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { ElementGeometry, GeometryParams, TextAnnotationLeader } from "@itwin/core-common";
+import { Loop, Path, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
+import { TextBlockLayout, TextStyleResolver } from "./TextBlockLayout";
+/**
+ * Constructs and appends leader lines and their terminators to the provided geometry builder for a text annotation.
+ *
+ * This function processes an array of `TextAnnotationLeader` objects, computes their attachment points
+ * relative to a text frame (or a default rectangular frame if none is provided), and appends the leader
+ * line and terminator geometry to the builder. It also applies color overrides if specified
+ * in the leader's style overrides.
+ *
+ * @param builder - The geometry builder to which the leader geometries will be appended.
+ * @param leaders - An array of leader properties.
+ * @param layout - The layout information for the text block, including its range.
+ * @param transform - The transform to apply to the frame and leader geometry.
+ * @param params - The geometry parameters, such as color, to use for the leader lines.
+ * @param frame - (Optional) The style properties for the text frame. If not provided or set to "none", a default rectangle is used.
+ * @returns `true` if at least one leader with a terminator was successfully appended; otherwise, `false`.
+ * @beta
+ */
+export declare function appendLeadersToBuilder(builder: ElementGeometry.Builder, leaders: TextAnnotationLeader[], layout: TextBlockLayout, transform: Transform, params: GeometryParams, textStyleResolver: TextStyleResolver): boolean;
+/**
+ * Computes the direction vector for an "elbow" for leader based on the attachment point and a frame curve.
+ * The elbow direction is determined by whether the attachment point is closer to the left or right side of the frame.
+ * If the computed elbow would be tangent to the frame at the intersection, no elbow direction is returned.
+ *
+ * @param attachmentPoint - The point where the leader attaches.
+ * @param frameCurve - The frame curve (either a Loop or Path) to which the leader is attached.
+ * @param elbowLength - The length of the elbow segment to be created.
+ * @returns The direction vector for the elbow, or `undefined` if the elbow would be tangent to the frame.
+ * @beta
+ */
+export declare function computeElbowDirection(attachmentPoint: Point3d, frameCurve: Loop | Path, elbowLength: number): Vector3d | undefined;
+/**
+ * Computes the attachment point for a leader line on a text annotation frame.
+ *
+ * The attachment point is determined based on the leader's attachment mode:
+ * - `"Nearest"`: Finds the closest point on the frame curve to the leader's start point.
+ * - `"KeyPoint"`: Uses a specific curve segment and fraction along that segment to determine the point.
+ * - `"TextPoint"`: Calculates a point on the text layout (top/bottom, left/right) and projects it onto the frame curve.
+ *
+ * @param leader - The leader props.
+ * @param frameCurve - The curve (Loop or Path) representing the annotation frame.
+ * @param textLayout - The layout information for the text block.
+ * @param transform - The transform applied to the text layout.
+ * @returns The computed attachment point as a `Point3d`, or `undefined` if it cannot be determined.
+ * @beta
+ */
+export declare function computeLeaderAttachmentPoint(leader: TextAnnotationLeader, frameCurve: Loop | Path, textLayout: TextBlockLayout, transform: Transform): Point3d | undefined;
+//# sourceMappingURL=LeaderGeometry.d.ts.map

package/lib/cjs/annotations/LeaderGeometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LeaderGeometry.d.ts","sourceRoot":"","sources":["../../../src/annotations/LeaderGeometry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAY,eAAe,EAAE,cAAc,EAAE,oBAAoB,EAAuC,MAAM,oBAAoB,CAAC;AAC1I,OAAO,EAA2C,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEzH,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,OAAO,CAmE9N;AAGD;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,GAAG,IAAI,EAAE,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CA4BlI;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,oBAAoB,EAC5B,UAAU,EAAE,IAAI,GAAG,IAAI,EACvB,UAAU,EAAE,eAAe,EAC3B,SAAS,EAAE,SAAS,GACnB,OAAO,GAAG,SAAS,CAyCrB"}