Instantiates a VRExperienceHelper. Helps to quickly add VR support to an existing scene.
The scene the VRExperienceHelper belongs to.
Options to modify the vr experience helper's behavior.
Gets or sets a boolean indicating that gaze can be enabled even if pointer lock is not engage (useful on iOS where fullscreen mode and pointer lock are not supported)
Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
To be optionaly changed by user to define custom selection logic (after ray selection)
Observable raised after camera teleportation
Observable raised when entering VR has completed.
Observable raised before camera teleportation
Observable raised when controller mesh is loaded.
Observable raised right before entering VR.
Observable raised when exiting VR.
Observable raised when a new mesh is selected based on meshSelectionPredicate. This observable will provide the mesh and the controller used to select the mesh
Observable raised when a new mesh is picked based on meshSelectionPredicate
Observable raised when a new mesh is selected based on meshSelectionPredicate
Observable raised when current selected mesh gets unselected
To be optionaly changed by user to define custom ray selection
Defines whether or not Pointer lock should be requested when switching to full screen.
Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
If the controller laser color should be updated when selecting meshes
If the gaze trackers color should be updated when selecting meshes
If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
Options to modify the vr experience helper's behavior.
If asking to force XR, this will be populated with the default xr experience
Was the XR test done already. If this is true AND this.xr exists, xr is initialized. If this is true and no this.xr, xr exists but is not supported, using WebVR.
Speed Constant Teleportation Mode
Time Constant Teleportation Mode
The deviceOrientationCamera used as the camera when not in VR.
If the ray of the gaze should be displayed.
Sets if the ray of the gaze should be displayed.
If the ray of the LaserPointer should be displayed.
Sets if the ray of the LaserPointer should be displayed.
The mesh used to display where the user is selecting, this mesh will be cloned and set as the gazeTracker for the left and right controller when set bakeCurrentTransformIntoVertices will be called on the mesh. See https://doc.babylonjs.com/resources/baking_transformations
The mesh used to display where the user is selecting, this mesh will be cloned and set as the gazeTracker for the left and right controller when set bakeCurrentTransformIntoVertices will be called on the mesh. See https://doc.babylonjs.com/resources/baking_transformations
Gets a value indicating if we are currently in VR mode.
Return this.onControllerMeshLoadedObservable Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
Return this.onEnteringVRObservable Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
Return this.onExitingVRObservable Note: This one is for backward compatibility. Please use onExitingVRObservable directly
The html button that is used to trigger entering into VR.
The deviceOrientationCamera that is used as a fallback when vr device is not connected.
The webVRCamera which is used when in VR.
Adds a floor mesh to be used for teleportation.
the mesh to be used for teleportation.
Sets the color of the ray from the vr headsets gaze.
new color for the ray.
Sets the color of the laser ray from the vr controllers.
new color for the ray.
Exits VR and disposes of the vr experience helper
Enables controllers and user interactions such as selecting and object or clicking on an object.
Enables interactions and teleportation using the VR controllers and gaze.
options to modify teleportation behavior.
Attempt to enter VR. If a headset is connected and ready, will request present on that. Otherwise, will use the fullscreen API.
Attempt to exit VR, or fullscreen.
Gets the name of the VRExperienceHelper class
"VRExperienceHelper"
Removes a floor mesh from being used for teleportation.
the mesh to be removed.
Set lighting enabled / disabled on the laser pointer of both controllers
should the lighting be enabled on the laser pointer
Teleports the users feet to the desired location
The location where the user's feet should be placed
Generated using TypeDoc
Helps to quickly add VR support to an existing scene. See https://doc.babylonjs.com/how_to/webvr_helper