Class StereoPlugin

Adds stereo view on mobile devices

Hierarchy (View Summary)

AbstractPlugin<StereoPluginEvents>
- StereoPlugin

Index

Constructors

Properties

viewer id VERSION

Methods

addEventListener dispatchEvent isEnabled removeEventListener start stop toggle

Constructors

constructor

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

Properties

`Protected`viewer

viewer: Viewer

`Static` `Readonly`id

id: "stereo" = 'stereo'

Unique identifier of the plugin

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

addEventListener<
    T extends "stereo-updated",
    E extends StereoUpdatedEvent & { type: T },
>(
    type: T,
    callback: EventListenerObject | (e: E) => void,
    options?: boolean | AddEventListenerOptions,
): 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: E) => void
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from AbstractPlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

dispatchEvent

dispatchEvent(e: StereoUpdatedEvent): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
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:99

removeEventListener

removeEventListener<
    T extends "stereo-updated",
    E extends StereoUpdatedEvent & { type: T },
>(
    type: "stereo-updated",
    callback: EventListenerObject | (e: E) => void,
    options?: boolean | EventListenerOptions,
): 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: E) => void
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from AbstractPlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

start

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

stop

stop(): void
Disables the stereo view

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

toggle

toggle(): void
Enables or disables the stereo view

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