Unigine.Plugins.OpenVR Class

OpenVR Class

Enums

CONTROLLER_ROLE#

Name	Description
INVALID = 0	Invalid value for controller type.
LEFT_HAND = 1	Tracked device is associated with the left hand.
RIGHT_HAND = 2	Tracked device is associated with the right hand.
OPT_OUT = 3	Tracked device is opting out of left/right hand.
TREADMILL = 4	Tracked device is a treadmill.
MAX = 5	Indicates the maximum number of controller roles.

BUTTON#

Name	Description
SYSTEM = 0	The system button. These events are not visible to applications and are used internally to bring up the Steam Overlay or the Steam Client.
APPLICATIONMENU = 1	The application menu button.
GRIP = 2	The grip button.
DPAD_LEFT = 3	The sensor panel left button.
DPAD_UP = 4	The sensor panel up button.
DPAD_RIGHT = 5	The sensor panel right button.
DPAD_DOWN = 6	The sensor panel down button.
A = 7	The button reserved for manual controllers.
AXIS0 = 32	The axis reserved for manual controllers.
AXIS1 = 33	The axis reserved for manual controllers.
AXIS2 = 34	The axis reserved for manual controllers.
AXIS3 = 35	The axis reserved for manual controllers.
AXIS4 = 36	The axis reserved for manual controllers.
STEAMVR_TOUCHPAD = 32	The touchpad on the SteamVR controller. It is the same as BUTTON_AXIS0.
STEAMVR_TRIGGER = 33	The trigger on the SteamVR controller. It is the same as BUTTON_AXIS1.
DASHBOARD_BACK = 2	The back to dashboard button.
MAX = 64	This is not an actual button. It just indicates the maximum number of buttons in the system.

AXIS#

Name	Description
NONE = 0	No axis is identified on the controller.
TRACKPAD = 1	An axis of a trackpad type.
JOYSTICK = 2	An axis of a joystick type.
TRIGGER = 3	An axis of a trigger type.

DEVICE#

Name	Description
INVALID = 0	A tracked device with an invalid index.
HMD = 1	A tracked head-mounted display.
CONTROLLER = 2	A tracked controller.
GENERIC_TRACKER = 3	A tracked tracker device (Vive Tracker).
TRACKING = 4	A tracked camera and base stations that serve as tracking reference points.

VIEWPORT#

Name	Description
BLACK_SCREEN = 0	No image (black screen).
MONO = 1	Mono image.
STEREO = 2	Stereo image (left and right eye).

TRACKING_SPACE#

Name	Description
SEATED = 0	Poses are provided relative to the seated zero pose.
STANDING = 1	Poses are provided relative to the safe bounds specified by the user.
RAW = 2	Poses are provided in the coordinate system defined by the tracker driver.

Properties

int ControllerStateAxisCount#

int MaxTrackedDeviceCount#

bool HeadPositionLock#

bool HeadRotationLock#

OpenVR.VIEWPORT ViewportMode#

OpenVR.TRACKING_SPACE TrackingSpace#

Members

---

vec2 GetControllerAxis ( int device_num, int axis_num ) #

Returns the coordinates of the specified controller axis along the X and Y axes.

Arguments

• int device_num - Device ID.
• int axis_num - Axis number.

Return value

X and Y in the range of [-1;1] ([0;1] for a trigger).

bool GetControllerButtonPressed ( int device_num, OpenVR.BUTTON button ) #

Returns the value indicating if the specified button is pressed.

Arguments

• int device_num - Device ID.
• OpenVR.BUTTON button - A button, one of the BUTTON variables.

Return value

true if the button is pressed; otherwise - false.

bool GetControllerButtonTouched ( int device_num, OpenVR.BUTTON button ) #

Returns the value indicating if the specified button is touched.

Arguments

• int device_num - Device ID.
• OpenVR.BUTTON button - A button, one of the BUTTON variables.

Return value

true if the button is pressed; otherwise - false.

int GetControllerPacketNum ( int device_num ) #

Returns the number of the controller packet.

Arguments

• int device_num - Device ID.

Return value

Number of the controller packet.

void SetControllerVibration ( int device_num, ushort duration ) #

Sets the vibration of the given duration and amplitude.

Arguments

• int device_num - Device ID.
• ushort duration - Duration of the vibration.

vec3 GetDeviceAngularVelocity ( int device_num ) #

Returns a device angular velocity, in radians per second.

Arguments

• int device_num - Device ID.

Return value

Angular velocity.

bool IsDeviceConnected ( int device_num ) #

Returns a value indicating if the device connected to the slot.

Arguments

• int device_num - Device ID.

Return value

true - connected; false - not connected.

mat4 GetDeviceTransform ( int device_num ) #

Returns a single pose for a tracked device.

Arguments

• int device_num - Device ID.

Return value

Identity matrix.

OpenVR.DEVICE GetDeviceType ( int device_num ) #

Returns the device type.

Arguments

• int device_num - Device ID.

Return value

Device type, one of the DEVICE variables.

vec3 GetDeviceVelocity ( int device_num ) #

Returns a device velocity in tracker space, in meters per second.

Arguments

• int device_num - Device ID.

Return value

Velocity.

bool IsPoseValid ( int device_num ) #

Returns a value indicating if the device pose is valid.

Arguments

• int device_num - Device ID.

Return value

true - valid; false - invalid.

int GetTrackingResult ( int device_num ) #

Returns the value indicating the tracking result:

• Uninitialized
• Calibrating in progress
• Calibrating out of range
• Running correctly
• Running out of range

Arguments

• int device_num - Device ID.

Return value

Tracking result.

OpenVR.AXIS GetDeviceAxisType ( int device_num, int axis_num ) #

Returns the value that identifies what type of axis is on the indicated controller.

Arguments

• int device_num - Device ID.
• int axis_num - Axis number.

Return value

Axis of a corresponding type. One of the AXIS variables.

string GetDeviceManufacturerName ( int device ) #

Returns the manufacturer name of the specified device.

Arguments

• int device - Device ID.

Return value

Manufacturer name.

string GetDeviceModelNumber ( int device ) #

Returns the model of the specified device.

Arguments

• int device - Device ID.

Return value

Model.

OpenVR.CONTROLLER_ROLE GetControllerRole ( int device_num ) #

Returns a specific role associated with a tracked device.

Arguments

• int device_num - Device ID.

Return value

Role associated with a tracked device. One of the CONTROLLER_ROLE variables.

void Render ( Player player, ivec2 size, bool render_window ) #

Calls OpenVR rendering logic.

Arguments

• Player player - The player camera.
• ivec2 size - The window size, in pixels.
• bool render_window - true to enable rendering of a copy to the current render target window; false — to disable it.

void FadeToColor ( float time, vec4 color, bool background = false ) #

Fades the view on the head-mounted display to the specified color.

Arguments

• float time - Time in seconds that the fade will take.
• vec4 color - Fade color.
• bool background -

vec4 GetCurrentFadeColor ( bool background = false ) #

Returns the current fade color.

Arguments

• bool background -

Return value

Fade color.

void FadeToGrid ( float time, bool grid ) #

Fades the grid in or out.

Arguments

• float time - Time in seconds that the fade will take.
• bool grid - true to fade the grid in, false to fade the grid out.

float GetCurrentGridAlpha ( ) #

Returns the current alpha value of the grid.

Return value

Grid alpha value.

void ResetZeroPose ( OpenVR.TRACKING_SPACE space ) #

Sets the zero pose of the given tracker coordinate system to the current tracker position.

Arguments

• OpenVR.TRACKING_SPACE space - Tracker coordinate system.