Class: NormalBufferPlugin
Plugins.NormalBufferPlugin
Hierarchy
GenericFilterPlugin
<NormalRenderPass
,"normalBuffer"
,""
,ViewerApp
>↳
NormalBufferPlugin
Implements
Properties
PluginType
▪ Static
Readonly
PluginType: "NormalBufferPlugin"
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:15
passId
• passId: "normalBuffer"
Overrides
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:9
_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
<NormalRenderPass
, "normalBuffer"
>
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:9
_beforeFilters
• Protected
_beforeFilters: string
[]
Overrides
GenericFilterPlugin._beforeFilters
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:11
_afterFilters
• Protected
_afterFilters: never
[] = []
Overrides
GenericFilterPlugin._afterFilters
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:12
_requiredFilters
• Protected
_requiredFilters: string
[]
Overrides
GenericFilterPlugin._requiredFilters
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:13
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
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
uiConfig
• get
uiConfig(): undefined
| UiObjectConfig
<any
, string
>
Returns
undefined
| UiObjectConfig
<any
, string
>
Implementation of
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:106
Methods
exportState
▸ exportState(): any
Returns
any
Inherited from
GenericFilterPlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
GenericFilterPlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:67
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:74
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:84
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:36
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
| NormalBufferPlugin
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| NormalBufferPlugin
Implementation of
IViewerPlugin.fromJSON
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:82
passCtor
▸ passCtor(v
): NormalRenderPass
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
NormalRenderPass
Overrides
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:18
getNormalBuffer
▸ getNormalBuffer(): undefined
| IRenderTarget
Returns
undefined
| IRenderTarget
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:88
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:92
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:96
updateShaderProperties
▸ updateShaderProperties(material
): NormalBufferPlugin
Parameters
Name | Type |
---|---|
material | Object |
material.defines | Record <string , undefined | string | number > |
material.uniforms | Object |
Returns
Implementation of
IShaderPropertiesUpdater.updateShaderProperties
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:101
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:60
_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/NormalBufferPlugin.ts:74
Constructors
constructor
• new NormalBufferPlugin(enabled?
)
Parameters
Name | Type | Default value |
---|---|---|
enabled | boolean | true |
Overrides
GenericFilterPlugin.constructor