Interface: IViewerPlugin<TViewer, IsSync>

Core-API.IViewerPlugin

Type parameters

Name	Type
TViewer	extends IViewerApp = IViewerApp
IsSync	extends boolean = boolean

Hierarchy

• IEventDispatcher<string>

• IUiConfigContainer

• Partial<IJSONSerializable>

  ↳ IViewerPlugin

  ↳↳ IViewerPluginSync

  ↳↳ IViewerPluginAsync

Implemented by

• AViewerPlugin
• AnisotropyPlugin
• BaseGroundPlugin
• BloomPlugin
• ClearcoatTintPlugin
• CombinedPostPlugin
• ContactShadowGroundPlugin
• CustomBumpMapPlugin
• DebugPlugin
• DepthOfFieldPlugin
• EXRLoadPlugin
• FBXLoadPlugin
• FragmentClippingExtensionPlugin
• FrameFadePlugin
• GBufferPlugin
• GLTFMeshOptPlugin
• GenericFilterPlugin
• GroundPlugin
• KTX2LoadPlugin
• KTXLoadPlugin
• MultiFilterPlugin
• NoiseBumpMaterialPlugin
• NormalBufferPlugin
• ObjMtlLoadPlugin
• PMREMGeneratorPlugin
• ProgressivePlugin
• RandomizedDirectionalLightPlugin
• Rhino3dmLoadPlugin
• SSAOPlugin
• SSBevelPlugin
• SSContactShadows
• SSGIPlugin
• SSRPlugin
• STLLoadPlugin
• TemporalAAPlugin
• ThinFilmLayerPlugin
• TriplanarUVMappingPlugin
• TweakpaneUiPlugin
• VelocityBufferPlugin

Properties

dependencies

• Optional dependencies: Class<IViewerPlugin<any, boolean>>[]

Defined in

webgi/src/interfaces.ts:508

---

dirty

• Optional dirty: boolean

Defined in

webgi/src/interfaces.ts:511

---

serializeWithViewer

• Optional serializeWithViewer: boolean

Defined in

webgi/src/interfaces.ts:522

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Defined in

webgi/src/interfaces.ts:586

Methods

onAdded

▸ onAdded(viewer): IsSync extends false ? Promise<void> : void

Parameters

Name	Type
viewer	TViewer

Returns

IsSync extends false ? Promise<void> : void

Defined in

webgi/src/interfaces.ts:514

---

onRemove

▸ onRemove(viewer): IsSync extends false ? Promise<void> : void

Parameters

Name	Type
viewer	TViewer

Returns

IsSync extends false ? Promise<void> : void

Defined in

webgi/src/interfaces.ts:517

---

onDispose

▸ Optional onDispose(viewer): IsSync extends false ? Promise<void> : void

Parameters

Name	Type
viewer	TViewer

Returns

IsSync extends false ? Promise<void> : void

Defined in

webgi/src/interfaces.ts:520

---

storeState

▸ Optional storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Defined in

webgi/src/interfaces.ts:524

---

loadState

▸ Optional loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Defined in

webgi/src/interfaces.ts:525