drawProjectView - Floorkit

The drawing is a list of lines, arcs, regions and text in metres.

Import

import {
  drawProjectView,
  drawProjectViewFromBuild,
  ProjectDrawingError,
} from '@opengeometry/floorkit';

Example

import {
  drawProjectViewFromBuild,
  type ProjectFile,
  type BuildingSession,
} from '@opengeometry/floorkit';

export function currentDrawing(project: ProjectFile, viewId: string, session: BuildingSession) {
  const current: ProjectFile = { ...project, buildingModel: session.snapshot() };
  return drawProjectViewFromBuild(current, viewId, session.currentBuild);
}

Notes

drawProjectView builds a temporary copy of the building. drawProjectViewFromBuild uses the build of a session that is open, which is faster.
With drawProjectViewFromBuild, put session.snapshot() into the project first.
A plan cuts straight walls at the cut height of the view.
If Floorkit cannot draw a view, it throws ProjectDrawingError with a code. It does not draw a footprint in place of a cut.

Signature

function drawProjectView(
  project: ProjectFile,
  viewId: string,
  options?: DrawProjectViewOptions,
): VectorDrawing;

Parameters

ProjectFile

required

string

required

DrawProjectViewOptions

Default: {}.

Returns

VectorDrawing;

drawProjectViewFromBuild

Draw a saved view from an existing compilation without rebuilding its geometry.

function drawProjectViewFromBuild(
  project: ProjectFile,
  viewId: string,
  built: BuildResult,
  options?: DrawProjectViewOptions,
): VectorDrawing;

ProjectDrawingError

class ProjectDrawingError extends Error {
  readonly code: ProjectDrawingErrorCode;
  readonly viewId: string;
  constructor(code: ProjectDrawingErrorCode, viewId: string, message: string);
}

Types

VectorDrawing

Plain-data vector drawing returned by a DrawingExtractor.

interface VectorDrawing {
  units: 'meters';
  bounds: PlanVectorBounds;
  primitives: DrawingPrimitive[];
  texts?: VectorText[];
}

'meters'

required

PlanVectorBounds

required

DrawingPrimitive[]

required

The standardized drawing geometry.

VectorText[]

Optional model-anchored labels (e.g. from the kernel projection path).

DrawProjectViewOptions

interface DrawProjectViewOptions {
  assetSources?: BuildOptions['assetSources'];
  massColors?: BuildOptions['massColors'];
}

BuildOptions['assetSources']

BuildOptions['massColors']

The colours of mass parts by use; see BuildOptions.massColors.

ProjectDrawingErrorCode

type ProjectDrawingErrorCode =
  | 'inconsistent-build'
  | 'unknown-view'
  | 'unknown-storey'
  | 'unknown-element'
  | 'unsupported-element'
  | 'empty-filter'
  | 'empty-view'
  | 'unsupported-visible-range'
  | 'unsupported-view';

PlanVectorBounds

interface PlanVectorBounds {
  min: PlanVectorPoint;
  max: PlanVectorPoint;
  width: number;
  height: number;
}

VectorExtractable

Implemented by model elements that can be drawn into a paper viewport — the three-free successor to PlanVectorExportable.getExportRoots().

interface VectorExtractable {
  getBrepEntities(): BrepEntity[];
}

DrawingSourceRef

A drawing hit may identify a saved feature without granting an edit gesture.

type DrawingSourceRef = BuildingSourceRef & {
  readonly interaction: 'selectable' | 'inspect-only';
};

VectorLine

A projected line segment.

type VectorLine = PlanVectorLine;

DrawingView

Views the extractor can project.

type DrawingView = 'top' | 'front' | 'right' | 'left' | 'back' | 'iso';

VectorText

A model label/tag projected as vector text (paper renders it natively).

interface VectorText {
  position: Point2;
  text: string;
  height: number;
  paperHeightMm?: number;
  rotationDeg?: number;
}

Point2

required

string

required

number

required

Text height in model units (meters).

number

Paper millimetres, overriding height at placement — see DrawingText.paperHeightMm.

number

VectorArc

An optional projected arc segment.

interface VectorArc {
  center: Point2;
  radius: number;
  startAngleDeg: number;
  endAngleDeg: number;
  stroke_width?: number;
  stroke_color?: PlanVectorColor;
}

DrawingRequest

Describes what a single viewport draws from model space.

interface DrawingRequest {
  view: DrawingView;
  cut?: {
    elevation?: number;
    sectionId?: string;
  };
  camera?: ProjectionCamera;
  hlr?: PlanProjectionHlr;
  entities?: string[] | 'all';
  labelMm?: number;
}

DrawingView

required

{ elevation?: number; sectionId?: string; }

Plan cut-plane elevation, or the section/elevation line id.

ProjectionCamera

Required for view: 'iso'.

PlanProjectionHlr

string[] | 'all'

Which model entities to include, or 'all'.

number

Print every text primitive at this height in paper millimetres, regardless of the sheet scale — stamped onto each as DrawingText.paperHeightMm. Without it a consumer has to rewrite each element’s fontSize before extracting, which mutates the model to change a drawing and reaches only the element types it knows about.

DrawingExtractor

Headless, three-free extraction API.

interface DrawingExtractor {
  extract(req: DrawingRequest): VectorDrawing;
}

DrawingLoop

An ordered, implicitly-closed ring of points.

type DrawingLoop = Point2[];

DrawingFill

Region fill (poché) descriptor.

interface DrawingFill {
  color?: PlanVectorColor;
  pattern?: 'solid' | 'hatch';
}

DrawingStyle

interface DrawingStyle {
  role?: 'cut' | 'silhouette' | 'projected' | 'hidden' | 'datum' | 'marker';
  ogType?: string;
  ogid?: string;
  subId?: string;
  outlineGroup?: string;
  stroke?: {
    color?: PlanVectorColor;
    width?: number;
  };
  fill?: DrawingFill;
  outline?: boolean;
  edgeClass?: string;
}

Physical drawing meaning; paper/renderers resolve its print appearance.

string

Source element type (“WALL”|“DOOR”|…) → app-side lineweight + fill policy.

string

Source element instance id. Stamped by the extractor so an interactive 2D renderer can map a picked primitive back to its element (getElementById(ogid) → getEditAnchors()). Unset on the export-only path.

string

Optional sub-feature id within the source element (e.g. “edge:2”, “v:outer:3”) for finer-grained editing/hit-testing. Producers set this when they emit per-feature primitives; element-level picking only needs ogid.

string

The joined wall group that an outline line bounds: the id of its first wall and the index of that wall’s cut region.

{ color?: PlanVectorColor; width?: number; }

DrawingFill

Region fill (poché). Unset unless a producer or fill policy assigns it.

boolean

false draws a region’s fill WITHOUT its own outline. Set when the outline is drawn separately: merged wall poché emits the boundary of the joined mass as line primitives, so each wall’s own ring must not be stroked or every junction seam comes back. Ignored by the other primitive kinds, which are outlines already.

string

Kernel HLR edge class, carried verbatim from projection (e.g. “VisibleOutline” | “Hidden” | “VisibleCrease”). Unset for authored 2D (plan) primitives. Lets the renderer dash hidden edges, etc.

DrawingPrimitiveSource

interface DrawingPrimitiveSource {
  sourceRef?: DrawingSourceRef;
  sourceRefs?: readonly DrawingSourceRef[];
}

DrawingSourceRef

Authored identity for selection; absent when the drawing cannot attribute a source.

readonly DrawingSourceRef[]

Multiple authored owners of merged material. No arbitrary single editable owner.

DrawingLine

interface DrawingLine extends DrawingPrimitiveSource {
  kind: 'line';
  start: Point2;
  end: Point2;
  style?: DrawingStyle;
}

DrawingArc

interface DrawingArc extends DrawingPrimitiveSource {
  kind: 'arc';
  center: Point2;
  radius: number;
  startAngleDeg: number;
  endAngleDeg: number;
  style?: DrawingStyle;
}

DrawingBoundary

type DrawingBoundary = DrawingLine | DrawingArc;

DrawingCurvedRegion

interface DrawingCurvedRegion extends DrawingPrimitiveSource {
  kind: 'curvedRegion';
  outer: DrawingBoundary[];
  holes: DrawingBoundary[][];
  style?: DrawingStyle;
}

DrawingRegion

interface DrawingRegion extends DrawingPrimitiveSource {
  kind: 'region';
  outer: DrawingLoop;
  holes: DrawingLoop[];
  style?: DrawingStyle;
}

'region'

required

DrawingLoop

required

Outer boundary ring.

DrawingLoop[]

required

Inner rings (holes) — even-odd voids, e.g. door/window openings in a wall.

DrawingStyle

DrawingText

interface DrawingText extends DrawingPrimitiveSource {
  kind: 'text';
  position: Point2;
  text: string;
  align?: 'left' | 'center' | 'right';
  height: number;
  paperHeightMm?: number;
  rotationDeg?: number;
  style?: DrawingStyle;
}

'text'

required

Point2

required

string

required

'left' | 'center' | 'right'

Horizontal alignment at position; omitted preserves centered text.

number

required

Text height in model units (meters).

number

Text height in PAPER millimetres, overriding height at placement.

number

DrawingStyle

DrawingPolyline

An open or closed run of straight segments through points (back to the first when closed).

interface DrawingPolyline extends DrawingPrimitiveSource {
  kind: 'polyline';
  points: Point2[];
  closed?: boolean;
  style?: DrawingStyle;
}

DrawingPrimitive

type DrawingPrimitive =
  | DrawingLine
  | DrawingArc
  | DrawingRegion
  | DrawingCurvedRegion
  | DrawingText
  | DrawingPolyline;

PlanVectorLine

interface PlanVectorLine {
  start: PlanVectorPoint;
  end: PlanVectorPoint;
  stroke_width?: number;
  stroke_color?: PlanVectorColor;
  ogType?: string;
}

PlanVectorPoint

required

PlanVectorPoint

required

number

PlanVectorColor

string

Source element type (e.g. “WALL”), for app-side lineweight policy.

​Import

​Example

​Notes

​Signature

​Parameters

​Returns

​drawProjectViewFromBuild

​ProjectDrawingError

​Types

​VectorDrawing

​DrawProjectViewOptions

​ProjectDrawingErrorCode

​PlanVectorBounds

​VectorExtractable

​DrawingSourceRef

​VectorLine

​DrawingView

​VectorText

​VectorArc

​DrawingRequest

​DrawingExtractor

​DrawingLoop

​DrawingFill

​DrawingStyle

​DrawingPrimitiveSource

​DrawingLine

​DrawingArc

​DrawingBoundary

​DrawingCurvedRegion

​DrawingRegion

​DrawingText

​DrawingPolyline

​DrawingPrimitive

​PlanVectorLine

​Related

Import

Example

Notes

Signature

Parameters

Returns

drawProjectViewFromBuild

ProjectDrawingError

Types

VectorDrawing

DrawProjectViewOptions

ProjectDrawingErrorCode

PlanVectorBounds

VectorExtractable

DrawingSourceRef

VectorLine

DrawingView

VectorText

VectorArc

DrawingRequest

DrawingExtractor

DrawingLoop

DrawingFill

DrawingStyle

DrawingPrimitiveSource

DrawingLine

DrawingArc

DrawingBoundary

DrawingCurvedRegion

DrawingRegion

DrawingText

DrawingPolyline

DrawingPrimitive

PlanVectorLine

Related