IFClite TypeScript API
    Preparing search index...

    Interface SnapOptions

    interface SnapOptions {
        screenSnapRadius: number;
        snapRadius: number;
        snapToEdges: boolean;
        snapToFaces: boolean;
        snapToPointClouds?: boolean;
        snapToVertices: boolean;
    }
    Index
    screenSnapRadius snapRadius snapToEdges snapToFaces snapToPointClouds? snapToVertices
    screenSnapRadius: number
    snapRadius: number

    Declared but never read. Documented as a world-units snap distance, but every proximity check in SnapDetector uses screenSnapRadius (pixels) instead — see the two call sites that pass opts.screenSnapRadius into the candidate search. Snapping is therefore purely screen-space and zoom-dependent; changing this value has no effect. Set screenSnapRadius instead. Slated for removal; see issue #2731.

    Ignored — screenSnapRadius is the value that is read.

    snapToEdges: boolean
    snapToFaces: boolean
    snapToPointClouds?: boolean

    Snap to point-cloud scan points (#1860). Consumed by RaycastEngine (SnapDetector itself never produces POINT_CLOUD targets). Optional: when absent, point snapping follows "is any of the mesh snap kinds above enabled", so the viewer's single snap toggle governs scan points too. See pointCloudSnapEnabled.

    snapToVertices: boolean

    Settings
    Member Visibility

    On This Page
    Properties