IFClite TypeScript API
    Preparing search index...

    Interface ScanProposalOptions

    Every field is optional; omitted fields take the Rust defaults below.

    interface ScanProposalOptions {
        classificationAngleDegrees?: number;
        defaultSlabThicknessMetres?: number;
        defaultWallThicknessMetres?: number;
        interiorPoint?: ScanVec3 | null;
        levelSnapMetres?: number;
        maxSlabThicknessMetres?: number;
        maxWallThicknessMetres?: number;
        minSlabAreaSquareMetres?: number;
        minWallHeightMetres?: number;
        minWallLengthMetres?: number;
        minWallOverlapFraction?: number;
        minWallThicknessMetres?: number;
        pairingAngleDegrees?: number;
        scanToModel?: number[];
        schema?: ProposalSchema;
    }
    Index
    classificationAngleDegrees? defaultSlabThicknessMetres? defaultWallThicknessMetres? interiorPoint? levelSnapMetres? maxSlabThicknessMetres? maxWallThicknessMetres? minSlabAreaSquareMetres? minWallHeightMetres? minWallLengthMetres? minWallOverlapFraction? minWallThicknessMetres? pairingAngleDegrees? scanToModel? schema?
    classificationAngleDegrees?: number

    Horizontal / vertical tolerance in the model frame. Default 10 degrees.

    defaultSlabThicknessMetres?: number

    Thickness of a slab seen from one side. Default 0.2 m.

    defaultWallThicknessMetres?: number

    Thickness of a wall seen from one side, placed behind the scanned side. Default 0.2 m.

    interiorPoint?: ScanVec3 | null

    A point inside the scanned space (model frame). Default: area-weighted plane centroid.

    levelSnapMetres?: number

    Wall and column ends within this of a floor or ceiling extend to it. Default 0.3 m.

    maxSlabThicknessMetres?: number

    A ceiling and the floor above pair into one slab when this close (and at least minWallThicknessMetres apart). Default 0.6 m.

    maxWallThicknessMetres?: number

    ... and at most this far. Default 0.6 m.

    minSlabAreaSquareMetres?: number

    Smaller horizontal planes are not slabs. Default 1 m^2.

    minWallHeightMetres?: number

    Lower vertical faces are not walls. Default 1 m.

    minWallLengthMetres?: number

    Shorter vertical faces are not walls. Default 0.5 m.

    minWallOverlapFraction?: number

    Paired faces overlap along the wall by this share of the shorter one. Default 0.5.

    minWallThicknessMetres?: number

    Paired wall faces lie this far apart or more. Default 0.05 m.

    pairingAngleDegrees?: number

    Wall faces pair when parallel within this. Default 5 degrees.

    scanToModel?: number[]

    Row-major 4x4 similarity (rotation, uniform scale, translation) from the report's frame to the IFC model frame. Default identity. Reflections and non-uniform scale are refused.

    schema?: ProposalSchema

    Decides the pipe class: IfcFlowSegment in IFC2X3, else IfcPipeSegment. Default IFC4.

    Settings
    Member Visibility

    On This Page
    Properties