Class: SSBevelPlugin

Plugins.SSBevelPlugin

Hierarchy

• GenericFilterPlugin<SSBevelPass, "ssBevel", "">

  ↳ SSBevelPlugin

Implements

• IViewerPluginAsync
• IGBufferUpdater

Properties

PluginType

▪ Static Readonly PluginType: "SSBevelPlugin"

---

SSBEVEL_GLTF_EXTENSION

▪ Static Readonly SSBEVEL_GLTF_EXTENSION: "WEBGI_materials_ssbevel"

---

passId

• passId: "ssBevel"

Overrides

GenericFilterPlugin.passId

---

dependencies

• dependencies: (typeof AssetManagerPlugin | typeof GBufferPlugin | typeof NormalBufferPlugin)[]

Implementation of

IViewerPluginAsync.dependencies

---

_dirty

• Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

---

_pass

• Protected Optional _pass: IFilter<SSBevelPass, "ssBevel">

Inherited from

GenericFilterPlugin._pass

---

_beforeFilters

• Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

---

_afterFilters

• Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

---

_requiredFilters

• Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

GenericFilterPlugin.viewer

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

---

pass

• get pass(): undefined | IFilter<T, TPassId>

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

---

bevelTarget

• get bevelTarget(): undefined | IRenderTarget

Returns

undefined | IRenderTarget

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPluginAsync.uiConfig

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

GenericFilterPlugin.onDispose

---

exportState

▸ exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

GenericFilterPlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

GenericFilterPlugin.loadState

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

GenericFilterPlugin.toJSON

---

fromJSON

▸ fromJSON(data, meta?): null | SSBevelPlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | SSBevelPlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

---

passCtor

▸ passCtor(v): SSBevelPass

Parameters

Name	Type
v	ViewerApp

Returns

SSBevelPass

Overrides

GenericFilterPlugin.passCtor

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

GenericFilterPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

GenericFilterPlugin.onRemove

---

setDirty

▸ setDirty(): void

Returns

void

---

updateGBuffer

▸ updateGBuffer(object, data): void

Parameters

Name	Type
object	Object3D<Object3DEventMap>
data	Vector4

Returns

void

Implementation of

IGBufferUpdater.updateGBuffer

---

getBevelMaterials

▸ getBevelMaterials(): unknown[]

Returns

unknown[]

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

---

_update

▸ Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

Name	Type
v	ViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Constructors

constructor

• new SSBevelPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

GenericFilterPlugin.constructor