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

package/lib/cjs/annotations/TextAnnotationElement.js

@@ -0,0 +1,411 @@
+"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.AnnotationTextStyle = exports.TextAnnotation3d = exports.TextAnnotation2d = void 0;
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("../Element");
+const core_bentley_1 = require("@itwin/core-bentley");
+const TextBlockLayout_1 = require("./TextBlockLayout");
+const TextAnnotationGeometry_1 = require("./TextAnnotationGeometry");
+const ElementDrivesTextAnnotation_1 = require("./ElementDrivesTextAnnotation");
+function parseTextAnnotationData(json) {
+    if (!json)
+        return undefined;
+    try {
+        return JSON.parse(json);
+    }
+    catch {
+        return undefined;
+    }
+}
+function getElementGeometryBuilderParams(iModel, modelId, _placementProps, stringifiedAnnotationProps, categoryId, _subCategory) {
+    const annotationProps = parseTextAnnotationData(stringifiedAnnotationProps);
+    const textBlock = core_common_1.TextAnnotation.fromJSON(annotationProps).textBlock;
+    const textStyleResolver = new TextBlockLayout_1.TextStyleResolver({ textBlock, iModel, modelId });
+    const layout = (0, TextBlockLayout_1.layoutTextBlock)({ iModel, textBlock, textStyleResolver });
+    const builder = new core_common_1.ElementGeometry.Builder();
+    (0, TextAnnotationGeometry_1.appendTextAnnotationGeometry)({ layout, textStyleResolver, annotationProps: annotationProps ?? {}, builder, categoryId });
+    return { entryArray: builder.entries };
+}
+/** An element that displays textual content within a 2d model.
+ * The text is stored as a [TextAnnotation]($common) from which the element's [geometry]($docs/learning/common/GeometryStream.md) and [Placement]($common) are computed.
+ * @see [[setAnnotation]] to change the textual content.
+ * @public @preview
+ */
+class TextAnnotation2d extends Element_1.AnnotationElement2d /* implements ITextAnnotation */ {
+    /** @internal */
+    static get className() { return "TextAnnotation2d"; }
+    /** Optional string containing the data associated with the text annotation. */
+    _textAnnotationData;
+    /** Extract the textual content, if present.
+     * @see [[setAnnotation]] to change it.
+     */
+    getAnnotation() {
+        const textAnnotationProps = parseTextAnnotationData(this._textAnnotationData);
+        return textAnnotationProps ? core_common_1.TextAnnotation.fromJSON(textAnnotationProps) : undefined;
+    }
+    /** Change the textual content of the `TextAnnotation2d`.
+     * @see [[getAnnotation]] to extract the current annotation.
+     * @param annotation The new annotation
+     */
+    setAnnotation(annotation) {
+        this._textAnnotationData = annotation ? JSON.stringify(annotation.toJSON()) : undefined;
+    }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._textAnnotationData = props.textAnnotationData;
+    }
+    /** Creates a new instance of `TextAnnotation2d` from its JSON representation. */
+    static fromJSON(props, iModel) {
+        return new TextAnnotation2d(props, iModel);
+    }
+    /**
+     * Converts the current `TextAnnotation2d` instance to its JSON representation.
+     * It also computes the `elementGeometryBuilderParams` property used to create the GeometryStream.
+  
+     * @inheritdoc
+     */
+    toJSON() {
+        const props = super.toJSON();
+        props.textAnnotationData = this._textAnnotationData;
+        if (this._textAnnotationData) {
+            props.elementGeometryBuilderParams = getElementGeometryBuilderParams(this.iModel, this.model, this.placement, this._textAnnotationData, this.category);
+        }
+        return props;
+    }
+    /** Creates a new `TextAnnotation2d` instance with the specified properties.
+     * @param iModelDb The iModel.
+     * @param category The category ID for the annotation.
+     * @param model The model ID where the annotation will be placed.
+     * @param placement The placement properties for the annotation.
+     * @param textAnnotationData Optional [[TextAnnotation]] JSON representation used to create the `TextAnnotation2d`. Essentially an empty element if not provided.
+     * @param code Optional code for the element.
+     */
+    static create(iModelDb, category, model, placement, textAnnotationData, code) {
+        const props = {
+            classFullName: this.classFullName,
+            textAnnotationData: JSON.stringify(textAnnotationData),
+            placement,
+            model,
+            category,
+            code: code ?? core_common_1.Code.createEmpty(),
+        };
+        return new this(props, iModelDb);
+    }
+    /**
+     * Updates the geometry of the TextAnnotation2d on insert.
+     * @inheritdoc
+     * @beta
+     */
+    static onInsert(arg) {
+        super.onInsert(arg);
+        this.updateGeometry(arg.iModel, arg.props);
+    }
+    /**
+     * Updates the geometry of the TextAnnotation2d on update.
+     * @inheritdoc
+     * @beta
+     */
+    static onUpdate(arg) {
+        super.onUpdate(arg);
+        this.updateGeometry(arg.iModel, arg.props);
+    }
+    /**
+     * Populates the `elementGeometryBuilderParams` property in the [TextAnnotation2dProps]($common).
+     * It only does this if the `elementGeometryBuilderParams` is not already set and if there is actually a text annotation to produce geometry for.
+     */
+    static updateGeometry(iModelDb, props) {
+        if (props.elementGeometryBuilderParams || !props.textAnnotationData) {
+            return;
+        }
+        props.elementGeometryBuilderParams = getElementGeometryBuilderParams(iModelDb, props.model, props.placement ?? core_common_1.Placement2d.fromJSON(), props.textAnnotationData, props.category);
+    }
+    /**
+     * Collects reference IDs used by this `TextAnnotation2d`.
+     * @inheritdoc
+     */
+    collectReferenceIds(ids) {
+        super.collectReferenceIds(ids);
+        const annotation = this.getAnnotation();
+        if (!annotation) {
+            return;
+        }
+        if (annotation.textBlock.styleId)
+            ids.addElement(annotation.textBlock.styleId);
+    }
+    /** @internal */
+    getTextBlocks() {
+        return getTextBlocks(this);
+    }
+    /** @internal */
+    updateTextBlocks(textBlocks) {
+        return updateTextBlocks(this, textBlocks);
+    }
+    /** @internal */
+    static onInserted(arg) {
+        super.onInserted(arg);
+        ElementDrivesTextAnnotation_1.ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);
+    }
+    /** @internal */
+    static onUpdated(arg) {
+        super.onUpdated(arg);
+        ElementDrivesTextAnnotation_1.ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);
+    }
+}
+exports.TextAnnotation2d = TextAnnotation2d;
+/** An element that displays textual content within a 3d model.
+ * The text is stored as a [TextAnnotation]($common) from which the element's [geometry]($docs/learning/common/GeometryStream.md) and [Placement]($common) are computed.
+ * @see [[setAnnotation]] to change the textual content.
+ * @public @preview
+ */
+class TextAnnotation3d extends Element_1.GraphicalElement3d /* implements ITextAnnotation */ {
+    /** @internal */
+    static get className() { return "TextAnnotation3d"; }
+    /** Optional string containing the data associated with the text annotation. */
+    _textAnnotationData;
+    /** Extract the textual content, if present.
+     * @see [[setAnnotation]] to change it.
+     */
+    getAnnotation() {
+        const textAnnotationProps = parseTextAnnotationData(this._textAnnotationData);
+        return textAnnotationProps ? core_common_1.TextAnnotation.fromJSON(textAnnotationProps) : undefined;
+    }
+    /** Change the textual content of the `TextAnnotation3d`.
+     * @see [[getAnnotation]] to extract the current annotation.
+     * @param annotation The new annotation
+     */
+    setAnnotation(annotation) {
+        this._textAnnotationData = annotation ? JSON.stringify(annotation.toJSON()) : undefined;
+    }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._textAnnotationData = props.textAnnotationData;
+    }
+    /** Creates a new instance of `TextAnnotation3d` from its JSON representation. */
+    static fromJSON(props, iModel) {
+        return new TextAnnotation3d(props, iModel);
+    }
+    /**
+     * Converts the current `TextAnnotation3d` instance to its JSON representation.
+     * It also computes the `elementGeometryBuilderParams` property used to create the GeometryStream.
+     * @inheritdoc
+     */
+    toJSON() {
+        const props = super.toJSON();
+        props.textAnnotationData = this._textAnnotationData;
+        if (this._textAnnotationData) {
+            props.elementGeometryBuilderParams = getElementGeometryBuilderParams(this.iModel, this.model, this.placement, this._textAnnotationData, this.category);
+        }
+        return props;
+    }
+    /** Creates a new `TextAnnotation3d` instance with the specified properties.
+     * @param iModelDb The iModel.
+     * @param category The category ID for the annotation.
+     * @param model The model ID where the annotation will be placed.
+     * @param placement The placement properties for the annotation.
+     * @param textAnnotationData Optional [[TextAnnotation]] JSON representation used to create the `TextAnnotation3d`. Essentially an empty element if not provided.
+     * @param code Optional code for the element.
+     */
+    static create(iModelDb, category, model, placement, textAnnotationData, code) {
+        const props = {
+            classFullName: this.classFullName,
+            textAnnotationData: JSON.stringify(textAnnotationData),
+            placement,
+            model,
+            category,
+            code: code ?? core_common_1.Code.createEmpty(),
+        };
+        return new this(props, iModelDb);
+    }
+    /**
+     * Updates the geometry of the TextAnnotation3d on insert.
+     * @inheritdoc
+     * @beta
+     */
+    static onInsert(arg) {
+        super.onInsert(arg);
+        this.updateGeometry(arg.iModel, arg.props);
+    }
+    /**
+     * Updates the geometry of the TextAnnotation3d on update.
+     * @inheritdoc
+     * @beta
+     */
+    static onUpdate(arg) {
+        super.onUpdate(arg);
+        this.updateGeometry(arg.iModel, arg.props);
+    }
+    /**
+     * Populates the `elementGeometryBuilderParams` property in the [TextAnnotation3dProps]($common).
+     * It only does this if the `elementGeometryBuilderParams` is not already set and if there is actually a text annotation to produce geometry for.
+     */
+    static updateGeometry(iModelDb, props) {
+        if (props.elementGeometryBuilderParams || !props.textAnnotationData) {
+            return;
+        }
+        props.elementGeometryBuilderParams = getElementGeometryBuilderParams(iModelDb, props.model, props.placement ?? core_common_1.Placement3d.fromJSON(), props.textAnnotationData, props.category);
+    }
+    /**
+     * Collects reference IDs used by this `TextAnnotation3d`.
+     * @inheritdoc
+     */
+    collectReferenceIds(ids) {
+        super.collectReferenceIds(ids);
+        const annotation = this.getAnnotation();
+        if (!annotation) {
+            return;
+        }
+        if (annotation.textBlock.styleId)
+            ids.addElement(annotation.textBlock.styleId);
+    }
+    /** @internal */
+    getTextBlocks() {
+        return getTextBlocks(this);
+    }
+    /** @internal */
+    updateTextBlocks(textBlocks) {
+        return updateTextBlocks(this, textBlocks);
+    }
+    /** @internal */
+    static onInserted(arg) {
+        super.onInserted(arg);
+        ElementDrivesTextAnnotation_1.ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);
+    }
+    /** @internal */
+    static onUpdated(arg) {
+        super.onUpdated(arg);
+        ElementDrivesTextAnnotation_1.ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);
+    }
+}
+exports.TextAnnotation3d = TextAnnotation3d;
+function getTextBlocks(elem) {
+    const annotation = elem.getAnnotation();
+    return annotation ? [{ textBlock: annotation.textBlock, id: undefined }] : [];
+}
+function updateTextBlocks(elem, textBlocks) {
+    (0, core_bentley_1.assert)(textBlocks.length === 1);
+    (0, core_bentley_1.assert)(textBlocks[0].id === undefined);
+    const annotation = elem.getAnnotation();
+    if (!annotation) {
+        // We must obtain the TextBlockAndId from the element in the first place, so the only way we could end up here is if
+        // somebody removed the text annotation after we called getTextBlocks. That's gotta be a mistake.
+        throw new Error("Text annotation element has no text");
+    }
+    annotation.textBlock = textBlocks[0].textBlock;
+    elem.setAnnotation(annotation);
+    elem.update();
+}
+/**
+ * The definition element that holds text style information.
+ * The style is stored as a [TextStyleSettings]($common).
+ * @beta
+ */
+class AnnotationTextStyle extends Element_1.DefinitionElement {
+    /** @internal */
+    static get className() { return "AnnotationTextStyle"; }
+    /**
+     * Optional text describing the `AnnotationTextStyle`.
+     */
+    description;
+    /**
+     * The text style settings for the `AnnotationTextStyle`.
+     * @see [[TextStyleSettings]] for more information.
+     */
+    settings;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.description = props.description;
+        const settingsProps = AnnotationTextStyle.parseTextStyleSettings(props.settings);
+        this.settings = core_common_1.TextStyleSettings.fromJSON(settingsProps);
+    }
+    /**
+     * Creates a Code for an `AnnotationTextStyle` given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     *
+     * @param iModel - The IModelDb.
+     * @param definitionModelId - The ID of the DefinitionModel that contains the AnnotationTextStyle and provides the scope for its name.
+     * @param name - The AnnotationTextStyle name.
+     */
+    static createCode(iModel, definitionModelId, name) {
+        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.annotationTextStyle);
+        return new core_common_1.Code({ spec: codeSpec.id, scope: definitionModelId, value: name });
+    }
+    /**
+     * Creates a new instance of `AnnotationTextStyle` with the specified properties.
+     *
+     * @param iModelDb - The iModelDb.
+     * @param definitionModelId - The ID of the [[DefinitionModel]].
+     * @param name - The name to assign to the `AnnotationTextStyle`.
+     * @param settings - Optional text style settings used to create the `AnnotationTextStyle`. Default settings will be used if not provided.
+     * @param description - Optional description for the `AnnotationTextStyle`.
+     */
+    static create(iModelDb, definitionModelId, name, settings, description) {
+        const props = {
+            classFullName: this.classFullName,
+            model: definitionModelId,
+            code: this.createCode(iModelDb, definitionModelId, name).toJSON(),
+            description,
+            settings: JSON.stringify(settings),
+        };
+        return new this(props, iModelDb);
+    }
+    /**
+     * Converts the current `AnnotationTextStyle` instance to its JSON representation.
+     * @inheritdoc
+     */
+    toJSON() {
+        const props = super.toJSON();
+        props.description = this.description;
+        props.settings = JSON.stringify(this.settings.toJSON());
+        return props;
+    }
+    /** Creates a new instance of `AnnotationTextStyle` from its JSON representation. */
+    static fromJSON(props, iModel) {
+        return new AnnotationTextStyle(props, iModel);
+    }
+    /**
+     * Validates that the AnnotationTextStyle's settings are valid before insert.
+     * @inheritdoc
+     * @beta
+     */
+    static onInsert(arg) {
+        super.onInsert(arg);
+        this.validateSettings(arg.props);
+    }
+    /**
+     * Validates that the AnnotationTextStyle's settings are valid before update.
+     * @inheritdoc
+     * @beta
+     */
+    static onUpdate(arg) {
+        super.onUpdate(arg);
+        this.validateSettings(arg.props);
+    }
+    static validateSettings(props) {
+        const settingProps = AnnotationTextStyle.parseTextStyleSettings(props.settings);
+        if (!settingProps)
+            return;
+        const settings = core_common_1.TextStyleSettings.fromJSON(settingProps);
+        const errors = settings.getValidationErrors();
+        if (errors.length > 0) {
+            throw new Error(`Invalid AnnotationTextStyle settings: ${errors.join(", ")}`);
+        }
+    }
+    static parseTextStyleSettings(json) {
+        if (!json)
+            return undefined;
+        try {
+            return JSON.parse(json);
+        }
+        catch {
+            return undefined;
+        }
+    }
+}
+exports.AnnotationTextStyle = AnnotationTextStyle;
+//# sourceMappingURL=TextAnnotationElement.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotationElement.js","sourceRoot":"","sources":["../../../src/annotations/TextAnnotationElement.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAqY;AAErY,wCAA2H;AAC3H,sDAAyD;AACzD,uDAAuE;AACvE,qEAAwE;AACxE,+EAA4F;AAE5F,SAAS,uBAAuB,CAAC,IAAwB;IACvD,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,+BAA+B,CAAC,MAAgB,EAAE,OAAmB,EAAE,eAA+B,EAAE,0BAAkC,EAAE,UAAsB,EAAE,YAAyB;IACpM,MAAM,eAAe,GAAG,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,4BAAc,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,SAAS,CAAC;IACrE,MAAM,iBAAiB,GAAG,IAAI,mCAAiB,CAAC,EAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;IAC9E,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,IAAI,6BAAe,CAAC,OAAO,EAAE,CAAC;IAC9C,IAAA,qDAA4B,EAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,eAAe,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;IAExH,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAa,gBAAiB,SAAQ,6BAAmB,CAAC,gCAAgC;IACxF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAC7E,+EAA+E;IACvE,mBAAmB,CAAU;IAErC;;OAEG;IACI,aAAa;QAClB,MAAM,mBAAmB,GAAG,uBAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC9E,OAAO,mBAAmB,CAAC,CAAC,CAAC,4BAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,UAA0B;QAC7C,IAAI,CAAC,mBAAmB,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1F,CAAC;IAED,YAAsB,KAA4B,EAAE,MAAgB;QAClE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAED,iFAAiF;IAC1E,MAAM,CAAC,QAAQ,CAAC,KAA4B,EAAE,MAAgB;QACnE,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACa,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACtD,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACpD,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,KAAK,CAAC,4BAA4B,GAAG,+BAA+B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzJ,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,QAAoB,EAAE,KAAiB,EAAE,SAA2B,EAAE,kBAAwC,EAAE,IAAgB;QACvK,MAAM,KAAK,GAA0B;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;YACtD,SAAS;YACT,KAAK;YACL,QAAQ;YACR,IAAI,EAAE,IAAI,IAAI,kBAAI,CAAC,WAAW,EAAE;SACjC,CAAA;QACD,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAU,QAAQ,CAAC,GAAsB;QACvD,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAA8B,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAU,QAAQ,CAAC,GAAsB;QACvD,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAA8B,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,cAAc,CAAC,QAAkB,EAAE,KAA4B;QAC9E,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;YACpE,OAAO;QACT,CAAC;QAED,KAAK,CAAC,4BAA4B,GAAG,+BAA+B,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,IAAI,yBAAW,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,kBAAkB,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnL,CAAC;IAED;;;OAGG;IACgB,mBAAmB,CAAC,GAAuB;QAC5D,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO;YAC9B,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB;IACT,aAAa;QAClB,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,gBAAgB;IACT,gBAAgB,CAAC,UAA4B;QAClD,OAAO,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,UAAU,CAAC,GAAmB;QACnD,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACtB,yDAA2B,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,SAAS,CAAC,GAAmB;QAClD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACrB,yDAA2B,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;CACF;AAvID,4CAuIC;AAED;;;;GAIG;AACH,MAAa,gBAAiB,SAAQ,4BAAkB,CAAC,gCAAgC;IACvF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAC7E,+EAA+E;IACvE,mBAAmB,CAAU;IAErC;;OAEG;IACI,aAAa;QAClB,MAAM,mBAAmB,GAAG,uBAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC9E,OAAO,mBAAmB,CAAC,CAAC,CAAC,4BAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,UAA0B;QAC7C,IAAI,CAAC,mBAAmB,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1F,CAAC;IAED,YAAsB,KAA4B,EAAE,MAAgB;QAClE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAED,iFAAiF;IAC1E,MAAM,CAAC,QAAQ,CAAC,KAA4B,EAAE,MAAgB;QACnE,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACa,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACtD,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACpD,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,KAAK,CAAC,4BAA4B,GAAG,+BAA+B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzJ,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,QAAoB,EAAE,KAAiB,EAAE,SAA2B,EAAE,kBAAwC,EAAE,IAAgB;QACvK,MAAM,KAAK,GAA0B;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;YACtD,SAAS;YACT,KAAK;YACL,QAAQ;YACR,IAAI,EAAE,IAAI,IAAI,kBAAI,CAAC,WAAW,EAAE;SACjC,CAAA;QACD,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAU,QAAQ,CAAC,GAAsB;QACvD,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAA8B,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAU,QAAQ,CAAC,GAAsB;QACvD,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAA8B,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,cAAc,CAAC,QAAkB,EAAE,KAA4B;QAC9E,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;YACpE,OAAO;QACT,CAAC;QAED,KAAK,CAAC,4BAA4B,GAAG,+BAA+B,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,IAAI,yBAAW,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,kBAAkB,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnL,CAAC;IAED;;;OAGG;IACgB,mBAAmB,CAAC,GAAuB;QAC5D,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO;YAC9B,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB;IACT,aAAa;QAClB,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,gBAAgB;IACT,gBAAgB,CAAC,UAA4B;QAClD,OAAO,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,UAAU,CAAC,GAAmB;QACnD,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACtB,yDAA2B,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,SAAS,CAAC,GAAmB;QAClD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACrB,yDAA2B,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;CACF;AAtID,4CAsIC;AAED,SAAS,aAAa,CAAC,IAAyC;IAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACxC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAChF,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAyC,EAAE,UAA4B;IAC/F,IAAA,qBAAM,EAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAChC,IAAA,qBAAM,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;IAEvC,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACxC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,oHAAoH;QACpH,iGAAiG;QACjG,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,UAAU,CAAC,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE/C,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC/B,IAAI,CAAC,MAAM,EAAE,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAa,mBAAoB,SAAQ,2BAAiB;IACxD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAChF;;OAEG;IACI,WAAW,CAAU;IAC5B;;;OAGG;IACI,QAAQ,CAAoB;IAEnC,YAAsB,KAA+B,EAAE,MAAgB;QACrE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,MAAM,aAAa,GAAG,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjF,IAAI,CAAC,QAAQ,GAAG,+BAAiB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,iBAAiC,EAAE,IAAY;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,mBAAmB,CAAC,CAAC;QACvF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,QAAiC,EAAE,WAAoB;QAC3I,MAAM,KAAK,GAA6B;YACtC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE;YACjE,WAAW;YACX,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SACnC,CAAA;QACD,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACa,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA8B,CAAC;QACzD,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,QAAQ,CAAC,KAA+B,EAAE,MAAgB;QACtE,OAAO,IAAI,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAU,QAAQ,CAAC,GAAsB;QACvD,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAiC,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAU,QAAQ,CAAC,GAAsB;QACvD,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAiC,CAAC,CAAC;IAC/D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,KAA+B;QAC7D,MAAM,YAAY,GAAG,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY;YAAE,OAAO;QAC1B,MAAM,QAAQ,GAAG,+BAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QAC9C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,IAAwB;QAC5D,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;CACF;AA1GD,kDA0GC","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 Elements\n */\n\nimport { AnnotationTextStyleProps, BisCodeSpec, Code, CodeProps, CodeScopeProps, CodeSpec, ElementGeometry, ElementGeometryBuilderParams, EntityReferenceSet, Placement2d, Placement2dProps, Placement3d, Placement3dProps, PlacementProps, TextAnnotation, TextAnnotation2dProps, TextAnnotation3dProps, TextAnnotationProps, TextStyleSettings, TextStyleSettingsProps } from \"@itwin/core-common\";\nimport { IModelDb } from \"../IModelDb\";\nimport { AnnotationElement2d, DefinitionElement, GraphicalElement3d, OnElementIdArg, OnElementPropsArg } from \"../Element\";\nimport { assert, Id64String } from \"@itwin/core-bentley\";\nimport { layoutTextBlock, TextStyleResolver } from \"./TextBlockLayout\";\nimport { appendTextAnnotationGeometry } from \"./TextAnnotationGeometry\";\nimport { ElementDrivesTextAnnotation, TextBlockAndId } from \"./ElementDrivesTextAnnotation\";\n\nfunction parseTextAnnotationData(json: string | undefined): TextAnnotationProps | undefined {\n  if (!json) return undefined;\n  try {\n    return JSON.parse(json);\n  } catch {\n    return undefined;\n  }\n}\n\nfunction getElementGeometryBuilderParams(iModel: IModelDb, modelId: Id64String, _placementProps: PlacementProps, stringifiedAnnotationProps: string, categoryId: Id64String, _subCategory?: Id64String): ElementGeometryBuilderParams {\n  const annotationProps = parseTextAnnotationData(stringifiedAnnotationProps);\n  const textBlock = TextAnnotation.fromJSON(annotationProps).textBlock;\n  const textStyleResolver = new TextStyleResolver({textBlock, iModel, modelId});\n  const layout = layoutTextBlock({ iModel, textBlock, textStyleResolver });\n  const builder = new ElementGeometry.Builder();\n  appendTextAnnotationGeometry({ layout, textStyleResolver, annotationProps: annotationProps ?? {}, builder, categoryId })\n\n  return { entryArray: builder.entries };\n}\n\n/** An element that displays textual content within a 2d model.\n * The text is stored as a [TextAnnotation]($common) from which the element's [geometry]($docs/learning/common/GeometryStream.md) and [Placement]($common) are computed.\n * @see [[setAnnotation]] to change the textual content.\n * @public @preview\n */\nexport class TextAnnotation2d extends AnnotationElement2d /* implements ITextAnnotation */ {\n  /** @internal */\n  public static override get className(): string { return \"TextAnnotation2d\"; }\n  /** Optional string containing the data associated with the text annotation. */\n  private _textAnnotationData?: string;\n\n  /** Extract the textual content, if present.\n   * @see [[setAnnotation]] to change it.\n   */\n  public getAnnotation(): TextAnnotation | undefined {\n    const textAnnotationProps = parseTextAnnotationData(this._textAnnotationData);\n    return textAnnotationProps ? TextAnnotation.fromJSON(textAnnotationProps) : undefined;\n  }\n\n  /** Change the textual content of the `TextAnnotation2d`.\n   * @see [[getAnnotation]] to extract the current annotation.\n   * @param annotation The new annotation\n   */\n  public setAnnotation(annotation: TextAnnotation) {\n    this._textAnnotationData = annotation ? JSON.stringify(annotation.toJSON()) : undefined;\n  }\n\n  protected constructor(props: TextAnnotation2dProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._textAnnotationData = props.textAnnotationData;\n  }\n\n  /** Creates a new instance of `TextAnnotation2d` from its JSON representation. */\n  public static fromJSON(props: TextAnnotation2dProps, iModel: IModelDb): TextAnnotation2d {\n    return new TextAnnotation2d(props, iModel);\n  }\n\n  /**\n   * Converts the current `TextAnnotation2d` instance to its JSON representation.\n   * It also computes the `elementGeometryBuilderParams` property used to create the GeometryStream.\n\n   * @inheritdoc\n   */\n  public override toJSON(): TextAnnotation2dProps {\n    const props = super.toJSON() as TextAnnotation2dProps;\n    props.textAnnotationData = this._textAnnotationData;\n    if (this._textAnnotationData) {\n      props.elementGeometryBuilderParams = getElementGeometryBuilderParams(this.iModel, this.model, this.placement, this._textAnnotationData, this.category);\n    }\n\n    return props;\n  }\n\n  /** Creates a new `TextAnnotation2d` instance with the specified properties.\n   * @param iModelDb The iModel.\n   * @param category The category ID for the annotation.\n   * @param model The model ID where the annotation will be placed.\n   * @param placement The placement properties for the annotation.\n   * @param textAnnotationData Optional [[TextAnnotation]] JSON representation used to create the `TextAnnotation2d`. Essentially an empty element if not provided.\n   * @param code Optional code for the element.\n   */\n  public static create(iModelDb: IModelDb, category: Id64String, model: Id64String, placement: Placement2dProps, textAnnotationData?: TextAnnotationProps, code?: CodeProps): TextAnnotation2d {\n    const props: TextAnnotation2dProps = {\n      classFullName: this.classFullName,\n      textAnnotationData: JSON.stringify(textAnnotationData),\n      placement,\n      model,\n      category,\n      code: code ?? Code.createEmpty(),\n    }\n    return new this(props, iModelDb);\n  }\n\n  /**\n   * Updates the geometry of the TextAnnotation2d on insert.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override onInsert(arg: OnElementPropsArg): void {\n    super.onInsert(arg);\n    this.updateGeometry(arg.iModel, arg.props as TextAnnotation2dProps);\n  }\n\n  /**\n   * Updates the geometry of the TextAnnotation2d on update.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override onUpdate(arg: OnElementPropsArg): void {\n    super.onUpdate(arg);\n    this.updateGeometry(arg.iModel, arg.props as TextAnnotation2dProps);\n  }\n\n  /**\n   * Populates the `elementGeometryBuilderParams` property in the [TextAnnotation2dProps]($common).\n   * It only does this if the `elementGeometryBuilderParams` is not already set and if there is actually a text annotation to produce geometry for.\n   */\n  protected static updateGeometry(iModelDb: IModelDb, props: TextAnnotation2dProps): void {\n    if (props.elementGeometryBuilderParams || !props.textAnnotationData) {\n      return;\n    }\n\n    props.elementGeometryBuilderParams = getElementGeometryBuilderParams(iModelDb, props.model, props.placement ?? Placement2d.fromJSON(), props.textAnnotationData, props.category);\n  }\n\n  /**\n   * Collects reference IDs used by this `TextAnnotation2d`.\n   * @inheritdoc\n   */\n  protected override collectReferenceIds(ids: EntityReferenceSet): void {\n    super.collectReferenceIds(ids);\n    const annotation = this.getAnnotation();\n    if (!annotation) {\n      return;\n    }\n    if (annotation.textBlock.styleId)\n      ids.addElement(annotation.textBlock.styleId);\n  }\n\n  /** @internal */\n  public getTextBlocks(): Iterable<TextBlockAndId> {\n    return getTextBlocks(this);\n  }\n\n  /** @internal */\n  public updateTextBlocks(textBlocks: TextBlockAndId[]): void {\n    return updateTextBlocks(this, textBlocks);\n  }\n\n  /** @internal */\n  public static override onInserted(arg: OnElementIdArg): void {\n    super.onInserted(arg);\n    ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);\n  }\n\n  /** @internal */\n  public static override onUpdated(arg: OnElementIdArg): void {\n    super.onUpdated(arg);\n    ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);\n  }\n}\n\n/** An element that displays textual content within a 3d model.\n * The text is stored as a [TextAnnotation]($common) from which the element's [geometry]($docs/learning/common/GeometryStream.md) and [Placement]($common) are computed.\n * @see [[setAnnotation]] to change the textual content.\n * @public @preview\n */\nexport class TextAnnotation3d extends GraphicalElement3d /* implements ITextAnnotation */ {\n  /** @internal */\n  public static override get className(): string { return \"TextAnnotation3d\"; }\n  /** Optional string containing the data associated with the text annotation. */\n  private _textAnnotationData?: string;\n\n  /** Extract the textual content, if present.\n   * @see [[setAnnotation]] to change it.\n   */\n  public getAnnotation(): TextAnnotation | undefined {\n    const textAnnotationProps = parseTextAnnotationData(this._textAnnotationData);\n    return textAnnotationProps ? TextAnnotation.fromJSON(textAnnotationProps) : undefined;\n  }\n\n  /** Change the textual content of the `TextAnnotation3d`.\n   * @see [[getAnnotation]] to extract the current annotation.\n   * @param annotation The new annotation\n   */\n  public setAnnotation(annotation: TextAnnotation) {\n    this._textAnnotationData = annotation ? JSON.stringify(annotation.toJSON()) : undefined;\n  }\n\n  protected constructor(props: TextAnnotation3dProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._textAnnotationData = props.textAnnotationData;\n  }\n\n  /** Creates a new instance of `TextAnnotation3d` from its JSON representation. */\n  public static fromJSON(props: TextAnnotation3dProps, iModel: IModelDb): TextAnnotation3d {\n    return new TextAnnotation3d(props, iModel);\n  }\n\n  /**\n   * Converts the current `TextAnnotation3d` instance to its JSON representation.\n   * It also computes the `elementGeometryBuilderParams` property used to create the GeometryStream.\n   * @inheritdoc\n   */\n  public override toJSON(): TextAnnotation3dProps {\n    const props = super.toJSON() as TextAnnotation3dProps;\n    props.textAnnotationData = this._textAnnotationData;\n    if (this._textAnnotationData) {\n      props.elementGeometryBuilderParams = getElementGeometryBuilderParams(this.iModel, this.model, this.placement, this._textAnnotationData, this.category);\n    }\n\n    return props;\n  }\n\n  /** Creates a new `TextAnnotation3d` instance with the specified properties.\n   * @param iModelDb The iModel.\n   * @param category The category ID for the annotation.\n   * @param model The model ID where the annotation will be placed.\n   * @param placement The placement properties for the annotation.\n   * @param textAnnotationData Optional [[TextAnnotation]] JSON representation used to create the `TextAnnotation3d`. Essentially an empty element if not provided.\n   * @param code Optional code for the element.\n   */\n  public static create(iModelDb: IModelDb, category: Id64String, model: Id64String, placement: Placement3dProps, textAnnotationData?: TextAnnotationProps, code?: CodeProps): TextAnnotation3d {\n    const props: TextAnnotation3dProps = {\n      classFullName: this.classFullName,\n      textAnnotationData: JSON.stringify(textAnnotationData),\n      placement,\n      model,\n      category,\n      code: code ?? Code.createEmpty(),\n    }\n    return new this(props, iModelDb);\n  }\n\n  /**\n   * Updates the geometry of the TextAnnotation3d on insert.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override onInsert(arg: OnElementPropsArg): void {\n    super.onInsert(arg);\n    this.updateGeometry(arg.iModel, arg.props as TextAnnotation3dProps);\n  }\n\n  /**\n   * Updates the geometry of the TextAnnotation3d on update.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override onUpdate(arg: OnElementPropsArg): void {\n    super.onUpdate(arg);\n    this.updateGeometry(arg.iModel, arg.props as TextAnnotation3dProps);\n  }\n\n  /**\n   * Populates the `elementGeometryBuilderParams` property in the [TextAnnotation3dProps]($common).\n   * It only does this if the `elementGeometryBuilderParams` is not already set and if there is actually a text annotation to produce geometry for.\n   */\n  protected static updateGeometry(iModelDb: IModelDb, props: TextAnnotation3dProps): void {\n    if (props.elementGeometryBuilderParams || !props.textAnnotationData) {\n      return;\n    }\n\n    props.elementGeometryBuilderParams = getElementGeometryBuilderParams(iModelDb, props.model, props.placement ?? Placement3d.fromJSON(), props.textAnnotationData, props.category);\n  }\n\n  /**\n   * Collects reference IDs used by this `TextAnnotation3d`.\n   * @inheritdoc\n   */\n  protected override collectReferenceIds(ids: EntityReferenceSet): void {\n    super.collectReferenceIds(ids);\n    const annotation = this.getAnnotation();\n    if (!annotation) {\n      return;\n    }\n    if (annotation.textBlock.styleId)\n      ids.addElement(annotation.textBlock.styleId);\n  }\n\n  /** @internal */\n  public getTextBlocks(): Iterable<TextBlockAndId> {\n    return getTextBlocks(this);\n  }\n\n  /** @internal */\n  public updateTextBlocks(textBlocks: TextBlockAndId[]): void {\n    return updateTextBlocks(this, textBlocks);\n  }\n\n  /** @internal */\n  public static override onInserted(arg: OnElementIdArg): void {\n    super.onInserted(arg);\n    ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);\n  }\n\n  /** @internal */\n  public static override onUpdated(arg: OnElementIdArg): void {\n    super.onUpdated(arg);\n    ElementDrivesTextAnnotation.updateFieldDependencies(arg.id, arg.iModel);\n  }\n}\n\nfunction getTextBlocks(elem: TextAnnotation2d | TextAnnotation3d): Iterable<TextBlockAndId> {\n  const annotation = elem.getAnnotation();\n  return annotation ? [{ textBlock: annotation.textBlock, id: undefined }] : [];\n}\n\nfunction updateTextBlocks(elem: TextAnnotation2d | TextAnnotation3d, textBlocks: TextBlockAndId[]): void {\n  assert(textBlocks.length === 1);\n  assert(textBlocks[0].id === undefined);\n\n  const annotation = elem.getAnnotation();\n  if (!annotation) {\n    // We must obtain the TextBlockAndId from the element in the first place, so the only way we could end up here is if\n    // somebody removed the text annotation after we called getTextBlocks. That's gotta be a mistake.\n    throw new Error(\"Text annotation element has no text\");\n  }\n\n  annotation.textBlock = textBlocks[0].textBlock;\n\n  elem.setAnnotation(annotation);\n  elem.update();\n}\n\n/**\n * The definition element that holds text style information.\n * The style is stored as a [TextStyleSettings]($common).\n * @beta\n */\nexport class AnnotationTextStyle extends DefinitionElement {\n  /** @internal */\n  public static override get className(): string { return \"AnnotationTextStyle\"; }\n  /**\n   * Optional text describing the `AnnotationTextStyle`.\n   */\n  public description?: string;\n  /**\n   * The text style settings for the `AnnotationTextStyle`.\n   * @see [[TextStyleSettings]] for more information.\n   */\n  public settings: TextStyleSettings;\n\n  protected constructor(props: AnnotationTextStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.description = props.description;\n    const settingsProps = AnnotationTextStyle.parseTextStyleSettings(props.settings);\n    this.settings = TextStyleSettings.fromJSON(settingsProps);\n  }\n\n  /**\n   * Creates a Code for an `AnnotationTextStyle` given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   *\n   * @param iModel - The IModelDb.\n   * @param definitionModelId - The ID of the DefinitionModel that contains the AnnotationTextStyle and provides the scope for its name.\n   * @param name - The AnnotationTextStyle name.\n   */\n  public static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.annotationTextStyle);\n    return new Code({ spec: codeSpec.id, scope: definitionModelId, value: name });\n  }\n\n  /**\n   * Creates a new instance of `AnnotationTextStyle` with the specified properties.\n   *\n   * @param iModelDb - The iModelDb.\n   * @param definitionModelId - The ID of the [[DefinitionModel]].\n   * @param name - The name to assign to the `AnnotationTextStyle`.\n   * @param settings - Optional text style settings used to create the `AnnotationTextStyle`. Default settings will be used if not provided.\n   * @param description - Optional description for the `AnnotationTextStyle`.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, settings?: TextStyleSettingsProps, description?: string) {\n    const props: AnnotationTextStyleProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name).toJSON(),\n      description,\n      settings: JSON.stringify(settings),\n    }\n    return new this(props, iModelDb);\n  }\n\n  /**\n   * Converts the current `AnnotationTextStyle` instance to its JSON representation.\n   * @inheritdoc\n   */\n  public override toJSON(): AnnotationTextStyleProps {\n    const props = super.toJSON() as AnnotationTextStyleProps;\n    props.description = this.description;\n    props.settings = JSON.stringify(this.settings.toJSON());\n    return props;\n  }\n\n  /** Creates a new instance of `AnnotationTextStyle` from its JSON representation. */\n  public static fromJSON(props: AnnotationTextStyleProps, iModel: IModelDb): AnnotationTextStyle {\n    return new AnnotationTextStyle(props, iModel);\n  }\n\n  /**\n   * Validates that the AnnotationTextStyle's settings are valid before insert.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override onInsert(arg: OnElementPropsArg): void {\n    super.onInsert(arg);\n    this.validateSettings(arg.props as AnnotationTextStyleProps);\n  }\n\n  /**\n   * Validates that the AnnotationTextStyle's settings are valid before update.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override onUpdate(arg: OnElementPropsArg): void {\n    super.onUpdate(arg);\n    this.validateSettings(arg.props as AnnotationTextStyleProps);\n  }\n\n  private static validateSettings(props: AnnotationTextStyleProps): void {\n    const settingProps = AnnotationTextStyle.parseTextStyleSettings(props.settings);\n    if (!settingProps) return;\n    const settings = TextStyleSettings.fromJSON(settingProps);\n    const errors = settings.getValidationErrors();\n    if (errors.length > 0) {\n      throw new Error(`Invalid AnnotationTextStyle settings: ${errors.join(\", \")}`);\n    }\n  }\n\n  private static parseTextStyleSettings(json: string | undefined): TextStyleSettingsProps | undefined {\n    if (!json) return undefined;\n    try {\n      return JSON.parse(json);\n    } catch {\n      return undefined;\n    }\n  }\n}\n\n\n"]}

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

@@ -0,0 +1,33 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { ElementGeometry, TextAnnotationProps } from "@itwin/core-common";
+import { TextBlockLayout, TextStyleResolver } from "./TextBlockLayout";
+import { Id64String } from "@itwin/core-bentley";
+/**
+ * Properties required to compute the geometry of a text annotation.
+ * @beta
+ * @see [[appendTextAnnotationGeometry]] to append the geometry to an [[ElementGeometry.Builder]].
+ */
+export interface AppendTextAnnotationGeometryArgs {
+    /** The annotation to be drawn. Be sure to include a TextBlock with runs or no geometry will be produced. */
+    annotationProps: TextAnnotationProps;
+    /** Layout provided by calling [[layoutTextBlock]] */
+    layout: TextBlockLayout;
+    /** [[TextStyleResolver]] used to get styling and scale information for creating geometry. */
+    textStyleResolver: TextStyleResolver;
+    /** Builder that will be added to in place */
+    builder: ElementGeometry.Builder;
+    /** The category the element will belong to. This will passed into the [[GeometryParams]] */
+    categoryId: Id64String;
+    /** The optional sub-category the element will belong to. This will passed into the [[GeometryParams]] */
+    subCategoryId?: Id64String;
+    /** Whether or not to draw geometry for things like the snap points, range, and anchor point */
+    wantDebugGeometry?: boolean;
+}
+/** Constructs the TextBlockGeometry and frame geometry and appends the geometry to the provided builder.
+ * @returns true if the geometry was successfully appended.
+ * @beta
+ */
+export declare function appendTextAnnotationGeometry(props: AppendTextAnnotationGeometryArgs): boolean;
+//# sourceMappingURL=TextAnnotationGeometry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotationGeometry.d.ts","sourceRoot":"","sources":["../../../src/annotations/TextAnnotationGeometry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAY,eAAe,EAA+C,mBAAmB,EAAqB,MAAM,oBAAoB,CAAC;AACpJ,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEvE,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKvD;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC/C,4GAA4G;IAC5G,eAAe,EAAE,mBAAmB,CAAC;IACrC,qDAAqD;IACrD,MAAM,EAAE,eAAe,CAAC;IACxB,6FAA6F;IAC7F,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,6CAA6C;IAC7C,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IACjC,4FAA4F;IAC5F,UAAU,EAAE,UAAU,CAAA;IACtB,yGAAyG;IACzG,aAAa,CAAC,EAAE,UAAU,CAAA;IAC1B,+FAA+F;IAC/F,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,gCAAgC,GAAG,OAAO,CA8B7F"}

package/lib/cjs/annotations/TextAnnotationGeometry.js

@@ -0,0 +1,137 @@
+"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.appendTextAnnotationGeometry = appendTextAnnotationGeometry;
+const core_common_1 = require("@itwin/core-common");
+const core_geometry_1 = require("@itwin/core-geometry");
+const core_bentley_1 = require("@itwin/core-bentley");
+const TextBlockGeometry_1 = require("./TextBlockGeometry");
+const FrameGeometry_1 = require("./FrameGeometry");
+const LeaderGeometry_1 = require("./LeaderGeometry");
+/** Constructs the TextBlockGeometry and frame geometry and appends the geometry to the provided builder.
+ * @returns true if the geometry was successfully appended.
+ * @beta
+ */
+function appendTextAnnotationGeometry(props) {
+    const annotation = core_common_1.TextAnnotation.fromJSON(props.annotationProps);
+    const transform = annotation.computeTransform(props.layout.range, props.textStyleResolver.scaleFactor);
+    let result = true;
+    // Construct the TextBlockGeometry
+    const params = new core_common_1.GeometryParams(props.categoryId, props.subCategoryId);
+    const entries = (0, TextBlockGeometry_1.produceTextBlockGeometry)(props.layout, transform.clone());
+    result = result && props.builder.appendTextBlock(entries, params);
+    // Construct the frame geometry
+    if (props.textStyleResolver.blockSettings.frame.shape !== "none") {
+        result = result && (0, FrameGeometry_1.appendFrameToBuilder)(props.builder, props.textStyleResolver.blockSettings.frame, props.layout.range, transform.clone(), params);
+    }
+    // Construct the leader geometry
+    if (annotation.leaders && annotation.leaders.length > 0) {
+        result = result && (0, LeaderGeometry_1.appendLeadersToBuilder)(props.builder, annotation.leaders, props.layout, transform.clone(), params, props.textStyleResolver);
+    }
+    // Construct the debug geometry
+    if (props.wantDebugGeometry) {
+        result = result && debugAnchorPoint(props.builder, annotation, props.layout, transform.clone());
+        result = result && debugRunLayout(props.builder, props.layout, transform.clone());
+        if (props.textStyleResolver.blockSettings.frame.shape !== "none")
+            result = result && debugSnapPoints(props.builder, props.textStyleResolver.blockSettings, props.layout.range, transform.clone());
+    }
+    return result;
+}
+;
+/**
+ * Draws the anchor point and margins of the text annotation.
+ * The anchor point is the point around which the text rotates and is drawn as a blue x (1m by 1m).
+ * The margins are drawn as a blue box.
+ * The text range is drawn as a red box.
+ */
+function debugAnchorPoint(builder, annotation, layout, transform) {
+    const range = core_geometry_1.Range2d.fromJSON(layout.range);
+    const debugAnchorPt = transform.multiplyPoint3d(annotation.computeAnchorPoint(range));
+    // Make it blue
+    const blueLineParams = new core_common_1.GeometryParams(core_bentley_1.Id64.invalid);
+    blueLineParams.lineColor = core_common_1.ColorDef.blue;
+    let result = builder.appendGeometryParamsChange(blueLineParams);
+    // Draw a blue box to show the element's margin
+    const marginCorners = range.corners3d(true);
+    transform.multiplyPoint3dArrayInPlace(marginCorners);
+    result = result && builder.appendGeometryQuery(core_geometry_1.LineString3d.create(marginCorners));
+    // Draw a blue x to show the anchor point - Rotation occurs around this point. The x will be 1 m by 1 m.
+    result = result && builder.appendGeometryQuery(core_geometry_1.LineString3d.create(debugAnchorPt.plusXYZ(-1, -1), debugAnchorPt.plusXYZ(1, 1)));
+    result = result && builder.appendGeometryQuery(core_geometry_1.LineString3d.create(debugAnchorPt.plusXYZ(1, -1), debugAnchorPt.plusXYZ(-1, 1)));
+    // Draw a red box to show the text range
+    const redLineParams = new core_common_1.GeometryParams(core_bentley_1.Id64.invalid);
+    redLineParams.lineColor = core_common_1.ColorDef.red;
+    result = result && builder.appendGeometryParamsChange(redLineParams);
+    const rangeCorners = layout.textRange.corners3d(true);
+    transform.multiplyPoint3dArrayInPlace(rangeCorners);
+    result = result && builder.appendGeometryQuery(core_geometry_1.LineString3d.create(rangeCorners));
+    return result;
+}
+/** Draws the interval points defined by calling [[computeIntervalPoints]]. The points are shown as black dots 5x larger than the borderWeight */
+function debugSnapPoints(builder, style, range, transform) {
+    if (style.frame.shape === "none")
+        return false;
+    const points = (0, FrameGeometry_1.computeIntervalPoints)({ frame: style.frame.shape, range, transform, lineIntervalFactor: 0.5, arcIntervalFactor: 0.25 });
+    const params = new core_common_1.GeometryParams(core_bentley_1.Id64.invalid);
+    params.lineColor = core_common_1.ColorDef.black;
+    params.weight = style.frame.borderWeight * 5; // We want the dots to be bigger than the frame so we can see them.
+    params.fillDisplay = core_common_1.FillDisplay.Always;
+    const result = builder.appendGeometryParamsChange(params) && builder.appendGeometryQuery(core_geometry_1.PointString3d.create(points));
+    return result;
+}
+/**
+ * Draws debug geometry for each line and run in a TextBlockLayout.
+ *
+ * For each line and run, this function draws boxes to visualize their layout and boundaries.
+ * Different run types (e.g., text, linebreak, fraction, tab) are assigned distinct colors for clarity.
+ * This is useful for debugging text layout and alignment issues.
+ *
+ * @param builder - The geometry builder to append debug geometry to.
+ * @param layout - The text block layout containing lines and runs to visualize.
+ * @param documentTransform - The transform to apply to the entire document.
+ * @returns True if all debug geometry was successfully appended.
+ */
+function debugRunLayout(builder, layout, documentTransform) {
+    let result = true; // Tracks if all geometry was appended successfully
+    let color = core_common_1.ColorDef.black; // Current color for the run type
+    let lastColor = color; // Last color used, to minimize param changes
+    // Map run types to debug colors
+    const colors = {
+        "text": core_common_1.ColorDef.fromString("orange"),
+        "linebreak": core_common_1.ColorDef.fromString("yellow"),
+        "fraction": core_common_1.ColorDef.fromString("green"),
+        "tab": core_common_1.ColorDef.fromString("aquamarine"),
+        "field": core_common_1.ColorDef.fromString("purple"),
+    };
+    layout.lines.forEach(line => {
+        // Apply the line's offset transform
+        const lineTrans = core_geometry_1.Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);
+        documentTransform.multiplyTransformTransform(lineTrans, lineTrans);
+        line.runs.forEach(run => {
+            // Determine color for this run type
+            color = colors[run.source.type] ?? core_common_1.ColorDef.black;
+            // Only change geometry params if the color changes
+            if (!lastColor.equals(color)) {
+                const colorParams = new core_common_1.GeometryParams(core_bentley_1.Id64.invalid);
+                colorParams.lineColor = color;
+                result = result && builder.appendGeometryParamsChange(colorParams);
+                lastColor = color;
+            }
+            // Apply the line's offset to the run's offset
+            const runTrans = core_geometry_1.Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);
+            lineTrans.multiplyTransformTransform(runTrans, runTrans);
+            // Draw the enclosing range for the run
+            const runCorners = run.range.corners3d(true);
+            runTrans.multiplyPoint3dArrayInPlace(runCorners);
+            result = result && builder.appendGeometryQuery(core_geometry_1.LineString3d.create(runCorners));
+        });
+    });
+    return result;
+}
+//# sourceMappingURL=TextAnnotationGeometry.js.map