Class OutlineEffect

An outline effect.

Hierarchy (View Summary)

Effect
- OutlineEffect

Index

Constructors

constructor

new OutlineEffect(
    scene?: Scene,
    camera?: Camera,
    options?: {
        blendFunction?: BlendFunction;
        blur?: boolean;
        edgeStrength?: number;
        height?: number;
        hiddenEdgeColor?: number;
        kernelSize?: KernelSize;
        multisampling?: number;
        patternScale?: number;
        patternTexture?: Texture;
        pulseSpeed?: number;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        visibleEdgeColor?: number;
        width?: number;
        xRay?: boolean;
    },
): OutlineEffect
Constructs a new outline effect.
Parameters
- Optionalscene: Scene
  The main scene.
- Optionalcamera: Camera
  The main camera.
- Optionaloptions: {
      blendFunction?: BlendFunction;
      blur?: boolean;
      edgeStrength?: number;
      height?: number;
      hiddenEdgeColor?: number;
      kernelSize?: KernelSize;
      multisampling?: number;
      patternScale?: number;
      patternTexture?: Texture;
      pulseSpeed?: number;
      resolutionScale?: number;
      resolutionX?: number;
      resolutionY?: number;
      visibleEdgeColor?: number;
      width?: number;
      xRay?: boolean;
  }
  The options.
  - OptionalblendFunction?: BlendFunction
    The blend function. Use BlendFunction.ALPHA for dark outlines.
  - Optionalblur?: boolean
    Whether the outline should be blurred.
  - OptionaledgeStrength?: number
    The edge strength.
  - Optionalheight?: number
    Deprecated. Use resolutionY instead.
  - OptionalhiddenEdgeColor?: number
    The color of hidden edges.
  - OptionalkernelSize?: KernelSize
    The blur kernel size.
  - Optionalmultisampling?: number
    The number of samples used for multisample antialiasing. Requires WebGL 2.
  - OptionalpatternScale?: number
    The pattern scale.
  - OptionalpatternTexture?: Texture
    A pattern texture.
  - OptionalpulseSpeed?: number
    The pulse speed. A value of zero disables the pulse effect.
  - OptionalresolutionScale?: number
    The resolution scale.
  - OptionalresolutionX?: number
    The horizontal resolution.
  - OptionalresolutionY?: number
    The vertical resolution.
  - OptionalvisibleEdgeColor?: number
    The color of visible edges.
  - Optionalwidth?: number
    Deprecated. Use resolutionX instead.
  - OptionalxRay?: boolean
    Whether occluded parts of selected objects should be visible.
Returns OutlineEffect
Overrides Effect.constructor

Properties

`Readonly`blendMode

blendMode: BlendMode

The blend mode of this effect.

blurPass

blurPass: KawaseBlurPass

A blur pass.

`Readonly`defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

`Readonly`extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

name

name: string

The name of this effect.

pulseSpeed

pulseSpeed: number

The pulse speed. Set to 0 to disable.

`Protected`renderer

renderer: WebGLRenderer

The renderer.

Deprecated

selection

selection: Selection

A selection of objects that will be outlined.

The default layer of this selection is 10.

`Readonly`uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

blur

get blur(): boolean
Indicates whether the outlines should be blurred.

Returns boolean
Deprecated
Use blurPass.enabled instead.
set blur(arg: boolean): void
Parameters
- arg: boolean
Returns void

dithering

get dithering(): boolean
Indicates whether dithering is enabled.

Returns boolean
Deprecated
set dithering(arg: boolean): void
Parameters
- arg: boolean
Returns void

edgeStrength

get edgeStrength(): number
The edge strength.

Returns number
set edgeStrength(arg: number): void
Parameters
- arg: number
Returns void

height

get height(): number
The current height of the internal render targets.

Returns number
Deprecated
Use resolution.height instead.
set height(arg: number): void
Parameters
- arg: number
Returns void

hiddenEdgeColor

get hiddenEdgeColor(): Color
The hidden edge color.

Returns Color
set hiddenEdgeColor(arg: Color): void
Parameters
- arg: Color
Returns void

inputColorSpace

get inputColorSpace(): ColorSpace
Experimental
The input color space.

Returns ColorSpace
Inherited from Effect.inputColorSpace
set inputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.inputColorSpace

kernelSize

get kernelSize(): KernelSize
The blur kernel size.

Returns KernelSize
Deprecated
Use blurPass.kernelSize instead.
set kernelSize(arg: KernelSize): void
Parameters
- arg: KernelSize
Returns void

mainCamera

set mainCamera(arg: Camera): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Effect.mainCamera

mainScene

set mainScene(arg: Scene): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Effect.mainScene

multisampling

get multisampling(): number
Experimental
The amount of MSAA samples.

Requires WebGL 2. Set to zero to disable multisampling.

Requires three >= r138.

Returns number
set multisampling(arg: number): void
Parameters
- arg: number
Returns void

outputColorSpace

get outputColorSpace(): ColorSpace
Experimental
The output color space.

Should only be changed if this effect converts the input colors to a different color space.

Returns ColorSpace
Inherited from Effect.outputColorSpace
set outputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.outputColorSpace

patternScale

get patternScale(): number
The pattern scale.

Returns number
set patternScale(arg: number): void
Parameters
- arg: number
Returns void

patternTexture

get patternTexture(): Texture
The pattern texture. Set to null to disable.

Returns Texture
set patternTexture(arg: Texture): void
Parameters
- arg: Texture
Returns void

resolution

get resolution(): Resolution
The resolution of this effect.

Returns Resolution

selectionLayer

get selectionLayer(): number
The selection layer.

Returns number
Deprecated
Use selection.layer instead.
set selectionLayer(arg: number): void
Parameters
- arg: number
Returns void

visibleEdgeColor

get visibleEdgeColor(): Color
The visible edge color.

Returns Color
set visibleEdgeColor(arg: Color): void
Parameters
- arg: Color
Returns void

width

get width(): number
The current width of the internal render targets.

Returns number
Deprecated
Use resolution.width instead.
set width(arg: number): void
Parameters
- arg: number
Returns void

xRay

get xRay(): boolean
Indicates whether X-ray mode is enabled.

Returns boolean
set xRay(arg: boolean): void
Parameters
- arg: boolean
Returns void

Methods

addEventListener

addEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener
addEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, OutlineEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, OutlineEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener

clearSelection

clearSelection(): OutlineEffect
Clears the list of selected objects.

Returns OutlineEffect
This pass.

Deprecated
Use selection.clear() instead.

deselectObject

deselectObject(object: Object3D): OutlineEffect
Deselects an object.
Parameters
- object: Object3D
  The object that should no longer be outlined.
Returns OutlineEffect
This pass.

Deprecated
Use selection.delete() instead.

dispatchEvent

dispatchEvent<T extends keyof Event<string, unknown>>(
event: BaseEvent<T> & Event<string, unknown>[T],
): void
Fire an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- event: BaseEvent<T> & Event<string, unknown>[T]
  The event that gets fired.
Returns void
Inherited from Effect.dispatchEvent

dispose

dispose(): void
Performs a shallow search for properties that define a dispose method and deletes them.

The EffectComposer calls this method when it is being destroyed.

Returns void
Inherited from Effect.dispose

getAttributes

getAttributes(): EffectAttribute
Returns the effect attributes.

Returns EffectAttribute
The attributes.

Inherited from Effect.getAttributes

getBlendMode

getBlendMode(): BlendMode
Returns the blend mode.

The result of this effect will be blended with the result of the previous effect using this blend mode.

Returns BlendMode
The blend mode.

Deprecated
Use blendMode instead.

Inherited from Effect.getBlendMode

getBlurPass

getBlurPass(): KawaseBlurPass
Returns the blur pass.

Returns KawaseBlurPass
The blur pass.

Deprecated
Use blurPass instead.

getDefines

getDefines(): Map<string, string>
Returns the preprocessor macro definitions.

Returns Map<string, string>
The extensions.

Deprecated
Use defines instead.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

getName

getName(): string
Returns the name of this effect.

Returns string
The name.

Deprecated
Use name instead.

Inherited from Effect.getName

getPulseSpeed

getPulseSpeed(): number
Returns the pulse speed.

Returns number
The speed.

Deprecated
Use pulseSpeed instead.

getResolution

getResolution(): Resolution
Returns the resolution.

Returns Resolution
The resolution.

getResolutionScale

getResolutionScale(): number
Returns the current resolution scale.

Returns number
The resolution scale.

Deprecated
Use resolution instead.

getSelection

getSelection(): Selection
Returns the selection.

Returns Selection
The selection.

Deprecated
Use selection instead.

getUniforms

getUniforms(): Map<string, Uniform<any>>
Returns the uniforms of this effect.

Returns Map<string, Uniform<any>>
The extensions.

Deprecated
Use uniforms instead.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

hasEventListener

hasEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener
hasEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, OutlineEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, OutlineEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener

initialize

initialize(
    renderer: WebGLRenderer,
    alpha: boolean,
    frameBufferType: number,
): void
Performs initialization tasks.
Parameters
- renderer: WebGLRenderer
  The renderer.
- alpha: boolean
  Whether the renderer uses the alpha channel or not.
- frameBufferType: number
  The type of the main frame buffers.
Returns void
Overrides Effect.initialize

isXRayEnabled

isXRayEnabled(): boolean
Indicates whether X-ray mode is enabled.

Returns boolean
Whether X-ray mode is enabled.

Deprecated
Use xRay instead.

removeEventListener

removeEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener
removeEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, OutlineEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{}, T, OutlineEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener

selectObject

selectObject(object: Object3D): OutlineEffect
Selects an object.
Parameters
- object: Object3D
  The object that should be outlined.
Returns OutlineEffect
This pass.

Deprecated
Use selection.add() instead.

`Protected`setAttributes

setAttributes(attributes: EffectAttribute): void
Protected
Sets the effect attributes.

Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.
Parameters
- attributes: EffectAttribute
  The attributes.
Returns void
Inherited from Effect.setAttributes

`Protected`setChanged

setChanged(): void
Protected
Informs the associated EffectPass that this effect requires a shader recompilation.

Should be called after changing macros or extensions and after adding/removing uniforms.

Returns void
Inherited from Effect.setChanged

setDepthTexture

setDepthTexture(
depthTexture: Texture,
depthPacking?: DepthPackingStrategies,
): void
Sets the depth texture.

You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.
Parameters
- depthTexture: Texture
  A depth texture.
- OptionaldepthPacking: DepthPackingStrategies
  The depth packing.
Returns void
Inherited from Effect.setDepthTexture

`Protected`setFragmentShader

setFragmentShader(fragmentShader: string): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  The fragment shader.
Returns void
Inherited from Effect.setFragmentShader

setPatternTexture

setPatternTexture(value: Texture): void
Sets the pattern texture.
Parameters
- value: Texture
  The new texture.
Returns void
Deprecated
Use patternTexture instead.

setPulseSpeed

setPulseSpeed(value: number): void
Sets the pulse speed. Set to zero to disable.
Parameters
- value: number
  The speed.
Returns void
Deprecated
Use pulseSpeed instead.

setRenderer

setRenderer(renderer: WebGLRenderer): void
Sets the renderer.
Parameters
- renderer: WebGLRenderer
  The renderer.
Returns void
Deprecated
Inherited from Effect.setRenderer

setResolutionScale

setResolutionScale(scale: number): void
Sets the resolution scale.
Parameters
- scale: number
  The new resolution scale.
Returns void
Deprecated
Use resolution instead.

setSelection

setSelection(objects: Object3D<Object3DEventMap>[]): OutlineEffect
Clears the current selection and selects a list of objects.
Parameters
- objects: Object3D<Object3DEventMap>[]
  The objects that should be outlined. This array will be copied.
Returns OutlineEffect
This pass.

Deprecated
Use selection.set() instead.

setSize

setSize(width: number, height: number): void
Updates the size of internal render targets.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Overrides Effect.setSize

`Protected`setVertexShader

setVertexShader(vertexShader: string): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  The vertex shader.
Returns void
Inherited from Effect.setVertexShader

setXRayEnabled

setXRayEnabled(value: boolean): void
Enables or disables X-ray outlines.
Parameters
- value: boolean
  Whether X-ray should be enabled.
Returns void
Deprecated
Use xRay instead.

update

update(
    renderer: WebGLRenderer,
    inputBuffer: WebGLRenderTarget,
    deltaTime?: number,
): void
Updates this effect.
Parameters
- renderer: WebGLRenderer
  The renderer.
- inputBuffer: WebGLRenderTarget
  A frame buffer that contains the result of the previous pass.
- OptionaldeltaTime: number
  The time between the last frame and the current one in seconds.
Returns void
Overrides Effect.update

Class OutlineEffect

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalblendFunction?: BlendFunction

Optionalblur?: boolean

OptionaledgeStrength?: number

Optionalheight?: number

OptionalhiddenEdgeColor?: number

OptionalkernelSize?: KernelSize

Optionalmultisampling?: number

OptionalpatternScale?: number

OptionalpatternTexture?: Texture

OptionalpulseSpeed?: number

OptionalresolutionScale?: number

OptionalresolutionX?: number

OptionalresolutionY?: number

OptionalvisibleEdgeColor?: number

Optionalwidth?: number

OptionalxRay?: boolean

Returns OutlineEffect

Properties

ReadonlyblendMode

blurPass

Readonlydefines

Readonlyextensions

name

pulseSpeed

Protectedrenderer

Deprecated

selection

Readonlyuniforms

Accessors

blur

Returns boolean

Deprecated

Parameters

Returns void

dithering

Returns boolean

Deprecated

Parameters

Returns void

edgeStrength

Returns number

Parameters

Returns void

height

Returns number

Deprecated

Parameters

Returns void

hiddenEdgeColor

Returns Color

Parameters

Returns void

inputColorSpace

Returns ColorSpace

Parameters

Returns void

kernelSize

Returns KernelSize

Deprecated

Parameters

Returns void

mainCamera

Parameters

Returns void

mainScene

Parameters

Returns void

multisampling

Returns number

Parameters

`Optional`blendFunction?: BlendFunction

`Optional`blur?: boolean

`Optional`edgeStrength?: number

`Optional`height?: number

`Optional`hiddenEdgeColor?: number

`Optional`kernelSize?: KernelSize

`Optional`multisampling?: number

`Optional`patternScale?: number

`Optional`patternTexture?: Texture

`Optional`pulseSpeed?: number

`Optional`resolutionScale?: number

`Optional`resolutionX?: number

`Optional`resolutionY?: number

`Optional`visibleEdgeColor?: number

`Optional`width?: number

`Optional`xRay?: boolean

`Readonly`blendMode

`Readonly`defines

`Readonly`extensions

`Protected`renderer

`Readonly`uniforms