@itwin/core-backend 5.1.0-dev.5 → 5.1.0-dev.51

package/lib/esm/annotations/TextAnnotationGeometry.js

@@ -0,0 +1,129 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { ColorDef, FillDisplay, GeometryParams, TextAnnotation } from "@itwin/core-common";
+import { LineString3d, PointString3d, Range2d, Transform } from "@itwin/core-geometry";
+import { Id64 } from "@itwin/core-bentley";
+import { produceTextBlockGeometry } from "./TextBlockGeometry";
+import { appendFrameToBuilder, computeIntervalPoints } from "./FrameGeometry";
+/** Constructs the TextBlockGeometry and frame geometry and appends the geometry to the provided builder.
+ * @returns true if the geometry was successfully appended.
+ * @beta
+ */
+export function appendTextAnnotationGeometry(props) {
+    const annotation = TextAnnotation.fromJSON(props.annotationProps);
+    const range = Range2d.fromJSON(props.layout.range);
+    const transform = annotation.computeTransform(range);
+    let result = true;
+    // Construct the TextBlockGeometry
+    const params = new GeometryParams(props.categoryId, props.subCategoryId);
+    const entries = produceTextBlockGeometry(props.layout, annotation.computeTransform(props.layout.range));
+    result = result && props.builder.appendTextBlock(entries, params);
+    // Construct the frame geometry
+    if (annotation.frame && annotation.frame.shape !== "none") {
+        result = result && appendFrameToBuilder(props.builder, annotation.frame, range, transform, params);
+    }
+    // Construct the debug geometry
+    if (props.wantDebugGeometry) {
+        result = result && debugAnchorPoint(props.builder, annotation, props.layout, annotation.computeTransform(props.layout.range));
+        result = result && debugRunLayout(props.builder, props.layout, annotation.computeTransform(props.layout.range));
+        if (annotation.frame)
+            result = result && debugSnapPoints(props.builder, annotation.frame, props.layout.range, annotation.computeTransform(props.layout.range));
+    }
+    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 = Range2d.fromJSON(layout.range);
+    const debugAnchorPt = transform.multiplyPoint3d(annotation.computeAnchorPoint(range));
+    // Make it blue
+    const blueLineParams = new GeometryParams(Id64.invalid);
+    blueLineParams.lineColor = 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(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(LineString3d.create(debugAnchorPt.plusXYZ(-1, -1), debugAnchorPt.plusXYZ(1, 1)));
+    result = result && builder.appendGeometryQuery(LineString3d.create(debugAnchorPt.plusXYZ(1, -1), debugAnchorPt.plusXYZ(-1, 1)));
+    // Draw a red box to show the text range
+    const redLineParams = new GeometryParams(Id64.invalid);
+    redLineParams.lineColor = ColorDef.red;
+    result = result && builder.appendGeometryParamsChange(redLineParams);
+    const rangeCorners = layout.textRange.corners3d(true);
+    transform.multiplyPoint3dArrayInPlace(rangeCorners);
+    result = result && builder.appendGeometryQuery(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, frame, range, transform) {
+    if (undefined === frame.shape || frame.shape === "none")
+        return false;
+    const points = computeIntervalPoints({ frame: frame.shape, range, transform, lineIntervalFactor: 0.5, arcIntervalFactor: 0.25 });
+    const params = new GeometryParams(Id64.invalid);
+    params.lineColor = ColorDef.black;
+    params.weight = (frame.borderWeight ?? 1) * 5; // We want the dots to be bigger than the frame so we can see them.
+    params.fillDisplay = FillDisplay.Always;
+    const result = builder.appendGeometryParamsChange(params) && builder.appendGeometryQuery(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 = 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": ColorDef.fromString("orange"),
+        "linebreak": ColorDef.fromString("yellow"),
+        "fraction": ColorDef.fromString("green"),
+        "tab": ColorDef.fromString("aquamarine"),
+    };
+    layout.lines.forEach(line => {
+        // Apply the line's offset transform
+        const lineTrans = 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] ?? ColorDef.black;
+            // Only change geometry params if the color changes
+            if (!lastColor.equals(color)) {
+                const colorParams = new GeometryParams(Id64.invalid);
+                colorParams.lineColor = color;
+                result = result && builder.appendGeometryParamsChange(colorParams);
+                lastColor = color;
+            }
+            // Apply the line's offset to the run's offset
+            const runTrans = 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(LineString3d.create(runCorners));
+        });
+    });
+    return result;
+}
+//# sourceMappingURL=TextAnnotationGeometry.js.map

package/lib/esm/annotations/TextAnnotationGeometry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotationGeometry.js","sourceRoot":"","sources":["../../../src/annotations/TextAnnotationGeometry.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAmB,WAAW,EAAE,cAAc,EAAE,cAAc,EAA4C,MAAM,oBAAoB,CAAC;AAEtJ,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAsB9E;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAuC;IAClF,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,kCAAkC;IAClC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,wBAAwB,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACxG,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAElE,+BAA+B;IAC/B,IAAI,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;QAC1D,MAAM,GAAG,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACrG,CAAC;IAED,+BAA+B;IAC/B,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC5B,MAAM,GAAG,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9H,MAAM,GAAG,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAChH,IAAI,UAAU,CAAC,KAAK;YAAE,MAAM,GAAG,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjK,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAAA,CAAC;AAEF;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,OAAgC,EAAE,UAA0B,EAAE,MAAuB,EAAE,SAAoB;IACnI,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtF,eAAe;IACf,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxD,cAAc,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC;IACzC,IAAI,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;IAEhE,+CAA+C;IAC/C,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC5C,SAAS,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;IACrD,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IAEnF,wGAAwG;IACxG,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAChI,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhI,wCAAwC;IACxC,MAAM,aAAa,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvD,aAAa,CAAC,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC;IACvC,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAErE,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACtD,SAAS,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;IACpD,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAElF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,iJAAiJ;AACjJ,SAAS,eAAe,CAAC,OAAgC,EAAE,KAA0B,EAAE,KAAc,EAAE,SAAoB;IACzH,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM;QACrD,OAAO,KAAK,CAAC;IACf,MAAM,MAAM,GAAG,qBAAqB,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjI,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;IAClC,MAAM,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,mEAAmE;IAClH,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC;IAExC,MAAM,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACvH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,cAAc,CAAC,OAAgC,EAAE,MAAuB,EAAE,iBAA4B;IAC7G,IAAI,MAAM,GAAG,IAAI,CAAC,CAAC,mDAAmD;IACtE,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,iCAAiC;IAC7D,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,6CAA6C;IAEpE,gCAAgC;IAChC,MAAM,MAAM,GAAG;QACb,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC;QACrC,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC;QAC1C,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC;QACxC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC;KACzC,CAAA;IAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC1B,oCAAoC;QACpC,MAAM,SAAS,GAAG,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1G,iBAAiB,CAAC,0BAA0B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAEnE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,oCAAoC;YACpC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC;YAElD,mDAAmD;YACnD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrD,WAAW,CAAC,SAAS,GAAG,KAAK,CAAC;gBAC9B,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;gBACnE,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;YAED,8CAA8C;YAC9C,MAAM,QAAQ,GAAG,SAAS,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;YAEzD,uCAAuC;YACvC,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7C,QAAQ,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC;YACjD,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,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\nimport { ColorDef, ElementGeometry, FillDisplay, GeometryParams, TextAnnotation, TextAnnotationProps, TextFrameStyleProps } from \"@itwin/core-common\";\r\nimport { TextBlockLayout } from \"./TextBlockLayout\";\r\nimport { LineString3d, PointString3d, Range2d, Transform } from \"@itwin/core-geometry\";\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { produceTextBlockGeometry } from \"./TextBlockGeometry\";\r\nimport { appendFrameToBuilder, computeIntervalPoints } from \"./FrameGeometry\";\r\n\r\n/**\r\n * Properties required to compute the geometry of a text annotation.\r\n * @beta\r\n * @see [[appendTextAnnotationGeometry]] to append the geometry to an [[ElementGeometry.Builder]].\r\n */\r\nexport interface AppendTextAnnotationGeometryArgs {\r\n  /** The annotation to be drawn. Be sure to include a TextBlock with runs or no geometry will be produced. */\r\n  annotationProps: TextAnnotationProps;\r\n  /** Layout provided by calling [[layoutTextBlock]] */\r\n  layout: TextBlockLayout;\r\n  /** Builder that will be added to in place */\r\n  builder: ElementGeometry.Builder;\r\n  /** The category the element will belong to. This will passed into the [[GeometryParams]] */\r\n  categoryId: Id64String\r\n  /** The optional sub-category the element will belong to. This will passed into the [[GeometryParams]] */\r\n  subCategoryId?: Id64String\r\n  /** Whether or not to draw geometry for things like the snap points, range, and anchor point */\r\n  wantDebugGeometry?: boolean;\r\n}\r\n\r\n/** Constructs the TextBlockGeometry and frame geometry and appends the geometry to the provided builder.\r\n * @returns true if the geometry was successfully appended.\r\n * @beta\r\n */\r\nexport function appendTextAnnotationGeometry(props: AppendTextAnnotationGeometryArgs): boolean {\r\n  const annotation = TextAnnotation.fromJSON(props.annotationProps);\r\n  const range = Range2d.fromJSON(props.layout.range);\r\n  const transform = annotation.computeTransform(range);\r\n  let result = true;\r\n\r\n  // Construct the TextBlockGeometry\r\n  const params = new GeometryParams(props.categoryId, props.subCategoryId);\r\n  const entries = produceTextBlockGeometry(props.layout, annotation.computeTransform(props.layout.range));\r\n  result = result && props.builder.appendTextBlock(entries, params);\r\n\r\n  // Construct the frame geometry\r\n  if (annotation.frame && annotation.frame.shape !== \"none\") {\r\n    result = result && appendFrameToBuilder(props.builder, annotation.frame, range, transform, params);\r\n  }\r\n\r\n  // Construct the debug geometry\r\n  if (props.wantDebugGeometry) {\r\n    result = result && debugAnchorPoint(props.builder, annotation, props.layout, annotation.computeTransform(props.layout.range));\r\n    result = result && debugRunLayout(props.builder, props.layout, annotation.computeTransform(props.layout.range));\r\n    if (annotation.frame) result = result && debugSnapPoints(props.builder, annotation.frame, props.layout.range, annotation.computeTransform(props.layout.range));\r\n  }\r\n\r\n  return result;\r\n};\r\n\r\n/**\r\n * Draws the anchor point and margins of the text annotation.\r\n * The anchor point is the point around which the text rotates and is drawn as a blue x (1m by 1m).\r\n * The margins are drawn as a blue box.\r\n * The text range is drawn as a red box.\r\n */\r\nfunction debugAnchorPoint(builder: ElementGeometry.Builder, annotation: TextAnnotation, layout: TextBlockLayout, transform: Transform): boolean {\r\n  const range = Range2d.fromJSON(layout.range);\r\n  const debugAnchorPt = transform.multiplyPoint3d(annotation.computeAnchorPoint(range));\r\n\r\n  // Make it blue\r\n  const blueLineParams = new GeometryParams(Id64.invalid);\r\n  blueLineParams.lineColor = ColorDef.blue;\r\n  let result = builder.appendGeometryParamsChange(blueLineParams);\r\n\r\n  // Draw a blue box to show the element's margin\r\n  const marginCorners = range.corners3d(true);\r\n  transform.multiplyPoint3dArrayInPlace(marginCorners);\r\n  result = result && builder.appendGeometryQuery(LineString3d.create(marginCorners));\r\n\r\n  // Draw a blue x to show the anchor point - Rotation occurs around this point. The x will be 1 m by 1 m.\r\n  result = result && builder.appendGeometryQuery(LineString3d.create(debugAnchorPt.plusXYZ(-1, -1), debugAnchorPt.plusXYZ(1, 1)));\r\n  result = result && builder.appendGeometryQuery(LineString3d.create(debugAnchorPt.plusXYZ(1, -1), debugAnchorPt.plusXYZ(-1, 1)));\r\n\r\n  // Draw a red box to show the text range\r\n  const redLineParams = new GeometryParams(Id64.invalid);\r\n  redLineParams.lineColor = ColorDef.red;\r\n  result = result && builder.appendGeometryParamsChange(redLineParams);\r\n\r\n  const rangeCorners = layout.textRange.corners3d(true);\r\n  transform.multiplyPoint3dArrayInPlace(rangeCorners);\r\n  result = result && builder.appendGeometryQuery(LineString3d.create(rangeCorners));\r\n\r\n  return result;\r\n}\r\n\r\n/** Draws the interval points defined by calling [[computeIntervalPoints]]. The points are shown as black dots 5x larger than the borderWeight */\r\nfunction debugSnapPoints(builder: ElementGeometry.Builder, frame: TextFrameStyleProps, range: Range2d, transform: Transform): boolean {\r\n  if (undefined === frame.shape || frame.shape === \"none\")\r\n    return false;\r\n  const points = computeIntervalPoints({ frame: frame.shape, range, transform, lineIntervalFactor: 0.5, arcIntervalFactor: 0.25 });\r\n\r\n  const params = new GeometryParams(Id64.invalid);\r\n  params.lineColor = ColorDef.black;\r\n  params.weight = (frame.borderWeight ?? 1) * 5; // We want the dots to be bigger than the frame so we can see them.\r\n  params.fillDisplay = FillDisplay.Always;\r\n\r\n  const result = builder.appendGeometryParamsChange(params) && builder.appendGeometryQuery(PointString3d.create(points));\r\n  return result;\r\n}\r\n\r\n/**\r\n * Draws debug geometry for each line and run in a TextBlockLayout.\r\n *\r\n * For each line and run, this function draws boxes to visualize their layout and boundaries.\r\n * Different run types (e.g., text, linebreak, fraction, tab) are assigned distinct colors for clarity.\r\n * This is useful for debugging text layout and alignment issues.\r\n *\r\n * @param builder - The geometry builder to append debug geometry to.\r\n * @param layout - The text block layout containing lines and runs to visualize.\r\n * @param documentTransform - The transform to apply to the entire document.\r\n * @returns True if all debug geometry was successfully appended.\r\n */\r\nfunction debugRunLayout(builder: ElementGeometry.Builder, layout: TextBlockLayout, documentTransform: Transform): boolean {\r\n  let result = true; // Tracks if all geometry was appended successfully\r\n  let color = ColorDef.black; // Current color for the run type\r\n  let lastColor = color; // Last color used, to minimize param changes\r\n\r\n  // Map run types to debug colors\r\n  const colors = {\r\n    \"text\": ColorDef.fromString(\"orange\"),\r\n    \"linebreak\": ColorDef.fromString(\"yellow\"),\r\n    \"fraction\": ColorDef.fromString(\"green\"),\r\n    \"tab\": ColorDef.fromString(\"aquamarine\"),\r\n  }\r\n\r\n  layout.lines.forEach(line => {\r\n    // Apply the line's offset transform\r\n    const lineTrans = Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);\r\n    documentTransform.multiplyTransformTransform(lineTrans, lineTrans);\r\n\r\n    line.runs.forEach(run => {\r\n      // Determine color for this run type\r\n      color = colors[run.source.type] ?? ColorDef.black;\r\n\r\n      // Only change geometry params if the color changes\r\n      if (!lastColor.equals(color)) {\r\n        const colorParams = new GeometryParams(Id64.invalid);\r\n        colorParams.lineColor = color;\r\n        result = result && builder.appendGeometryParamsChange(colorParams);\r\n        lastColor = color;\r\n      }\r\n\r\n      // Apply the line's offset to the run's offset\r\n      const runTrans = Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);\r\n      lineTrans.multiplyTransformTransform(runTrans, runTrans);\r\n\r\n      // Draw the enclosing range for the run\r\n      const runCorners = run.range.corners3d(true);\r\n      runTrans.multiplyPoint3dArrayInPlace(runCorners);\r\n      result = result && builder.appendGeometryQuery(LineString3d.create(runCorners));\r\n    });\r\n  });\r\n\r\n  return result;\r\n}"]}

package/lib/esm/annotations/TextBlockGeometry.d.ts

@@ -0,0 +1,16 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { TextBlockGeometryProps } from "@itwin/core-common";
+import { TextBlockLayout } from "./TextBlockLayout";
+import { Transform } from "@itwin/core-geometry";
+/**
+ * Produces the geometry for a text block in a way that can be interpreted by a [[GeometryStreamBuilder]] or [[ElementBuilder.Geometry]].
+ * To build the geometry for a whole [[TextAnnotation]], use [[appendTextAnnotationGeometry]] instead.
+ * @param layout of the text block as computed by [[layoutTextBlock]].
+ * @param documentTransform that positions the text block in world coordinates.
+ * @returns TextBlockGeometryProps.
+ * @beta
+ */
+export declare function produceTextBlockGeometry(layout: TextBlockLayout, documentTransform: Transform): TextBlockGeometryProps;
+//# sourceMappingURL=TextBlockGeometry.d.ts.map

package/lib/esm/annotations/TextBlockGeometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextBlockGeometry.d.ts","sourceRoot":"","sources":["../../../src/annotations/TextBlockGeometry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAA2D,MAAM,oBAAoB,CAAC;AACrH,OAAO,EAAa,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAmC,SAAS,EAAY,MAAM,sBAAsB,CAAC;AAoH5F;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,SAAS,GAAG,sBAAsB,CAsBtH"}

package/lib/esm/{TextAnnotationGeometry.js → annotations/TextBlockGeometry.js}

@@ -5,8 +5,7 @@
 /** @packageDocumentation
  * @module ElementGeometry
  */
-import { ColorDef, TextString } from "@itwin/core-common";
-import { layoutTextBlock } from "./TextAnnotationLayout";
+import { TextString } from "@itwin/core-common";
 import { LineSegment3d, Point3d, Range2d, Transform, Vector2d } from "@itwin/core-geometry";
 import { assert } from "@itwin/core-bentley";
 function setColor(color, context) {
@@ -93,12 +92,21 @@ function processFractionRun(run, transform, context) {
         context.entries.push({ text: createFractionTextString(source.denominator, run, denominatorOffset, transform) });
     }
 }
-function produceTextBlockGeometry(layout, documentTransform, debugAnchorPt) {
+/**
+ * Produces the geometry for a text block in a way that can be interpreted by a [[GeometryStreamBuilder]] or [[ElementBuilder.Geometry]].
+ * To build the geometry for a whole [[TextAnnotation]], use [[appendTextAnnotationGeometry]] instead.
+ * @param layout of the text block as computed by [[layoutTextBlock]].
+ * @param documentTransform that positions the text block in world coordinates.
+ * @returns TextBlockGeometryProps.
+ * @beta
+ */
+export function produceTextBlockGeometry(layout, documentTransform) {
     const context = { entries: [] };
     for (const line of layout.lines) {
         const lineTrans = Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);
         for (const run of line.runs) {
-            if ("linebreak" === run.source.type) {
+            // Skip runs that are solely whitespace
+            if (run.source.isWhitespace) {
                 continue;
             }
             const runTrans = Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);
@@ -112,70 +120,6 @@ function produceTextBlockGeometry(layout, documentTransform, debugAnchorPt) {
             }
         }
     }
-    if (debugAnchorPt) {
-        context.entries.push({
-            color: ColorDef.blue.toJSON()
-        });
-        // Draw a blue box to show the element's margin
-        const marginCorners = layout.range.corners3d(true);
-        documentTransform.multiplyPoint3dArrayInPlace(marginCorners);
-        marginCorners.forEach((corner, index) => {
-            const next = marginCorners[index + 1];
-            if (!next)
-                return;
-            context.entries.push({
-                separator: {
-                    startPoint: [corner.x, corner.y, 0],
-                    endPoint: [next.x, next.y, 0],
-                },
-            });
-        });
-        // Draw a blue x to show the anchor point - Rotation occurs around this point. The x will be 1 m by 1 m.
-        context.entries.push({
-            separator: {
-                startPoint: [debugAnchorPt.x - 1, debugAnchorPt.y - 1, 0],
-                endPoint: [debugAnchorPt.x + 1, debugAnchorPt.y + 1, 0],
-            },
-        });
-        context.entries.push({
-            separator: {
-                startPoint: [debugAnchorPt.x + 1, debugAnchorPt.y - 1, 0],
-                endPoint: [debugAnchorPt.x - 1, debugAnchorPt.y + 1, 0],
-            },
-        });
-        // Draw a red box to show the text range
-        context.entries.push({
-            color: ColorDef.red.toJSON(),
-        });
-        const rangeCorners = layout.textRange.corners3d(true);
-        documentTransform.multiplyPoint3dArrayInPlace(rangeCorners);
-        rangeCorners.forEach((corner, index) => {
-            const next = rangeCorners[index + 1];
-            if (!next)
-                return;
-            context.entries.push({
-                separator: {
-                    startPoint: [corner.x, corner.y, 0],
-                    endPoint: [next.x, next.y, 0],
-                },
-            });
-        });
-    }
     return { entries: context.entries };
 }
-/** Produce a geometric representation of a text annotation, with the annotation's anchor point at the origin.
- * 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 function produceTextAnnotationGeometry(args) {
-    const layout = layoutTextBlock({
-        ...args,
-        textBlock: args.annotation.textBlock,
-    });
-    const dimensions = layout.range;
-    const transform = args.annotation.computeTransform(dimensions);
-    const anchorPoint = args.debugAnchorPointAndRange ? transform.multiplyPoint3d(args.annotation.computeAnchorPoint(dimensions)) : undefined;
-    return produceTextBlockGeometry(layout, transform, anchorPoint);
-}
-//# sourceMappingURL=TextAnnotationGeometry.js.map
+//# sourceMappingURL=TextBlockGeometry.js.map

package/lib/esm/annotations/TextBlockGeometry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextBlockGeometry.js","sourceRoot":"","sources":["../../../src/annotations/TextBlockGeometry.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAuD,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAErH,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAO7C,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,MAAM,CAAC,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,UAAU,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,MAAM,CAAC,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,EAAE,CAAC,CAAC;AACrC,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,MAAM,CAAC,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,MAAM,CAAC,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,MAAM,CAAC,SAAS,KAAK,GAAG,CAAC,cAAc,IAAI,SAAS,KAAK,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAE/E,MAAM,QAAQ,GAAG,IAAI,QAAQ,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,OAAO,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,OAAO,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,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC5D,MAAM,gBAAgB,GAAG,OAAO,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,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;SAAM,CAAC;QACN,MAAM,EAAE,GAAG,IAAI,OAAO,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,OAAO,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,aAAa,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,EAAE,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;IAClH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAuB,EAAE,iBAA4B;IAC5F,MAAM,OAAO,GAAoB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,SAAS,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,uCAAuC;YACvC,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC5B,SAAS;YACX,CAAC;YAED,MAAM,QAAQ,GAAG,SAAS,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,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;AACtC,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\nimport { TextBlockGeometryProps, TextBlockGeometryPropsEntry, TextString, TextStyleColor } from \"@itwin/core-common\";\r\nimport { RunLayout, TextBlockLayout } from \"./TextBlockLayout\";\r\nimport { LineSegment3d, Point3d, Range2d, Transform, Vector2d } from \"@itwin/core-geometry\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\n\r\ninterface GeometryContext {\r\n  curColor?: TextStyleColor;\r\n  entries: TextBlockGeometryPropsEntry[];\r\n}\r\n\r\nfunction setColor(color: TextStyleColor, context: GeometryContext): void {\r\n  if (color !== context.curColor) {\r\n    context.curColor = color;\r\n    context.entries.push({ color });\r\n  }\r\n}\r\n\r\nfunction createTextString(text: string, run: RunLayout, origin?: Point3d): TextString {\r\n  assert(text.length > 0);\r\n\r\n  const { lineHeight, widthFactor, isBold, isItalic, isUnderlined } = run.style;\r\n\r\n  return new TextString({\r\n    text,\r\n    font: run.fontId,\r\n    height: lineHeight,\r\n    widthFactor,\r\n    bold: isBold,\r\n    italic: isItalic,\r\n    underline: isUnderlined,\r\n    origin,\r\n  });\r\n}\r\n\r\nfunction processTextRun(run: RunLayout, transform: Transform, context: GeometryContext): void {\r\n  assert(run.source.type === \"text\");\r\n  const text = run.source.content.substring(run.charOffset, run.charOffset + run.numChars);\r\n  if (text.length === 0) {\r\n    return;\r\n  }\r\n\r\n  const ts = createTextString(text, run);\r\n  if (\"none\" !== run.source.baselineShift) {\r\n    const isSub = \"subscript\" === run.source.baselineShift;\r\n    const offsetFactor = run.style[isSub ? \"subScriptOffsetFactor\" : \"superScriptOffsetFactor\"];\r\n    const scale = run.style[isSub ? \"subScriptScale\" : \"superScriptScale\"];\r\n\r\n    ts.origin.y += offsetFactor * ts.height;\r\n    ts.height *= scale;\r\n  }\r\n\r\n  ts.transformInPlace(transform);\r\n\r\n  setColor(run.style.color, context);\r\n  context.entries.push({ text: ts });\r\n}\r\n\r\nfunction createFractionTextString(text: string, run: RunLayout, origin: Point3d, transform: Transform): TextString {\r\n  const ts = createTextString(text, run, origin);\r\n  assert(undefined !== ts.widthFactor);\r\n\r\n  ts.height *= run.style.stackedFractionScale;\r\n\r\n  ts.transformInPlace(transform);\r\n\r\n  return ts;\r\n}\r\n\r\nfunction processFractionRun(run: RunLayout, transform: Transform, context: GeometryContext): void {\r\n  const source = run.source;\r\n  assert(source.type === \"fraction\");\r\n\r\n  if (source.numerator.length === 0 && source.denominator.length === 0) {\r\n    return;\r\n  }\r\n\r\n  assert(undefined !== run.numeratorRange && undefined !== run.denominatorRange);\r\n\r\n  const fontSize = new Vector2d(run.style.lineHeight * run.style.widthFactor, run.style.lineHeight);\r\n  fontSize.scale(run.style.stackedFractionScale, fontSize);\r\n\r\n  const numeratorOffset = new Point3d(run.numeratorRange.low.x, run.numeratorRange.low.y, 0);\r\n  const denominatorOffset = new Point3d(run.denominatorRange.low.x, run.denominatorRange.low.y, 0);\r\n\r\n  setColor(run.style.color, context);\r\n\r\n  if (source.numerator.length > 0) {\r\n    context.entries.push({ text: createFractionTextString(source.numerator, run, numeratorOffset, transform) });\r\n  }\r\n\r\n  const numeratorRange = Range2d.fromJSON(run.numeratorRange);\r\n  const denominatorRange = Range2d.fromJSON(run.denominatorRange);\r\n\r\n  let separator: LineSegment3d;\r\n  if (run.style.stackedFractionType === \"horizontal\") {\r\n    const fractionWidth = Math.max(numeratorRange.xLength(), denominatorRange.xLength());\r\n    const y = 1.25 * denominatorRange.yLength();\r\n    separator = LineSegment3d.createXYXY(0, y, fractionWidth, y);\r\n  } else {\r\n    const p0 = new Point3d(denominatorRange.low.x - fontSize.x / 2, denominatorRange.low.y + fontSize.y * (1 / 3), 0);\r\n    const p1 = new Point3d(p0.x + fontSize.x, p0.y + fontSize.y * 1.5, 0);\r\n    separator = LineSegment3d.createCapture(p0, p1);\r\n  }\r\n\r\n  separator.tryTransformInPlace(transform);\r\n\r\n  context.entries.push({\r\n    separator: {\r\n      startPoint: separator.point0Ref.toJSON(),\r\n      endPoint: separator.point1Ref.toJSON(),\r\n    },\r\n  });\r\n\r\n  if (source.denominator.length > 0) {\r\n    context.entries.push({ text: createFractionTextString(source.denominator, run, denominatorOffset, transform) });\r\n  }\r\n}\r\n\r\n/**\r\n * Produces the geometry for a text block in a way that can be interpreted by a [[GeometryStreamBuilder]] or [[ElementBuilder.Geometry]].\r\n * To build the geometry for a whole [[TextAnnotation]], use [[appendTextAnnotationGeometry]] instead.\r\n * @param layout of the text block as computed by [[layoutTextBlock]].\r\n * @param documentTransform that positions the text block in world coordinates.\r\n * @returns TextBlockGeometryProps.\r\n * @beta\r\n */\r\nexport function produceTextBlockGeometry(layout: TextBlockLayout, documentTransform: Transform): TextBlockGeometryProps {\r\n  const context: GeometryContext = { entries: [] };\r\n  for (const line of layout.lines) {\r\n    const lineTrans = Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);\r\n    for (const run of line.runs) {\r\n      // Skip runs that are solely whitespace\r\n      if (run.source.isWhitespace) {\r\n        continue;\r\n      }\r\n\r\n      const runTrans = Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);\r\n      lineTrans.multiplyTransformTransform(runTrans, runTrans);\r\n      documentTransform.multiplyTransformTransform(runTrans, runTrans);\r\n      if (\"text\" === run.source.type) {\r\n        processTextRun(run, runTrans, context);\r\n      } else {\r\n        processFractionRun(run, runTrans, context);\r\n      }\r\n    }\r\n  }\r\n\r\n  return { entries: context.entries };\r\n}\r\n"]}

package/lib/esm/{TextAnnotationLayout.d.ts → annotations/TextBlockLayout.d.ts}

@@ -1,9 +1,9 @@
 /** @packageDocumentation
  * @module ElementGeometry
  */
-import { BaselineShift, FontId, FontType, FractionRun, LineLayoutResult, Paragraph, Run, RunLayoutResult, TextBlock, TextBlockLayoutResult, TextRun, TextStyleSettings } from "@itwin/core-common";
+import { BaselineShift, FontId, FontType, FractionRun, LineLayoutResult, Paragraph, Run, RunLayoutResult, TabRun, TextBlock, TextBlockLayoutResult, TextRun, TextStyleSettings } from "@itwin/core-common";
 import { Range2d } from "@itwin/core-geometry";
-import { IModelDb } from "./IModelDb";
+import { IModelDb } from "../IModelDb";
 /** @internal */
 export interface TextLayoutRanges {
     layout: Range2d;
@@ -55,13 +55,13 @@ export interface LayoutTextBlockArgs {
  * 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.
  * @see [[computeLayoutTextBlockResult]]
- * @internal
+ * @beta
  */
 export declare function layoutTextBlock(args: LayoutTextBlockArgs): TextBlockLayout;
 /**
  * Gets the result of laying out the the contents of a TextBlock into a series of lines containing runs.
  * The visual layout accounts for the [TextStyle]($common)s, fonts, and [TextBlock.width]($common). It applies word-wrapping if needed.
- * The layout returned matches the visual layout of the geometry produced by [[produceTextAnnotationGeometry]].
+ * The layout returned matches the visual layout of the geometry produced by [[appendTextAnnotationGeometry]].
  * @beta
  */
 export declare function computeLayoutTextBlockResult(args: LayoutTextBlockArgs): TextBlockLayoutResult;
@@ -103,8 +103,14 @@ declare class LayoutContext {
         numerator: Range2d;
         denominator: Range2d;
     };
+    computeRangeForTabRun(style: TextStyleSettings, source: TabRun, length: number): Range2d;
 }
-/** @internal */
+/**
+ * Represents the layout of a single run (text, fraction, or line break) within a line of text.
+ * Stores information about the run's position, style, and font within the line.
+ * Provides utilities for splitting text runs for word wrapping and converting to result objects.
+ * @beta
+ */
 export declare class RunLayout {
     source: Run;
     charOffset: number;
@@ -130,7 +136,12 @@ export declare class RunLayout {
     split(context: LayoutContext): RunLayout[];
     toResult(paragraph: Paragraph): RunLayoutResult;
 }
-/** @internal */
+/**
+ * Represents the layout of a single line within a paragraph of a text block.
+ * Contains a sequence of RunLayout objects, the computed range of the line, and its offset from the document origin.
+ * Provides utilities for appending runs, computing ranges, and converting to result objects.
+ * @beta
+ */
 export declare class LineLayout {
     source: Paragraph;
     range: Range2d;
@@ -139,6 +150,7 @@ export declare class LineLayout {
         x: number;
         y: number;
     };
+    lengthFromLastTab: number;
     private _runs;
     constructor(source: Paragraph);
     /** Compute a string representation, primarily for debugging purposes. */
@@ -153,7 +165,9 @@ export declare class LineLayout {
 }
 /**
  * Describes the layout of a text block as a collection of lines containing runs.
- * @internal
+ * Computes the visual layout of the text block, including word wrapping, justification, and margins.
+ * Provides access to the computed lines, ranges, and utilities for converting to result objects.
+ * @beta
  */
 export declare class TextBlockLayout {
     source: TextBlock;
@@ -174,4 +188,4 @@ export declare class TextBlockLayout {
     private applyMargins;
 }
 export {};
-//# sourceMappingURL=TextAnnotationLayout.d.ts.map
+//# sourceMappingURL=TextBlockLayout.d.ts.map

package/lib/esm/annotations/TextBlockLayout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextBlockLayout.d.ts","sourceRoot":"","sources":["../../../src/annotations/TextBlockLayout.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,qBAAqB,EAAoB,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AACrP,OAAO,EAAY,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAKvC,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;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC;AAEnE,gBAAgB;AAChB,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,iBAAiB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,SAAS,EAAE,SAAS,CAAC;IACrB,8FAA8F;IAC9F,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;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAQ1E;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,mBAAmB,GAAG,qBAAqB,CAG7F;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACrE,wGAAwG;IACxG,cAAc,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,eAAe,EAAE,eAAe,CAAC;IACjC,sIAAsI;IACtI,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,EAAE,CAqBlF;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;IAgCxI,qBAAqB,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAShG;AAiCD;;;;;GAKG;AACH,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;IAoCpE,yEAAyE;IAClE,SAAS,IAAI,MAAM;IAInB,OAAO,IAAI,IAAI,IAAI;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE;IAI7C,OAAO,CAAC,YAAY;IAab,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,EAAE;IAsB1C,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,eAAe;CAyBvD;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,UAA2B;IAChC,kBAAkB,UAA2B;IAC7C,kBAAkB;;;MAAkB;IACpC,iBAAiB,SAAK;IAC7B,OAAO,CAAC,KAAK,CAAmB;gBAEb,MAAM,EAAE,SAAS;IAIpC,yEAAyE;IAClE,SAAS,IAAI,MAAM;IAK1B,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;IAgCd,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,gBAAgB;CASxD;AAED;;;;;GAKG;AACH,qBAAa,eAAe;IACnB,MAAM,EAAE,SAAS,CAAC;IAEzB,8FAA8F;IACvF,SAAS,UAAiB;IAEjC,wDAAwD;IACjD,KAAK,UAAiB;IACtB,KAAK,EAAE,UAAU,EAAE,CAAM;IAChC,OAAO,CAAC,QAAQ,CAAgB;gBAEb,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa;IAcrD,QAAQ,IAAI,qBAAqB;IAOxC,yEAAyE;IAClE,SAAS,IAAI,MAAM;IAI1B,OAAO,KAAK,KAAK,GAGhB;IAED,OAAO,CAAC,aAAa;IAoErB,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,SAAS;IAqCjB,OAAO,CAAC,YAAY;CAoBrB"}

package/lib/esm/{TextAnnotationLayout.js → annotations/TextBlockLayout.js}

@@ -16,7 +16,7 @@ import * as LineBreaker from "linebreak";
  * 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.
  * @see [[computeLayoutTextBlockResult]]
- * @internal
+ * @beta
  */
 export function layoutTextBlock(args) {
     const findFontId = args.findFontId ?? ((name, type) => args.iModel.fonts.findId({ name, type }) ?? 0);
@@ -28,7 +28,7 @@ export function layoutTextBlock(args) {
 /**
  * Gets the result of laying out the the contents of a TextBlock into a series of lines containing runs.
  * The visual layout accounts for the [TextStyle]($common)s, fonts, and [TextBlock.width]($common). It applies word-wrapping if needed.
- * The layout returned matches the visual layout of the geometry produced by [[produceTextAnnotationGeometry]].
+ * The layout returned matches the visual layout of the geometry produced by [[appendTextAnnotationGeometry]].
  * @beta
  */
 export function computeLayoutTextBlockResult(args) {
@@ -172,6 +172,13 @@ class LayoutContext {
         layout.extendRange(denominator);
         return { layout, numerator, denominator };
     }
+    computeRangeForTabRun(style, source, length) {
+        const interval = source.styleOverrides.tabInterval ?? style.tabInterval;
+        const tabEndX = interval - length % interval;
+        const range = new Range2d(0, 0, 0, style.lineHeight);
+        range.extendXY(tabEndX, range.low.y);
+        return range;
+    }
 }
 function split(source) {
     if (source.length === 0) {
@@ -189,7 +196,17 @@ function split(source) {
     }
     return segments;
 }
-/** @internal */
+function applyTabShift(run, parent, context) {
+    if (run.source.type === "tab") {
+        run.range.setFrom(context.computeRangeForTabRun(run.style, run.source, parent.lengthFromLastTab));
+    }
+}
+/**
+ * Represents the layout of a single run (text, fraction, or line break) within a line of text.
+ * Stores information about the run's position, style, and font within the line.
+ * Provides utilities for splitting text runs for word wrapping and converting to result objects.
+ * @beta
+ */
 export class RunLayout {
     source;
     charOffset;
@@ -236,8 +253,9 @@ export class RunLayout {
                 denominatorRange = ranges.denominator;
                 break;
             }
-            default: {
-                // We do this so that blank lines space correctly without special casing later.
+            default: { // "linebreak" or "tab"
+                // "tab": Tabs rely on the context they are in, so we compute its range later.
+                // lineBreak: We do this so that blank lines space correctly without special casing later.
                 range = new Range2d(0, 0, 0, style.lineHeight);
                 break;
             }
@@ -302,12 +320,18 @@ export class RunLayout {
         return result;
     }
 }
-/** @internal */
+/**
+ * Represents the layout of a single line within a paragraph of a text block.
+ * Contains a sequence of RunLayout objects, the computed range of the line, and its offset from the document origin.
+ * Provides utilities for appending runs, computing ranges, and converting to result objects.
+ * @beta
+ */
 export class LineLayout {
     source;
     range = new Range2d(0, 0, 0, 0);
     justificationRange = new Range2d(0, 0, 0, 0);
     offsetFromDocument = { x: 0, y: 0 };
+    lengthFromLastTab = 0; // Used to track the length from the last tab for tab runs.
     _runs = [];
     constructor(source) {
         this.source = source;
@@ -347,6 +371,12 @@ export class LineLayout {
                 const runJustificationRange = run.justificationRange?.cloneTranslated(runOffset);
                 this.justificationRange.extendRange(runJustificationRange ?? runLayoutRange);
             }
+            if (run.source.type === "tab") {
+                this.lengthFromLastTab = 0;
+            }
+            else {
+                this.lengthFromLastTab += run.range.xLength();
+            }
         }
     }
     toResult(textBlock) {
@@ -361,7 +391,9 @@ export class LineLayout {
 }
 /**
  * Describes the layout of a text block as a collection of lines containing runs.
- * @internal
+ * Computes the visual layout of the text block, including word wrapping, justification, and margins.
+ * Provides access to the computed lines, ranges, and utilities for converting to result objects.
+ * @beta
  */
 export class TextBlockLayout {
     source;
@@ -385,7 +417,7 @@ export class TextBlockLayout {
     toResult() {
         return {
             lines: this.lines.map((x) => x.toResult(this.source)),
-            range: this.textRange.toJSON(),
+            range: this.range.toJSON(),
         };
     }
     /** Compute a string representation, primarily for debugging purposes. */
@@ -418,22 +450,32 @@ export class TextBlockLayout {
                     curLine = this.flushLine(context, curLine);
                     continue;
                 }
+                // If this is a tab, we need to apply the tab shift first, and then we can treat it like a text run.
+                applyTabShift(run, curLine, context);
+                // If our width is not set (doWrap is false), then we don't have to compute word wrapping, so just append the run, and continue.
                 if (!doWrap) {
                     curLine.append(run);
                     continue;
                 }
+                // Next, determine if we can append this run to the current line without exceeding the document width
                 const runWidth = run.range.xLength();
                 const lineWidth = curLine.range.xLength();
+                // If true, then no word wrapping is required, so we can append to the current line.
                 if (runWidth + lineWidth < doc.width || Geometry.isAlmostEqualNumber(runWidth + lineWidth, doc.width, Geometry.smallMetricDistance)) {
                     curLine.append(run);
                     continue;
                 }
+                // Do word wrapping
                 if (curLine.runs.length === 0) {
                     curLine.append(run);
+                    // Lastly, flush line
                     curLine = this.flushLine(context, curLine);
                 }
                 else {
+                    // First, flush line
                     curLine = this.flushLine(context, curLine);
+                    // Recompute tab shift if applicable
+                    applyTabShift(run, curLine, context);
                     curLine.append(run);
                 }
             }
@@ -510,4 +552,4 @@ export class TextBlockLayout {
         this.range.extendXY(xLow, yLow);
     }
 }
-//# sourceMappingURL=TextAnnotationLayout.js.map
+//# sourceMappingURL=TextBlockLayout.js.map