IFClite TypeScript API
    Preparing search index...

    Interface GenerateSpacesOptions

    interface GenerateSpacesOptions {
        boundaryMode?: BoundaryMode;
        debug?: boolean;
        dryRun?: boolean;
        extraDividerTypes?: string[];
        guidRandom?: RandomSource;
        height?: number;
        longName?: string;
        minArea?: number;
        namePattern?: string;
        predefinedType?: string;
        skipFootprints?: AutoSpaceVec2[][];
        snapTolerance?: number;
    }
    Index
    boundaryMode? debug? dryRun? extraDividerTypes? guidRandom? height? longName? minArea? namePattern? predefinedType? skipFootprints? snapTolerance?
    boundaryMode?: BoundaryMode

    Where the space boundary sits relative to its walls. Default 'inner'.

    debug?: boolean

    When true, every stage of the pipeline (wall extraction → detection) emits console.debug messages so the viewer's Room tool Auto "no regions detected" failure mode can be diagnosed from devtools without touching the algorithm. The result also carries detection stats unconditionally.

    dryRun?: boolean

    When true, runs detection but doesn't emit any IfcSpace.

    extraDividerTypes?: string[]

    Additional element types to treat as space dividers (passed to the wall extractor verbatim — case-insensitive). The defaults already cover walls, curtain walls, virtual elements, plates, members, and railings.

    guidRandom?: RandomSource

    Optional seeded randomness for the emitted GlobalIds (spaces + rels), forwarded to the builders via SpatialAnchor.guidRandom. Omit for the default platform CSPRNG.

    height?: number

    IfcSpace extrusion height (m). Default 3.

    longName?: string

    Optional override for IfcSpace.LongName (single value, all spaces).

    minArea?: number

    Drop detected regions below this area in m². Default 0.5 m².

    namePattern?: string

    Naming pattern for emitted spaces. {n} is replaced with a 1-based index. Default 'Space {n}'.

    predefinedType?: string

    Optional IfcSpacePredefinedType (defaults to INTERNAL).

    skipFootprints?: AutoSpaceVec2[][]

    Footprint polygons (same metre frame as the detected rooms) of existing spaces on this storey. A detected room whose centroid falls inside one is an overlap with an already-present space and is skipped — so re-running (or filling a partly-spaced floor) doesn't duplicate spaces. Per-space, not per-storey: non-overlapping rooms are still emitted.

    snapTolerance?: number

    Snap tolerance for wall-end vertex merge in METRES. Default 0.1 m.

    Settings
    Member Visibility

    On This Page
    Properties