Class: TonemapPlugin
Plugins.TonemapPlugin
Hierarchy
GenericExtensionPlugin<TonemapExtension>↳
TonemapPlugin
Implements
Properties
PluginType
▪ Static Readonly PluginType: "Tonemap"
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:180
enabled
• enabled: boolean = true
Inherited from
GenericExtensionPlugin.enabled
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:14
dependencies
• dependencies: typeof CombinedPostPlugin[]
Inherited from
GenericExtensionPlugin.dependencies
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:16
depthTonemap
• Readonly depthTonemap: boolean = true
_dirty
• Protected _dirty: boolean = false
Inherited from
GenericExtensionPlugin._dirty
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
GenericExtensionPlugin._viewer
Defined in
webgi/src/core/AViewerPlugin.ts:27
_extension
• Protected Optional _extension: TonemapExtension
Inherited from
GenericExtensionPlugin._extension
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:10
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
GenericExtensionPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
GenericExtensionPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
viewer
• get viewer(): undefined | TViewer
Returns
undefined | TViewer
Inherited from
GenericExtensionPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
uiConfig
• get uiConfig(): undefined | UiObjectConfig<any, string>
Returns
undefined | UiObjectConfig<any, string>
Inherited from
GenericExtensionPlugin.uiConfig
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:18
config
• get config(): undefined | T
Returns
undefined | T
Inherited from
GenericExtensionPlugin.config
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:22
exposure
• get exposure(): number
Returns
number
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:207
• set exposure(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:211
saturation
• get saturation(): number
Returns
number
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:218
• set saturation(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:222
contrast
• get contrast(): number
Returns
number
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:229
• set contrast(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:233
toneMapping
• get toneMapping(): ToneMapping
Returns
ToneMapping
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:240
• set toneMapping(value): void
Parameters
| Name | Type |
|---|---|
value | ToneMapping |
Returns
void
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:244
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
GenericExtensionPlugin.onDispose
Defined in
webgi/src/core/AViewerPlugin.ts:40
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
GenericExtensionPlugin.toJSON
Defined in
webgi/src/core/AViewerPlugin.ts:49
exportState
▸ exportState(): any
Returns
any
Inherited from
GenericExtensionPlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
GenericExtensionPlugin.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
Inherited from
GenericExtensionPlugin.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>
Inherited from
GenericExtensionPlugin.loadState
Defined in
webgi/src/core/AViewerPlugin.ts:88
disposeExtension
▸ disposeExtension(): void
Returns
void
Inherited from
GenericExtensionPlugin.disposeExtension
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:28
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
GenericExtensionPlugin.onRemove
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:38
fromJSON
▸ fromJSON(data, meta?): null | TonemapPlugin | Promise<null | TonemapPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | TonemapPlugin | Promise<null | TonemapPlugin>
Overrides
GenericExtensionPlugin.fromJSON
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:188
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
GenericExtensionPlugin.onAdded
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:198
generateExtension
▸ generateExtension(viewer): TonemapExtension
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
TonemapExtension
Overrides
GenericExtensionPlugin.generateExtension
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:203
updateGBuffer
▸ updateGBuffer(object, data): void
Parameters
| Name | Type |
|---|---|
object | Object3D<Event, string> |
data | Vector4 |
Returns
void
Implementation of
Defined in
webgi/src/plugins/threejs/TonemapPlugin.ts:251
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
GenericExtensionPlugin._storeKey
Defined in
webgi/src/core/AViewerPlugin.ts:64
Constructors
constructor
• new TonemapPlugin(depthTonemap?)
Parameters
| Name | Type | Default value |
|---|---|---|
depthTonemap | boolean | true |
Overrides
GenericExtensionPlugin<TonemapExtension\>.constructor