Unigine.InputVRDevice Class
The base class for VR devices. It provides access to properties and settings that all VR devices have. For example, you can get a device name, check if it has a battery, or whether it will drift in a specific direction, and so on.
Also, the class functionality allows getting the model of the VR device. For example, you can use it for controller rendering:
- Get the controller to render by using the corresponding methods of the Input class. For example, to get the left controller, call getVRControllerLeft().
- Check it exists.
- Get the number of its models via getNumModels().
- Load its meshes and textures individually, one by one, or get the entire mesh at once. Note that there may be a delay during the loading process.
- Render the loaded meshes with textures.
InputVRDevice Class
Enums
TYPE#
Properties
bool IsAvailable#
The true if the device is available; otherwise, false.
int Number#
The Device index.
string Name#
The Device name.
Input.DEVICE DeviceType#
The Input device type.
InputVRDevice.TYPE Type#
The VR device type.
string DeviceModelName#
The Model name.
bool IsCharging#
The true if the device is charging; otherwise, false.
float BatteryValue#
The Battery level, in percents.
string ModelNumber#
The Model number.
string SerialNumber#
The Seril number.
string ManufacturerName#
The Vendor name.
ulong HardwareRevision#
The Hardware revision.
ulong FirmwareVersion#
The Firmware version
mat4 WorldTransform#
The World transformation matrix.
mat4 Transform#
The Local transformation matrix.
vec3 LinearVelocity#
The Linear velocity.
vec3 AngularVelocity#
The Angular velocity.
vec3 AngularAcceleration#
The Angular acceleration.
bool IsTransformValid#
The true if transformation is valid; otherwise, false.
int NumModels#
The Number of models.
Mesh CombinedModelMesh#
The Mesh of the combined model.
Texture CombinedModelTexture#
The Texure of the combined model.
string CombinedModelName#
The Name of the combined model.
Members
bool HasYawDrift ( ) #
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 ( ) #
Returns a value indicating if the VR device has a battery.Return value
true if the device has the battery; otherwise, false.bool CanReportBatteryValue ( ) #
Returns a value indicating if the VR device provides the battery status.Return value
true if the battery status is provided; otherwise, false.mat4 GetModelTransform ( int num ) #
Returns the local transformation of the given model.Arguments
- int num - Model index.
Return value
Local transformation matrix of the model.mat4 GetModelWorldTransform ( int num ) #
Returns the world transformation of the given model.Arguments
- int num - Model index.
Return value
World transformation matrix of the model.Mesh GetModelMesh ( int num ) #
Returns the mesh of the given model.Arguments
- int num - Model index.
Return value
Model mesh.Texture GetModelTexture ( int num ) #
Returns the texture of the given model.Arguments
- int num - Model index.
Return value
Model texture.string GetModelName ( int num ) #
Returns the name of the given model.Arguments
- int num - Model index.
Return value
Model name.Last update:
2023-11-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)