Unigine::InputVRDevice Class

InputVRDevice Class

Enums

TYPE#

Name	Description
INPUT_VR_UNKNOWN = 0	Unknown VR device.
INPUT_VR_DEVICE = 1	VR device.
INPUT_VR_HEAD = 2	Head-mounted display.
INPUT_VR_CONTROLLER = 3	Controller.
INPUT_VR_TRACKER = 4	Tracker.
INPUT_VR_BASE_STATION = 5	Base station.
NUM_TYPES = 6	Total number of types of the VR devices.

TRANSFORM_TYPE#

Name	Description
TRANSFORM_TYPE_AIM = 0	(OpenXR only) A pose that allows applications to point in the world using the input source, according to the platform’s conventions for aiming with that kind of source. The aim pose is defined as follows: For tracked hands: The ray that follows platform conventions for how the user aims at objects in the world with their entire hand, with +Y up, +X to the right, and -Z forward. The ray chosen will be runtime-dependent, often a ray emerging from the hand at a target pointed by moving the forearm. For handheld motion controllers: The ray that follows platform conventions for how the user targets objects in the world with the motion controller, with +Y up, +X to the right, and -Z forward. This is usually for applications that are rendering a model matching the physical controller, as an application rendering a virtual object in the user’s hand likely prefers to point based on the geometry of that virtual object. The ray chosen will be runtime-dependent, although this will often emerge from the frontmost tip of a motion controller.
TRANSFORM_TYPE_GRIP = 1	A pose that allows applications to reliably render a virtual object held in the user’s hand, whether it is tracked directly or by a motion controller. The grip pose is defined as follows: The grip position: For tracked hands: The user’s palm centroid when closing the fist, at the surface of the palm. For handheld motion controllers: A fixed position within the controller that generally lines up with the palm centroid when held by a hand in a neutral position. This position should be adjusted left or right to center the position within the controller’s grip. The grip orientation’s +X axis: When you completely open your hand to form a flat 5-finger pose, the ray that is normal to the user’s palm (away from the palm in the left hand, into the palm in the right hand). The grip orientation’s -Z axis: When you close your hand partially (as if holding the controller), the ray that goes through the center of the tube formed by your non-thumb fingers, in the direction of little finger to thumb. The grip orientation’s +Y axis: orthogonal to +Z and +X using the right-hand rule.
TRANSFORM_TYPE_MESH = 2	A pose (grip_surface) that allows applications to reliably anchor visual content relative to the user’s physical hand, whether the user’s hand is tracked directly or its position and orientation is inferred by a physical controller. The grip_surface pose is defined as follows: The grip_surface position: The user’s physical palm centroid, at the surface of the palm. For the avoidance of doubt, the palm does not include fingers. The grip_surface orientation’s +X axis: When a user is holding the controller and straightens their index fingers pointing forward, the ray that is normal (perpendicular) to the user’s palm (away from the palm in the left hand, into the palm in the right hand). The grip_surface orientation’s -Z axis: When a user is holding the controller and straightens their index finger, the ray that is parallel to their finger’s pointing direction. The grip_surface orientation’s +Y axis: orthogonal to +Z and +X using the right-hand rule.
TRANSFORM_TYPE_PINCH = 3	Pinch pose designed for interacting with a small object within arm’s reach using a finger and thumb with a "pinch" gesture. For example, turning a key to open a lock or moving the knob on a slider control are interactions suited to the "pinch" pose.
TRANSFORM_TYPE_POKE = 4	Poke pose designed for interactions using a fingertip to touch and push a small object. For example, pressing a push button with a fingertip, swiping to scroll a browser view, or typing on a virtual keyboard are interactions suited to the "poke" pose.
NUM_TRANSFORM_TYPES = 5	Total number of transformation types.

Members

bool isAvailable() const#

Return value

true if the device is available; otherwise false.

int getNumber() const#

Return value

Current device index.

const char * getName() const#

Return value

Current device name.

Input::DEVICE getDeviceType() const#

Return value

Current input device type.

InputVRDevice::TYPE getType() const#

Return value

Current VR device type.

const char * getDeviceModelName() const#

Return value

Current model name.

bool isCharging() const#

Return value

true if the VR device is charging; otherwise false.

float getBatteryValue() const#

Return value

Current battery level, in percent.

String getModelNumber() const#

Return value

Current model number.

String getSerialNumber() const#

Return value

Current serial number.

String getManufacturerName() const#

Return value

Current vendor name.

unsigned long long getHardwareRevision() const#

Return value

Current hardware revision.

unsigned long long getFirmwareVersion() const#

Return value

Current firmware revision.

int getNumModels() const#

Return value

Current number of models.

Ptr<Mesh> getCombinedModelMesh() const#

Return value

Current mesh of the combined model.

Ptr<Texture> getCombinedModelTexture() const#

Return value

Current texture of the combined model.

const char * getCombinedModelName() const#

Return value

Current name of the combined model.

---

bool hasYawDrift ( ) const#

Returns a value indicating if the VR device will drift in a specific direction.

Return value

true if the device has yaw drift; otherwise, false.

bool hasBattery ( ) const#

Returns a value indicating if the VR device has a battery.

Return value

true if the device has the battery; otherwise, false.

bool canReportBatteryValue ( ) const#

Returns a value indicating if the VR device provides the battery status.

Return value

true if the battery status is provided; otherwise, false.

Math::Mat4 getWorldTransform ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Retuns the world transformation of the VR device for the specified transformation type.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

World transformation matrix.

Math::mat4 getTransform ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns the local transformation of the VR device for the specified transformation type.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

Local transformation matrix.

Math::vec3 getLinearVelocity ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns the linear velocity of the VR device for the specified transformation type.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

Linear velocity.

Math::vec3 getAngularVelocity ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns the angular velocity of the VR device for the specified transformation type.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

Angular velocity.

Math::vec3 getAngularAcceleration ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns the angular acceleration of the VR device for the specified transformation type.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

Angular acceleration.

bool isTransformValid ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns a value indicating if transformation of the VR device for the specified transformation type is valid.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

true if transformation is valid; otherwise, false.

bool isVelocityValid ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns a value indicating if the velocity of the VR device for the specified transformation type is valid.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

true if velocity is valid; otherwise, false.

bool isTransformTypeSupported ( InputVRDevice::TRANSFORM_TYPE type = Enum.InputVRDevice.TRANSFORM_TYPE.GRIP ) const#

Returns a value indicating if the VR device supports the specified transformation type.

Arguments

• InputVRDevice::TRANSFORM_TYPE type - Transformation type.

Return value

true if transformation type is supported; otherwise, false.

Math::mat4 getModelTransform ( int num ) const#

Returns the local transformation of the given model.

Arguments

• int num - Model index.

Return value

Local transformation matrix of the model.

Math::Mat4 getModelWorldTransform ( int num ) const#

Returns the world transformation of the given model.

Arguments

• int num - Model index.

Return value

World transformation matrix of the model.

Ptr<Mesh> getModelMesh ( int num ) #

Returns the mesh of the given model.

Arguments

• int num - Model index.

Return value

Model mesh.

Ptr<Texture> getModelTexture ( int num ) #

Returns the texture of the given model.

Arguments

• int num - Model index.

Return value

Model texture.

const char * getModelName ( int num ) #

Returns the name of the given model.

Arguments

• int num - Model index.

Return value

Model name.