Dimension geometry

Import

import {
  dimensionGeometry,
  measureDimension,
  resolveMeasure,
  resolveAngular,
  resolveRadial,
  leaderGeometry,
  terminatorGeometry,
} from '@opengeometry/floorkit';

dimensionGeometry

Resolve a linear dimension to vector lines + a label (paper mm).

function dimensionGeometry(dimension: DimensionInput, style?: DimensionStyle): AnnotationGeometry;

measureDimension

Build a viewport-linked dimension between two saved model points (metres).

function measureDimension(
  from: Point2,
  to: Point2,
  viewportId: string,
  options: MeasureOptions,
): MeasureAnnotation;

resolveMeasure

Resolve a MeasureAnnotation to vector geometry at render time, using the SAME viewportTransform the viewport’s drawing uses — so witness lines use the same transform as the drawing.

function resolveMeasure(
  annotation: MeasureAnnotation,
  viewport: Viewport,
  drawing: VectorDrawing,
  system?: UnitSystem,
): AnnotationGeometry;

resolveAngular

Resolve an AngularMeasureAnnotation at render time.

function resolveAngular(
  annotation: AngularMeasureAnnotation,
  viewport: Viewport,
  drawing: VectorDrawing,
): AnnotationGeometry;

resolveRadial

Resolve a RadialMeasureAnnotation at render time.

function resolveRadial(
  annotation: RadialMeasureAnnotation,
  viewport: Viewport,
  drawing: VectorDrawing,
  system?: UnitSystem,
): AnnotationGeometry;

leaderGeometry

Resolve a leader (polyline + arrowhead + text) to vector lines + a label (paper mm).

function leaderGeometry(leader: LeaderInput, style?: LeaderStyle): AnnotationGeometry;

terminatorGeometry

One terminator at at, opening back along inward.

function terminatorGeometry(
  kind: TerminatorKind,
  at: Point2,
  inward: Point2,
  sizeMm: number,
): TerminatorGeometry;

Types

DimensionInput

The package does not export this type by name.

interface DimensionInput {
  start: Point2;
  end: Point2;
  offset: number;
  label?: string;
  fontSize: number;
}

Point2

required

Point2

required

number

required

Perpendicular offset of the dimension line from the start→end segment.

string

Override text; defaults to the measured paper distance.

number

required

DimensionStyle

The package does not export this type by name.

interface DimensionStyle extends StrokeStyle {
  tickLength?: number;
  terminator?: TerminatorKind;
}

number

Terminator half-length in paper mm. Defaults to fontSize * 0.5.

TerminatorKind

Which mark to draw at each end. Defaults to “slash” — the architectural convention this package has always drawn, and the only one it could.

AnnotationGeometry

The vector primitives an annotation resolves to (paper mm). The package does not export this type by name.

interface AnnotationGeometry {
  lines: VectorLine[];
  label: VectorText;
  fills?: DrawingLoop[];
}

VectorLine[]

required

VectorText

required

DrawingLoop[]

Solid areas — a filled arrowhead, a dot terminator. Absent for annotations drawn entirely in stroke, which is every one this package emitted before terminators became configurable.

Point2

2D point in the extractor’s output.

type Point2 = PlanVectorPoint;

UnitSystem

Drawing scales: the named ratios a technical drawing is actually plotted at, and the one formatter that turns a ratio into the label printed on the sheet.

type UnitSystem = 'metric' | 'imperial';

AngularMeasureAnnotation

A viewport-linked angular dimension: vertex/from/to are saved points in the viewport’s model space (metres). The package does not export this type by name.

interface AngularMeasureAnnotation {
  id: string;
  kind: 'angular';
  styleId?: string;
  viewportId: string;
  vertex: Point2;
  from: Point2;
  to: Point2;
  radius: number;
  fontSize: number;
  precision?: number;
  label?: string;
}

string

required

"angular"

required

string

Named style in PaperDocument.dimensionStyles. Absent uses the default.

string

required

Point2

required

Angle vertex (model metres).

Point2

required

A point along the first ray (model metres).

Point2

required

A point along the second ray (model metres).

number

required

Arc radius in paper mm (annotation scale, zoom/scale-independent).

number

required

number

Decimal places on the degree value. Default 0.

string

Optional label override; default = measured angle in degrees.

RadialMeasureAnnotation

A viewport-linked radial dimension: center/edge are saved points in a viewport’s model space (metres), typically an arc/circle centre and edge. The package does not export this type by name.

interface RadialMeasureAnnotation {
  id: string;
  kind: 'radial';
  styleId?: string;
  viewportId: string;
  center: Point2;
  edge: Point2;
  mode: 'radius' | 'diameter';
  fontSize: number;
  precision?: number;
  label?: string;
}

string

required

"radial"

required

string

Named style in PaperDocument.dimensionStyles. Absent uses the default.

string

required

Point2

required

Arc/circle centre (model metres).

Point2

required

A point on the arc/circle (model metres); |edge − center| is the radius.

"radius" | "diameter"

required

radius → “R…”; diameter → ”⌀…” (line spans through the centre).

number

required

number

Decimal places on the measured mm value. Default 0.

string

Optional label override; default = measured radius/diameter in mm.

LeaderInput

The package does not export this type by name.

interface LeaderInput {
  target: Point2;
  points: Point2[];
  text: string;
  fontSize: number;
}

Point2

required

Arrow tip — points at the thing being annotated.

Point2[]

required

Knee points from the target to the text anchor (last point).

string

required

number

required

LeaderStyle

The package does not export this type by name.

interface LeaderStyle extends StrokeStyle {
  arrowLength?: number;
  arrowAngleDeg?: number;
}

number

Arrowhead barb length in paper mm. Defaults to fontSize.

number

Half-angle of the arrowhead in degrees. Defaults to 20.

TerminatorKind

type TerminatorKind = 'slash' | 'arrow' | 'open-arrow' | 'dot' | 'none';

TerminatorGeometry type

A terminator’s ink: stroked lines plus any filled loops. The package does not export this type by name.

interface TerminatorGeometry {
  lines: VectorLine[];
  fills: DrawingLoop[];
}

VectorLine[]

required

DrawingLoop[]

required

Solid areas — a filled arrowhead or a dot. Empty for stroked kinds.

StrokeStyle

Shared stroke styling for annotation lines (paper mm). The package does not export this type by name.

interface StrokeStyle {
  strokeColor?: PlanVectorColor;
  strokeWidth?: number;
}

PlanVectorPoint

interface PlanVectorPoint {
  x: number;
  y: number;
}

PlanVectorColor

type PlanVectorColor = [number, number, number];

API Reference

Runtime

Primitives

Shapes

Architecture

Datums

Annotations

Drawings

Views

World

Exports

Editor

Integration

Licensing

Dimension geometry

Import