Class: CombinedPostPlugin
Plugins.CombinedPostPlugin
Hierarchy
GenericFilterPlugin
<CombinedPostPass
,"combinedPost"
,""
,ViewerApp
>↳
CombinedPostPlugin
Implements
Properties
PluginType
▪ Static
Readonly
PluginType: "CombinedPostPlugin"
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:12
passId
• passId: "combinedPost"
Overrides
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:13
dependencies
• dependencies: typeof GBufferPlugin
[]
Implementation of
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:15
toJSON
• toJSON: any
= undefined
Implementation of
IViewerPlugin.toJSON
Overrides
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:17
depthTonemap
• Readonly
depthTonemap: boolean
= true
_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
<CombinedPostPass
, "combinedPost"
>
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:9
_beforeFilters
• Protected
_beforeFilters: never
[] = []
Overrides
GenericFilterPlugin._beforeFilters
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:19
_afterFilters
• Protected
_afterFilters: string
[]
Overrides
GenericFilterPlugin._afterFilters
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:20
_requiredFilters
• Protected
_requiredFilters: string
[]
Overrides
GenericFilterPlugin._requiredFilters
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.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
renderToScreen
• get
renderToScreen(): boolean
Returns
boolean
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:24
uiConfig
• get
uiConfig(): UiObjectConfig
<any
, string
>
Returns
UiObjectConfig
<any
, string
>
Implementation of
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:83
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
fromJSON
▸ fromJSON(data
, meta?
): null
| CombinedPostPlugin
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| CombinedPostPlugin
Implementation of
IViewerPlugin.fromJSON
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:82
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:42
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:52
passCtor
▸ passCtor(v
): CombinedPostPass
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
CombinedPostPass
Overrides
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:57
addExtension
▸ addExtension(extension
): void
Parameters
Name | Type |
---|---|
extension | MaterialExtension |
Returns
void
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:89
reRender
▸ reRender(): void
Returns
void
Defined in
webgi/src/plugins/threejs/CombinedPostPlugin.ts:94
_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/threejs/CombinedPostPlugin.ts:72
Constructors
constructor
• new CombinedPostPlugin(depthTonemap?
, renderToScreen?
)
Parameters
Name | Type | Default value |
---|---|---|
depthTonemap | boolean | true |
renderToScreen | boolean | true |
Overrides
GenericFilterPlugin.constructor