Class: ScrollableCameraViewPreviewPlugin

Plugins.ScrollableCameraViewPreviewPlugin

Integrates with the viewer container in the editor to allow preview of ScrollableCameraViewPlugin

Hierarchy

• ScrollableCameraViewPlugin

  ↳ ScrollableCameraViewPreviewPlugin

Properties

PluginType

▪ Static Readonly PluginType: "ScrollableCameraViewPlugin"

Inherited from

ScrollableCameraViewPlugin.PluginType

---

enabled

• enabled: boolean = true

Inherited from

ScrollableCameraViewPlugin.enabled

---

animEase

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

EasingFunctions

Inherited from

ScrollableCameraViewPlugin.animEase

---

interpolateMode

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

Inherited from

ScrollableCameraViewPlugin.interpolateMode

---

enableDamping

• enableDamping: boolean = true

Inherited from

ScrollableCameraViewPlugin.enableDamping

---

damping

• damping: number = 0.04

Inherited from

ScrollableCameraViewPlugin.damping

---

initAnimationTime

• initAnimationTime: number = 1

Inherited from

ScrollableCameraViewPlugin.initAnimationTime

---

dependencies

• dependencies: typeof CameraViewPlugin[]

Inherited from

ScrollableCameraViewPlugin.dependencies

---

wrapper

• wrapper: HTMLDivElement

Inherited from

ScrollableCameraViewPlugin.wrapper

---

parent

• parent: HTMLElement

Inherited from

ScrollableCameraViewPlugin.parent

---

toJSON

• toJSON: any = undefined

Inherited from

ScrollableCameraViewPlugin.toJSON

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Inherited from

ScrollableCameraViewPlugin.uiConfig

---

canvasUp

• canvasUp: boolean = false

---

_dirty

• Protected _dirty: boolean = false

Inherited from

ScrollableCameraViewPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

ScrollableCameraViewPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

ScrollableCameraViewPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

ScrollableCameraViewPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

ScrollableCameraViewPlugin.viewer

---

_cameraViews

• Protected get _cameraViews(): CameraView[]

Returns

CameraView[]

Inherited from

ScrollableCameraViewPlugin._cameraViews

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

ScrollableCameraViewPlugin.onDispose

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | ScrollableCameraViewPreviewPlugin | Promise<null | ScrollableCameraViewPreviewPlugin>

Inherited from

ScrollableCameraViewPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

ScrollableCameraViewPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

ScrollableCameraViewPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

ScrollableCameraViewPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

ScrollableCameraViewPlugin.loadState

---

setState

▸ setState(state): void

Parameters

Name	Type
state	number

Returns

void

Inherited from

ScrollableCameraViewPlugin.setState

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

ScrollableCameraViewPlugin.onRemove

---

generateCode

▸ generateCode(): void

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

ScrollableCameraViewPlugin.onAdded

---

deserialize

▸ deserialize(ev): void

Parameters

Name	Type
ev	IEvent<any>

Returns

void

---

addView

▸ addView(ev): void

Parameters

Name	Type
ev	IEvent<any>

Returns

void

---

deleteView

▸ deleteView(ev): void

Parameters

Name	Type
ev	IEvent<any>

Returns

void

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

ScrollableCameraViewPlugin._storeKey

---

_preFrame

▸ Protected _preFrame(ev): void

Parameters

Name	Type
ev	any

Returns

void

Inherited from

ScrollableCameraViewPlugin._preFrame

---

_onEnabledChanged

▸ Protected _onEnabledChanged(): void

Returns

void

Overrides

ScrollableCameraViewPlugin._onEnabledChanged

---

_createSection

▸ Protected _createSection(name): void

Parameters

Name	Type
name	string

Returns

void

Constructors

constructor

• new ScrollableCameraViewPreviewPlugin(parent?, enabled?)

Parameters

Name	Type	Default value
parent	string | HTMLElement	document.body
enabled	boolean	false

Overrides

ScrollableCameraViewPlugin.constructor