Module: hmd

Head Mounted Devices add-on. Provides support for HMD devices using WebVR API.

Summary

Members

Methods

Type Definitions

Detailed Description

Members

HMD_ALL_AXES_MOUSE_NONE

HMD behavior: HMD controls camera rotation, mouse does not affect camera orientation.
Type:
  • HMDBehavior
Source:

HMD_ALL_AXES_MOUSE_YAW

HMD behavior: HMD affects camera rotation, mouse affect yaw rotation.
Type:
  • HMDBehavior
Source:

HMD_NONE_MOUSE_ALL_AXES

HMD behavior: HMD does not affect camera orientation, mouse controls camera rotation.
Type:
  • HMDBehavior
Source:

HMD_ROLL_PITCH_MOUSE_YAW

HMD behavior: HMD controls roll and ritch rotation, mouse controls yaw rotation.
Type:
  • HMDBehavior
Source:

Methods

check_browser_support() → {Boolean}

Check if the browser supports WebVR API or it is a mobile version of the browser.
Returns:
Checking result.
Type
Boolean
Source:

disable_hmd()

Disable HMD.
Source:

enable_hmd(control_type)

Enable HMD.
Parameters:
Name Type Description
control_type HMDBehavior Camera rotation type.
Source:

get_hmd_device() → {HMDVRDevice}

Get mounted hmd device.
Returns:
HMD object.
Type
HMDVRDevice
Deprecated:
  • Yes
Source:

get_rotate_quat(dest) → {Quat}

Get hmd initial rotation quat.
Parameters:
Name Type Description
dest Quat Initial rotation quaternion.
Returns:
dest.
Type
Quat
Source:

reset()

Reset the sensors, return position and orientation sensors values to zero.
Deprecated:
Source:

set_rotate_quat(quat)

Set hmd initial rotation quat.
Parameters:
Name Type Description
quat Quat Initial rotation quaternion.
Source:

Type Definitions