@itwin/core-backend 4.6.0-dev.9 → 4.6.0

package/lib/cjs/TextAnnotationGeometry.d.ts

@@ -0,0 +1,28 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { TextAnnotation, TextBlockGeometryProps } from "@itwin/core-common";
+import { ComputeRangesForTextLayout, FindFontId, FindTextStyle } from "./TextAnnotationLayout";
+import { IModelDb } from "./IModelDb";
+/** Arguments supplied to [[produceTextAnnotationGeometry]].
+ * @beta
+ */
+export interface ProduceTextAnnotationGeometryArgs {
+    /** The annotation from which to produce the geometry. */
+    annotation: TextAnnotation;
+    /** The iModel from which to obtain fonts and text styles. */
+    iModel: IModelDb;
+    /** @internal chiefly for tests */
+    computeTextRange?: ComputeRangesForTextLayout;
+    /** @internal chiefly for tests */
+    findTextStyle?: FindTextStyle;
+    /** @internal chiefly for tests */
+    findFontId?: FindFontId;
+}
+/** Produce a geometric representation of a text annotation.
+ * The result can be supplied to [GeometryStreamBuilder.appendTextBlock]($common).
+ * @see [[TextAnnotation2d.setAnnotation]] and [[TextAnnotation3d.setAnnotation]] to update the annotation, geometry, and placement of an annotation element.
+ * @beta
+ */
+export declare function produceTextAnnotationGeometry(args: ProduceTextAnnotationGeometryArgs): TextBlockGeometryProps;
+//# sourceMappingURL=TextAnnotationGeometry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotationGeometry.d.ts","sourceRoot":"","sources":["../../src/TextAnnotationGeometry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAY,cAAc,EAAE,sBAAsB,EAA2D,MAAM,oBAAoB,CAAC;AAC/I,OAAO,EAAE,0BAA0B,EAAE,UAAU,EAAE,aAAa,EAA+C,MAAM,wBAAwB,CAAC;AAG5I,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AA8JtC;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,yDAAyD;IACzD,UAAU,EAAE,cAAc,CAAC;IAC3B,6DAA6D;IAC7D,MAAM,EAAE,QAAQ,CAAC;IACjB,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;IAC9C,kCAAkC;IAClC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,kCAAkC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,iCAAiC,GAAG,sBAAsB,CAW7G"}

package/lib/cjs/TextAnnotationGeometry.js

@@ -0,0 +1,154 @@
+"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.produceTextAnnotationGeometry = void 0;
+const core_common_1 = require("@itwin/core-common");
+const TextAnnotationLayout_1 = require("./TextAnnotationLayout");
+const core_geometry_1 = require("@itwin/core-geometry");
+const core_bentley_1 = require("@itwin/core-bentley");
+function setColor(color, context) {
+    if (color !== context.curColor) {
+        context.curColor = color;
+        context.entries.push({ color });
+    }
+}
+function createTextString(text, run, origin) {
+    (0, core_bentley_1.assert)(text.length > 0);
+    const { lineHeight, widthFactor, isBold, isItalic, isUnderlined } = run.style;
+    return new core_common_1.TextString({
+        text,
+        font: run.fontId,
+        height: lineHeight,
+        widthFactor,
+        bold: isBold,
+        italic: isItalic,
+        underline: isUnderlined,
+        origin,
+    });
+}
+function processTextRun(run, transform, context) {
+    (0, core_bentley_1.assert)(run.source.type === "text");
+    const text = run.source.content.substring(run.charOffset, run.charOffset + run.numChars);
+    if (text.length === 0) {
+        return;
+    }
+    const ts = createTextString(text, run);
+    if ("none" !== run.source.baselineShift) {
+        const isSub = "subscript" === run.source.baselineShift;
+        const offsetFactor = run.style[isSub ? "subScriptOffsetFactor" : "superScriptOffsetFactor"];
+        const scale = run.style[isSub ? "subScriptScale" : "superScriptScale"];
+        ts.origin.y += offsetFactor * ts.height;
+        ts.height *= scale;
+    }
+    ts.transformInPlace(transform);
+    setColor(run.style.color, context);
+    context.entries.push({ text: ts });
+}
+function createFractionTextString(text, run, origin, transform) {
+    const ts = createTextString(text, run, origin);
+    (0, core_bentley_1.assert)(undefined !== ts.widthFactor);
+    ts.height *= run.style.stackedFractionScale;
+    ts.transformInPlace(transform);
+    return ts;
+}
+function processFractionRun(run, transform, context) {
+    const source = run.source;
+    (0, core_bentley_1.assert)(source.type === "fraction");
+    if (source.numerator.length === 0 && source.denominator.length === 0) {
+        return;
+    }
+    (0, core_bentley_1.assert)(undefined !== run.numeratorRange && undefined !== run.denominatorRange);
+    const fontSize = new core_geometry_1.Vector2d(run.style.lineHeight * run.style.widthFactor, run.style.lineHeight);
+    fontSize.scale(run.style.stackedFractionScale, fontSize);
+    const numeratorOffset = new core_geometry_1.Point3d(run.numeratorRange.low.x, run.numeratorRange.low.y, 0);
+    const denominatorOffset = new core_geometry_1.Point3d(run.denominatorRange.low.x, run.denominatorRange.low.y, 0);
+    setColor(run.style.color, context);
+    if (source.numerator.length > 0) {
+        context.entries.push({ text: createFractionTextString(source.numerator, run, numeratorOffset, transform) });
+    }
+    const numeratorRange = core_geometry_1.Range2d.fromJSON(run.numeratorRange);
+    const denominatorRange = core_geometry_1.Range2d.fromJSON(run.denominatorRange);
+    let separator;
+    if (run.style.stackedFractionType === "horizontal") {
+        const fractionWidth = Math.max(numeratorRange.xLength(), denominatorRange.xLength());
+        const y = 1.25 * denominatorRange.yLength();
+        separator = core_geometry_1.LineSegment3d.createXYXY(0, y, fractionWidth, y);
+    }
+    else {
+        const p0 = new core_geometry_1.Point3d(denominatorRange.low.x - fontSize.x / 2, denominatorRange.low.y + fontSize.y * (1 / 3), 0);
+        const p1 = new core_geometry_1.Point3d(p0.x + fontSize.x, p0.y + fontSize.y * 1.5, 0);
+        separator = core_geometry_1.LineSegment3d.createCapture(p0, p1);
+    }
+    separator.tryTransformInPlace(transform);
+    context.entries.push({
+        separator: {
+            startPoint: separator.point0Ref.toJSON(),
+            endPoint: separator.point1Ref.toJSON(),
+        },
+    });
+    if (source.denominator.length > 0) {
+        context.entries.push({ text: createFractionTextString(source.denominator, run, denominatorOffset, transform) });
+    }
+}
+function produceTextBlockGeometry(layout, documentTransform, debugAnchorPt) {
+    const context = { entries: [] };
+    for (const line of layout.lines) {
+        const lineTrans = core_geometry_1.Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);
+        for (const run of line.runs) {
+            if ("linebreak" === run.source.type) {
+                continue;
+            }
+            const runTrans = core_geometry_1.Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);
+            lineTrans.multiplyTransformTransform(runTrans, runTrans);
+            documentTransform.multiplyTransformTransform(runTrans, runTrans);
+            if ("text" === run.source.type) {
+                processTextRun(run, runTrans, context);
+            }
+            else {
+                processFractionRun(run, runTrans, context);
+            }
+        }
+    }
+    if (debugAnchorPt) {
+        // Draw lines representing the horizontal and vertical ranges, intersecting at the anchor point.
+        context.entries.push({
+            color: core_common_1.ColorDef.red.toJSON(),
+        });
+        context.entries.push({
+            separator: {
+                startPoint: [layout.range.low.x, debugAnchorPt.y, 0],
+                endPoint: [layout.range.high.x, debugAnchorPt.y, 0],
+            },
+        });
+        context.entries.push({
+            separator: {
+                startPoint: [debugAnchorPt.x, layout.range.low.y, 0],
+                endPoint: [debugAnchorPt.x, layout.range.high.y, 0],
+            },
+        });
+    }
+    return { entries: context.entries };
+}
+/** Produce a geometric representation of a text annotation.
+ * The result can be supplied to [GeometryStreamBuilder.appendTextBlock]($common).
+ * @see [[TextAnnotation2d.setAnnotation]] and [[TextAnnotation3d.setAnnotation]] to update the annotation, geometry, and placement of an annotation element.
+ * @beta
+ */
+function produceTextAnnotationGeometry(args) {
+    const layout = (0, TextAnnotationLayout_1.layoutTextBlock)({
+        ...args,
+        textBlock: args.annotation.textBlock,
+    });
+    const transform = args.annotation.computeDocumentTransform(layout.range);
+    const debugAnchorPointAndRange = false;
+    const anchorPoint = debugAnchorPointAndRange ? args.annotation.computeAnchorPoint(layout.range) : undefined;
+    return produceTextBlockGeometry(layout, transform, anchorPoint);
+}
+exports.produceTextAnnotationGeometry = produceTextAnnotationGeometry;
+//# sourceMappingURL=TextAnnotationGeometry.js.map

package/lib/cjs/TextAnnotationGeometry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotationGeometry.js","sourceRoot":"","sources":["../../src/TextAnnotationGeometry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAA+I;AAC/I,iEAA4I;AAC5I,wDAA4F;AAC5F,sDAA6C;AAQ7C,SAAS,QAAQ,CAAC,KAAqB,EAAE,OAAwB;IAC/D,IAAI,KAAK,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC;QACzB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY,EAAE,GAAc,EAAE,MAAgB;IACtE,IAAA,qBAAM,EAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC;IAE9E,OAAO,IAAI,wBAAU,CAAC;QACpB,IAAI;QACJ,IAAI,EAAE,GAAG,CAAC,MAAM;QAChB,MAAM,EAAE,UAAU;QAClB,WAAW;QACX,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,QAAQ;QAChB,SAAS,EAAE,YAAY;QACvB,MAAM;KACP,CAAC,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CAAC,GAAc,EAAE,SAAoB,EAAE,OAAwB;IACpF,IAAA,qBAAM,EAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;IACnC,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,IAAI,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,WAAW,KAAK,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;QACvD,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC;QAC5F,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAEvE,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,YAAY,GAAG,EAAE,CAAC,MAAM,CAAC;QACxC,EAAE,CAAC,MAAM,IAAI,KAAK,CAAC;IACrB,CAAC;IAED,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/B,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAY,EAAE,GAAc,EAAE,MAAe,EAAE,SAAoB;IACnG,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC/C,IAAA,qBAAM,EAAC,SAAS,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;IAErC,EAAE,CAAC,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC;IAE5C,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/B,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAc,EAAE,SAAoB,EAAE,OAAwB;IACxF,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAC1B,IAAA,qBAAM,EAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAEnC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrE,OAAO;IACT,CAAC;IAED,IAAA,qBAAM,EAAC,SAAS,KAAK,GAAG,CAAC,cAAc,IAAI,SAAS,KAAK,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAE/E,MAAM,QAAQ,GAAG,IAAI,wBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;IAEzD,MAAM,eAAe,GAAG,IAAI,uBAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3F,MAAM,iBAAiB,GAAG,IAAI,uBAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEjG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEnC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,wBAAwB,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED,MAAM,cAAc,GAAG,uBAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC5D,MAAM,gBAAgB,GAAG,uBAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAEhE,IAAI,SAAwB,CAAC;IAC7B,IAAI,GAAG,CAAC,KAAK,CAAC,mBAAmB,KAAK,YAAY,EAAE,CAAC;QACnD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;QACrF,MAAM,CAAC,GAAG,IAAI,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC5C,SAAS,GAAG,6BAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;SAAM,CAAC;QACN,MAAM,EAAE,GAAG,IAAI,uBAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClH,MAAM,EAAE,GAAG,IAAI,uBAAO,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;QACtE,SAAS,GAAG,6BAAa,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAEzC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACnB,SAAS,EAAE;YACT,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE;YACxC,QAAQ,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE;SACvC;KACF,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,wBAAwB,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,EAAC,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;IACjH,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAuB,EAAE,iBAA4B,EAAE,aAAuB;IAC9G,MAAM,OAAO,GAAoB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,yBAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1G,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,WAAW,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACpC,SAAS;YACX,CAAC;YAED,MAAM,QAAQ,GAAG,yBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC/F,SAAS,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACzD,iBAAiB,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACjE,IAAI,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC/B,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,gGAAgG;QAChG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;YACnB,KAAK,EAAE,sBAAQ,CAAC,GAAG,CAAC,MAAM,EAAE;SAC7B,CAAC,CAAC;QAEH,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;YACnB,SAAS,EAAE;gBACT,UAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpD,QAAQ,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;aACpD;SACF,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;YACnB,SAAS,EAAE;gBACT,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpD,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;aACpD;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;AACtC,CAAC;AAkBD;;;;GAIG;AACH,SAAgB,6BAA6B,CAAC,IAAuC;IACnF,MAAM,MAAM,GAAG,IAAA,sCAAe,EAAC;QAC7B,GAAG,IAAI;QACP,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS;KACrC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEzE,MAAM,wBAAwB,GAAG,KAAK,CAAC;IACvC,MAAM,WAAW,GAAG,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5G,OAAO,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;AAClE,CAAC;AAXD,sEAWC","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 ElementGeometry\n */\n\nimport { ColorDef, TextAnnotation, TextBlockGeometryProps, TextBlockGeometryPropsEntry, TextString, TextStyleColor } from \"@itwin/core-common\";\nimport { ComputeRangesForTextLayout, FindFontId, FindTextStyle, layoutTextBlock, RunLayout, TextBlockLayout } from \"./TextAnnotationLayout\";\nimport { LineSegment3d, Point3d, Range2d, Transform, Vector2d } from \"@itwin/core-geometry\";\nimport { assert } from \"@itwin/core-bentley\";\nimport { IModelDb } from \"./IModelDb\";\n\ninterface GeometryContext {\n  curColor?: TextStyleColor;\n  entries: TextBlockGeometryPropsEntry[];\n}\n\nfunction setColor(color: TextStyleColor, context: GeometryContext): void {\n  if (color !== context.curColor) {\n    context.curColor = color;\n    context.entries.push({ color });\n  }\n}\n\nfunction createTextString(text: string, run: RunLayout, origin?: Point3d): TextString {\n  assert(text.length > 0);\n\n  const { lineHeight, widthFactor, isBold, isItalic, isUnderlined } = run.style;\n\n  return new TextString({\n    text,\n    font: run.fontId,\n    height: lineHeight,\n    widthFactor,\n    bold: isBold,\n    italic: isItalic,\n    underline: isUnderlined,\n    origin,\n  });\n}\n\nfunction processTextRun(run: RunLayout, transform: Transform, context: GeometryContext): void {\n  assert(run.source.type === \"text\");\n  const text = run.source.content.substring(run.charOffset, run.charOffset + run.numChars);\n  if (text.length === 0) {\n    return;\n  }\n\n  const ts = createTextString(text, run);\n  if (\"none\" !== run.source.baselineShift) {\n    const isSub = \"subscript\" === run.source.baselineShift;\n    const offsetFactor = run.style[isSub ? \"subScriptOffsetFactor\" : \"superScriptOffsetFactor\"];\n    const scale = run.style[isSub ? \"subScriptScale\" : \"superScriptScale\"];\n\n    ts.origin.y += offsetFactor * ts.height;\n    ts.height *= scale;\n  }\n\n  ts.transformInPlace(transform);\n\n  setColor(run.style.color, context);\n  context.entries.push({ text: ts});\n}\n\nfunction createFractionTextString(text: string, run: RunLayout, origin: Point3d, transform: Transform): TextString {\n  const ts = createTextString(text, run, origin);\n  assert(undefined !== ts.widthFactor);\n\n  ts.height *= run.style.stackedFractionScale;\n\n  ts.transformInPlace(transform);\n\n  return ts;\n}\n\nfunction processFractionRun(run: RunLayout, transform: Transform, context: GeometryContext): void {\n  const source = run.source;\n  assert(source.type === \"fraction\");\n\n  if (source.numerator.length === 0 && source.denominator.length === 0) {\n    return;\n  }\n\n  assert(undefined !== run.numeratorRange && undefined !== run.denominatorRange);\n\n  const fontSize = new Vector2d(run.style.lineHeight * run.style.widthFactor, run.style.lineHeight);\n  fontSize.scale(run.style.stackedFractionScale, fontSize);\n\n  const numeratorOffset = new Point3d(run.numeratorRange.low.x, run.numeratorRange.low.y, 0);\n  const denominatorOffset = new Point3d(run.denominatorRange.low.x, run.denominatorRange.low.y, 0);\n\n  setColor(run.style.color, context);\n\n  if (source.numerator.length > 0) {\n    context.entries.push({ text: createFractionTextString(source.numerator, run, numeratorOffset, transform) });\n  }\n\n  const numeratorRange = Range2d.fromJSON(run.numeratorRange);\n  const denominatorRange = Range2d.fromJSON(run.denominatorRange);\n\n  let separator: LineSegment3d;\n  if (run.style.stackedFractionType === \"horizontal\") {\n    const fractionWidth = Math.max(numeratorRange.xLength(), denominatorRange.xLength());\n    const y = 1.25 * denominatorRange.yLength();\n    separator = LineSegment3d.createXYXY(0, y, fractionWidth, y);\n  } else {\n    const p0 = new Point3d(denominatorRange.low.x - fontSize.x / 2, denominatorRange.low.y + fontSize.y * (1 / 3), 0);\n    const p1 = new Point3d(p0.x + fontSize.x, p0.y + fontSize.y * 1.5, 0);\n    separator = LineSegment3d.createCapture(p0, p1);\n  }\n\n  separator.tryTransformInPlace(transform);\n\n  context.entries.push({\n    separator: {\n      startPoint: separator.point0Ref.toJSON(),\n      endPoint: separator.point1Ref.toJSON(),\n    },\n  });\n\n  if (source.denominator.length > 0) {\n    context.entries.push({ text: createFractionTextString(source.denominator, run,denominatorOffset, transform) });\n  }\n}\n\nfunction produceTextBlockGeometry(layout: TextBlockLayout, documentTransform: Transform, debugAnchorPt?: Point3d): TextBlockGeometryProps {\n  const context: GeometryContext = { entries: [] };\n  for (const line of layout.lines) {\n    const lineTrans = Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);\n    for (const run of line.runs) {\n      if (\"linebreak\" === run.source.type) {\n        continue;\n      }\n\n      const runTrans = Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);\n      lineTrans.multiplyTransformTransform(runTrans, runTrans);\n      documentTransform.multiplyTransformTransform(runTrans, runTrans);\n      if (\"text\" === run.source.type) {\n        processTextRun(run, runTrans, context);\n      } else {\n        processFractionRun(run, runTrans, context);\n      }\n    }\n  }\n\n  if (debugAnchorPt) {\n    // Draw lines representing the horizontal and vertical ranges, intersecting at the anchor point.\n    context.entries.push({\n      color: ColorDef.red.toJSON(),\n    });\n\n    context.entries.push({\n      separator: {\n        startPoint: [layout.range.low.x, debugAnchorPt.y, 0],\n        endPoint: [layout.range.high.x, debugAnchorPt.y, 0],\n      },\n    });\n    context.entries.push({\n      separator: {\n        startPoint: [debugAnchorPt.x, layout.range.low.y, 0],\n        endPoint: [debugAnchorPt.x, layout.range.high.y, 0],\n      },\n    });\n  }\n\n  return { entries: context.entries };\n}\n\n/** Arguments supplied to [[produceTextAnnotationGeometry]].\n * @beta\n */\nexport interface ProduceTextAnnotationGeometryArgs {\n  /** The annotation from which to produce the geometry. */\n  annotation: TextAnnotation;\n  /** The iModel from which to obtain fonts and text styles. */\n  iModel: IModelDb;\n  /** @internal chiefly for tests */\n  computeTextRange?: ComputeRangesForTextLayout;\n  /** @internal chiefly for tests */\n  findTextStyle?: FindTextStyle;\n  /** @internal chiefly for tests */\n  findFontId?: FindFontId;\n}\n\n/** Produce a geometric representation of a text annotation.\n * The result can be supplied to [GeometryStreamBuilder.appendTextBlock]($common).\n * @see [[TextAnnotation2d.setAnnotation]] and [[TextAnnotation3d.setAnnotation]] to update the annotation, geometry, and placement of an annotation element.\n * @beta\n */\nexport function produceTextAnnotationGeometry(args: ProduceTextAnnotationGeometryArgs): TextBlockGeometryProps {\n  const layout = layoutTextBlock({\n    ...args,\n    textBlock: args.annotation.textBlock,\n  });\n\n  const transform = args.annotation.computeDocumentTransform(layout.range);\n\n  const debugAnchorPointAndRange = false;\n  const anchorPoint = debugAnchorPointAndRange ? args.annotation.computeAnchorPoint(layout.range) : undefined;\n  return produceTextBlockGeometry(layout, transform, anchorPoint);\n}\n"]}

package/lib/cjs/TextAnnotationLayout.d.ts

@@ -0,0 +1,124 @@
+import { BaselineShift, FontId, FractionRun, Paragraph, Run, TextBlock, TextRun, TextStyleSettings } from "@itwin/core-common";
+import { Range2d } from "@itwin/core-geometry";
+import { IModelDb } from "./IModelDb";
+/** @internal */
+export interface TextLayoutRanges {
+    layout: Range2d;
+    justification: Range2d;
+}
+/** Arguments to [[ComputeRangesForTextLayout]].
+ * @internal
+ */
+export interface ComputeRangesForTextLayoutArgs {
+    chars: string;
+    bold: boolean;
+    italic: boolean;
+    baselineShift: BaselineShift;
+    fontId: FontId;
+    widthFactor: number;
+    lineHeight: number;
+}
+/** A function that uses a font to compute the layout and justification ranges of a string of text.
+ * @internal
+ */
+export type ComputeRangesForTextLayout = (args: ComputeRangesForTextLayoutArgs) => TextLayoutRanges;
+/** @internal */
+export type FindFontId = (name: string) => FontId;
+/** @internal */
+export type FindTextStyle = (name: string) => TextStyleSettings;
+/** @internal */
+export interface LayoutTextBlockArgs {
+    textBlock: TextBlock;
+    iModel: IModelDb;
+    /** @internal chiefly for tests, by default uses IModelJsNative.DgnDb.computeRangesForText. */
+    computeTextRange?: ComputeRangesForTextLayout;
+    /** @internal chiefly for tests, by default looks up styles from a workspace. */
+    findTextStyle?: FindTextStyle;
+    /** @internal chiefly for tests, by default uses IModelDb.fontMap. */
+    findFontId?: FindFontId;
+}
+/**
+ * Lays out the contents of a TextBlock into a series of lines containing runs.
+ * Each paragraph is decomposed into a series of lines.
+ * Each series of consecutive non-linebreak runs within a paragraph is concatenated into one line.
+ * If the document specifies a width > 0, individual lines are split to try to avoid exceeding that width.
+ * Individual TextRuns can be split onto multiple lines at word boundaries if necessary. Individual FractionRuns are never split.
+ * @internal
+ */
+export declare function layoutTextBlock(args: LayoutTextBlockArgs): TextBlockLayout;
+declare class LayoutContext {
+    private readonly _computeTextRange;
+    private readonly _findTextStyle;
+    private readonly _findFontId;
+    private readonly _textStyles;
+    private readonly _fontIds;
+    readonly blockSettings: TextStyleSettings;
+    constructor(block: TextBlock, _computeTextRange: ComputeRangesForTextLayout, _findTextStyle: FindTextStyle, _findFontId: FindFontId);
+    findFontId(name: string): FontId;
+    findTextStyle(name: string): TextStyleSettings;
+    createRunSettings(run: Run): TextStyleSettings;
+    computeRangeForText(chars: string, style: TextStyleSettings, baselineShift: BaselineShift): TextLayoutRanges;
+    computeRangeForTextRun(style: TextStyleSettings, run: TextRun, charOffset: number, numChars: number): TextLayoutRanges;
+    computeRangeForFractionRun(style: TextStyleSettings, source: FractionRun): {
+        layout: Range2d;
+        numerator: Range2d;
+        denominator: Range2d;
+    };
+}
+/** @internal */
+export declare class RunLayout {
+    source: Run;
+    charOffset: number;
+    numChars: number;
+    range: Range2d;
+    justificationRange?: Range2d;
+    denominatorRange?: Range2d;
+    numeratorRange?: Range2d;
+    offsetFromLine: {
+        x: number;
+        y: number;
+    };
+    style: TextStyleSettings;
+    fontId: FontId;
+    private constructor();
+    static create(source: Run, context: LayoutContext): RunLayout;
+    canWrap(): this is {
+        source: TextRun;
+    };
+    private cloneForWrap;
+    wrap(availableWidth: number, shouldForceLeadingUnit: boolean, context: LayoutContext): RunLayout | undefined;
+}
+/** @internal */
+export declare class LineLayout {
+    source: Paragraph;
+    range: Range2d;
+    justificationRange: Range2d;
+    offsetFromDocument: {
+        x: number;
+        y: number;
+    };
+    private _runs;
+    constructor(source: Paragraph);
+    get runs(): ReadonlyArray<RunLayout>;
+    get isEmpty(): boolean;
+    get back(): RunLayout;
+    append(run: RunLayout): void;
+    /** Invoked every time a run is appended,. */
+    private computeRanges;
+}
+/**
+ * Describes the layout of a text block as a collection of lines containing runs.
+ * @internal
+ */
+export declare class TextBlockLayout {
+    source: TextBlock;
+    range: Range2d;
+    lines: LineLayout[];
+    constructor(source: TextBlock, context: LayoutContext);
+    private get _back();
+    private populateLines;
+    private justifyLines;
+    private flushLine;
+}
+export {};
+//# sourceMappingURL=TextAnnotationLayout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotationLayout.d.ts","sourceRoot":"","sources":["../../src/TextAnnotationLayout.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AACvJ,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,gBAAgB;AAChB,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,aAAa,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,IAAI,EAAE,8BAA8B,KAAK,gBAAgB,CAAC;AAEpG,gBAAgB;AAChB,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAElD,gBAAgB;AAChB,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,iBAAiB,CAAC;AAEhE,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,QAAQ,CAAC;IACjB,8FAA8F;IAC9F,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;IAC9C,gFAAgF;IAChF,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,qEAAqE;IACrE,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAQ1E;AAuBD,cAAM,aAAa;IAKoB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAA8B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAAiB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAJjL,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwC;IACpE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,SAAgB,aAAa,EAAE,iBAAiB,CAAC;gBAE9B,KAAK,EAAE,SAAS,EAAmB,iBAAiB,EAAE,0BAA0B,EAAmB,cAAc,EAAE,aAAa,EAAmB,WAAW,EAAE,UAAU;IAKtL,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAShC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB;IAS9C,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,iBAAiB;IAS9C,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,GAAG,gBAAgB;IAmC5G,sBAAsB,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,gBAAgB;IAItH,0BAA0B,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,GAAG;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE;CA+BhJ;AAED,gBAAgB;AAChB,qBAAa,SAAS;IACb,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,KAAK,EAAE,iBAAiB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IAEtB,OAAO;WAaO,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,GAAG,SAAS;IAmC7D,OAAO,IAAI,IAAI,IAAI;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE;IAI7C,OAAO,CAAC,YAAY;IAab,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS;CAmDpH;AAED,gBAAgB;AAChB,qBAAa,UAAU;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,UAA2B;IAChC,kBAAkB,UAA2B;IAC7C,kBAAkB;;;MAAkB;IAC3C,OAAO,CAAC,KAAK,CAAmB;gBAEb,MAAM,EAAE,SAAS;IAIpC,IAAW,IAAI,IAAI,aAAa,CAAC,SAAS,CAAC,CAAuB;IAClE,IAAW,OAAO,YAAsC;IACxD,IAAW,IAAI,IAAI,SAAS,CAG3B;IAEM,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI;IAKnC,6CAA6C;IAC7C,OAAO,CAAC,aAAa;CAiBtB;AAED;;;GAGG;AACH,qBAAa,eAAe;IACnB,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,UAAiB;IACtB,KAAK,EAAE,UAAU,EAAE,CAAM;gBAEb,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa;IAO5D,OAAO,KAAK,KAAK,GAGhB;IAED,OAAO,CAAC,aAAa;IAiErB,OAAO,CAAC,YAAY;IA8BpB,OAAO,CAAC,SAAS;CAoClB"}