RealityAPI

• webVis API Reference
• RealityAPI

Interface RealityAPI

The RealityAPI provides functionalities for controlling an XRSession together with all XR capable members.

Example

// Start by connecting to the XR Session
const xrSessionState = await webvis.getContext().connectXRSession();

// Get a list of all available XR members
const xrMembers = webvis.getContext().getXRMembers();

// The local XR member is always the first one in the list
const localXRMember = xrMembers[0];

// To kick-off modeltracking, let the XRMember enter the INIT mode
webvis.getContext().enterXRMemberInitMode(localXRMember);

// You can also hardreset the modeltracker by specifying the `resetHard` option
webvis.getContext().enterXRMemberInitMode(localXRMember, {resetHard: true});

// By default, enterXRMemberInitMode will fit the current model to the viewport
// If you want to disable this behavior, you can set the `fitView` option to false
webvis.getContext().enterXRMemberInitMode(localXRMember, {fitView: false});

// The modeltracker will try to align the virtual model and its real world counterpart.
// If this process is successful, this will automatically anchor the 3D model to the SLAM pose (provided e.g. by the ARKit)
// You can also manually fixate the model by calling the `exitXRMemberInitMode` method
webvis.getContext().exitXRMemberInitMode(localXRMember);

Hierarchy

• RealityAPI
  • ContextAPI

Index

Methods

connectXRSession enterXRMemberInitMode exitXRMemberInitMode exportXRInitTemplate fixateXRMember getXRMemberInfo getXRMemberState getXRMembers getXRSessionState importXRInitTemplate requestXMemberCapabilities resetAR setXRFusionMode setXRMemberSettings showExpertDialog startAR startXRMemberSpectate stopAR stopXRMemberSpectate unfixateXRMember

Methods

connectXRSession

• connectXRSession(): Promise<XRSessionState>
• Experimental

  Connects to the XR Session.

  Returns Promise<XRSessionState>

  Returns a Promise with the current XRSessionState.

enterXRMemberInitMode

• enterXRMemberInitMode(memberId: number, xrInitOptions?: XRInitOptions): Promise<boolean>
• Experimental

  Enters the initialization phase for modeltracking. This is also used to reset the current modeltracking. It will also trigger a XRMemberStateChangedEvent event with XRState.FIXATED set to false. By default the modeltracking will be softreset. If you choose to reset different data on the modeltracker you can do so by specifying the XRInitOptions.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  • Optional xrInitOptions: XRInitOptions

    Specify initialization options. E.g. reset behavior of modeltracker. Default is softreset.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

exitXRMemberInitMode

• exitXRMemberInitMode(memberId: number): Promise<boolean>
• Experimental

  Exits the initialization phase for modeltracking, this will also anchor the model at the current position.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

exportXRInitTemplate

• exportXRInitTemplate(memberId: number): Promise<string>
• Experimental

  Exports init template for modeltracking. Usage: After a successful tracking session, the learned init template data can be exported with this function and stored for later.

  Only supported if the XRMember has the MODELTRACKER capability.

  The aquired data can be imported via importXRInitTemplate function

  Parameters

  • memberId: number

    the XRMember that the operation should be applied on

  Returns Promise<string>

  base64 encoded init template data

fixateXRMember

• fixateXRMember(memberId: number): Promise<boolean>
• Experimental

  Anchors the model at the current position. It will also trigger a XRMemberStateChangedEvent event with XRState.FIXATED set to true.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

getXRMemberInfo

• getXRMemberInfo(memberId: number): XRMemberInfo
• Experimental

  Get the XRMemberInfo for a given XRMember.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns XRMemberInfo

  Returns an XRMemberInfo struct containing all relevant infos (memberId, XRCapabilities, sessionMemberData) for the given member.

getXRMemberState

• getXRMemberState(memberId: number): XRMemberState
• Experimental

  Get the runtime state of a given XRMember.

  Parameters

  • memberId: number

    The XRMember that the state should be queried from.

  Returns XRMemberState

  Returns either the member state if the member exist or return undefined if XR is not connected or the memberId does not exist.

getXRMembers

• getXRMembers(): number[]
• Experimental

  Lists all the available XRMembers in the current session.

  Returns number[]

  Returns a Promise with the list of the IDs of all available XRMembers.

getXRSessionState

• getXRSessionState(): XRSessionState
• Experimental

  Get the current XRSessionState. This method can be used to check if the XR session is currently connected.

  Returns XRSessionState

  Returns the current XRSessionState.

importXRInitTemplate

• importXRInitTemplate(memberId: number, template: string): Promise<void>
• Experimental

  Imports init template for modeltracking. When using Model tracking, Init templates are captured during the tracking process. This initialization data is linked to previously visited view-points along the traveled camera path. Once the tracking is lost the templates are used to quickly reinitialize from similar view-points without the user having to align the line model with the real object.

  Once the init template data is imported. It will stay until enterInitMode with resetInitTemplate set to true is called.

  Only supported if the XRMember has the MODELTRACKER capability.

  The input data can be aquired via exportXRInitTemplate function

  Parameters

  • memberId: number

    the XRMember that the operation should be applied on

  • template: string

  Returns Promise<void>

requestXMemberCapabilities

• requestXMemberCapabilities(memberId: number): Promise<boolean>
• Experimental

  Execute whatever is necessary to enable XRCapbilities on the given member, e.g. start the camera or forward to the booster.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

resetAR

• resetAR(): Promise<boolean>

• Deprecated

  Restart modeltracker initialization for the local xr member

  Returns Promise<boolean>

  returns true if resetting was successfull or false if not

setXRFusionMode

• setXRFusionMode(memberId: number, xrFusionMode: XRFusionMode): Promise<boolean>
• Experimental

  Sets the passed fusion mode for the given XRMember. The fusion mode determines which inputs will be used for the final visualization.

  Parameters

  • memberId: number

    the XRMember that the operation should be applied on

  • xrFusionMode: XRFusionMode

    the fusion mode that should be set

  Returns Promise<boolean>

  returns a Promise which reports whether the operation was successful or not

setXRMemberSettings

• setXRMemberSettings(memberId: number, settings: XRMemberSettings): Promise<boolean>
• Experimental

  This will change the XRMemberSettings for the specified XRMember.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  • settings: XRMemberSettings

    The quality threshold for the modeltracker must be between 0 and 1

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

showExpertDialog

• showExpertDialog(): Promise<boolean>

• Deprecated

  Show expert dialog for developers or advanced users

  Returns Promise<boolean>

  returns true if the operation was successfull or false if not

startAR

• startAR(): Promise<boolean>

• Deprecated

  Start AR. Projects the camera stream in the background and starts searching for the given reference. The reference is defined by setting the realproperty on the particular node via the webvis API. E.g. webvis.setProperty(0, pluginAPI.realProperty, pluginAPI.realState.Enabled)

  Returns Promise<boolean>

  returns true if starting was successfull or false if it could not start AR

startXRMemberSpectate

• startXRMemberSpectate(memberId: number): Promise<boolean>
• Experimental

  Puts the image stream in the background of the renderer. It will also trigger a XRMemberStateChangedEvent event with XRState.FOLLOWING set to true.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

stopAR

• stopAR(): Promise<boolean>

• Deprecated

  Stop AR. Stop projecting the camera stream in the background and reset background to default color.

  Returns Promise<boolean>

  returns true if stopping was successfull or false if it could not stop AR

stopXRMemberSpectate

• stopXRMemberSpectate(memberId: number): Promise<boolean>
• Experimental

  Stops the image stream in the background of the renderer. It will also trigger a XRMemberStateChangedEvent event with XRState.FOLLOWING set to false.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

unfixateXRMember

• unfixateXRMember(memberId: number): Promise<boolean>
• Experimental

  Unfixates the model. The model will move with the device. It will also trigger a XRMemberStateChangedEvent event with XRState.FIXATED set to false.

  Parameters

  • memberId: number

    The XRMember that the operation should be applied on.

  Returns Promise<boolean>

  Returns a Promise which reports whether the operation was successful or not.

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)