Window

Attach it to a wall and the wall gets a real opening.

Import

import { Window } from '@opengeometry/floorkit';

Example

import { Window, Wall, WallNetwork, WallMaterial, Floorkit } from '@opengeometry/floorkit';

async function example(wasmURL: string): Promise<void> {
  await new Floorkit().setupOpenGeometry(wasmURL);
  const network = new WallNetwork();
  const opening = new Window({
    stationLocal: { alongWall: 2.5 },
    windowDimensions: { width: 1.2, thickness: 0.04 },
    windowHeight: 1.2,
    sillHeight: 0.9,
  });
  try {
    const wall = network.add(
      new Wall({
        labelName: 'Partition',
        axis: { kind: 'line', start: [0, 0, 0], end: [5, 0, 0] },
        thickness: 0.2,
        height: 3,
        baseElevation: 0,
        locationLine: 'centre',
        locationOffset: 0,
        material: WallMaterial.CONCRETE,
        color: 0xcccccc,
        priority: 0,
        joins: { start: { allow: true }, end: { allow: true } },
      }),
    );
    network.resolve();
    wall.attachOpening(opening, { offset: 2.5 });
    opening.setOPConfig({ ...opening.getOPConfig(), sillHeight: 1.1 });
    console.log(network.resolve().diagnostics);
    wall.commitOpeningCuts();
    console.log(opening.getPhysicalParts(), opening.toDrawing('top'));
  } finally {
    network.dispose();
    opening.dispose();
  }
}

Notes

Dimensions are in metres.
sillHeight is the bottom of the glass above the base of the host wall.
After you attach or change a window on a live wall, call wall.commitOpeningCuts(). This call cuts the wall.
setOPConfig needs the full options. Copy getOPConfig(), change one field and pass the copy.
Start the geometry kernel before you create this object. See Floorkit.
This object is live geometry. To save a building, write it in a building model.

Inheritance: extends Opening<ElementType.WINDOW> implements IShape, PlanVectorExportable

Constructor

constructor(baseWindowConfig?: Partial<WindowOptions>);

WindowStationLocal

Window centre in the host wall’s local frame — horizontal only. The vertical is sillHeight and nothing else.

{ width: number; thickness: number; }

WindowType

number

Clear height of the glass opening.

number

Height of the sill — the bottom of the glass opening — above the host wall’s base.

number

string

ElementType.WINDOW

string

number

THE vertical authority: the bottom of the rough opening, measured above the host wall’s base. Never a world Y — the host frame’s origin supplies the storey elevation, so world.y = frame.origin.y + baseHeight. Without a host or free placement, the identity frame makes baseHeight world Y.

number

[number, number][]

PropertySets

Properties

WindowOptions

boolean

string | null

WindowStationLocal

number

Bottom of the ROUGH OPENING above the wall base — the unified vertical every opening exposes. A window is authored by its sill, and the opening it needs starts one frame-width lower to seat the lining, so the two differ by exactly frameDimensions.width. That relationship is stated here and nowhere else.

number

Read-only. Station-based: the authored position along the host wall.

string

string | undefined

number

boolean

Opening

Read-only. Window IS the opening — return self. Kept for compatibility with wall attachers.

Vector3[]

Read-only. Plan-view hole loop (Vector3[] at Y=0). The 1 µm across-wall inset (HOLE_2D_TOLERANCE) keeps hole edges strictly inside the outer polygon so the WASM triangulator handles them correctly.

Methods

editableSchema

static editableSchema(): OPEditableSchema;

getPhysicalParts

getPhysicalParts(): readonly PhysicalElementPart[];

Borrow actual material parts; descriptors contain no seeds, cutters or symbols.

anchorSpace

anchorSpace(): "local" | "world";

A single draggable handle that slides the window along its host wall.

getEditAnchors

getEditAnchors(): EditAnchor[];

applyEditAnchor

applyEditAnchor(id: string, position: [
    number,
    number,
    number
], snapRadius?: number): void;

move

move(delta: Vec3): void;

A window is positioned by its station and sill, not by a centreline, so the base Opening.move (which walks points) does not apply.

getAnalyticCutBounds

getAnalyticCutBounds(): AnalyticOpeningCutBounds;

Exact station/elevation rectangle used by analytic wall subtraction.

getOPConfig

getOPConfig(): WindowOptions;

setOPConfig

setOPConfig(config: WindowOptions): void;

getExportRoots

getExportRoots(view: PlanExportView): THREE.Object3D[];

toDrawing

toDrawing(view: PlanExportView): DrawingPrimitive[];

Produce the window’s plan symbol as standardized region primitives: the two jamb linings and the two glazing slits, from its authored 2D geometry.

dispose

dispose(): void;

setOPGeometry

setOPGeometry(): void;

setOPMaterial

setOPMaterial(): void;

Types

WindowOptions

interface WindowOptions extends OpeningOptions<ElementType.WINDOW> {
  stationLocal: WindowStationLocal;
  windowDimensions: {
    width: number;
    thickness: number;
  };
  frameDimensions: {
    width: number;
    thickness: number;
  };
  windowType: WindowType;
  windowHeight: number;
  sillHeight: number;
  frameColor: number;
  glassColor: number;
}

WindowStationLocal

interface WindowStationLocal {
  alongWall: number;
}

number

required

Distance along the wall from its start point.

WindowType

enum WindowType {
  GLASS = 'GLASS',
  WOOD = 'WOOD',
  SLIDING = 'SLIDING',
  CASEMENT = 'CASEMENT',
  AWNING = 'AWNING',
  FIXED = 'FIXED',
  OTHER = 'OTHER',
}

API Reference

Runtime

Primitives

Shapes

Architecture

Datums

Annotations

Drawings

Views

World

Exports

Editor

Integration

Licensing

Import

Example

Notes

Constructor

Properties

Methods

editableSchema

getPhysicalParts

anchorSpace

getEditAnchors

applyEditAnchor

move

getAnalyticCutBounds

getOPConfig

setOPConfig

getExportRoots

toDrawing

dispose

setOPGeometry

setOPMaterial

Types

WindowOptions

WindowStationLocal

WindowType

​Import

​Example

​Notes

​Constructor

​Properties

​Methods

​editableSchema

​getPhysicalParts

​anchorSpace

​getEditAnchors

​applyEditAnchor

​move

​getAnalyticCutBounds

​getOPConfig

​setOPConfig

​getExportRoots

​toDrawing

​dispose

​setOPGeometry

​setOPMaterial

​Types

​WindowOptions

​WindowStationLocal

​WindowType

​Related

Import

Example

Notes

Constructor

Properties

Methods

editableSchema

getPhysicalParts

anchorSpace

getEditAnchors

applyEditAnchor

move

getAnalyticCutBounds

getOPConfig

setOPConfig

getExportRoots

toDrawing

dispose

setOPGeometry

setOPMaterial

Types

WindowOptions

WindowStationLocal

WindowType

Related