engine.vive Functions

This set of functions is available when the AppVive plugin is loaded.

Notice

AppVive plugin cannot be used in a Qt-based application

If the plugin is loaded together with the engine, the HAS_APP_VIVE definition is set. This definition can be used, for example, to avoid errors if the plugin is not loaded: the code in which the plugin functions are executed can be wrapped around as follows:

Source code (UnigineScript)

#ifdef HAS_APP_VIVE
	// engine.vive functions
#endif

The source code of OpenVR can be found here.

The full set of Vive devices is described here.

Methods:

Name	Description View: Sort by:
getControllerAxis	Returns the coordinates of the specified controller axis along the X and Y axes.
getControllerButtonPressed	Returns the value indicating if the specified button is pressed.
getControllerButtonTouched	Returns the value indicating if the specified button is touched.
getControllerPacketNum	Returns the number of the controller packet.
setControllerVibration	Sets the vibration of the given duration and amplitude.
getDeviceAngularVelocity	Returns a device angular velocity, in radians per second.
isDeviceConnected	Returns a value indicating if the device connected to the slot.
getDevicePose	Returns a single pose for a tracked device.
getDeviceType	Returns the device type.
getDeviceVelocity	Returns a device velocity in tracker space, in meters per second.
setHeadPositionLock	Locks the head position.
isHeadPositionLocked	Returns the value indicating if the head position is locked.
setHeadRotationLock	Locks the head rotation.
isHeadRotationLocked	Returns the value indicating if the head rotation is locked.
isPoseValid	Returns a value indicating if the device pose is valid.
getTrackingResult	Returns the value indicating the tracking result.
getViewportMode	Returns a value indicating the current viewport mode, that determines the type of image to be displayed in the viewport.
setViewportMode	Sets the viewport mode, that determines the type of image to be displayed in the viewport.

Variables:

Name	Description
BUTTON_A	The button reserved for manual controllers.
BUTTON_APPLICATIONMENU	The application menu button.
BUTTON_AXIS0	The axis reserved for manual controllers.
BUTTON_AXIS1	The axis reserved for manual controllers.
BUTTON_AXIS2	The axis reserved for manual controllers.
BUTTON_AXIS3	The axis reserved for manual controllers.
BUTTON_AXIS4	The axis reserved for manual controllers.
BUTTON_DASHBOARD_BACK	The back to dashboard button.
BUTTON_DPAD_DOWN	The sensor panel down button.
BUTTON_DPAD_LEFT	The sensor panel left button.
BUTTON_DPAD_RIGHT	The sensor panel right button.
BUTTON_DPAD_UP	The sensor panel up button.
BUTTON_GRIP	The grip button.
BUTTON_MAX	This is not an actual button. It just indicates the maximum number of buttons in the system.
BUTTON_STEAMVR_TOUCHPAD	This is the touchpad on the SteamVR controller. It is the same as BUTTON_AXIS0.
BUTTON_STEAMVR_TRIGGER	This is the trigger on the SteamVR controller. It is the same as BUTTON_AXIS1.
BUTTON_SYSTEM	The system button. These events are not visible to applications and are used internally to bring up the Steam Overlay or the Steam Client.
CONTROLLER_AXIS_JOYSTICK	An axis of a joystick type.
CONTROLLER_AXIS_NONE
CONTROLLER_AXIS_TRACKPAD	An axis of a trackpad type.
CONTROLLER_AXIS_TRIGGER	An axis of a trigger type.
CONTROLLER_STATE_AXIS_COUNT	A number of axes.
MAX_TRACKED_DEVICE_COUNT	The maximum value of tracked devices. Default value is 16.
TRACKED_DEVICE_CONTROLLER	A tracked controller.
TRACKED_DEVICE_HMD	A tracked head-mounted display.
TRACKED_DEVICE_GENERIC_TRACKER	A tracked tracker device (Vive Tracker).
TRACKED_DEVICE_INVALID	A tracked device with an invalid index.
TRACKED_DEVICE_OTHER	A tracked device different from base Vive types.
TRACKED_DEVICE_TRACKING	A tracked camera and base stations that serve as tracking reference points.

Vive Class

Members

vec3 engine.vive.getControllerAxis( int device, int axis )

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

Arguments

int device - A device ID.
int axis - One of the following predefined constants:
- CONTROLLER_AXIS_NONE = 0
- CONTROLLER_AXIS_TRACKPAD = 1
- CONTROLLER_AXIS_JOYSTICK = 2
- CONTROLLER_AXIS_TRIGGER = 3

Return value

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

int engine.vive.getControllerButtonPressed( int device, int button )

Returns the value indicating if the specified button is pressed.

Arguments

int device - A device ID.
int button - A button, one of the following predefined constants:

Return value

1 if the button is pressed; otherwise - 0.

int engine.vive.getControllerButtonTouched( int device, int button )

Returns the value indicating if the specified button is touched.

Arguments

int device - A device ID.
int button - A button, one of the following predefined constants:

Return value

1 if the button is pressed; otherwise - 0.

int engine.vive.getControllerPacketNum( int device )

Returns the number of the controller packet.

Arguments

int device - A device ID.

Return value

Number of the controller packet.

void engine.vive.setControllerVibration( int device, unsigned short duration )

Sets the vibration of the given duration and amplitude.

Arguments

int device - ID if the device.
unsigned short duration - Duration of the vibration.

vec3 engine.vive.getDeviceAngularVelocity( int device )

Returns a device angular velocity, in radians per second.

Arguments

int device - A device ID.

Return value

Angular velocity.

bool engine.vive.isDeviceConnected( int device )

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

Arguments

int device - A device ID.

Return value

true - connected; false - not connected.

mat4 engine.vive.getDevicePose( int device )

Returns a single pose for a tracked device.

Arguments

int device - A device ID.

Return value

Identity matrix.

int engine.vive.getDeviceType( int device )

Returns the device type.

Arguments

int device - A device ID.

Return value

A device type, one of the following predefined constants:

vec3 engine.vive.getDeviceVelocity( int device )

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

Arguments

int device - A device ID.

Return value

Velocity.

void engine.vive.setHeadPositionLock( int lock )

Locks the head position.

Arguments

int lock - 1 to lock the head position.

int engine.vive.isHeadPositionLocked( )

Returns the value indicating if the head position is locked.

Return value

1 if the head position is locked; otherwise - 0.

void engine.vive.setHeadRotationLock( int lock )

Locks the head rotation.

Arguments

int lock - 1 to lock the head rotation.

int engine.vive.isHeadRotationLocked( )

Returns the value indicating if the head rotation is locked.

Return value

1 if the head rotation is locked; otherwise - 0.

bool engine.vive.isPoseValid( int device )

Returns a value indicating if the device pose is valid.

Arguments

int device - A device ID.

Return value

true - valid; false - invalid.

int engine.vive.getTrackingResult( int device )

Returns the value indicating the tracking result:

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

Arguments

int device - A device ID.

Return value

Tracking result.

int engine.vive.getViewportMode( )

Returns a value indicating the current viewport mode, that determines the type of image to be displayed in the viewport.

Return value

Current viewport mode. One of the following values:

0 - no image (black screen)
1 - mono image
2 - stereo image (left and right eye)

void engine.vive.setViewportMode( int mode )

Sets the viewport mode, that determines the type of image to be displayed in the viewport.

Arguments

int mode - Viewport mode. One of the following values:
- 0 - no image (black screen)
- 1 - mono image
- 2 - stereo image (left and right eye)

Last update: 2020-01-14

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

engine.vive Functions

See also#

Methods:

Variables:

Vive Class

Members

vec3 engine.vive.getControllerAxis( int device, int axis )

Arguments

Return value

int engine.vive.getControllerButtonPressed( int device, int button )

Arguments

Return value

int engine.vive.getControllerButtonTouched( int device, int button )

Arguments

Return value

int engine.vive.getControllerPacketNum( int device )

Arguments

Return value

void engine.vive.setControllerVibration( int device, unsigned short duration )

Arguments

vec3 engine.vive.getDeviceAngularVelocity( int device )

Arguments

Return value

bool engine.vive.isDeviceConnected( int device )

Arguments

Return value

mat4 engine.vive.getDevicePose( int device )

Arguments

Return value

int engine.vive.getDeviceType( int device )

Arguments

Return value

vec3 engine.vive.getDeviceVelocity( int device )

Arguments

Return value

void engine.vive.setHeadPositionLock( int lock )

Arguments

int engine.vive.isHeadPositionLocked( )

Return value

void engine.vive.setHeadRotationLock( int lock )

Arguments

int engine.vive.isHeadRotationLocked( )

Return value

bool engine.vive.isPoseValid( int device )

Arguments

Return value

int engine.vive.getTrackingResult( int device )

Arguments

Return value

int engine.vive.getViewportMode( )

Return value

void engine.vive.setViewportMode( int mode )

Arguments