Opening - Floorkit

Use it only when you need a free cutter shape. For a hole in a wall, use one of the three subclasses.

Import

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

Example

import { Opening, Floorkit } from '@opengeometry/floorkit';

async function example(wasmURL: string): Promise<void> {
  await new Floorkit().setupOpenGeometry(wasmURL);
  const opening = new Opening({
    points: [
      [0, 0],
      [1.2, 0],
    ],
    thickness: 0.3,
    height: 2.1,
    baseHeight: 0,
  });
  try {
    opening.setOPConfig({ ...opening.getOPConfig(), height: 2.2 });
    console.log(opening.holeLoop2D, opening.getAnalyticCutBounds());
  } finally {
    opening.dispose();
  }
}

Notes

Points are [alongWall, acrossWall] in metres. baseHeight gives the vertical position.
An opening does not cut the objects near it. The host does the cut.
Wall.attachOpening accepts a Door, a Window or a WallOpening.
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 OPElement implements IShape, IPlaceable

Constructor

constructor(openingConfig?: Partial<OpeningOptions<T>>);

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

string

Map<string, OPGeometry>

boolean

Event<null>

OpeningOptions<T>

boolean

string

number

Read-only. Where this opening currently sits along its host wall — the counterpart of baseHeight for the horizontal axis. Read by the walls so that attaching without an explicit offset preserves an authored position instead of snapping the opening back to the wall’s start.

number

Bottom of the rough opening above the host wall’s base. See OpeningOptions.

[ number, number ]

boolean

Vector3[]

Read-only. Plan-view hole loop (Vector3[] in the XZ plane at Y=0). The wall uses this as a Polygon hole. The 1 µm across-wall inset keeps hole edges strictly inside the outer polygon so the WASM triangulator does not produce degenerate output when edges coincide with the boundary.

AnalyticSolid

Read-only.

Methods

bindHostEdit

bindHostEdit(callbacks: {
    begin: () => void;
    preview?: (position: Vec3, snapRadius: number) => void;
    commit: () => {
        undo: () => void;
        redo: () => void;
    } | void;
} | null): void;

beginEdit

beginEdit(): void;

endEdit

endEdit(): {
    undo: () => void;
    redo: () => void;
} | undefined;

bindHostCurve

bindHostCurve(curve: OpeningHostCurve | null): void;

move

move(delta: Vec3): void;

Translate this opening by a WORLD-space delta, hosted or not — the delta is projected onto the active frame’s axes (identity when no frame is bound), so there is one interpretation rather than one per hosting state.

rotate

rotate(angleDeg: number, axis?: Vec3, anchor?: Vec3): void;

Rotate this element by angleDeg around axis (default Y-up), pivoted at anchor (default the element’s own centroid).

setOPConfig

setOPConfig(config: OpeningOptions<T>): void;

getOPConfig

getOPConfig(): OpeningOptions<T>;

anchorSpace

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

Two draggable endpoints.

getEditAnchors

getEditAnchors(): EditAnchor[];

applyEditAnchor

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

bindHostFrame

bindHostFrame(frame: WallFrame | null): void;

Bind this opening to its host wall’s frame.

bindFreePlacement

bindFreePlacement(placement: FreeOpeningPlacement): void;

Place an unhosted opening at a storey datum without creating a wall host.

toWorldPoints

toWorldPoints(): Vector3[];

Stored centreline points as world-space Vector3s, at baseHeight.

getAnalyticCutBounds

getAnalyticCutBounds(): AnalyticOpeningCutBounds | null;

Exact station/elevation rectangle used by analytic wall subtraction.

getWorldCutElevationRange

getWorldCutElevationRange(): {
    bottom: number;
    top: number;
} | null;

World Y range of the analytic rough opening, including ancestor placement once.

dispose

dispose(): void;

setOPGeometry

setOPGeometry(): void;

setOPMaterial

setOPMaterial(): void;

Types

OPGeometry

Visual primitive stored in an element’s subElements2D / subElements3D maps.

interface OPGeometry extends THREE.Object3D {
  outline?: boolean;
}

OpeningHostCurve

interface OpeningHostCurve {
  center: [number, number, number];
  radius: number;
  startAngle: number;
  sweepAngle: number;
  centreOffset: number;
}

OpeningOptions

interface OpeningOptions<T extends ElementType = ElementType.OPENING> extends HasPropertySets {
  ogid?: string;
  labelName: string;
  type: T;
  hostWallId?: string;
  thickness?: number;
  height?: number;
  baseHeight?: number;
  length?: number;
  points?: [number, number][];
}

WallFrame

Wall-local coordinate frame. The package does not export this type by name.

interface WallFrame {
  origin: Vector3;
  alongWallAxis: Vector3;
  acrossWallAxis: Vector3;
  verticalAxis: Vector3;
  length: number;
  thickness?: number;
}

Vector3

required

Vector3

required

Vector3

required

Vector3

required

number

required

number

Host wall thickness. Populated when the frame comes from a wall; undefined for unhosted use.

FreeOpeningPlacement

interface FreeOpeningPlacement {
  position: [x: number, z: number];
  yawDeg: number;
  elevation: number;
}

[ x: number, z: number ]

required

Centre of the opening in the world XZ plane.

number

required

Degrees from +X toward +Z.

number

required

World Y of the owning storey’s datum.

​Import

​Example

​Notes

​Constructor

​Properties

​Methods

​bindHostEdit

​beginEdit

​endEdit

​bindHostCurve

​move

​rotate

​setOPConfig

​getOPConfig

​anchorSpace

​getEditAnchors

​applyEditAnchor

​bindHostFrame

​bindFreePlacement

​toWorldPoints

​getAnalyticCutBounds

​getWorldCutElevationRange

​dispose

​setOPGeometry

​setOPMaterial

​Types

​OPGeometry

​OpeningHostCurve

​OpeningOptions

​WallFrame

​FreeOpeningPlacement

​Related

Import

Example

Notes

Constructor

Properties

Methods

bindHostEdit

beginEdit

endEdit

bindHostCurve

move

rotate

setOPConfig

getOPConfig

anchorSpace

getEditAnchors

applyEditAnchor

bindHostFrame

bindFreePlacement

toWorldPoints

getAnalyticCutBounds

getWorldCutElevationRange

dispose

setOPGeometry

setOPMaterial

Types

OPGeometry

OpeningHostCurve

OpeningOptions

WallFrame

FreeOpeningPlacement

Related