Class SumerianProvider

Hierarchy

AbstractXRProvider
- SumerianProvider

Implements

any

Index

Constructors

constructor

Accessors

options

Methods

Constructors

constructor

new SumerianProvider(options?: ProviderOptions): SumerianProvider

Overrides AbstractXRProvider.constructor
- Defined in xr/src/Providers/SumerianProvider.ts:31
Parameters
- Default value options: ProviderOptions = {}
Returns SumerianProvider

Accessors

Protected options

get options(): ProviderOptions

Inherited from AbstractXRProvider.options
- Defined in xr/src/Providers/XRProvider.ts:38
Returns ProviderOptions

Methods

configure

configure(config?: ProviderOptions): ProviderOptions

Inherited from AbstractXRProvider.configure
- Defined in xr/src/Providers/XRProvider.ts:26
Parameters
- Default value config: ProviderOptions = {}
Returns ProviderOptions

enableAudio

enableAudio(sceneName: string): void

Overrides AbstractXRProvider.enableAudio
- Defined in xr/src/Providers/SumerianProvider.ts:247
Parameters
- sceneName: string
Returns void

enterVR

enterVR(sceneName: string): void

Overrides AbstractXRProvider.enterVR
- Defined in xr/src/Providers/SumerianProvider.ts:222
Parameters
- sceneName: string
Returns void

exitVR

exitVR(sceneName: string): void

Overrides AbstractXRProvider.exitVR
- Defined in xr/src/Providers/SumerianProvider.ts:227
Parameters
- sceneName: string
Returns void

getCategory

getCategory(): string

Inherited from AbstractXRProvider.getCategory
- Defined in xr/src/Providers/XRProvider.ts:34
Returns string

getProviderName

getProviderName(): string

Overrides AbstractXRProvider.getProviderName
- Defined in xr/src/Providers/SumerianProvider.ts:36
Returns string

getSceneController

getSceneController(sceneName: string): any

Overrides AbstractXRProvider.getSceneController
- Defined in xr/src/Providers/SumerianProvider.ts:188
Parameters
- sceneName: string
Returns any

isMuted

isMuted(sceneName: string): boolean

Overrides AbstractXRProvider.isMuted
- Defined in xr/src/Providers/SumerianProvider.ts:232
Parameters
- sceneName: string
Returns boolean

isSceneLoaded

isSceneLoaded(sceneName: string): any

Overrides AbstractXRProvider.isSceneLoaded
- Defined in xr/src/Providers/SumerianProvider.ts:161
Parameters
- sceneName: string
Returns any

isVRCapable

isVRCapable(sceneName: string): boolean

Overrides AbstractXRProvider.isVRCapable
- Defined in xr/src/Providers/SumerianProvider.ts:212
Parameters
- sceneName: string
Returns boolean

loadScene

loadScene(sceneName: string, domElementId: string, sceneOptions: SumerianSceneOptions): Promise<void>

Overrides AbstractXRProvider.loadScene
- Defined in xr/src/Providers/SumerianProvider.ts:55
Parameters
- sceneName: string
- domElementId: string
- sceneOptions: SumerianSceneOptions
Returns Promise<void>

onSceneEvent

onSceneEvent(sceneName: string, eventName: string, eventHandler: Function): void

Overrides AbstractXRProvider.onSceneEvent
- Defined in xr/src/Providers/SumerianProvider.ts:242
Parameters
- sceneName: string
- eventName: string
- eventHandler: Function
Returns void

setMuted

setMuted(sceneName: string, muted: boolean): void

Overrides AbstractXRProvider.setMuted
- Defined in xr/src/Providers/SumerianProvider.ts:237
Parameters
- sceneName: string
- muted: boolean
Returns void

start

start(sceneName: string): void

Overrides AbstractXRProvider.start
- Defined in xr/src/Providers/SumerianProvider.ts:217
Parameters
- sceneName: string
Returns void