Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOutlineEffectDefinition

Hierarchy

Index

Properties

Properties

type

type: OUTLINE

The type of this effect.

Optional properties

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

Type declaration

  • Optional blendFunction?: BlendFunction

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

  • Optional blur?: boolean

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

  • Optional edgeStrength?: number

    The edge strength. (default: 1.0)

  • Optional hiddenEdgeColor?: Color

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

  • Optional kernelSize?: KernelSize

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

  • Optional multisampling?: number

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

  • Optional pulseSpeed?: number

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

  • Optional resolution?: number

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

  • Optional visibleEdgeColor?: Color

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

  • Optional xRay?: boolean

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

Optional token

token?: string

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