Viewer
    Preparing search index...

    Interface IOutlineEffectDefinition

    interface IOutlineEffectDefinition {
        type: OUTLINE;
        properties?: {
            blendFunction?: number;
            blur?: boolean;
            depthBias?: number;
            edgeStrength?: number;
            hiddenEdgeColor?: Color;
            kernelSize?: number;
            multisampling?: number;
            pulseSpeed?: number;
            resolution?: number;
            separateObjects?: boolean;
            visibleEdgeColor?: Color;
            xRay?: boolean;
        };
        token?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    type properties? token?

    Properties

    type: OUTLINE

    The type of this effect.

    properties?: {
        blendFunction?: number;
        blur?: boolean;
        depthBias?: number;
        edgeStrength?: number;
        hiddenEdgeColor?: Color;
        kernelSize?: number;
        multisampling?: number;
        pulseSpeed?: number;
        resolution?: number;
        separateObjects?: boolean;
        visibleEdgeColor?: Color;
        xRay?: boolean;
    }

    Type Declaration

    • OptionalblendFunction?: number

      The blend function of this effect. (default: BlendFunction.SCREEN)

    • Optionalblur?: boolean

      Whether the outline should be blurred. (default: false)

    • OptionaldepthBias?: number

      A depth bias in view-space units added to the depth comparison when xRay is false. Reduces z-fighting artifacts where co-planar or nearly co-planar geometry causes the outline halo to incorrectly bleed through adjacent surfaces. Tune to scene scale; a value of 0 disables the bias. (default: 0)

    • OptionaledgeStrength?: number

      The edge strength. (default: 1.0)

    • OptionalhiddenEdgeColor?: Color

      The color of hidden edges. (default: #22090a)

    • OptionalkernelSize?: number

      The blur kernel size. (default: KernelSize.VERY_SMALL)

    • Optionalmultisampling?: number

      The number of samples used for multisample antialiasing. Requires WebGL 2. (default: 0)

    • OptionalpulseSpeed?: number

      The pulse speed. A value of zero disables the pulse effect. (default: 0.0)

    • Optionalresolution?: number

      The resolution that is used for the effect. (default: 480)

    • OptionalseparateObjects?: boolean

      Whether each selected node should be outlined separately instead of as a unified group. Prevents depth artifacts when objects are layered (e.g. one in front, one behind). Has a per-node performance cost. (default: false)

    • OptionalvisibleEdgeColor?: Color

      The color of visible edges. (default: #ffffff)

    • OptionalxRay?: boolean

      Whether occluded parts of selected objects should be visible. (default: true)

    token?: string

    The token of the effect, is only returned by the viewer, but ignored as an input.

    Settings

    Member Visibility

    On This Page

    Properties