Class: AViewerPlugin<T, TViewer>

Core-API.AViewerPlugin

Type parameters

Name	Type
T	extends string
TViewer	extends IViewerApp = ViewerApp

Hierarchy

• SimpleEventDispatcher<T | "serialize" | "deserialize">

  ↳ AViewerPlugin

  ↳↳ AAssetManagerProcessStatePlugin

  ↳↳ CSS3DRendererPlugin

  ↳↳ AnisotropyPlugin

  ↳↳ ARPlugin

  ↳↳ VRPluginBasic

  ↳↳ InteractionPromptPlugin

  ↳↳ CameraViewPlugin

  ↳↳ CanvasRecorderPlugin

  ↳↳ CanvasSnipperPlugin

  ↳↳ GenericFilterPlugin

  ↳↳ GLTFAnimationPlugin

  ↳↳ BaseGroundPlugin

  ↳↳ HDRiGroundPlugin

  ↳↳ MaterialConfiguratorBasePlugin

  ↳↳ MaterialLibraryBasePlugin

  ↳↳ MultiFilterPlugin

  ↳↳ ObjectRotationPlugin

  ↳↳ ParallaxMappingPlugin

  ↳↳ ThinFilmLayerPlugin

  ↳↳ FragmentClippingExtensionPlugin

  ↳↳ NoiseBumpMaterialPlugin

  ↳↳ CustomBumpMapPlugin

  ↳↳ RandomizedDirectionalLightPlugin

  ↳↳ SSContactShadows

  ↳↳ SwitchNodeBasePlugin

  ↳↳ ShapeTubeExtrudePlugin

  ↳↳ FullScreenPlugin

  ↳↳ PopmotionPlugin

  ↳↳ ClearcoatTintPlugin

  ↳↳ SimpleTextPlugin

  ↳↳ PresetLibraryPlugin

  ↳↳ SceneLoopPlugin

  ↳↳ CSGPluginBase

  ↳↳ ACameraControlsPlugin

  ↳↳ SimplifyModifierPlugin

  ↳↳ CustomAnimationHelperPlugin

  ↳↳ FileTransferPlugin

  ↳↳ CameraViewControlPlugin

  ↳↳ TriplanarUVMappingPlugin

  ↳↳ LayeredMaterialPlugin

  ↳↳ XAtlasPlugin

  ↳↳ VariationConfiguratorPlugin

  ↳↳ ParallaxCameraControllerPlugin

  ↳↳ TransformAnimationPlugin

  ↳↳ VirtualCamerasPlugin

  ↳↳ GeometryGeneratorPlugin

  ↳↳ TransfrSharePlugin

  ↳↳ RainbowDiamondPlugin

  ↳↳ BeringRingAnimation

  ↳↳ CannonPhysicsPlugin

  ↳↳ GLTFKHRMaterialVariantsPlugin

  ↳↳ AssetExporterPlugin

  ↳↳ GLTFDracoExportPlugin

  ↳↳ PickingPlugin

  ↳↳ SimpleBackgroundEnvUiPlugin

  ↳↳ SimpleViewerUi

  ↳↳ HierarchyUiPlugin

  ↳↳ LightsUiPlugin

  ↳↳ SceneCamerasUiPlugin

  ↳↳ RendererUiPlugin

  ↳↳ CameraUiPlugin

  ↳↳ WindowiseDialogPlugin

  ↳↳ ExtrasUiPlugin

  ↳↳ Object3DWidgetsPlugin

  ↳↳ AWSClientPlugin

Implements

• IViewerPlugin<TViewer>

Constructors

constructor

• new AViewerPlugin<T, TViewer>()

Type parameters

Name	Type
T	extends string
TViewer	extends IViewerApp<TViewer> = ViewerApp

Inherited from

SimpleEventDispatcher<T|'serialize'|'deserialize'>.constructor

Defined in

webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

viewer

• get viewer(): undefined | TViewer

Returns

undefined | TViewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Properties

enabled

• Abstract enabled: boolean

Defined in

webgi/src/core/AViewerPlugin.ts:34

---

_dirty

• Protected _dirty: boolean = false

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: TViewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Methods

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	TViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	TViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	TViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:44

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:49

---

fromJSON

▸ fromJSON(data, meta?): null | AViewerPlugin<T, TViewer> | Promise<null | AViewerPlugin<T, TViewer>>

Parameters

Name	Type
data	any
meta?	any

Returns

null | AViewerPlugin<T, TViewer> | Promise<null | AViewerPlugin<T, TViewer>>

Implementation of

IViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:56

---

exportState

▸ exportState(): any

Returns

any

Defined in

webgi/src/core/AViewerPlugin.ts:68

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

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

Implementation of

IViewerPlugin.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>

Implementation of

IViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Defined in

webgi/src/core/AViewerPlugin.ts:64