Parameters for a View's edge enhancement effect, Edges.

interface EdgesParams {
    edgeAlpha?: number;
    edgeColor?: Vec3;
    edgeDarken?: number;
    edgeFadeEnd?: number;
    edgeFadeStart?: number;
    edgeWidth?: number;
    renderModes?: number[];
    useMeshColor?: boolean;
}

Properties

edgeAlpha?: number

Edge transparency for Edges.

A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

Default value is 1.0.

edgeColor?: Vec3

RGB edge color for Edges.

Used unless useMeshColor is set.

Default value is [0.2, 0.2, 0.2].

edgeDarken?: number

Multiplier applied to each mesh's colour when useMeshColor is true.

0 yields black edges, 1 leaves the mesh colour unchanged. Range [0, 1].

Default value is 0.5.

edgeFadeEnd?: number

Distance (as a fraction of the active camera's far plane) at which edges are fully transparent.

Combined with edgeFadeStart to produce the smooth falloff. Effective range is [0, 1].

Default value is 1.0.

edgeFadeStart?: number

Distance (as a fraction of the active camera's far plane) at which edge fade-out begins. Edges closer than this remain at full intensity.

Combined with edgeFadeEnd to produce a smooth alpha falloff that prevents edge density from clumping into a dark mass at long range — most visible in x-ray and silhouette modes.

Effective range is [0, 1]. Set this >= edgeFadeEnd to disable the fade and keep the previous distance-independent appearance.

Default value is 0.4.

edgeWidth?: number

Line width for Edges.

Default value is 1.0 pixels.

renderModes?: number[]

Which rendering modes in which to render edges.

Default value is [DetailedRender].

useMeshColor?: boolean

When true, the base edges effect colours each edge with its own mesh's colour darkened by edgeDarken, instead of the fixed edgeColor — so edges read as a shaded outline of each object rather than one uniform colour.

Only affects the base edges effect — x-ray / highlight / selected edges always use their emphasis material's colour.

Default value is false.