Class: InteractionPromptPlugin

Plugins.InteractionPromptPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ InteractionPromptPlugin

Properties

PluginType

▪ Static Readonly PluginType: "InteractionPromptPlugin"

---

enabled

• enabled: boolean

Overrides

AViewerPlugin.enabled

---

currentSphericalPosition

• Optional currentSphericalPosition: Spherical

---

animationRunning

• animationRunning: boolean = false

---

cursorEl

• Optional cursorEl: HTMLElement

---

animationDuration

• animationDuration: number = 2000

Animation duration in ms

---

animationDistance

• animationDistance: number = 80

Animation distance in pixels

---

animationPauseDuration

• animationPauseDuration: number = 6000

---

rotationDistance

• rotationDistance: number = 0.3

---

yOffset

• yOffset: number = 0

---

autoStart

• autoStart: boolean = true

Autostart after camera stop

---

autoStartDelay

• autoStartDelay: number = 30000

Time in ms to wait before auto start after the camera stops.

---

autoStop

• autoStop: boolean = true

Auto stop on user interaction pointer down or wheel

---

autoStartOnObjectLoad

• autoStartOnObjectLoad: boolean = true

Auto start on scene object load. This requires autoStart to be true

---

autoStartOnObjectLoadDelay

• autoStartOnObjectLoadDelay: number = 3000

---

currentTime

• currentTime: number = 0

---

lastActionTime

• lastActionTime: number = Infinity

---

pointerIcon

• pointerIcon: string

---

onlyOnOrbitControls

• onlyOnOrbitControls: boolean = true

---

_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

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | InteractionPromptPlugin | Promise<null | InteractionPromptPlugin>

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(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

---

startAnimation

▸ startAnimation(): void

Returns

void

---

stopAnimation

▸ stopAnimation(__namedParameters?): undefined | Promise<unknown>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.reset?	boolean

Returns

undefined | Promise<unknown>

---

disable

▸ disable(key): void

Parameters

Name	Type
key	any

Returns

void

---

enable

▸ enable(key): void

Parameters

Name	Type
key	any

Returns

void

---

isDisabled

▸ isDisabled(): boolean

Returns

boolean

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new InteractionPromptPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

AViewerPlugin.constructor