Wave Eye Tracking Interface¶

Refer to Wave XR Plugin Packages about VIVE Wave™ XR plugin packages.

Wave.Essence.Eye.EyeManager: Provides VIVE Wave™ XR Plugin Eye Tracking interface.

EyeManager Interface¶

To use the Wave.Essence.Eye.EyeManager class, you have to import the Essence package (refer to Wave XR Plugin Packages).

EyeType¶

public enum EyeType
{
        Combined = 0,
        Right,
        Left
}

EyeTrackingStatus¶

public enum EyeTrackingStatus
{
        // Initial, can call Start API in this state.
        NOT_START,
        START_FAILURE,

        // Processing, should NOT call API in this state.
        STARTING,
        STOPING,

        // Running, can call Stop API in this state.
        AVAILABLE,

        // Do nothing.
        UNSUPPORT
}

EyeSpace¶

public enum EyeSpace : UInt32
{
        Local = WVR_CoordinateSystem.WVR_CoordinateSystem_Local,
        World = WVR_CoordinateSystem.WVR_CoordinateSystem_Global
}

IsEyeTrackingDeviceConnected¶

Checks if the Eye Tracking device is connected.

bool IsEyeTrackingDeviceConnected()

GetEyeTrackingStatus¶

Retrieves current eye tracking service status.

EyeTrackingStatus GetEyeTrackingStatus()

IsEyeTrackingAvailable¶

Checks whether the eye tracking service is available.

bool IsEyeTrackingAvailable()

HasEyeTrackingData¶

Checks if the eye tracking data is provided.

bool HasEyeTrackingData()

GetEyeOrigin¶

Retrieves the origin location of specified eye.

bool GetEyeOrigin(EyeType eye, out Vector3 origin)

GetEyeDirectionNormalized¶

Retrieves the normalized direction of specified eye.

bool GetEyeDirectionNormalized(EyeType eye, out Vector3 direction)

GetCombinedEyeOrigin¶

Retrieves the origin location of combined eye.

bool GetCombinedEyeOrigin(out Vector3 origin)

GetCombindedEyeDirectionNormalized¶

Retrieves the looking direction of combined eye.

bool GetCombindedEyeDirectionNormalized(out Vector3 direction)

GetLeftEyeOrigin¶

Retrieves the origin location of left eye.

bool GetLeftEyeOrigin(out Vector3 origin)

GetLeftEyeDirectionNormalized¶

Retrieves the looking direction of left eye.

bool GetLeftEyeDirectionNormalized(out Vector3 direction)

GetLeftEyeOpenness¶

Retrieves the value representing how open the left eye is.

bool GetLeftEyeOpenness(out float openness)

GetLeftEyePupilDiameter¶

Retrieves the diameter of left eye pupil in millimeters.

bool GetLeftEyePupilDiameter(out float diameter)

GetLeftEyePupilPositionInSensorArea¶

Retrieves the normalized position of left eye pupil in Vector2.

bool GetLeftEyePupilPositionInSensorArea(out Vector2 area)

GetRightEyeOrigin¶

Retrieves the origin location of right eye.

bool GetRightEyeOrigin(out Vector3 origin)

GetRightEyeDirectionNormalized¶

Retrieves the looking direction of right eye.

bool GetRightEyeDirectionNormalized(out Vector3 direction)

GetRightEyeOpenness¶

Retrieves the value representing how open the right eye is.

bool GetRightEyeOpenness(out float openness)

GetRightEyePupilDiameter¶

Retrieves the diameter of right eye pupil in millimeters.

bool GetRightEyePupilDiameter(out float diameter)

GetRightEyePupilPositionInSensorArea¶

Retrieves the normalized position of right eye pupil in Vector2.

bool GetRightEyePupilPositionInSensorArea(out Vector2 area)