Configures edge enhancement effect for a View.

See @xeokit/sdk/viewing/viewer for usage info.

Properties

view: View

The View to which this Edges belongs.

Accessors

  • get edgeFadeEnd(): number

    Gets the fraction of the active camera's far plane at which edges become fully transparent.

    Default value is 1.0.

    Returns number

  • set edgeFadeEnd(value: number): void

    Sets the fraction of the active camera's far plane at which edges become fully transparent.

    Default value is 1.0.

    Parameters

    • value: number

    Returns void

  • get edgeFadeStart(): number

    Gets the fraction of the active camera's far plane at which edge fade-out begins.

    Default value is 0.4.

    Returns number

  • set edgeFadeStart(value: number): void

    Sets the fraction of the active camera's far plane at which edge fade-out begins.

    Smoothly attenuates edge alpha with view-space depth so distant edges stop crowding into a dark mass — most visible in x-ray and silhouette modes. Edges closer than this remain at full intensity. Range is [0, 1]; set this >= edgeFadeEnd to disable the fade.

    Default value is 0.4.

    Parameters

    • value: number

    Returns void

  • get useMeshColor(): boolean

    Gets whether the base edges effect uses each mesh's darkened colour instead of the fixed edgeColor.

    Default value is false.

    Returns boolean

  • set useMeshColor(value: boolean): void

    Sets whether the base edges effect colours each edge with its own mesh's colour darkened by edgeDarken, instead of the fixed edgeColor.

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

    Default value is false.

    Parameters

    • value: boolean

    Returns void

Methods