Home Reference Source
import {OutlineBlendMaterial} from 'postprocessing/src/materials/OutlineBlendMaterial.js'
public class | source

OutlineBlendMaterial

Extends:

three~ShaderMaterial → OutlineBlendMaterial

An outline blend shader material.

Constructor Summary

Public Constructor
public

constructor(options: Object, alphaBlending: Boolean, xRay: Boolean)

Constructs a new outline blend material.

Member Summary

Public Members
public

Method Summary

Public Methods
public

Enables or disables the alpha blending.

public

setPatternTexture(texture: Texture)

Sets a pattern texture to use as overlay.

public

Defines whether hidden parts of selected objects should be visible.

Public Constructors

public constructor(options: Object, alphaBlending: Boolean, xRay: Boolean) source

Constructs a new outline blend material.

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.edgeStrength Number
  • optional
  • default: 1.0

The edge strength.

options.patternScale Number
  • optional
  • default: 1.0

The scale of the pattern texture.

options.visibleEdgeColor Number
  • optional
  • default: 0xffffff

The color of visible edges.

options.hiddenEdgeColor Number
  • optional
  • default: 0x22090A

The color of hidden edges.

alphaBlending Boolean
  • optional
  • default: false

Whether the outline should be blended using alpha.

xRay Boolean
  • optional
  • default: true

Whether hidden parts of selected objects should be visible.

Public Members

public needsUpdate: boolean source

Public Methods

public setAlphaBlendingEnabled(enabled: Boolean) source

Enables or disables the alpha blending.

Params:

NameTypeAttributeDescription
enabled Boolean

Whether the alpha blending should be enabled.

public setPatternTexture(texture: Texture) source

Sets a pattern texture to use as overlay.

Params:

NameTypeAttributeDescription
texture Texture
  • optional
  • default: null

A pattern texture. Set to null to disable the pattern.

public setXRayEnabled(enabled: Boolean) source

Defines whether hidden parts of selected objects should be visible.

Params:

NameTypeAttributeDescription
enabled Boolean

Whether hidden parts of selected objects should be visible.