SDK JS
    Preparing search index...

    Interface MeshEdgeOptions

    How the hard-edge overlay looks, and how much of the model counts as an edge.

    interface MeshEdgeOptions {
        color?: readonly [number, number, number];
        creaseAngle?: number;
        maxEdgesPerTile?: number;
        opacity?: number;
        overshoot?: number;
        width?: number;
    }
    Index

    Properties

    color? creaseAngle? maxEdgesPerTile? opacity? overshoot? width?

    Properties

    color?: readonly [number, number, number]

    Line colour, each channel 0-1. Default near-black [0.05, 0.06, 0.08].

    creaseAngle?: number

    How sharp a fold has to be, in degrees, before it counts as an edge. Default 25.

    Lower catches subtler detail (window reveals, shallow gables) at the cost of more lines; higher keeps only the strong structure. Below about 10 a curved or domed roof starts to read as a contour map. Fixed per layer, because it is applied at decode.

    maxEdgesPerTile?: number

    Cap on extracted edges per tile. Default 400 000. Guards against a pathological mesh.

    opacity?: number

    Line opacity, 0-1. Default 0.85.

    overshoot?: number

    Pixels by which to extend each edge past its endpoints. Default 0 (exact).

    A small value (1-3) gives the drafted, hand-drawn look where corners overshoot slightly. It also papers over the hairline gap that shows at a corner when two edges meet at a sharp angle.

    width?: number

    Line width in CSS pixels. Default 1.

    Settings

    Member Visibility

    On This Page

    Properties