Class: CameraViewPlugin

Plugins.CameraViewPlugin

Plugin to save, interact and animate between with multiple camera states/views.

Hierarchy

• AViewerPlugin<"viewChange" | "startViewChange" | "viewAdd" | "viewDelete">

  ↳ CameraViewPlugin

Properties

PluginType

▪ Static Readonly PluginType: "CameraViews"

Defined in

webgi/src/plugins/CameraViewPlugin.ts:76

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/CameraViewPlugin.ts:78

---

viewLooping

• viewLooping: boolean = false

Defined in

webgi/src/plugins/CameraViewPlugin.ts:105

---

viewPauseTime

• viewPauseTime: number = 200

Pauses time between view changes when animating all views or looping.

Defined in

webgi/src/plugins/CameraViewPlugin.ts:109

---

animEase

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

EasingFunctions

Defined in

webgi/src/plugins/CameraViewPlugin.ts:114

---

animDuration

• animDuration: number = 1000

Defined in

webgi/src/plugins/CameraViewPlugin.ts:115

---

rotationOffset

• rotationOffset: number = 0.25

Defined in

webgi/src/plugins/CameraViewPlugin.ts:116

---

interpolateMode

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

Defined in

webgi/src/plugins/CameraViewPlugin.ts:118

---

animateOnScroll

• animateOnScroll: boolean = false

Defined in

webgi/src/plugins/CameraViewPlugin.ts:121

---

seekOnScroll

• seekOnScroll: boolean = false

Defined in

webgi/src/plugins/CameraViewPlugin.ts:124

---

dependencies

• dependencies: never[] = []

Defined in

webgi/src/plugins/CameraViewPlugin.ts:128

---

scrollAnimationDamping

• scrollAnimationDamping: number = 0.1

Defined in

webgi/src/plugins/CameraViewPlugin.ts:131

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:636

---

_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

---

animationLooping

• get animationLooping(): boolean

Returns

boolean

Defined in

webgi/src/plugins/CameraViewPlugin.ts:70

---

animating

• get animating(): boolean

Returns

boolean

Defined in

webgi/src/plugins/CameraViewPlugin.ts:73

---

camViews

• get camViews(): CameraView[]

Returns

CameraView[]

Defined in

webgi/src/plugins/CameraViewPlugin.ts:97

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

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45

---

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/CameraViewPlugin.ts:172

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/CameraViewPlugin.ts:263

---

animateAllViews

▸ animateAllViews(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:291

---

resetToFirstView

▸ resetToFirstView(duration?): Promise<void>

Parameters

Name	Type	Default value
duration	number	100

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:302

---

recordAllViews

▸ recordAllViews(onStart?, downloadOnEnd?): Promise<undefined | Blob>

Parameters

Name	Type	Default value
onStart?	() => void	undefined
downloadOnEnd	boolean	true

Returns

Promise<undefined | Blob>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:310

---

addCurrentView

▸ addCurrentView(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:352

---

addView

▸ addView(view): void

Parameters

Name	Type
view	CameraView

Returns

void

Defined in

webgi/src/plugins/CameraViewPlugin.ts:363

---

getCurrentCameraView

▸ getCurrentCameraView(camera?, worldSpace?, view?): CameraView

Parameters

Name	Type	Default value
camera?	CameraController	undefined
worldSpace	boolean	true
view?	CameraView	undefined

Returns

CameraView

Defined in

webgi/src/plugins/CameraViewPlugin.ts:369

---

setCurrentCameraView

▸ setCurrentCameraView(view): void

Parameters

Name	Type
view	CameraView

Returns

void

Defined in

webgi/src/plugins/CameraViewPlugin.ts:417

---

focusView

▸ focusView(view): Promise<void>

Parameters

Name	Type
view	CameraView

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:436

---

deleteView

▸ deleteView(view): void

Parameters

Name	Type
view	CameraView

Returns

void

Defined in

webgi/src/plugins/CameraViewPlugin.ts:440

---

focusNext

▸ focusNext(wrap?): void

Parameters

Name	Type	Default value
wrap	boolean	true

Returns

void

Defined in

webgi/src/plugins/CameraViewPlugin.ts:449

---

focusPrevious

▸ focusPrevious(wrap?): void

Parameters

Name	Type	Default value
wrap	boolean	true

Returns

void

Defined in

webgi/src/plugins/CameraViewPlugin.ts:460

---

stopAllAnimations

▸ stopAllAnimations(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:472

---

animateToView

▸ animateToView(view, duration?, easing?, throwOnStop?): Promise<void>

Parameters

Name	Type	Default value
view	CameraView	undefined
duration?	number	undefined
easing?	Easing | "linear" | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"	undefined
throwOnStop	boolean	false

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:481

---

fromJSON

▸ fromJSON(data, meta?): null | CameraViewPlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | CameraViewPlugin

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/CameraViewPlugin.ts:576

---

animateToObject

▸ animateToObject(selected?, distanceMultiplier?, duration?, ease?, distanceBounds?): Promise<void>

Parameters

Name	Type	Default value
selected?	Object3D<Event, string>	undefined
distanceMultiplier	number	4
duration?	number	undefined
ease?	Easing | "linear" | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"	undefined
distanceBounds	Object	undefined
distanceBounds.min	number	0.5
distanceBounds.max	number	5.0

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:588

---

animateToFitObject

▸ animateToFitObject(selected?, distanceMultiplier?, duration?, ease?, distanceBounds?): Promise<void>

Parameters

Name	Type	Default value
selected?	Object3D<Event, string>	undefined
distanceMultiplier	number	1.5
duration	number	1000
ease?	Easing | "linear" | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"	undefined
distanceBounds	Object	undefined
distanceBounds.min	number	0.5
distanceBounds.max	number	50.0

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:597

---

animateToTarget

▸ animateToTarget(distanceFromTarget, center, duration?, ease?): Promise<void>

Parameters

Name	Type	Description
distanceFromTarget	number	in world units
center	Vector3	target (center) of the view in world coordinates
duration?	number	in milliseconds
ease?	Easing | "linear" | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

Returns

Promise<void>

Defined in

webgi/src/plugins/CameraViewPlugin.ts:628

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

• new CameraViewPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/CameraViewPlugin.ts:84