InputVRDevice Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
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
Members
int isAvailable ( ) #
Returns a value indicating if the VR device is available.Return value
true if the device is available; otherwise, false.int getNumber ( ) #
Returns the index of the VR device.Return value
Device index.string getName ( ) #
Returns the name of the VR device.Return value
Device name.int getDeviceType ( ) #
Returns the type of the input device (wheel, throttle, etc.).Return value
Input device type.int getType ( ) #
Returns the type of the VR device (HMD, controller, base station, etc.).Return value
VR device type.string getDeviceModelName ( ) #
Returns the name of the model of the VR device.Return value
Model name.int 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.int isCharging ( ) #
Returns a value indicating if the VR device is charging.Return value
true if the device is charging; otherwise, false.int hasBattery ( ) #
Returns a value indicating if the VR device has a battery.Return value
true if the device has the battery; otherwise, false.int canReportBatteryValue ( ) #
Returns a value indicating if the VR device provides the battery status.Return value
true if the battery status is provided; otherwise, false.float getBatteryValue ( ) #
Returns the current battery level.Return value
Battery level, in percents.String getModelNumber ( ) #
Returns the model number for the VR device.Return value
Model number.String getSerialNumber ( ) #
Returns the serial number of the VR device.Return value
Seril number.String getManufacturerName ( ) #
Returns the name of the VR device's vendor.Return value
Vendor name.long getHardwareRevision ( ) #
Returns the hardware revision of the VR device.Return value
Hardware revision.long getFirmwareVersion ( ) #
Returns the firmware version of the VR device.Return value
Firmware versionMat4 getWorldTransform ( ) #
Retuns the world transformation of the VR device.Return value
World transformation matrix.mat4 getTransform ( ) #
Returns the local transformation of the VR device.Return value
Local transformation matrix.vec3 getLinearVelocity ( ) #
Returns the linear velocity of the VR device.Return value
Linear velocity.vec3 getAngularVelocity ( ) #
Returns the angular velocity of the VR device.Return value
Angular velocity.vec3 getAngularAcceleration ( ) #
Returns the angular acceleration of the VR device.Return value
Angular acceleration.int isTransformValid ( ) #
Returns a value indicating if transformation if the VR device is valid.Return value
true if transformation is valid; otherwise, false.int getNumModels ( ) #
Returns the number of VR device's models.Return value
Number of models.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.Mesh getCombinedModelMesh ( ) #
Returns the entire mesh of the combined model of the VR device.Notice
You cannot animate this mesh. However, if you get a mesh of each model individually, it will be automatically animated.
Return value
Mesh of the combined model.Texture getCombinedModelTexture ( ) #
Returns the texture of the combined model of the VR device.Return value
Texure of the combined model.string getCombinedModelName ( ) #
Returns the name of the combined model of the VR device.Return value
Name of the combined model.Last update:
2023-11-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)