fast-mesh-wasm
    Preparing search index...

    Interface ContactHeatmapOptions

    Options of contactHeatmap. Distances are in the meshes' units.

    interface ContactHeatmapOptions {
        colors?: {
            contact?: Rgba;
            deep?: Rgba;
            far?: Rgba;
            near?: Rgba;
            shallow?: Rgba;
        };
        depth: number;
        exactDepth?: boolean;
        gap: number;
        sign?: SignMode;
        tolerance?: number;
    }
    Index
    colors?: {
        contact?: Rgba;
        deep?: Rgba;
        far?: Rgba;
        near?: Rgba;
        shallow?: Rgba;
    }

    Overrides of the default colours.

    depth: number

    The penetration depth shown darkest (deep); deeper clamps to it. > 0.

    exactDepth?: boolean

    true computes every vertex's distance (maxDistance: Infinity), so any penetration deeper than depth shows deep; every update recomputes the whole field. false (the default) bounds the field at 2 · max(depth, gap), the fast contact path: vertices beyond it are far and show the base colour, deep penetration included. The bound sits past the range ends, so the values just beyond the coloured area are still known and its outer edge is a value boundary (which bindMesh's fragment shading softens with edgeSoftness); only an edge from a coloured vertex to one beyond the bound (a deep interior, or a triangle longer than the margin) switches hard, half way along.

    gap: number

    The gap shown far; farther shows the base colour. >= 0: at 0 only penetration (and the contact band) is coloured.

    sign?: SignMode

    Defaults to "auto".

    tolerance?: number

    Distances in [-tolerance, +tolerance] are contact (contact). In [0, min(depth, gap)), or [0, depth) when gap is 0; defaults to 0.