Interface EffectParams

Parameters for a View's selected, highlighted and x-ray effects.

interface EffectParams {
    backfaces?: boolean;
    edgeAlpha?: number;
    edgeColor?: Vec3;
    edges?: boolean;
    edgeWidth?: number;
    fill?: boolean;
    fillAlpha?: number;
    fillColor?: Vec3;
    glowThrough?: boolean;
}

Properties

backfaces? edgeAlpha? edgeColor? edges? edgeWidth? fill? fillAlpha? fillColor? glowThrough?

Properties

Optionalbackfaces

backfaces?: boolean

Whether Effect backfaces are visible.

Default is false.

OptionaledgeAlpha

edgeAlpha?: number

Opacity of Effect edges.

Value is in range [0..1].

Default is 1.

OptionaledgeColor

edgeColor?: Vec3

The RGB color of Effect edges.

Default is [0.2, 0.2, 0.2].

Optionaledges

edges?: boolean

Whether Effect edges are visible.

Default is true.

OptionaledgeWidth

edgeWidth?: number

Pixel width of Effect edges.

Default is 1.

Optionalfill

fill?: boolean

Whether Effect surfaces are filled.

Default is true.

OptionalfillAlpha

fillAlpha?: number

Opacity of Effect surfaces.

Value is in range [0..1].

Default is 1.

OptionalfillColor

fillColor?: Vec3

The RGB color of Effect surfaces.

Default is [1.0, 1.0, 1.0].

OptionalglowThrough

glowThrough?: boolean

Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".

Default is true.

Note: updating this property will not affect the appearance of objects that are already emphasized.

Settings

Member Visibility

On This Page

Properties