Class: ParallaxCameraControllerPlugin

Plugins.ParallaxCameraControllerPlugin

Camera parallax effect using asymmetric frustum using mouse or gyroscope as input

Hierarchy

• AViewerPlugin<"">

  ↳ ParallaxCameraControllerPlugin

Implements

• IUiConfigContainer

Properties

PluginType

▪ Static Readonly PluginType: "ParallaxCameraControllerPlugin"

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Implementation of

IUiConfigContainer.uiConfig

---

enabled

• enabled: boolean = false

Overrides

AViewerPlugin.enabled

---

enableEdit

• enableEdit: boolean = false

---

invert

• invert: boolean = false

---

sensitivity

• sensitivity: number = 0.5

---

focalPointHit

• focalPointHit: Vector3

---

damping

• damping: number = 0.5

---

cameraView

• cameraView: string = ''

Name of the camera view from the 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

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | ParallaxCameraControllerPlugin | Promise<null | ParallaxCameraControllerPlugin>

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

---

onAdded

▸ onAdded(v): Promise<void>

Parameters

Name	Type
v	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

addIndicator

▸ addIndicator(): void

Returns

void

---

onPointerDown

▸ onPointerDown(e): void

Parameters

Name	Type
e	MouseEvent

Returns

void

---

onPointerUp

▸ onPointerUp(): void

Returns

void

---

update

▸ update(delta): void

Parameters

Name	Type
delta	number

Returns

void

---

dispose

▸ dispose(): void

Returns

void

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_onObjectHit

▸ Protected _onObjectHit(e): void

Parameters

Name	Type
e	any

Returns

void

Constructors

constructor

• new ParallaxCameraControllerPlugin()

Overrides

AViewerPlugin.constructor