TrackXRController

This component is used to track and obtain the controller input state (buttons, triggers, etc.). Most VR platforms support controller devices, such as Oculus Touch, Vive Controllers, or Valve Index Controllers.

Properties

When you add this component to your entity, you will see this in Evergine Studio:

Property	Description
Handedness	With this property, you will indicate the handedness of the device that you want to track: LeftHand to specify the left hand. RightHand to specify the right hand. Undefined if the device has no specific handedness.
TrackingLostMode	Specify the strategy to follow in case the device is not well-tracked: DisableEntityOnPoseInvalid disables the entity if the tracked pose is not valid. If the device is well-tracked again, the entity will be enabled again. This is the default value. KeepLastPose stops tracking the entity if the pose is not valid, maintaining the entity with the last pose received. DisableEntityOnDisconnection disables the entity only if the selected device is no longer connected.
ControllerState	Structure that exposes the controller input state.

Controller State

Gives the user access to the following properties through the XRControllerGenericState structure:

Property	Description
IsConnected	Indicates whether this device is connected.
Trigger	Returns a 0-1 float value of the trigger state.
TriggerButton	Gives the ButtonState enum of the trigger, to check if it is pressed or not.
Grip	Indicates if the grip button is pressed.
ThumbStick	'Vector2' value that indicates the direction of the typical mini-stick on the controller.
ThumbStickButton	'ButtonState' that indicates if the thumbstick is pressed.
Touchpad	'Vector2' value that indicates the direction of the touchpad placed on some VR controllers.
Menu	'ButtonState' of the menu button.
Button1	'ButtonState' of the typical first button on a controller (it can usually be labeled as A or X).
Button2	'ButtonState' of the typical second button on a controller (it can usually be labeled as B or Y).

Using TrackXRController

Create a TrackXRController from code

In the following code, you will find how to create an entity that tracks a controller through code:

protected override void CreateScene()
{
    base.CreateScene();

    var material = Application.Current.Container
        .Resolve<AssetsService>()
        .Load<Material>(DefaultResourcesIDs.DefaultMaterialID);

    // Left entity
    var leftDevice = new Entity()
        .AddComponent(new Transform3D())
        .AddComponent(new MaterialComponent() { Material = material })
        .AddComponent(new TeapotMesh() { Size = 0.15f })
        .AddComponent(new MeshRenderer())
        .AddComponent(new TrackXRController()
        {
            Handedness = XRHandedness.LeftHand // select the left device
        })
        .AddComponent(new ScaleEntityWithController()); // Described in the next section :)

    this.Managers.EntityManager.Add(leftDevice);
}

Read the Controller State

A small sample to read the controller state:

public class ScaleEntityWithController : Behavior
{
    [BindComponent]
    private Transform3D transform;
    
    [BindComponent]
    private TrackXRController trackXRController;

    protected override void Update(TimeSpan gameTime)
    {
        if (trackXRController.IsConnected)
        {
            // Scale the entity if the user presses the trigger (from 1 to 2)
            this.transform.LocalScale = Vector3.One * (1 + trackXRController.ControllerState.Trigger);
        }
    }
}