Interface: IViewerPlugin<TViewer>
Core-API.IViewerPlugin
Type parameters
| Name | Type |
|---|---|
TViewer | extends IViewerApp = IViewerApp |
Hierarchy
IEventDispatcher<string>Partial<IJSONSerializable>↳
IViewerPlugin
Implemented by
AViewerPluginAnisotropyPluginAssetManagerPluginBaseGroundPluginBloomPluginClearcoatTintPluginCombinedPostPluginContactShadowGroundPluginCustomBumpMapPluginDebugPluginDepthOfFieldPluginDropzonePluginEXRLoadPluginFBXLoadPluginFragmentClippingExtensionPluginFrameFadePluginGBufferPluginGLTFMeshOptPluginGenericFilterPluginGroundPluginKTX2LoadPluginKTXLoadPluginMultiFilterPluginNoiseBumpMaterialPluginNormalBufferPluginObjMtlLoadPluginPMREMGeneratorPluginProgressivePluginRandomizedDirectionalLightPluginRhino3dmLoadPluginSSAOPluginSSBevelPluginSSContactShadowsSSGIPluginSSRPluginSTLLoadPluginTemporalAAPluginThinFilmLayerPluginTweakpaneUiPluginVelocityBufferPlugin
Methods
addEventListener
▸ addEventListener(type, listener): void
Adds a listener to an event type.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of event to listen to. |
listener | (event: IEvent<string>) => void | The function that gets called when the event is fired. |
Returns
void
Inherited from
IEventDispatcher.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:14
hasEventListener
▸ hasEventListener(type, listener): boolean
Checks if listener is added to an event type.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of event to listen to. |
listener | (event: IEvent<string>) => void | The function that gets called when the event is fired. |
Returns
boolean
Inherited from
IEventDispatcher.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:21
removeEventListener
▸ removeEventListener(type, listener): void
Removes a listener from an event type.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of the listener that gets removed. |
listener | (event: IEvent<string>) => void | The listener function that gets removed. |
Returns
void
Inherited from
IEventDispatcher.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:28
dispatchEvent
▸ dispatchEvent(event): void
Fire an event type.
Parameters
| Name | Type |
|---|---|
event | IEvent<string> |
Returns
void
Inherited from
IEventDispatcher.dispatchEvent
Defined in
webgi/src/helpers/EventDispatcher.ts:34
toJSON
▸ Optional toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
Partial.toJSON
Defined in
fromJSON
▸ Optional fromJSON(data, meta?): null | IJSONSerializable | Promise<null | IJSONSerializable>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | IJSONSerializable | Promise<null | IJSONSerializable>
Inherited from
Partial.fromJSON
Defined in
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | TViewer |
Returns
Promise<void>
Defined in
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | TViewer |
Returns
Promise<void>
Defined in
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | TViewer |
Returns
Promise<void>
Defined in
Properties
dependencies
• Optional dependencies: Class<IViewerPlugin<any>>[]
Defined in
dirty
• Optional dirty: boolean
Defined in
serializeWithViewer
• Optional serializeWithViewer: boolean
Defined in
uiConfig
• Optional uiConfig: UiObjectConfig<any, string>