Create a plan view

​

Before you start

​

Save the view in a project

import {
  drawProjectView,
  type BuildingModel,
  type ProjectFile,
  type SavedDrawingView,
} from '@opengeometry/floorkit';

export const groundPlan: SavedDrawingView = {
  id: 'ground-plan',
  name: 'Ground floor plan',
  kind: 'plan',
  storeyId: 'ground',
  cutHeightAboveStorey: 1.2,
};

export function createProject(buildingModel: BuildingModel): ProjectFile {
  return {
    schema: 'floorkit.project',
    version: 3,
    buildingModel,
    views: [groundPlan],
    paper: { version: 1, unitSystem: 'metric', sheets: [] },
  };
}

​

Get the linework

export function planLinework(project: ProjectFile) {
  const drawing = drawProjectView(project, 'ground-plan');
  console.log(`${drawing.primitives.length} primitives`, drawing.bounds);
  return drawing;
}

​

Rules

• cutHeightAboveStorey is in metres above the storey elevation. A cut at 1.2 metres goes through doors and most windows.
• The view holds no lines. It is drawn from the model, so it is always up to date.
• showMassing: true also draws the outline of each part of the mass of every building on the site, on the sheet and in the plan editor. Under the masses it draws the parcel and the dashed setback line: the edge of what the setback check of evaluateZoning leaves buildable under the site’s zoning rules. Both are drawn only, never selected. It is off by default. A file with this field does not open in Floorkit 1.1.0.
• Give the project the current model of your session before you draw: { ...project, buildingModel: session.snapshot() }.
• To show the plan and let the user edit it, use the plan editor.

​

Next