Class: GenericFilterPlugin<T, TPassId, TEvent>
Plugins.GenericFilterPlugin
Type parameters
Name | Type |
---|---|
T | extends IPass |
TPassId | extends IPassID |
TEvent | extends string |
Hierarchy
AViewerPlugin
<TEvent
>↳
GenericFilterPlugin
↳↳
BloomPlugin
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
enabled
• get
enabled(): boolean
Returns
boolean
Overrides
AViewerPlugin.enabled
• set
enabled(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Overrides
AViewerPlugin.enabled
pass
• get
pass(): undefined
| IFilter
<T
, TPassId
>
Returns
undefined
| IFilter
<T
, TPassId
>
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
passCtor
▸ Abstract
passCtor(v
): T
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
T
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
| GenericFilterPlugin
<T
, TPassId
, TEvent
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| GenericFilterPlugin
<T
, TPassId
, TEvent
>
Implementation of
IViewerPluginAsync.fromJSON
Overrides
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
_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
Properties
passId
• Abstract
passId: TPassId
_dirty
• Protected
_dirty: boolean
= false
Inherited from
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
_pass
• Protected
Optional
_pass: IFilter
<T
, TPassId
>
_afterFilters
• Protected
Optional
_afterFilters: string
[]
_beforeFilters
• Protected
Optional
_beforeFilters: string
[]
_requiredFilters
• Protected
Optional
_requiredFilters: string
[]
Constructors
constructor
• new GenericFilterPlugin<T
, TPassId
, TEvent
>()
Type parameters
Name | Type |
---|---|
T | extends IPass <T > |
TPassId | extends string |
TEvent | extends string |