Class OutlinePlugin

Outline Plugin Adds an extension to ScreenPass material and a RenderPass to render the outlines and highlights of the selected objects. It interfaces with the PickingPlugin to render the outlines of the selected objects. The intensity, thickness, etc of the effect can be controlled with the intensity(previously outlineIntensity), thickness etc properties.

Hierarchy

Constructors

constructor

Properties

_pass? _shaderPatch _viewerListeners bufferType color debugOutline dependencies enabled enableDynamicSelection enableHighlight extraDefines extraUniforms highlightMaterialSameNames highlightSelectedMaterials highlightTransparency intensity material mouseInOutAnimationEnabled passId priority target? texture? thickness transparency OldPluginType PluginType

Accessors

outlineColor outlineIntensity

Methods

_createPass _createTarget _disposeTarget onAdded onRemove parsFragmentSnippet setDirty

Constructors

constructor

Properties

Protected Optional_pass

_pass?: OutlinePluginPass

Protected_shaderPatch

_shaderPatch: string = 'diffuseColor = outline(diffuseColor);'

Protected_viewerListeners

_viewerListeners: { preRender: () => void } = ...

ReadonlybufferType

bufferType: TextureDataType

color

color: Color = ...

debugOutline

debugOutline: boolean = false

dependencies

dependencies: (typeof GBufferPlugin | typeof PickingPlugin)[] = ...

enabled

enabled: boolean

enableDynamicSelection

enableDynamicSelection: boolean = true

enableHighlight

enableHighlight: boolean = false

extraDefines

extraDefines: { DEBUG_OUTLINE: "0" } = ...

ReadonlyextraUniforms

extraUniforms: {
    dpr: IUniform<number>;
    enableHighlight: { value: true };
    highlightTransparency: { value: 1 };
    outlineBuffer: { value: null };
    outlineColor: { value: Color };
    outlineIntensity: { value: 1 };
    outlineThickness: { value: 2 };
    tDiffuseSize: { value: Vector2 };
} = ...

highlightMaterialSameNames

highlightMaterialSameNames: boolean = false

highlightSelectedMaterials

highlightSelectedMaterials: boolean = false

highlightTransparency

highlightTransparency: number = 0.84

intensity

intensity: number = 2

Readonlymaterial

material: ShaderMaterial = ...

mouseInOutAnimationEnabled

mouseInOutAnimationEnabled: boolean = true

ReadonlypassId

passId: "outline" = 'outline'

priority

priority: number = -101

The priority of the material extension when applied to the material in ScreenPass set to very low priority, so applied at the end.

Optionaltarget

target?: WebGLRenderTarget

Optionaltexture

texture?: Texture

thickness

thickness: number = 2

transparency

transparency: number = 0

For internal use, don't change

Static ReadonlyOldPluginType

OldPluginType: "Outline" = 'Outline'

Static ReadonlyPluginType

PluginType: "OutlinePlugin" = 'OutlinePlugin'

Accessors

outlineColor

  • get outlineColor(): number

  • Returns number

  • set outlineColor(v: number): void

  • Parameters

    • v: number

    Returns void

outlineIntensity

  • get outlineIntensity(): number

  • Returns number

  • set outlineIntensity(v: number): void

  • Parameters

    • v: number

    Returns void

Methods

Protected_createPass

Protected_createTarget

  • _createTarget(recreate?: boolean): void

  • Parameters

    • recreate: boolean = true

    Returns void

Protected_disposeTarget

  • _disposeTarget(): void

  • Returns void

onAdded

  • onAdded(viewer: ThreeViewer): void

  • Parameters

    Returns void

onRemove

  • onRemove(viewer: ThreeViewer): void

  • Parameters

    Returns void

parsFragmentSnippet

  • parsFragmentSnippet(): string

  • Returns string

setDirty

  • setDirty(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods