buildFromBuildingModel

Use it to show a building that the user does not edit. For editing, use BuildingSession.

Import

import { buildFromBuildingModel, disposeBuildResult, BmBuildError } from '@opengeometry/floorkit';

Example

import * as THREE from 'three';
import {
  buildFromBuildingModel,
  disposeBuildResult,
  type BuildingModel,
} from '@opengeometry/floorkit';

export function inspectBuild(model: BuildingModel): void {
  const build = buildFromBuildingModel(model, new THREE.Group());
  try {
    console.log(build.warnings, build.sourceByLiveId);
  } finally {
    disposeBuildResult(build);
  }
}

Notes

Start the geometry kernel first.
The root of the result is already a child of the parent that you give.
elementsById gives the element for an id in the model. sourceByLiveId gives the model id for a live element.
Read warnings after the build.
A door, a window or a hole that does not fit on its wall at its saved offset is drawn there without a hole. The build does not change the model. It gives the warning opening-does-not-fit: its openingFit gives the offsets where the opening fits and the nearest one. Move the opening to such an offset to remove the warning.
Call disposeBuildResult when you replace or remove the build.
Give the content of external assets in assetSources. The function does not download them.

Signature

function buildFromBuildingModel(
  ir: BuildingModel,
  parent: THREE.Object3D,
  options?: BuildOptions,
): BuildResult;

Parameters

BuildingModel

required

THREE.Object3D

required

BuildOptions

Default: {}.

Returns

BuildResult;

disposeBuildResult

Release a completed build after replacing it or closing its owner.

function disposeBuildResult(built: BuildResult): void;

BmBuildError

class BmBuildError extends Error {
  readonly path: string;
  readonly code: string;
  readonly reason?: unknown;
  constructor(path: string, code: string, message: string, reason?: unknown);
}

Types

BuildOptions

interface BuildOptions {
  validated?: boolean;
  stampMembership?: boolean;
  assetSources?: Record<string, string | OpenElementDefinition>;
  massColors?: Readonly<Record<string, BmColor>>;
}

boolean

Skip revalidation for a document already checked this tick.

boolean

Stamp storeyId/buildingId onto every element’s propertySet. Default true.

Record<string, string | OpenElementDefinition>

.op sources for the document’s external-op assets, keyed by their uri, as either a raw buffer or an already-parsed definition. Fetching is the CALLER’s pre-step so this function stays synchronous — the same split .opbase uses (OPBaseOptions.assetSources). An embedded-op asset needs nothing here.

Readonly<Record<string, BmColor>>

The colour of a mass part by its use, #rrggbb by use name, used for a part when neither it nor its mass has a color. Replaces MASS_COLORS_BY_USE whole; a use it does not list takes #a0b8c8. Pass it where the project is opened (ProjectManager build) so that the live build, the plan drawings and the sheets take the same colours.

BuildResult

interface BuildResult {
  root: THREE.Group;
  elementsById: Map<string, OPElement>;
  modelObjectsById: Map<string, CompiledModelObject>;
  sourceByLiveId: Map<string, BuildingSourceRef>;
  storeyGroups: Map<string, THREE.Group>;
  wallNetworks: Map<string, WallNetwork>;
  warnings: BmIssue[];
  spatialStructure: BuildingModelSpatialStructure;
}

THREE.Group

required

One group per build, already added to the parent, at identity — elements are in world coordinates.

Map<string, OPElement>

required

BuildingModel id -> live element, so a caller can edit without re-parsing the document.

Map<string, CompiledModelObject>

required

Saved basic geometry, kept separate from BIM elements and their exporter contract.

Map<string, BuildingSourceRef>

required

Live element ID -> authored BuildingModel identity and feature.

Map<string, THREE.Group>

required

Map<string, WallNetwork>

required

BmIssue[]

required

BuildingModelSpatialStructure

required

CompiledModelObject

Extend this discriminated union alongside BmModelObject.

type CompiledModelObject =
  | CompiledLineObject
  | CompiledArcObject
  | CompiledPolylineObject
  | CompiledPolygonObject
  | CompiledRectangleObject
  | CompiledCuboidObject
  | CompiledCylinderObject;

BuildingModelSpatialStructure

The non-geometric ownership context returned by a BuildingModel build.

interface BuildingModelSpatialStructure {
  project: SpatialStructureScope;
  site?: SpatialStructureScope;
  buildings: SpatialStructureBuilding[];
}

CompiledLineObject

A compiled line and its authored ownership, kept separate from BIM elements. The package does not export this type by name.

interface CompiledLineObject {
  kind: 'line';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  worldStart: Vec3;
  worldEnd: Vec3;
  color?: string;
  object: LinePrimitive;
}

'line'

required

string

required

string

required

string

required

string

required

Vec3

required

Vec3

required

string

Saved #rrggbb stroke, independent of the live THREE material.

LinePrimitive

required

CompiledArcObject

A compiled circular arc and its world-space working-plane frame.

interface CompiledArcObject {
  kind: 'arc';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  worldCenter: Vec3;
  worldXAxis: Vec3;
  worldYAxis: Vec3;
  radius: number;
  startAngle: number;
  sweepAngle: number;
  color?: string;
  object: ArcPrimitive;
}

CompiledPolylineObject

A compiled open path with vertices in world XYZ coordinates.

interface CompiledPolylineObject {
  kind: 'polyline';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  worldVertices: Vec3[];
  color?: string;
  object: PolylinePrimitive;
}

CompiledPolygonObject

A compiled filled profile with rings in world XYZ coordinates.

interface CompiledPolygonObject {
  kind: 'polygon';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  worldOuterRing: Vec3[];
  worldHoles: Vec3[][];
  color?: string;
  object: PolygonPrimitive;
}

CompiledRectangleObject

A compiled rectangle with its saved mode and projected world boundary.

interface CompiledRectangleObject {
  kind: 'rectangle';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  mode: 'size' | 'freeform';
  worldOuterRing: Vec3[];
  worldHoles: Vec3[][];
  color?: string;
  object: RectanglePrimitive;
}

CompiledCuboidObject

A native upright body and its authored footprint, with explicit saved ownership.

interface CompiledCuboidObject {
  kind: 'cuboid';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  mode: 'size' | 'freeform';
  height: number;
  worldOuterRing: Vec3[];
  worldHoles: Vec3[][];
  color?: string;
  object: AnalyticSolid & {
    ogType: string;
  };
}

CompiledCylinderObject

A native circular body with explicit authored ownership and world placement.

interface CompiledCylinderObject {
  kind: 'cylinder';
  id: string;
  buildingId: string;
  storeyId: string;
  workingPlaneId: string;
  worldCenter: Vec3;
  radius: number;
  height: number;
  color?: string;
  object: AnalyticSolid & {
    ogType: string;
  };
}

SpatialStructureScope

Property-bearing owner in a BuildingModel spatial hierarchy.

interface SpatialStructureScope {
  id: string;
  name: string;
  elevation?: number;
  propertySets?: PropertySets;
}

SpatialStructureBuilding

interface SpatialStructureBuilding extends SpatialStructureScope {
  storeys: SpatialStructureScope[];
}

API Reference

Runtime

Primitives

Shapes

Architecture

Datums

Annotations

Drawings

Views

World

Exports

Editor

Integration

Licensing

buildFromBuildingModel

Import

Example

Notes

Signature

Parameters

Returns

disposeBuildResult

BmBuildError

Types

BuildOptions

BuildResult

CompiledModelObject

BuildingModelSpatialStructure

CompiledLineObject

CompiledArcObject

CompiledPolylineObject

CompiledPolygonObject

CompiledRectangleObject

CompiledCuboidObject

CompiledCylinderObject

SpatialStructureScope

SpatialStructureBuilding

​Import

​Example

​Notes

​Signature

​Parameters

​Returns

​disposeBuildResult

​BmBuildError

​Types

​BuildOptions

​BuildResult

​CompiledModelObject

​BuildingModelSpatialStructure

​CompiledLineObject

​CompiledArcObject

​CompiledPolylineObject

​CompiledPolygonObject

​CompiledRectangleObject

​CompiledCuboidObject

​CompiledCylinderObject

​SpatialStructureScope

​SpatialStructureBuilding

​Related

Import

Example

Notes

Signature

Parameters

Returns

disposeBuildResult

BmBuildError

Types

BuildOptions

BuildResult

CompiledModelObject

BuildingModelSpatialStructure

CompiledLineObject

CompiledArcObject

CompiledPolylineObject

CompiledPolygonObject

CompiledRectangleObject

CompiledCuboidObject

CompiledCylinderObject

SpatialStructureScope

SpatialStructureBuilding

Related