Class: MultiFilterPlugin<TEvent, TPasses>
Plugins.MultiFilterPlugin
Type parameters
Name | Type |
---|---|
TEvent | extends string |
TPasses | extends IFilter <IPass , IPassID >[] |
Hierarchy
AViewerPlugin
<TEvent
>↳
MultiFilterPlugin
↳↳
SSAOPlugin
↳↳
SSGIPlugin
↳↳
SSRPlugin
Implements
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Implementation of
Inherited from
AViewerPlugin.dirty
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
AViewerPlugin.dirty
viewer
• get
viewer(): undefined
| ViewerApp
Returns
undefined
| ViewerApp
Inherited from
AViewerPlugin.viewer
passes
• get
passes(): TTupleRecord
<TPasses
, "passId"
>
Returns
TTupleRecord
<TPasses
, "passId"
>
pipeline
• get
pipeline(): string
[]
Returns
string
[]
• set
pipeline(value
): void
Parameters
Name | Type |
---|---|
value | string [] |
Returns
void
Properties
enabled
• Abstract
enabled: boolean
Inherited from
_dirty
• Protected
_dirty: boolean
= false
Inherited from
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Inherited from
exportState
▸ exportState(): any
Returns
any
Inherited from
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Implementation of
Inherited from
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Implementation of
Inherited from
createPasses
▸ Abstract
createPasses(v
): TPasses
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
TPasses
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Implementation of
IViewerPluginAsync.toJSON
Overrides
fromJSON
▸ fromJSON(data
, meta?
): null
| MultiFilterPlugin
<TEvent
, TPasses
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| MultiFilterPlugin
<TEvent
, TPasses
>
Implementation of
IViewerPluginAsync.fromJSON
Overrides
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Constructors
constructor
• new MultiFilterPlugin<TEvent
, TPasses
>()
Type parameters
Name | Type |
---|---|
TEvent | extends string |
TPasses | extends IFilter <IPass , string >[] |