IFClite TypeScript API
    Preparing search index...

    Interface ScanOutlineOptionsJs

    Every field is optional; absent or undefined means the default. Unknown fields and non-finite numbers are refused. Lengths in metres; pass plane coordinates local to the slab (f32 input).

    interface ScanOutlineOptionsJs {
        cellSize?: number;
        maxCells?: number;
        maxCellSize?: number;
        maxGap?: number;
        maxVertexMoveCells?: number;
        minCellSize?: number;
        minComponentArea?: number;
        minHoleArea?: number;
        minPointsPerCell?: number;
        minSnapPoints?: number;
        noiseFraction?: number;
        openRadiusCells?: number;
        simplifyToleranceCells?: number;
        snap?: boolean;
        snapDistanceCells?: number;
        square?: boolean;
        squareAngleToleranceDeg?: number;
        squareOffsetTolerance?: number;
        targetPointsPerCell?: number;
    }
    Index
    cellSize? maxCells? maxCellSize? maxGap? maxVertexMoveCells? minCellSize? minComponentArea? minHoleArea? minPointsPerCell? minSnapPoints? noiseFraction? openRadiusCells? simplifyToleranceCells? snap? snapDistanceCells? square? squareAngleToleranceDeg? squareOffsetTolerance? targetPointsPerCell?
    cellSize?: number

    Fixed cell edge; omit to pick it from the point density between minCellSize and maxCellSize.

    maxCells?: number

    Cell budget for the padded grid, from (2·pad + 1)² (81 with the defaults) up to 67108864. Default 16777216; hitting it sets diagnostics.cellCapHit.

    maxCellSize?: number

    Default 0.05.

    maxGap?: number

    Widest gap the closing bridges, about a wall thickness; clamped to 0.5. Default 0.3.

    maxVertexMoveCells?: number

    Largest squaring move, in cells (at most 32). Default 4.

    minCellSize?: number

    Default 0.02, at least 0.001.

    minComponentArea?: number

    Solid components below this area (m²) are dropped. Default 0.02.

    minHoleArea?: number

    Enclosed holes below this area (m²) are filled. Default 0.5.

    minPointsPerCell?: number

    Default 1.

    minSnapPoints?: number

    Fewest points to refit an edge. Default 8.

    noiseFraction?: number

    A cell is occupied from this fraction of the median occupied-cell count. Default 0.25.

    openRadiusCells?: number

    Speckle opening radius in cells (0 disables). Default 1.

    simplifyToleranceCells?: number

    Douglas-Peucker tolerance in cells. Default 1.5.

    snap?: boolean

    Refit edges to the points. Default true.

    snapDistanceCells?: number

    Evidence band beside an edge, in cells (at most 16). Default 3.

    square?: boolean

    Square edges to the dominant direction. Default true.

    squareAngleToleranceDeg?: number

    Default 3.

    squareOffsetTolerance?: number

    Squares edges whose ends move at most this far. Default 0.03.

    targetPointsPerCell?: number

    Adaptive cells grow until the median occupied cell holds this many points. Default 6.

    Settings
    Member Visibility

    On This Page
    Properties