Class StereoPlugin

Adds stereo view on mobile devices

Hierarchy

AbstractPlugin<StereoPluginEvents>
- StereoPlugin

Index

Constructors

Properties

viewer VERSION id

Methods

addEventListener dispatchEvent isEnabled removeEventListener start stop toggle

Constructors

constructor

new StereoPlugin(viewer): StereoPlugin
Parameters
- viewer: Viewer
Returns StereoPlugin
Overrides AbstractPlugin.constructor
- Defined in packages/stereo-plugin/src/StereoPlugin.ts:37

Properties

`Protected` viewer

viewer: Viewer

`Static` `Readonly` VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

`Static` `Readonly` id

id: "stereo" = 'stereo'

Unique identifier of the plugin

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "stereo-updated"
  
  the name of event
- E extends StereoUpdatedEvent & {
  type: T;
  }
  
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | AddEventListenerOptions
  Optional
Returns void
Inherited from AbstractPlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

dispatchEvent

dispatchEvent(e): boolean
Parameters
- e: StereoUpdatedEvent
Returns boolean
Inherited from AbstractPlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

isEnabled

isEnabled(): boolean
Checks if the stereo view is enabled

Returns boolean
- Defined in packages/stereo-plugin/src/StereoPlugin.ts:87

removeEventListener

removeEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "stereo-updated"
  
  the name of event
- E extends StereoUpdatedEvent & {
  type: T;
  }
  
  the class of the event
Parameters
- type: "stereo-updated"
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | EventListenerOptions
  Optional
Returns void
Inherited from AbstractPlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

start

start(): Promise<void>
Enables the stereo view

Returns Promise<void>
Description
- enables wake lock
- enables full screen
- starts gyroscope controle
- hides markers, navbar and panel
- instanciate the stereo effect
- Defined in packages/stereo-plugin/src/StereoPlugin.ts:100

stop

stop(): void
Disables the stereo view

Returns void
- Defined in packages/stereo-plugin/src/StereoPlugin.ts:135

toggle

toggle(): void
Enables or disables the stereo view

Returns void
- Defined in packages/stereo-plugin/src/StereoPlugin.ts:156

Generated using TypeDoc