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:25
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:29
_pass
• Protected
Optional
_pass: IFilter
<NormalRenderPass
, "normalBuffer"
>
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:8
_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:18
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
GenericFilterPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:22
enabled
• get
enabled(): boolean
Returns
boolean
Inherited from
GenericFilterPlugin.enabled
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:17
• set
enabled(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
GenericFilterPlugin.enabled
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:21
pass
• get
pass(): undefined
| IFilter
<T
, TPassId
>
Returns
undefined
| IFilter
<T
, TPassId
>
Inherited from
GenericFilterPlugin.pass
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:62
uiConfig
• get
uiConfig(): undefined
| UiObjectConfig
<any
, string
>
Returns
undefined
| UiObjectConfig
<any
, string
>
Implementation of
Defined in
webgi/src/plugins/NormalBufferPlugin.ts:106
Methods
addEventListener
▸ addEventListener(type
, listener
): void
Adds a listener to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Implementation of
IViewerPlugin.addEventListener
Inherited from
GenericFilterPlugin.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:48
hasEventListener
▸ hasEventListener(type
, listener
): boolean
Checks if listener is added to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
boolean
Implementation of
IViewerPlugin.hasEventListener
Inherited from
GenericFilterPlugin.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:56
removeEventListener
▸ removeEventListener(type
, listener
): void
Removes a listener from an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Implementation of
IViewerPlugin.removeEventListener
Inherited from
GenericFilterPlugin.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:63
dispatchEvent
▸ dispatchEvent(event
): void
Fire an event type.
Parameters
Name | Type |
---|---|
event | IEvent <"" | "serialize" | "deserialize" > |
Returns
void
Implementation of
Inherited from
GenericFilterPlugin.dispatchEvent
Defined in
webgi/src/helpers/EventDispatcher.ts:74
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:29
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Implementation of
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:66
fromJSON
▸ fromJSON(data
, meta?
): null
| NormalBufferPlugin
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| NormalBufferPlugin
Implementation of
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:75
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
_update
▸ Protected
_update(v
): boolean
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