Class: SSBevelPlugin
Plugins.SSBevelPlugin
Hierarchy
GenericFilterPlugin<SSBevelPass,"ssBevel","">↳
SSBevelPlugin
Implements
Properties
PluginType
▪ Static Readonly PluginType: "SSBevelPlugin"
Defined in
webgi/src/plugins/SSBevelPlugin.ts:26
SSBEVEL_GLTF_EXTENSION
▪ Static Readonly SSBEVEL_GLTF_EXTENSION: "WEBGI_materials_ssbevel"
Defined in
webgi/src/plugins/SSBevelPlugin.ts:122
passId
• passId: "ssBevel"
Overrides
Defined in
webgi/src/plugins/SSBevelPlugin.ts:17
dependencies
• dependencies: (typeof AssetManagerPlugin | typeof GBufferPlugin | typeof NormalBufferPlugin)[]
Implementation of
Defined in
webgi/src/plugins/SSBevelPlugin.ts:31
_dirty
• Protected _dirty: boolean = false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
_pass
• Protected Optional _pass: IFilter<SSBevelPass, "ssBevel">
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:9
_beforeFilters
• Protected _beforeFilters: string[]
Overrides
GenericFilterPlugin._beforeFilters
Defined in
webgi/src/plugins/SSBevelPlugin.ts:19
_afterFilters
• Protected _afterFilters: string[]
Overrides
GenericFilterPlugin._afterFilters
Defined in
webgi/src/plugins/SSBevelPlugin.ts:20
_requiredFilters
• Protected _requiredFilters: string[]
Overrides
GenericFilterPlugin._requiredFilters
Defined in
webgi/src/plugins/SSBevelPlugin.ts:21
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Implementation of
Inherited from
GenericFilterPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
GenericFilterPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
viewer
• get viewer(): undefined | TViewer
Returns
undefined | TViewer
Inherited from
GenericFilterPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
enabled
• get enabled(): boolean
Returns
boolean
Inherited from
GenericFilterPlugin.enabled
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:24
• set enabled(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
GenericFilterPlugin.enabled
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:28
pass
• get pass(): undefined | IFilter<T, TPassId>
Returns
undefined | IFilter<T, TPassId>
Inherited from
GenericFilterPlugin.pass
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:69
bevelTarget
• get bevelTarget(): undefined | IRenderTarget
Returns
undefined | IRenderTarget
Defined in
webgi/src/plugins/SSBevelPlugin.ts:23
uiConfig
• get uiConfig(): UiObjectConfig<any, string>
Returns
UiObjectConfig<any, string>
Implementation of
Defined in
webgi/src/plugins/SSBevelPlugin.ts:103
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
exportState
▸ exportState(): any
Returns
any
Inherited from
GenericFilterPlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
GenericFilterPlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:71
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Implementation of
Inherited from
GenericFilterPlugin.storeState
Defined in
webgi/src/core/AViewerPlugin.ts:78
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:88
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Implementation of
IViewerPlugin.toJSON
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:73
fromJSON
▸ fromJSON(data, meta?): null | SSBevelPlugin
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | SSBevelPlugin
Implementation of
IViewerPlugin.fromJSON
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:82
passCtor
▸ passCtor(v): SSBevelPass
Parameters
| Name | Type |
|---|---|
v | ViewerApp |
Returns
Overrides
Defined in
webgi/src/plugins/SSBevelPlugin.ts:47
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Implementation of
Overrides
Defined in
webgi/src/plugins/SSBevelPlugin.ts:59
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Implementation of
Overrides
Defined in
webgi/src/plugins/SSBevelPlugin.ts:73
setDirty
▸ setDirty(): void
Returns
void
Defined in
webgi/src/plugins/SSBevelPlugin.ts:78
updateGBuffer
▸ updateGBuffer(object, data): void
Parameters
| Name | Type |
|---|---|
object | Object3D<Event, string> |
data | Vector4 |
Returns
void
Implementation of
Defined in
webgi/src/plugins/SSBevelPlugin.ts:109
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
_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
Defined in
webgi/src/plugins/SSBevelPlugin.ts:83
Constructors
constructor
• new SSBevelPlugin(enabled?)
Parameters
| Name | Type | Default value |
|---|---|---|
enabled | boolean | true |
Overrides
GenericFilterPlugin.constructor