Class: VirtualCamerasPlugin

Plugins.VirtualCamerasPlugin

Hierarchy

• AViewerPlugin<"preRenderCamera" | "preBlitCamera" | "postRenderCamera">

  ↳ VirtualCamerasPlugin

Properties

PluginType

▪ Static Readonly PluginType: "VirtualCamerasPlugin"

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:14

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:17

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:19

---

cameras

• cameras: VirtualCamera[] = []

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:26

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

fromJSON

▸ fromJSON(data, meta?): null | VirtualCamerasPlugin | Promise<null | VirtualCamerasPlugin>

Parameters

Name	Type
data	any
meta?	any

Returns

null | VirtualCamerasPlugin | Promise<null | VirtualCamerasPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:28

---

addCamera

▸ addCamera(camera): VirtualCamera

Parameters

Name	Type
camera	ICamera<ICameraOptions, any, any>

Returns

VirtualCamera

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:60

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

---

_preRender

▸ Protected _preRender(): void

Returns

void

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:33

Constructors

constructor

• new VirtualCamerasPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/VirtualCamerasPlugin.ts:21