Class Outline2

描边（不通过深度对比可以描边片元着色物体）

Export

Date

2022.6.30

Author

xwb

Hierarchy

EffcetBase
- Outline2

Index

Constructors

Properties

_blendFunction composer effect effects pass passes

Accessors

blendFunction dithering enable opacity

Methods

_loadTexture addOutline getVisibleEdgeColor removeOutline setBlurSize setEdgeDetectionAlpha setEdgeStrength setOutline setPulseSpeed setVisibleEdgeColor

Constructors

constructor

new Outline2(composer, renderer, scene, camera, params?): Outline2
Parameters
- composer: EffectComposer
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- Optional params: OutlineParams | OutlineParams[]
Returns Outline2

Overrides EffcetBase.constructor

Properties

_blendFunction

_blendFunction: BlendFunction

composer

composer: EffectComposer

effect

effect: Effect

effects

effects: OutlineEffect[]

pass

pass: Pass

passes

passes: EffectPass[]

Accessors

blendFunction

set blendFunction(value): void
混合方式
Parameters
- value: BlendFunction
Returns void

Memberof
EffcetBase

Inherited from EffcetBase.blendFunction

dithering

set dithering(value): void
颜色抖动
Parameters
- value: boolean
Returns void

Memberof
EffcetBase

Inherited from EffcetBase.dithering

enable

set enable(value): void
是否开启
Parameters
- value: boolean
Returns void

Memberof
EffcetBase

Inherited from EffcetBase.enable

opacity

set opacity(value): void
透明度
Parameters
- value: number
Returns void

Memberof
EffcetBase

Inherited from EffcetBase.opacity

Methods

`Protected` _loadTexture

_loadTexture(url): Promise<Texture>
Protected
加载图片
Parameters
- url: string
Returns Promise<Texture>
{Promise}

Memberof
EffcetBase

Inherited from EffcetBase._loadTexture

addOutline

addOutline(param?): void
根据指定参数添加一个描边效果
Parameters
- Optional param: OutlineParams
Returns void

Memberof
Outline2

getVisibleEdgeColor

getVisibleEdgeColor(effectIndex?): number
获取颜色
Parameters
- Optional effectIndex: number = 0
Returns number
{number}

Memberof
Outline2

removeOutline

removeOutline(indexs): void
移除一个描边效果
Parameters
- indexs: number[]
Returns void

Memberof
Outline2

setBlurSize

setBlurSize(value, effectIndex?): void
设置模糊度
Parameters
- value: KernelSize
- Optional effectIndex: number = 0
Returns void

Memberof
Outline2

setEdgeDetectionAlpha

setEdgeDetectionAlpha(value, effectIndex?): void
设置边缘透明度阈值
Parameters
- value: number
- Optional effectIndex: number = 0
Returns void

Memberof
Outline2

setEdgeStrength

setEdgeStrength(value, effectIndex?): void
设置强度
Parameters
- value: number
- Optional effectIndex: number = 0
Returns void

Memberof
Outline2

setOutline

setOutline(renderable, isAdd, effectIndex?, objectNames?): void
设置描边效果(添加或删除)
Parameters
- renderable: Renderable
- isAdd: boolean
- Optional effectIndex: number = 0
- Optional objectNames: string[]
Returns void

Memberof
Outline2

setPulseSpeed

setPulseSpeed(value, effectIndex?): void
动画闪动速度
Parameters
- value: number
- Optional effectIndex: number = 0
Returns void

Memberof
Outline2

setVisibleEdgeColor

setVisibleEdgeColor(value, effectIndex?): void
设置颜色
Parameters
- value: ColorRepresentation
- Optional effectIndex: number = 0
Returns void

Memberof
Outline2