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

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,EAA0C,MAAM,oBAAoB,CAAC;AAEpJ,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;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAwB1D;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAuC;IAClF,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAElE,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAEvG,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,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IAC1E,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAElE,+BAA+B;IAC/B,IAAI,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;QACjE,MAAM,GAAG,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;IACrJ,CAAC;IAED,gCAAgC;IAChC,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxD,MAAM,GAAG,MAAM,IAAI,sBAAsB,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACjJ,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,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QAChG,MAAM,GAAG,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QAClF,IAAI,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM;YAAE,MAAM,GAAG,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IACpM,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,KAAwB,EAAE,KAAc,EAAE,SAAoB;IACvH,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM;QAC9B,OAAO,KAAK,CAAC;IACf,MAAM,MAAM,GAAG,qBAAqB,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAEvI,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,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,mEAAmE;IACjH,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;QACxC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC;KACvC,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":["/*---------------------------------------------------------------------------------------------\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, ElementGeometry, FillDisplay, GeometryParams, TextAnnotation, TextAnnotationProps, TextStyleSettings } from \"@itwin/core-common\";\nimport { TextBlockLayout, TextStyleResolver } from \"./TextBlockLayout\";\nimport { LineString3d, PointString3d, Range2d, Transform } from \"@itwin/core-geometry\";\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { produceTextBlockGeometry } from \"./TextBlockGeometry\";\nimport { appendFrameToBuilder, computeIntervalPoints } from \"./FrameGeometry\";\nimport { appendLeadersToBuilder } from \"./LeaderGeometry\";\n\n/**\n * Properties required to compute the geometry of a text annotation.\n * @beta\n * @see [[appendTextAnnotationGeometry]] to append the geometry to an [[ElementGeometry.Builder]].\n */\nexport interface AppendTextAnnotationGeometryArgs {\n  /** The annotation to be drawn. Be sure to include a TextBlock with runs or no geometry will be produced. */\n  annotationProps: TextAnnotationProps;\n  /** Layout provided by calling [[layoutTextBlock]] */\n  layout: TextBlockLayout;\n  /** [[TextStyleResolver]] used to get styling and scale information for creating geometry. */\n  textStyleResolver: TextStyleResolver;\n  /** Builder that will be added to in place */\n  builder: ElementGeometry.Builder;\n  /** The category the element will belong to. This will passed into the [[GeometryParams]] */\n  categoryId: Id64String\n  /** The optional sub-category the element will belong to. This will passed into the [[GeometryParams]] */\n  subCategoryId?: Id64String\n  /** Whether or not to draw geometry for things like the snap points, range, and anchor point */\n  wantDebugGeometry?: boolean;\n}\n\n/** Constructs the TextBlockGeometry and frame geometry and appends the geometry to the provided builder.\n * @returns true if the geometry was successfully appended.\n * @beta\n */\nexport function appendTextAnnotationGeometry(props: AppendTextAnnotationGeometryArgs): boolean {\n  const annotation = TextAnnotation.fromJSON(props.annotationProps);\n\n  const transform = annotation.computeTransform(props.layout.range, props.textStyleResolver.scaleFactor);\n\n  let result = true;\n\n  // Construct the TextBlockGeometry\n  const params = new GeometryParams(props.categoryId, props.subCategoryId);\n  const entries = produceTextBlockGeometry(props.layout, transform.clone());\n  result = result && props.builder.appendTextBlock(entries, params);\n\n  // Construct the frame geometry\n  if (props.textStyleResolver.blockSettings.frame.shape !== \"none\") {\n    result = result && appendFrameToBuilder(props.builder, props.textStyleResolver.blockSettings.frame, props.layout.range, transform.clone(), params);\n  }\n\n  // Construct the leader geometry\n  if (annotation.leaders && annotation.leaders.length > 0) {\n    result = result && appendLeadersToBuilder(props.builder, annotation.leaders, props.layout, transform.clone(), params, props.textStyleResolver);\n  }\n\n  // Construct the debug geometry\n  if (props.wantDebugGeometry) {\n    result = result && debugAnchorPoint(props.builder, annotation, props.layout, transform.clone());\n    result = result && debugRunLayout(props.builder, props.layout, transform.clone());\n    if (props.textStyleResolver.blockSettings.frame.shape !== \"none\") result = result && debugSnapPoints(props.builder, props.textStyleResolver.blockSettings, props.layout.range, transform.clone());\n  }\n\n  return result;\n};\n\n/**\n * Draws the anchor point and margins of the text annotation.\n * The anchor point is the point around which the text rotates and is drawn as a blue x (1m by 1m).\n * The margins are drawn as a blue box.\n * The text range is drawn as a red box.\n */\nfunction debugAnchorPoint(builder: ElementGeometry.Builder, annotation: TextAnnotation, layout: TextBlockLayout, transform: Transform): boolean {\n  const range = Range2d.fromJSON(layout.range);\n  const debugAnchorPt = transform.multiplyPoint3d(annotation.computeAnchorPoint(range));\n\n  // Make it blue\n  const blueLineParams = new GeometryParams(Id64.invalid);\n  blueLineParams.lineColor = ColorDef.blue;\n  let result = builder.appendGeometryParamsChange(blueLineParams);\n\n  // Draw a blue box to show the element's margin\n  const marginCorners = range.corners3d(true);\n  transform.multiplyPoint3dArrayInPlace(marginCorners);\n  result = result && builder.appendGeometryQuery(LineString3d.create(marginCorners));\n\n  // Draw a blue x to show the anchor point - Rotation occurs around this point. The x will be 1 m by 1 m.\n  result = result && builder.appendGeometryQuery(LineString3d.create(debugAnchorPt.plusXYZ(-1, -1), debugAnchorPt.plusXYZ(1, 1)));\n  result = result && builder.appendGeometryQuery(LineString3d.create(debugAnchorPt.plusXYZ(1, -1), debugAnchorPt.plusXYZ(-1, 1)));\n\n  // Draw a red box to show the text range\n  const redLineParams = new GeometryParams(Id64.invalid);\n  redLineParams.lineColor = ColorDef.red;\n  result = result && builder.appendGeometryParamsChange(redLineParams);\n\n  const rangeCorners = layout.textRange.corners3d(true);\n  transform.multiplyPoint3dArrayInPlace(rangeCorners);\n  result = result && builder.appendGeometryQuery(LineString3d.create(rangeCorners));\n\n  return result;\n}\n\n/** Draws the interval points defined by calling [[computeIntervalPoints]]. The points are shown as black dots 5x larger than the borderWeight */\nfunction debugSnapPoints(builder: ElementGeometry.Builder, style: TextStyleSettings, range: Range2d, transform: Transform): boolean {\n  if (style.frame.shape === \"none\")\n    return false;\n  const points = computeIntervalPoints({ frame: style.frame.shape, range, transform, lineIntervalFactor: 0.5, arcIntervalFactor: 0.25 });\n\n  const params = new GeometryParams(Id64.invalid);\n  params.lineColor = ColorDef.black;\n  params.weight = style.frame.borderWeight * 5; // We want the dots to be bigger than the frame so we can see them.\n  params.fillDisplay = FillDisplay.Always;\n\n  const result = builder.appendGeometryParamsChange(params) && builder.appendGeometryQuery(PointString3d.create(points));\n  return result;\n}\n\n/**\n * Draws debug geometry for each line and run in a TextBlockLayout.\n *\n * For each line and run, this function draws boxes to visualize their layout and boundaries.\n * Different run types (e.g., text, linebreak, fraction, tab) are assigned distinct colors for clarity.\n * This is useful for debugging text layout and alignment issues.\n *\n * @param builder - The geometry builder to append debug geometry to.\n * @param layout - The text block layout containing lines and runs to visualize.\n * @param documentTransform - The transform to apply to the entire document.\n * @returns True if all debug geometry was successfully appended.\n */\nfunction debugRunLayout(builder: ElementGeometry.Builder, layout: TextBlockLayout, documentTransform: Transform): boolean {\n  let result = true; // Tracks if all geometry was appended successfully\n  let color = ColorDef.black; // Current color for the run type\n  let lastColor = color; // Last color used, to minimize param changes\n\n  // Map run types to debug colors\n  const colors = {\n    \"text\": ColorDef.fromString(\"orange\"),\n    \"linebreak\": ColorDef.fromString(\"yellow\"),\n    \"fraction\": ColorDef.fromString(\"green\"),\n    \"tab\": ColorDef.fromString(\"aquamarine\"),\n    \"field\": ColorDef.fromString(\"purple\"),\n  }\n\n  layout.lines.forEach(line => {\n    // Apply the line's offset transform\n    const lineTrans = Transform.createTranslationXYZ(line.offsetFromDocument.x, line.offsetFromDocument.y, 0);\n    documentTransform.multiplyTransformTransform(lineTrans, lineTrans);\n\n    line.runs.forEach(run => {\n      // Determine color for this run type\n      color = colors[run.source.type] ?? ColorDef.black;\n\n      // Only change geometry params if the color changes\n      if (!lastColor.equals(color)) {\n        const colorParams = new GeometryParams(Id64.invalid);\n        colorParams.lineColor = color;\n        result = result && builder.appendGeometryParamsChange(colorParams);\n        lastColor = color;\n      }\n\n      // Apply the line's offset to the run's offset\n      const runTrans = Transform.createTranslationXYZ(run.offsetFromLine.x, run.offsetFromLine.y, 0);\n      lineTrans.multiplyTransformTransform(runTrans, runTrans);\n\n      // Draw the enclosing range for the run\n      const runCorners = run.range.corners3d(true);\n      runTrans.multiplyPoint3dArrayInPlace(runCorners);\n      result = result && builder.appendGeometryQuery(LineString3d.create(runCorners));\n    });\n  });\n\n  return result;\n}\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;AAkI5F;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,SAAS,GAAG,sBAAsB,CAwBtH"}

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) {
@@ -47,6 +46,17 @@ function processTextRun(run, transform, context) {
     setColor(run.style.color, context);
     context.entries.push({ text: ts });
 }
+function processFieldRun(run, transform, context) {
+    assert(run.source.type === "field");
+    const text = run.source.cachedContent.substring(run.charOffset, run.charOffset + run.numChars);
+    if (text.length === 0) {
+        return;
+    }
+    const ts = createTextString(text, run);
+    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);
     assert(undefined !== ts.widthFactor);
@@ -93,12 +103,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);
@@ -107,75 +126,14 @@ function produceTextBlockGeometry(layout, documentTransform, debugAnchorPt) {
             if ("text" === run.source.type) {
                 processTextRun(run, runTrans, context);
             }
-            else {
+            else if ("fraction" === run.source.type) {
                 processFractionRun(run, runTrans, context);
             }
+            else {
+                processFieldRun(run, runTrans, context);
+            }
         }
     }
-    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,eAAe,CAAC,GAAc,EAAE,SAAoB,EAAE,OAAwB;IACrF,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/F,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,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,IAAI,UAAU,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC1C,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACN,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;AACtC,CAAC","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 { TextBlockGeometryProps, TextBlockGeometryPropsEntry, TextString, TextStyleColor } from \"@itwin/core-common\";\nimport { RunLayout, TextBlockLayout } from \"./TextBlockLayout\";\nimport { LineSegment3d, Point3d, Range2d, Transform, Vector2d } from \"@itwin/core-geometry\";\nimport { assert } from \"@itwin/core-bentley\";\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 processFieldRun(run: RunLayout, transform: Transform, context: GeometryContext): void {\n  assert(run.source.type === \"field\");\n  const text = run.source.cachedContent.substring(run.charOffset, run.charOffset + run.numChars);\n  if (text.length === 0) {\n    return;\n  }\n\n  const ts = createTextString(text, run);\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\n/**\n * Produces the geometry for a text block in a way that can be interpreted by a [[GeometryStreamBuilder]] or [[ElementBuilder.Geometry]].\n * To build the geometry for a whole [[TextAnnotation]], use [[appendTextAnnotationGeometry]] instead.\n * @param layout of the text block as computed by [[layoutTextBlock]].\n * @param documentTransform that positions the text block in world coordinates.\n * @returns TextBlockGeometryProps.\n * @beta\n */\nexport function produceTextBlockGeometry(layout: TextBlockLayout, documentTransform: Transform): 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      // Skip runs that are solely whitespace\n      if (run.source.isWhitespace) {\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 if (\"fraction\" === run.source.type) {\n        processFractionRun(run, runTrans, context);\n      } else {\n        processFieldRun(run, runTrans, context);\n      }\n    }\n  }\n\n  return { entries: context.entries };\n}\n"]}

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

@@ -1,9 +1,10 @@
 /** @packageDocumentation
  * @module ElementGeometry
  */
-import { BaselineShift, FontId, FontType, FractionRun, LineLayoutResult, Paragraph, Run, RunLayoutResult, TextBlock, TextBlockLayoutResult, TextRun, TextStyleSettings } from "@itwin/core-common";
+import { BaselineShift, FieldRun, FontId, FontType, FractionRun, LineLayoutResult, Paragraph, Run, RunLayoutResult, TabRun, TextAnnotationLeader, TextBlock, TextBlockLayoutResult, TextRun, TextStyleSettings } from "@itwin/core-common";
 import { Range2d } from "@itwin/core-geometry";
-import { IModelDb } from "./IModelDb";
+import { IModelDb } from "../IModelDb";
+import { Id64String } from "@itwin/core-bentley";
 /** @internal */
 export interface TextLayoutRanges {
     layout: Range2d;
@@ -30,8 +31,8 @@ export type ComputeRangesForTextLayout = (args: ComputeRangesForTextLayoutArgs)
  * @internal
  */
 export type FindFontId = (name: string, type?: FontType) => FontId;
-/** @internal */
-export type FindTextStyle = (name: string) => TextStyleSettings;
+/** @internal chiefly for tests. */
+export type FindTextStyle = (id: Id64String) => TextStyleSettings;
 /**
  * Arguments supplied to [[computeLayoutTextBlockResult]].
  * @beta
@@ -39,12 +40,12 @@ export type FindTextStyle = (name: string) => TextStyleSettings;
 export interface LayoutTextBlockArgs {
     /** The text block whose extents are to be computed. */
     textBlock: TextBlock;
-    /** The iModel from which to obtain fonts and [TextStyle]($common)s when laying out glyphs. */
+    /** The iModel from which to obtain fonts and [[AnnotationTextStyle]]s when laying out glyphs. */
     iModel: IModelDb;
+    /** The text style resolver used to resolve effective text styles during layout. */
+    textStyleResolver: TextStyleResolver;
     /** @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;
 }
@@ -55,13 +56,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 visual layout accounts for the [[AnnotationTextStyle]]s, fonts, and [TextBlock.width]($common). It applies word-wrapping if needed.
+ * The layout returned matches the visual layout of the geometry produced by [[appendTextAnnotationGeometry]].
  * @beta
  */
 export declare function computeLayoutTextBlockResult(args: LayoutTextBlockArgs): TextBlockLayoutResult;
@@ -85,26 +86,64 @@ export interface ComputeGraphemeOffsetsArgs extends LayoutTextBlockArgs {
  * @beta
  */
 export declare function computeGraphemeOffsets(args: ComputeGraphemeOffsetsArgs): Range2d[];
+/**
+ * Arguments used when constructing a [[TextStyleResolver]].
+ * @beta
+ */
+export interface TextStyleResolverArgs {
+    /** The text block whose styles are being resolved. */
+    textBlock: TextBlock;
+    /** The iModel from which to obtain [[AnnotationTextStyle]]s when resolving styles. */
+    iModel: IModelDb;
+    /** The ID of the model containing the text block, used to compute the scale factor. */
+    modelId?: Id64String;
+    /** @internal chiefly for tests, by default looks up an [[AnnotationTextStyle]] in the iModel by ID. */
+    findTextStyle?: FindTextStyle;
+}
+/**
+ * Resolves the effective style of TextBlockComponents and Leaders, taking into account overrides/style of the instance and its parent(s).
+ * @beta
+ */
+export declare class TextStyleResolver {
+    private readonly _textStyles;
+    private readonly _findTextStyle;
+    /** The resolved style of the TextBlock. */
+    readonly blockSettings: TextStyleSettings;
+    /** The scale factor of the model containing the TextBlock. */
+    readonly scaleFactor: number;
+    constructor(args: TextStyleResolverArgs);
+    private resolveParagraphSettingsImpl;
+    /** Looks up an [[AnnotationTextStyle]] by ID. Uses caching. */
+    findTextStyle(id: Id64String): TextStyleSettings;
+    /** Resolves the effective style for a [TextAnnotationLeader]($common). The TextAnnotationLeader should be a sibling of the provided TextBlock. */
+    resolveTextAnnotationLeaderSettings(leader: TextAnnotationLeader): TextStyleSettings;
+    /** Resolves the effective style for a [Paragraph]($common). Paragraph should be child of provided TextBlock. */
+    resolveParagraphSettings(paragraph: Paragraph): TextStyleSettings;
+    /** Resolves the effective style for a [Run]($common). Run should be child of provided Paragraph and TextBlock. */
+    resolveRunSettings(paragraph: Paragraph, run: Run): TextStyleSettings;
+}
 declare class LayoutContext {
+    readonly textStyleResolver: TextStyleResolver;
     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);
+    constructor(textStyleResolver: TextStyleResolver, _computeTextRange: ComputeRangesForTextLayout, _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;
+    computeRangeForTextRun(style: TextStyleSettings, run: TextRun | FieldRun, charOffset: number, numChars: number): TextLayoutRanges;
     computeRangeForFractionRun(style: TextStyleSettings, source: FractionRun): {
         layout: Range2d;
         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;
@@ -120,7 +159,7 @@ export declare class RunLayout {
     style: TextStyleSettings;
     fontId: FontId;
     private constructor();
-    static create(source: Run, context: LayoutContext): RunLayout;
+    static create(source: Run, parentParagraph: Paragraph, context: LayoutContext): RunLayout;
     /** Compute a string representation, primarily for debugging purposes. */
     stringify(): string;
     canWrap(): this is {
@@ -130,7 +169,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 +183,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 +198,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 +221,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,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,SAAS,EAAE,qBAAqB,EAAoB,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AACrR,OAAO,EAAY,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAU,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAMlF,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,mCAAmC;AACnC,MAAM,MAAM,aAAa,GAAG,CAAC,EAAE,EAAE,UAAU,KAAK,iBAAiB,CAAC;AAclE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,SAAS,EAAE,SAAS,CAAC;IACrB,iGAAiG;IACjG,MAAM,EAAE,QAAQ,CAAC;IACjB,mFAAmF;IACnF,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,8FAA8F;IAC9F,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;IAC9C,qEAAqE;IACrE,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAK1E;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,CAoBlF;AAkDD;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,sDAAsD;IACtD,SAAS,EAAE,SAAS,CAAC;IACrB,sFAAsF;IACtF,MAAM,EAAE,QAAQ,CAAC;IACjB,uFAAuF;IACvF,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,uGAAuG;IACvG,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA4C;IACxE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,2CAA2C;IAC3C,SAAgB,aAAa,EAAE,iBAAiB,CAAC;IACjD,8DAA8D;IAC9D,SAAgB,WAAW,EAAE,MAAM,CAAC;gBAEjB,IAAI,EAAE,qBAAqB;IAe9C,OAAO,CAAC,4BAA4B;IASpC,+DAA+D;IACxD,aAAa,CAAC,EAAE,EAAE,UAAU,GAAG,iBAAiB;IASvD,kJAAkJ;IAC3I,mCAAmC,CAAC,MAAM,EAAE,oBAAoB,GAAG,iBAAiB;IAS3F,gHAAgH;IACzG,wBAAwB,CAAC,SAAS,EAAE,SAAS,GAAG,iBAAiB;IAIxE,kHAAkH;IAC3G,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,GAAG,iBAAiB;CAQ7E;AAED,cAAM,aAAa;aAGkB,iBAAiB,EAAE,iBAAiB;IAAE,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAA8B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAFrK,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;gBAEnB,iBAAiB,EAAE,iBAAiB,EAAmB,iBAAiB,EAAE,0BAA0B,EAAmB,WAAW,EAAE,UAAU;IAE1K,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAShC,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,GAAG,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,gBAAgB;IAejI,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,eAAe,EAAE,SAAS,EAAG,OAAO,EAAE,aAAa,GAAG,SAAS;IAsCjG,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"}