Class: CameraViewControlPlugin

Plugins.CameraViewControlPlugin

Hierarchy

• AViewerPlugin<"enableChanged">

  ↳ CameraViewControlPlugin

  ↳↳ ScrollableCameraViewPlugin

Properties

PluginType

▪ Static Readonly PluginType: string = 'CameraViewControlPlugin'

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

animEase

• animEase: "linear" | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine" = 'easeInOutSine'

EasingFunctions

---

interpolateMode

• interpolateMode: "linear" | "spherical" = 'spherical'

---

enableDamping

• enableDamping: boolean = true

---

damping

• damping: number = 0.04

---

initAnimationTime

• initAnimationTime: number = 1

---

dependencies

• dependencies: typeof CameraViewPlugin[]

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

---

_cameraViews

• Protected get _cameraViews(): CameraView[]

Returns

CameraView[]

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | CameraViewControlPlugin | Promise<null | CameraViewControlPlugin>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

setState

▸ setState(state): void

Parameters

Name	Type
state	number

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_onEnabledChanged

▸ Protected _onEnabledChanged(): void

Returns

void

---

_preFrame

▸ Protected _preFrame(ev): void

Parameters

Name	Type
ev	any

Returns

void

Constructors

constructor

• new CameraViewControlPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

AViewerPlugin.constructor