Options to modify the vr experience helper's behavior.




Optional controllerMeshes

Find examples in Playground
controllerMeshes: boolean

Should the native controller meshes be initialized. (default: true)

Optional createDeviceOrientationCamera

Find examples in Playground
createDeviceOrientationCamera: boolean

Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)

Optional createFallbackVRDeviceOrientationFreeCamera

Find examples in Playground
createFallbackVRDeviceOrientationFreeCamera: boolean

Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)

Optional customVRButton

Find examples in Playground
customVRButton: HTMLButtonElement

If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)

Optional defaultHeight

Find examples in Playground
defaultHeight: number

To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)

Optional defaultLightingOnControllers

Find examples in Playground
defaultLightingOnControllers: boolean

Creating a default HemiLight only on controllers. (default: true)

Optional displayName

Find examples in Playground
displayName: string

If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)

Optional floorMeshes

Find examples in Playground
floorMeshes: Mesh[]

A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)

Optional laserToggle

Find examples in Playground
laserToggle: boolean

Uses the main button on the controller to toggle the laser casted. (default: true)

Optional positionScale

Find examples in Playground
positionScale: number

Sets the scale of the vrDevice in babylon space. (default: 1)

Optional rayLength

Find examples in Playground
rayLength: number

To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)

Optional trackPosition

Find examples in Playground
trackPosition: boolean

Sets if the webVR camera should be tracked to the vrDevice. (default: true)

Optional useCustomVRButton

Find examples in Playground
useCustomVRButton: boolean

If you don't want to use the default VR button of the helper. (default: false)

Optional useMultiview

Find examples in Playground
useMultiview: boolean

If multiview should be used if availible (default: false)

Optional vrDeviceOrientationCameraMetrics

Find examples in Playground
vrDeviceOrientationCameraMetrics: VRCameraMetrics

Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)

Generated using TypeDoc