Class: InteractionPromptPlugin
Plugins.InteractionPromptPlugin
Hierarchy
AViewerPlugin<"">↳
InteractionPromptPlugin
Properties
PluginType
▪ Static Readonly PluginType: "InteractionPromptPlugin"
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:10
enabled
• enabled: boolean
Overrides
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:13
currentSphericalPosition
• Optional currentSphericalPosition: Spherical
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:15
animationRunning
• animationRunning: boolean = false
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:16
cursorEl
• Optional cursorEl: HTMLElement
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:17
interactionsDisabled
• interactionsDisabled: boolean = false
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:18
animationDuration
• animationDuration: number = 2000
Animation duration in ms
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:25
animationDistance
• animationDistance: number = 80
Animation distance in pixels
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:32
animationPauseDuration
• animationPauseDuration: number = 6000
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:36
rotationDistance
• rotationDistance: number = 0.3
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:40
yOffset
• yOffset: number = 0
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:44
autoStart
• autoStart: boolean = true
Autostart after camera stop
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:51
autoStartDelay
• autoStartDelay: number = 30000
Time in ms to wait before auto start after the camera stops.
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:58
autoStop
• autoStop: boolean = true
Auto stop on user interaction pointer down or wheel
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:65
autoStartOnObjectLoad
• autoStartOnObjectLoad: boolean = true
Auto start on scene object load. This requires autoStart to be true
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:72
autoStartOnObjectLoadDelay
• autoStartOnObjectLoadDelay: number = 3000
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:76
currentTime
• currentTime: number = 0
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:79
lastActionTime
• lastActionTime: number = Infinity
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:82
pointerIcon
• pointerIcon: string
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:92
onlyOnOrbitControls
• onlyOnOrbitControls: boolean = true
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:184
_dirty
• Protected _dirty: boolean = false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
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
viewer
• get viewer(): undefined | TViewer
Returns
undefined | TViewer
Inherited from
AViewerPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:49
fromJSON
▸ fromJSON(data, meta?): null | InteractionPromptPlugin | Promise<null | InteractionPromptPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | InteractionPromptPlugin | Promise<null | InteractionPromptPlugin>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:56
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:71
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:78
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:88
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:111
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:142
startAnimation
▸ startAnimation(): void
Returns
void
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:189
stopAnimation
▸ stopAnimation(): void
Returns
void
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:211
disable
▸ disable(key): void
Parameters
| Name | Type |
|---|---|
key | any |
Returns
void
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:272
enable
▸ enable(key): void
Parameters
| Name | Type |
|---|---|
key | any |
Returns
void
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:277
isDisabled
▸ isDisabled(): boolean
Returns
boolean
Defined in
webgi/src/plugins/InteractionPromptPlugin.ts:282
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
Constructors
constructor
• new InteractionPromptPlugin(enabled?)
Parameters
| Name | Type | Default value |
|---|---|---|
enabled | boolean | true |