Class WebXRMotionControllerManager

constructor

• new WebXRMotionControllerManager(): WebXRMotionControllerManager

  Returns WebXRMotionControllerManager

StaticBaseRepositoryUrl

StaticDisableControllerCache

StaticPrioritizeOnlineRepository

StaticUseOnlineRepository

StaticClearControllerCache

• ClearControllerCache(): void

  Clear the controller's cache (usually happens at the end of a session)

  Returns void

StaticClearProfilesCache

• ClearProfilesCache(): void

  Clear the cache used for profile loading and reload when requested again

  Returns void

StaticDefaultFallbacks

• DefaultFallbacks(): void

  Register the default fallbacks. This function is called automatically when this file is imported.

  Returns void

StaticFindFallbackWithProfileId

• FindFallbackWithProfileId(profileId: string): string[]

  Find a fallback profile if the profile was not found. There are a few predefined generic profiles.

  Parameters

  • profileId: string

    the profile to which a fallback needs to be found

  Returns string[]

  an array with corresponding fallback profiles

StaticGetMotionControllerWithXRInput

• GetMotionControllerWithXRInput(
      xrInput: XRInputSource,
      scene: Scene,
      forceProfile?: string,
  ): Promise<WebXRAbstractMotionController>

  When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile. The order of search:

  1. Iterate the profiles array of the xr input and try finding a corresponding motion controller
  2. (If not found) search in the gamepad id and try using it (legacy versions only)
  3. search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  4. return the generic trigger controller if none were found

  Parameters

  • xrInput: XRInputSource

    the xrInput to which a new controller is initialized

  • scene: Scene

    the scene to which the model will be added

  • OptionalforceProfile: string

    force a certain profile for this controller

  Returns Promise<WebXRAbstractMotionController>

  A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found

StaticRegisterController

• RegisterController(
      type: string,
      constructFunction: MotionControllerConstructor,
  ): void

  Register a new controller based on its profile. This function will be called by the controller classes themselves.

  If you are missing a profile, make sure it is imported in your source, otherwise it will not register.

  Parameters

  • type: string

    the profile type to register

  • constructFunction: MotionControllerConstructor

    the function to be called when loading this profile

  Returns void

StaticRegisterFallbacksForProfileId

• RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void

  Register a fallback to a specific profile.

  Parameters

  • profileId: string

    the profileId that will receive the fallbacks

  • fallbacks: string[]

    A list of fallback profiles

  Returns void

StaticUpdateProfilesList

• UpdateProfilesList(): Promise<{ [profile: string]: string }>

  Will update the list of profiles available in the repository

  Returns Promise<{ [profile: string]: string }>

  a promise that resolves to a map of profiles available online