Class NeedleWebXRHtmlElement

Hierarchy

HTMLElement
- NeedleWebXRHtmlElement

Index

Constructors

Accessors

arButton quicklookButton sendToQuestButton vrButton

Methods

createARButton createQRCode createQuicklookButton createSendToQuestButton createVRButton create getOrCreate

Constructors

constructor

new NeedleWebXRHtmlElement(): NeedleWebXRHtmlElement
Returns NeedleWebXRHtmlElement
Overrides HTMLElement.constructor

Accessors

arButton

get arButton(): HTMLButtonElement
Returns HTMLButtonElement
the WebXR AR button if it was created

quicklookButton

get quicklookButton(): HTMLButtonElement
Returns HTMLButtonElement
the quicklook button if it was created

sendToQuestButton

get sendToQuestButton(): HTMLButtonElement
Returns HTMLButtonElement
the Send to Quest button

vrButton

get vrButton(): HTMLButtonElement
Returns HTMLButtonElement
the WebXR VR button if it was created

Methods

createARButton

createARButton(init?): HTMLButtonElement
get or create the WebXR AR button
Parameters
- Optional init: XRSessionInit
  optional session init options Behaviour of the button:
  - if the device supports AR, the button will be visible and clickable
  - if the device does not support AR, the button will be hidden
  - if the device changes and now supports AR, the button will be visible
Returns HTMLButtonElement

createQRCode

createQRCode(): Promise<void>
Returns Promise<void>

createQuicklookButton

createQuicklookButton(): HTMLButtonElement
get or create the quicklook button Behaviour of the button:
- if the button is clicked a USDZExporter component will be searched for in the scene and if found, it will be used to export the scene to USDZ / Quicklook
Returns HTMLButtonElement

createSendToQuestButton

createSendToQuestButton(): HTMLButtonElement
get or create the Send To Quest button Behaviour of the button:
- if the button is clicked, the current URL will be sent to the Oculus Browser on the Quest
Returns HTMLButtonElement

createVRButton

createVRButton(init?): HTMLButtonElement
get or create the WebXR VR button
Parameters
- Optional init: XRSessionInit
  optional session init options Behaviour of the button:
  - if the device supports VR, the button will be visible and clickable
  - if the device does not support VR, the button will be hidden
  - if the device changes and now supports VR, the button will be visible
Returns HTMLButtonElement

`Static` create

create(): NeedleWebXRHtmlElement
Returns NeedleWebXRHtmlElement

`Static` getOrCreate

getOrCreate(context): NeedleWebXRHtmlElement
Parameters
- context: Context
Returns NeedleWebXRHtmlElement

Generated using TypeDoc