Class: FilmicGrainPlugin
Plugins.FilmicGrainPlugin
Hierarchy
GenericExtensionPlugin
<FilmicGrainExtension
>↳
FilmicGrainPlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "FilmicGrain"
enabled
• enabled: boolean
= true
Inherited from
GenericExtensionPlugin.enabled
dependencies
• dependencies: typeof CombinedPostPlugin
[]
Inherited from
GenericExtensionPlugin.dependencies
_dirty
• Protected
_dirty: boolean
= false
Inherited from
GenericExtensionPlugin._dirty
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
GenericExtensionPlugin._viewer
_extension
• Protected
Optional
_extension: FilmicGrainExtension
Inherited from
GenericExtensionPlugin._extension
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Inherited from
GenericExtensionPlugin.dirty
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
GenericExtensionPlugin.dirty
viewer
• get
viewer(): undefined
| ViewerApp
Returns
undefined
| ViewerApp
Inherited from
GenericExtensionPlugin.viewer
uiConfig
• get
uiConfig(): undefined
| UiObjectConfig
<any
, string
>
Returns
undefined
| UiObjectConfig
<any
, string
>
Inherited from
GenericExtensionPlugin.uiConfig
config
• get
config(): undefined
| T
Returns
undefined
| T
Inherited from
GenericExtensionPlugin.config
intensity
• get
intensity(): number
Returns
number
• set
intensity(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
multiply
• get
multiply(): boolean
Returns
boolean
• set
multiply(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
GenericExtensionPlugin.onDispose
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Inherited from
GenericExtensionPlugin.toJSON
fromJSON
▸ fromJSON(data
, meta?
): null
| FilmicGrainPlugin
| Promise
<null
| FilmicGrainPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| FilmicGrainPlugin
| Promise
<null
| FilmicGrainPlugin
>
Inherited from
GenericExtensionPlugin.fromJSON
exportState
▸ exportState(): any
Returns
any
Inherited from
GenericExtensionPlugin.exportState
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
GenericExtensionPlugin.importState
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
GenericExtensionPlugin.storeState
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
GenericExtensionPlugin.loadState
disposeExtension
▸ disposeExtension(): void
Returns
void
Inherited from
GenericExtensionPlugin.disposeExtension
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
GenericExtensionPlugin.onAdded
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
GenericExtensionPlugin.onRemove
generateExtension
▸ generateExtension(viewer
): FilmicGrainExtension
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
FilmicGrainExtension
Overrides
GenericExtensionPlugin.generateExtension
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
GenericExtensionPlugin._storeKey
Constructors
constructor
• new FilmicGrainPlugin()
Overrides
GenericExtensionPlugin<FilmicGrainExtension\>.constructor