Types in wvr.h

WVR enum

  • Common enum
enum WVR_Result

the returned result of a function call for providing the information of failure.

Values:

WVR_Success = 0

The result of the function call was successful.

WVR_Error_SystemInvalid = 1

The initialization was not finished or the feature was not started yet.

WVR_Error_InvalidArgument = 2

One of the arguments was not appropriate for the function call.

WVR_Error_OutOfMemory = 3

A memory allocation has failed.

WVR_Error_FeatureNotSupport = 4

The feature was not supported; either lack of some services or service does not support this feature.

WVR_Error_RuntimeVersionNotSupport = 5

The runtime version is too old to support the function call.

WVR_Error_CameraNotAvailable = 6

Camera was unavaliable, cannot query camera related information.

WVR_Error_CameraPermissionNotGranted = 7

The Android camera permission was not granted yet.

WVR_Error_CtrlerModel_WrongDeviceType = 100

Input wrong device type for asking controller model.

WVR_Error_CtrlerModel_DeviceDisconnected = 101

The controller device you want to get its model is disconnected.

WVR_Error_CtrlerModel_InvalidModel = 102

We can’t get model that can be use.

WVR_Error_CtrlerModel_Unknown = 103

Unknown error.

  • Tracking Device enum
enum WVR_DeviceErrorStatus

The error status of the specified device from the device service.

The device service uses bitmask to record the device error, because many errors might occur at the same time. Each error status represents a hardware exception for the device. The restore status means that the error status has been fixed.

Values:

WVR_DeviceErrorStatus_None = 0

Status of the device service is normal.

WVR_DeviceErrorStatus_BatteryOverheat = 1

Battery temperature is too hot.

WVR_DeviceErrorStatus_BatteryOverheatRestore = 1 << 1

Battery temperature has cooled down.

WVR_DeviceErrorStatus_BatteryOvervoltage = 1 << 2

Battery is overvoltage when charging.

WVR_DeviceErrorStatus_BatteryOvervoltageRestore = 1 << 3

Overvoltage has been fixed.

WVR_DeviceErrorStatus_DeviceConnectFail = 1 << 4

Failed to connect to the USB device.

WVR_DeviceErrorStatus_DeviceConnectRestore = 1 << 5

Connection failure has been fixed.

WVR_DeviceErrorStatus_DeviceLostTracking = 1 << 6

The device being tracked might be out of range.

WVR_DeviceErrorStatus_DeviceTrackingRestore = 1 << 7

Lost tracking has been fixed.

WVR_DeviceErrorStatus_ChargeFail = 1 << 8

The consumed voltage is larger than the charging voltage when the device is charging.

WVR_DeviceErrorStatus_ChargeRestore = 1 << 9

Charging failure has been fixed.

enum WVR_DeviceType

The type of VR device.

Describes the role of VR devices

Values:

WVR_DeviceType_Invalid = 0

The device is unknown or not existing.

WVR_DeviceType_HMD = 1

Head-Mounted Display.

WVR_DeviceType_Controller_Right = 2

Right hand tracked controller.

WVR_DeviceType_Controller_Left = 3

Left hand tracked controller.

enum WVR_EventType

event type

Values:

WVR_EventType_Quit = 1000

common event region Application Quit.

WVR_EventType_SystemInteractionModeChanged = 1001

WVR_InteractionMode changed. Use WVR_GetInteractionMode to get the interaction mode.

WVR_EventType_SystemGazeTriggerTypeChanged = 1002

WVR_GazeTriggerType changed. Use WVR_GetGazeTriggerType to get the gaze trigger type.

WVR_EventType_TrackingModeChanged = 1003

Notification for tracking mode change(3 DoF/6 DoF). Use WVR_GetDegreeOfFreedom to get the current tracking mode.

WVR_EventType_RecommendedQuality_Lower = 1004

Notification for recommended quality to be Lower from runtime.

WVR_EventType_RecommendedQuality_Higher = 1005

Notification for recommended quality to be Higher from runtime.

WVR_EventType_HandGesture_Changed = 1006

Notification for changed gesture.

WVR_EventType_HandGesture_Abnormal = 1007

Notification for abnormal gesture.

WVR_EventType_HandTracking_Abnormal = 1008

Notification for abnormal hand tracking.

WVR_EventType_DeviceConnected = 2000

Device events region WVR_DeviceType is connected.

WVR_EventType_DeviceDisconnected = 2001

WVR_DeviceType is disconnected.

WVR_EventType_DeviceStatusUpdate = 2002

WVR_DeviceType configuration has changed.

WVR_EventType_DeviceSuspend = 2003

When user takes off the HMD

WVR_EventType_DeviceResume = 2004

When user puts the HMD back on

WVR_EventType_IpdChanged = 2005

The interpupillary distance has changed; Use WVR_GetRenderProps to get the current IPD.

WVR_EventType_DeviceRoleChanged = 2006

WVR_DeviceType controller roles have switched.

WVR_EventType_BatteryStatusUpdate = 2007

The battery status of WVR_DeviceType device has changed. Use WVR_GetBatteryStatus to check the current battery status.

WVR_EventType_ChargeStatusUpdate = 2008

The charged status of WVR_DeviceType device has changed. Use WVR_GetChargeStatus to check the current battery charge status.

WVR_EventType_DeviceErrorStatusUpdate = 2009

WVR_DeviceType device error occurs. Use WVR_GetDeviceErrorState to get the current error status from the device service.

WVR_EventType_BatteryTemperatureStatusUpdate = 2010

The battery temperature status of WVR_DeviceType device has changed. Use WVR_GetBatteryTemperatureStatus to check the current battery temperature.

WVR_EventType_RecenterSuccess = 2011

Notification for successful recenter for the 6 DoF device

WVR_EventType_RecenterFail = 2012

Notification for recenter failed for the 6 DoF device

WVR_EventType_RecenterSuccess3DoF = 2013

Notification for recenter successful for the 3 DoF device

WVR_EventType_RecenterFail3DoF = 2014

Notification for recenter failed for the 3 DoF device

WVR_EventType_PassthroughOverlayShownBySystem = 2100

Notification for passthrough overlay is shown by the system.

WVR_EventType_PassthroughOverlayHiddenBySystem = 2101

Notification for passthrough overlay is hidden by the system.

WVR_EventType_ButtonPressed = 3000

Input Event region WVR_InputId status changed to pressed.

WVR_EventType_ButtonUnpressed = 3001

WVR_InputId status changed to not pressed

WVR_EventType_TouchTapped = 3002

WVR_InputId status changed to touched.

WVR_EventType_TouchUntapped = 3003

WVR_InputId status changed to untouched.

WVR_EventType_LeftToRightSwipe = 3004

Notification for swipe motion (left to right) on the touchpad

WVR_EventType_RightToLeftSwipe = 3005

Notification for swipe motion (right to left) on the touchpad

WVR_EventType_DownToUpSwipe = 3006

Notification for swipe motion (down to up) on the touchpad

WVR_EventType_UpToDownSwipe = 3007

Notification for swipe motion (up to down) on the touchpad

enum WVR_Eye

The sides of target scene.

Specify the side of eye for targe scene.

Values:

WVR_Eye_Left = 0

WVR_Eye_Left: Left eye id.

WVR_Eye_Right = 1

WVR_Eye_Right: Right eye id.

enum WVR_InputId

The input id of the device.

Values:

WVR_InputId_0 = 0
WVR_InputId_1 = 1
WVR_InputId_2 = 2
WVR_InputId_3 = 3
WVR_InputId_4 = 4
WVR_InputId_5 = 5
WVR_InputId_6 = 6
WVR_InputId_7 = 7
WVR_InputId_8 = 8
WVR_InputId_9 = 9
WVR_InputId_10 = 10
WVR_InputId_11 = 11
WVR_InputId_14 = 14
WVR_InputId_15 = 15
WVR_InputId_16 = 16
WVR_InputId_17 = 17
WVR_InputId_18 = 18
WVR_InputId_Alias1_System = WVR_InputId_0

System button.

WVR_InputId_Alias1_Menu = WVR_InputId_1

Menu button.

WVR_InputId_Alias1_Grip = WVR_InputId_2

Grip button.

WVR_InputId_Alias1_DPad_Left = WVR_InputId_3

A physical DPad_Left button, or simulated by pressing the left part of the touchpad.

WVR_InputId_Alias1_DPad_Up = WVR_InputId_4

A physical DPad_Up button, or simulated by pressing the top part of the touchpad.

WVR_InputId_Alias1_DPad_Right = WVR_InputId_5

A physical DPad_Right button, or simulated by pressing the right part of the touchpad.

WVR_InputId_Alias1_DPad_Down = WVR_InputId_6

A physical DPad_Down button, or simulated by pressing the bottom part of the touchpad.

WVR_InputId_Alias1_Volume_Up = WVR_InputId_7

Volume_Up button.

WVR_InputId_Alias1_Volume_Down = WVR_InputId_8

Volume_Down button.

WVR_InputId_Alias1_Bumper = WVR_InputId_9

Bumper button.

WVR_InputId_Alias1_A = WVR_InputId_10

A button.

WVR_InputId_Alias1_B = WVR_InputId_11

B button.

WVR_InputId_Alias1_Back = WVR_InputId_14

Hmd Back button

WVR_InputId_Alias1_Enter = WVR_InputId_15

Hmd Enter button

WVR_InputId_Alias1_Touchpad = WVR_InputId_16

Touchpad input device.

WVR_InputId_Alias1_Trigger = WVR_InputId_17

Trigger input device.

WVR_InputId_Alias1_Thumbstick = WVR_InputId_18

Thumbstick input device.

WVR_InputId_Max = 32
enum WVR_PoseOriginModel

The style of tracking origin.

Identifies which style of tracking origin the application wants to use for the poses it is requesting

Values:

WVR_PoseOriginModel_OriginOnHead = 0

The origin of 6 DoF pose is on head.

WVR_PoseOriginModel_OriginOnGround = 1

The origin of 6 DoF pose is on ground.

WVR_PoseOriginModel_OriginOnTrackingObserver = 2

The raw pose from tracking system.

WVR_PoseOriginModel_OriginOnHead_3DoF = 3

The origin of 3 DoF pose is on head.

enum WVR_RecenterType

Recenter effect of WVR_InAppRecenter.

Values:

WVR_RecenterType_Disabled = 0

Make everything back to system coordinate instantly

WVR_RecenterType_YawOnly = 1

Only adjust the Yaw angle

WVR_RecenterType_YawAndPosition = 2

Adjust the Yaw angle, and also reset user’s position to Virtual World’s center

WVR_RecenterType_RotationAndPosition = 3

Affect all the XYZ and Pitch Yaw Roll. It is sensitive to user’s head gesture at recentering.

enum WVR_SimulationType

Arm/Neck Model options of WVR_SetArmModel/WVR_SetNeckModel.

Values:

WVR_SimulationType_Auto = 0

Simulates device position while device tracking is only 3DoF.

WVR_SimulationType_ForceOn = 1

Always simulates and replaces devices’ positions.

WVR_SimulationType_ForceOff = 2

Do NOT activate Position Simulation.

  • Device enum
enum WVR_AnalogType

Analog type.

Values:

WVR_AnalogType_None = 0
WVR_AnalogType_2D = 1

Provide analog data with x and y coordinate, WVR_Axis value is -1 ~ 1

WVR_AnalogType_1D = 2

Provide analog data with x coordinate, WVR_Axis value is 0 ~ 1

  • Arena enum
enum WVR_ArenaVisible

To decide whether vitual wall should be showed.

Values:

WVR_ArenaVisible_Auto = 0

Show Arena while HMD is near boundaries

WVR_ArenaVisible_ForceOn = 1

Always show Arena

WVR_ArenaVisible_ForceOff = 2

Never show Arena

enum WVR_NumDoF

The type of degree of freedom (DoF)

Values:

WVR_NumDoF_3DoF = 0

Position (x, y, z) on 3 coordinates, which contains (1) moving up and down, (2) moving left and right, (3) moving forward and backward.

WVR_NumDoF_6DoF = 1

Position (x, y, z) on 3 coordinates and rotation (yaw, pitch, roll) on 3 coordinates.

enum WVR_ArenaShape

Supported play area shape.

Values:

WVR_ArenaShape_None = 0

Arena shape is undefined

WVR_ArenaShape_Rectangle = 1

Arena shape is rectangle

WVR_ArenaShape_Round = 2

Arena shape is round

WVR struct

  • Event struct
struct WVR_CommonEvent

Common Event that includes WVR_EventType and timestamp.

Public Members

WVR_EventType type

The event types

int64_t timestamp

Delivered time in nanoseconds

struct WVR_DeviceEvent

Device Event that includes WVR_EventType, timestamp, and WVR_DeviceType.

Public Members

WVR_CommonEvent_t common
WVR_DeviceType deviceType

Post event by WVR_DeviceType

struct WVR_InputEvent

Input Event that includes WVR_EventType, timestamp, WVR_DeviceType, and WVR_InputId.

Public Members

WVR_DeviceEvent_t device
WVR_InputId inputId

Post event by WVR_InputId

  • Tracking pose struct
struct WVR_Matrix4f

The basic matrix (4x4 floats) struct to be used in pose.

Public Members

float m[4][4]

Matrix form (4X4) to represent rotation and position of pose data.

struct WVR_Vector3f

The basic vector (3 floats) struct to be used in pose.

Public Members

float v[3]

Matrix form (3X1) to represent a set of data which contains 3 elements.

struct WVR_Vector2f

The basic vector (2 floats) struct to be used in pose.

Public Members

float v[2]

Matrix form (2X1) to represent a set of data which contains 2 elements.

struct WVR_Quatf

The basic quaternion (4 floats) struct to be used in pose.

Public Members

float w
float x
float y
float z

Quaternion form to represent rotation of pose.

struct WVR_Pose

Describes a single pose in quaternion form for a tracked object.

Public Members

WVR_Vector3f_t position

Position (x, y, z) part of Pose (refer to WVR_Vector3f).

WVR_Quatf_t rotation

Rotation (quaternion form: w, x, y, z) part of Pose (refer to WVR_Quatf).

struct WVR_PoseState

Describes a single pose in rotation matrix form for a tracked object.

Public Members

bool isValidPose

The label of valid(true)/invalid(false) pose.

WVR_Matrix4f_t poseMatrix

The pose data (ratation, position) in matrix form (refer to WVR_Matrix4f).

WVR_Vector3f_t velocity

The velocity of pose (refer to WVR_Vector3f).

WVR_Vector3f_t angularVelocity

The angular velocity of pose.

bool is6DoFPose

The label of 6 DoF(true)/3 DoF(false) pose.

int64_t timestamp

Absolute time (in nanosecond) of pose.

WVR_Vector3f_t acceleration

The acceleration of pose.

WVR_Vector3f_t angularAcceleration

The angular acceleration of pose.

float predictedMilliSec

Number of milliseconds from now to predict poses.

WVR_PoseOriginModel originModel

The origin model of pose.

WVR_Pose_t rawPose

The raw data of pose from device

struct WVR_DevicePosePair

Aggregate the device type identity and device tracking pose.

Public Members

WVR_DeviceType type

VR device type.

WVR_PoseState_t pose

Pose information of the tracked VR device (refer to WVR_PoseState).

  • Device struct
struct WVR_Axis

Analog data.

Public Members

float x

-1<=x<=1 for WVR_AnalogType_2D; 0<=x<=1 for WVR_AnalogType_1D.

float y

-1<=y<=1 for WVR_AnalogType_2D; 0 for WVR_AnalogType_1D.

struct WVR_AnalogState

Analog state structure.

Public Members

WVR_InputId id

indicate the analog state belongs to which WVR_InputId

WVR_AnalogType type

indicate the analog data’s type

WVR_Axis_t axis

WVR_Axis, include analog data

  • Arena struct
struct WVR_ArenaRectangle

Describes rectangle Arena area (play area) size parameters.

Public Members

float width

The width of rectangle Arena area

float length

The length of rectangle Arena area

struct WVR_ArenaRound

Describes round Arena area (play area) size parameter.

Public Members

float diameter

The diameter of round Arena area

struct WVR_Arena

Describes current effective Arena area (play area) shape and its related range parameters.

Public Members

WVR_ArenaShape shape

The setting of Arena shape

WVR_ArenaArea_t area

The setting of Arena area (refer to WVR_ArenaArea)

union WVR_ArenaArea
#include <wvr_arena.h>

Describes 2 types of Arena area (play area) range parameters.

Public Members

WVR_ArenaRectangle_t rectangle

The setting of rectangle Arena area (refer to WVR_ArenaRectangle)

WVR_ArenaRound_t round

The setting of round Arena area (refer to WVR_ArenaRound)