QWR API Reference
This page provides a comprehensive API reference for the DPVR Unity Plugin specifically designed for VROneEdu educational VR headset development.
QWRCameraRig
The main camera rig component optimized for VROneEdu with educational-specific features.
Properties
| Name | Type | Description |
|---|---|---|
HeadPosition | Vector3 | The current head position. |
HeadRotation | Quaternion | The current head rotation. |
HeadVelocity | Vector3 | The current head velocity. |
HeadAngularVelocity | Vector3 | The current head angular velocity. |
ComfortLevel | ComfortLevel | The current comfort level setting. |
IPD | float | The interpupillary distance. |
IsEducationalModeEnabled | bool | Whether educational mode is enabled. |
Methods
| Name | Return Type | Parameters | Description |
|---|---|---|---|
GetHeadPosition() | Vector3 | None | Gets the current head position. |
GetHeadRotation() | Quaternion | None | Gets the current head rotation. |
GetHeadVelocity() | Vector3 | None | Gets the current head velocity. |
GetHeadAngularVelocity() | Vector3 | None | Gets the current head angular velocity. |
SetComfortSettings(ComfortLevel level) | void | level: The comfort level to set | Sets the comfort level for extended use. |
GetComfortLevel() | ComfortLevel | None | Gets the current comfort level. |
SetIPD(float ipd) | void | ipd: The IPD value in meters | Sets the interpupillary distance. |
GetIPD() | float | None | Gets the current IPD value. |
SetEducationalMode(bool enabled) | void | enabled: Whether to enable educational mode | Enables educational-specific features. |
SetSpatialAudio(bool enabled) | void | enabled: Whether to enable spatial audio | Enables or disables spatial audio. |
SetUIInteraction(bool enabled) | void | enabled: Whether to enable UI interaction | Enables or disables UI interaction features. |
Events
| Name | Event Type | Description |
|---|---|---|
OnHeadTrackingAcquired | Action | Triggered when head tracking is acquired. |
OnHeadTrackingLost | Action | Triggered when head tracking is lost. |
OnComfortLevelChanged | Action<ComfortLevel> | Triggered when comfort level changes. |
QWRController
Controller input handling specifically designed for VROneEdu educational applications.
Properties
| Name | Type | Description |
|---|---|---|
IsControllerConnected | bool | Whether a controller is connected. |
ControllerPosition | Vector3 | The current controller position. |
ControllerRotation | Quaternion | The current controller rotation. |
Methods
| Name | Return Type | Parameters | Description |
|---|---|---|---|
GetButton(DPVRButton button) | bool | button: The button to check | Checks if a button is currently pressed. |
GetButtonDown(DPVRButton button) | bool | button: The button to check | Checks if a button was pressed this frame. |
GetButtonUp(DPVRButton button) | bool | button: The button to check | Checks if a button was released this frame. |
GetAxis(DPVRAxis axis) | Vector2 | axis: The axis to check | Gets the value of a 2D axis (like touchpad). |
GetAxisValue(DPVRAxis axis) | float | axis: The axis to check | Gets the value of a 1D axis. |
TriggerHaptic(float intensity, float duration) | void | intensity: Haptic intensity (0-1), duration: Duration in seconds | Triggers haptic feedback. |
StopHaptic() | void | None | Stops all haptic feedback. |
IsControllerConnected() | bool | None | Checks if a controller is connected. |
GetControllerPosition() | Vector3 | None | Gets the current controller position. |
GetControllerRotation() | Quaternion | None | Gets the current controller rotation. |
Events
| Name | Event Type | Description |
|---|---|---|
OnButtonPressed | Action<DPVRButton> | Triggered when a button is pressed. |
OnButtonReleased | Action<DPVRButton> | Triggered when a button is released. |
OnAxisChanged | Action<DPVRAxis, Vector2> | Triggered when an axis value changes. |
OnControllerConnected | Action | Triggered when a controller is connected. |
OnControllerDisconnected | Action | Triggered when a controller is disconnected. |
For more detailed information about specific components, check out the following pages:
- Plugin Integration Guide: Step-by-step integration guide
- Demo Explanation: Interactive examples and demos
- Getting Started Guide: Quick start tutorial
This API reference provides comprehensive information about the DPVR Unity Plugin components and APIs specifically designed for VROneEdu educational VR headset development.