$HEADER

"OpenXR" PlugIT

The "OpenXR" PlugIT allows to use OpenXR compatible virtual reality headsets, such as the Meta Quest/Quest2 or Pico4 devices for mobile and also SteamVR and OpenXR compatible desktop headsets.

 

Parameters

1

The object representative of the left controller.

2

Position offset for the left controller object.

3

Orientation offset for the left controller object.

4

The object representative of the right controller.

5

Allows to enable or disable the pointer ray of the left controller.

6

Position offset for the right controller object.

7

Orientation offset for the right controller object.

8

Allows to enable or disable the pointer ray of the right controller.

9

If checked the controllers will not collide with the other objects of the 3D world.

10

Allows to display or not a pointer ray at the ends of the controllers, at all times or only over user interfaces.

11

If checked the click is automatically triggered when the end of the controller is close enough of a clickable object or interface. Useful to simulate the natural action of "touching" a button to enable it.

12

The distance for the auto click to be triggered.

13

The object the pointer ray comes from for the left controller.

14

The object the pointer ray comes from for the right controller.

15

The teleportation mode :
- None: Teleportation is disabled
- Pad only: Pressing and holding the touchpad displays the teleportation target. Releasing the touchpad teleports the player on the target.
- Pad + trigger: Pressing and holding the touchpad displays the teleportation target. Pressing the trigger while holding the touchpad teleports the player on the target.

16

The controller(s) that can be used to teleport itself.

17

Factor allowing to reduce the rendering resolution to increase fluidity.

18

Allow hand tracking OpenXR extension when the device support it.

19

Allow passthrough OpenXR extension when the device support it.

20

Starts the VR headset at the same time as the application.

 

Action

Disable

Disables the VR headset.

Enable

Enables the VR headset.

Disable controllers

Disables the controllers.

Enable Controllers

Enables the controllers.

Hide ray

Hides the pointer ray at the ends of the controllers.

Left controller

All of the actions linked to the left controller :

Rumble Vibrates the controller.
Set object Sets the object representative of the controller.
Set offset Sets the position and orientation offset of the object representative of the controller.
Grab / Ungrab Grabs an object / drops the grabbed object.
Enable / Disable ray Enables / disables the pointer ray of the controller.

Reset

 Reset the VR headset tracking.

Right controller

All of the actions linked to the right controller :

Rumble Vibrates the controller.
Set object Sets the object representative of the controller.
Set offset Sets the position and orientation offset of the object representative of the controller.
Grab / Ungrab Grabs an object / drops the grabbed object.
Enable / Disable ray Enables / disables the pointer ray of the controller.

Set teleport mode

 Sets th teleport mode (0 = None, 1 = Pad only, 2 = Pad + trigger).

Show ray

Shows the pointer ray at the ends of the controllers.

Enable passthrough

 Enable the passthrough feature (the device must support it).

Disable passthrough

 Disable the passthrough feature.

 

Event

Control

Sends the position and orientation of the VR headset formatted for navigation PlugITs.

Device found

Sent when a VR headset is found.

Device not found

Sent when no VR headset is found.

Left controller

All of the events linked to the left controller :

X up/down Sent when the X button is pressed/released
X touch/untouch Sent when a finger is laid on/removed from the X button
Y up/down Sent when the Y button is pressed/released
Y touch/untouch Sent when a finger is laid on/removed from the Y button
Control Sends the position and orientation of the controller formatted for navigation PlugITs
Found/Lost Sent when the controller is found/lost
Grab/Ungrab Sent when the controller grab/drop an object
Grip up/down Sent when the grip button is pressed/released
Grip value Sends the grip button exact value
Index pointing/not pointing Sent when the user points its index/stops pointing its finger
Is controller Sent when the users uses the controller
Is hand Sent when the user uses te hand tracking instead of the controller
Menu up/down Sent when the menu button is pressed/released
Orientation Sends the controller orientation
Position Sends the controller position
Stick Sends the values of the joystick or touchpad of the controller
Thumb up/down Sent when the controller touchpad is pressed/released. Provide the coordinates at which the touchpad is pressed
Thumb touch/untouch Sent when a finger is laid on/removed from the joystick or touchpad of the controller
Trigger up/down Sent when the trigger is pressed/released
Trigger touch/untouch Sent when a finger is laid on/removed from the trigger
Trigger value Sends the trigger exact value

Orientation

Sends the VR headset orientation.

Position

Sends the VR headset position.

Right controller

All of the events linked to the right controller :

A up/down Sent when the A button is pressed/released
A touch/untouch Sent when a finger is laid on/removed from the A button
B up/down Sent when the B button is pressed/released
B touch/untouch Sent when a finger is laid on/removed from the B button
Control Sends the position and orientation of the controller formatted for navigation PlugITs
Found/Lost Sent when the controller is found/lost
Grab/Ungrab Sent when the controller grab/drop an object
Grip up/down Sent when the grip button is pressed/released
Grip value Sends the grip button exact value
Index pointing/not pointing Sent when the user points its index/stops pointing its finger
Is controller Sent when the users uses the controller
Is hand Sent when the user uses te hand tracking instead of the controller
Menu up/down Sent when the menu button is pressed/released
Orientation Sends the controller orientation
Position Sends the controller position
Stick Sends the values of the joystick or touchpad of the controller
Thumb up/down Sent when the controller touchpad is pressed/released. Provide the coordinates at which the touchpad is pressed
Thumb touch/untouch Sent when a finger is laid on/removed from the joystick or touchpad of the controller
Trigger up/down Sent when the trigger is pressed/released
Trigger touch/untouch Sent when a finger is laid on/removed from the trigger
Trigger value Sends the trigger exact value

Teleport

Sends the position where the user tries to teleport itself.
$FOOTER