GazeTrack (Javadocs: GazeTrack)

java.lang.Object
- gazetrack.GazeTrack

public class GazeTrack
extends Object

GazeTrack is an eye-tracking library for Processing. It works with most commercial Tobii eye-trackers, including the EyeX and the 4C (tested), and most Tobii-enabled laptops. Before you start, make sure the 'TobiiStream.exe' is running and displaying gaze data. You can download this application from: http://web.tecnico.ulisboa.pt/augusto.esteves/GazeTrack/TobiiStream.zip

+Example

/* 
GazeTrack: Basic demo
-
In this demo, the user's gaze is represented
by a white circle.
-

Before you run this demo, make sure the
Tobii eye-tracker (EyeX, 4C) is connected
to the computer, and that the Tobii software 
is running and calibrated to your eyes.

Finally, make sure the 'TobiiStream.exe' is 
running and displaying gaze data. You can
download this application from:
http://web.tecnico.ulisboa.pt/augusto.esteves/GazeTrack/TobiiStream.zip

by Augusto Esteves
http://web.tecnico.ulisboa.pt/augusto.esteves/
https://github.com/AugustoEst/gazetrack
*/

import gazetrack.*;

GazeTrack gazeTrack;

void setup() 
{
  fullScreen();
  
  // Gaze cursor param.
  noFill();
  stroke(50, 100);
  strokeWeight(4);
  
  gazeTrack = new GazeTrack(this);
  
  // If the TobiiStream.exe asked you to use a 
  // different socket port (e.g., 5656), use this instead:
  // gazeTrack = new GazeTrack(this, "5656");
}

void draw() 
{
  background(255);
  
  if (gazeTrack.gazePresent())
  {
    ellipse(gazeTrack.getGazeX(), gazeTrack.getGazeY(), 80, 80);
    
    // Print the tracker's timestamp for the gaze cursor above
    println("Latest gaze data at: " + gazeTrack.getTimestamp());
  }
}

Constructor Summary

Constructors
Constructor and Description
`GazeTrack(PApplet theParent)` The GazeTrack constructor (default ZMQ socket)
`GazeTrack(PApplet theParent, String socket)` The GazeTrack constructor (specific ZMQ socket).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Anything in here will be called automatically when the parent sketch shuts down.
`boolean`	`gazePresent()` Returns true if the eye-tracker is capturing the user's gaze
`float`	`getGazeX()` Returns the user's latest gaze position (X)
`float`	`getGazeY()` Returns the user's latest gaze position (Y)
`float`	`getHeadPitch()` Returns the user's head rotation (Pitch)
`float`	`getHeadPositionX()` Returns the user's head position (X)
`float`	`getHeadPositionY()` Returns the user's head position (Y)
`float`	`getHeadPositionZ()` Returns the user's head position (Z)
`float`	`getHeadRoll()` Returns the user's head rotation (Roll)
`float`	`getHeadYaw()` Returns the user's head rotation (Yaw)
`float`	`getLeftEyeX()` Returns the user's left eye position (normalized X)
`float`	`getLeftEyeXmm()` Returns the user's left eye position.
`float`	`getLeftEyeY()` Returns the user's left eye position (normalized Y)
`float`	`getLeftEyeYmm()` Returns the user's left eye position.
`float`	`getLeftEyeZ()` Returns the user's left eye position (normalized Z)
`float`	`getLeftEyeZmm()` Returns the user's left eye position.
`float`	`getRightEyeX()` Returns the user's right eye position (normalized X)
`float`	`getRightEyeXmm()` Returns the user's right eye position.
`float`	`getRightEyeY()` Returns the user's right eye position (Y)
`float`	`getRightEyeYmm()` Returns the user's right eye position.
`float`	`getRightEyeZ()` Returns the user's right eye position (normalized Z)
`float`	`getRightEyeZmm()` Returns the user's right eye position.
`double`	`getTimestamp()` Returns the timestamp for the latest gaze event
`boolean`	`leftEyePresent()` Returns true if the eye-tracker is capturing the user's left eye
`boolean`	`rightEyePresent()` Returns true if the eye-tracker is capturing the user's right eye

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GazeTrack
```
public GazeTrack(PApplet theParent)
```
    The GazeTrack constructor (default ZMQ socket)
    
    Parameters:
    
    theParent -
  - GazeTrack
```
public GazeTrack(PApplet theParent,
                 String socket)
```
    The GazeTrack constructor (specific ZMQ socket). This should be used when the TobiiStream.exe asks for a new socket port (due to the default being in use already)
    
    Parameters:
    
    theParent -
    
    socket -
- Method Detail
  - getGazeX
```
public float getGazeX()
```
    Returns the user's latest gaze position (X)
    
    Returns:
    
    gaze position in x
  - getGazeY
```
public float getGazeY()
```
    Returns the user's latest gaze position (Y)
    
    Returns:
    
    gaze position in y
  - getTimestamp
```
public double getTimestamp()
```
    Returns the timestamp for the latest gaze event
    
    Returns:
    
    timestamp of the last gaze event
  - gazePresent
```
public boolean gazePresent()
```
    Returns true if the eye-tracker is capturing the user's gaze
    
    Returns:
    
    true if the user's gaze is present
  - leftEyePresent
```
public boolean leftEyePresent()
```
    Returns true if the eye-tracker is capturing the user's left eye
    
    Returns:
    
    true if user's left eye is present
  - getLeftEyeXmm
```
public float getLeftEyeXmm()
```
    Returns the user's left eye position. This is the X position given in space coordinates (mm) relative to the center of the screen
    
    Returns:
    
    left eye position in x (mm)
  - getLeftEyeYmm
```
public float getLeftEyeYmm()
```
    Returns the user's left eye position. This is the Y position given in space coordinates (mm) relative to the center of the screen
    
    Returns:
    
    left eye position in y (mm)
  - getLeftEyeZmm
```
public float getLeftEyeZmm()
```
    Returns the user's left eye position. This is the Z position given in space coordinates (mm) relative to the center of the screen
    
    Returns:
    
    left eye position in z (mm)
  - getLeftEyeX
```
public float getLeftEyeX()
```
    Returns the user's left eye position (normalized X)
    
    Returns:
    
    left left eye position in x (normalized)
  - getLeftEyeY
```
public float getLeftEyeY()
```
    Returns the user's left eye position (normalized Y)
    
    Returns:
    
    left eye position in y (normalized)
  - getLeftEyeZ
```
public float getLeftEyeZ()
```
    Returns the user's left eye position (normalized Z)
    
    Returns:
    
    left eye position in z (normalized)
  - rightEyePresent
```
public boolean rightEyePresent()
```
    Returns true if the eye-tracker is capturing the user's right eye
    
    Returns:
    
    true if user's right eye is present
  - getRightEyeXmm
```
public float getRightEyeXmm()
```
    Returns the user's right eye position. This is the X position given in space coordinates (mm) relative to the center of the screen
    
    Returns:
    
    right eye position in x (mm)
  - getRightEyeYmm
```
public float getRightEyeYmm()
```
    Returns the user's right eye position. This is the Y position given in space coordinates (mm) relative to the center of the screen
    
    Returns:
    
    right eye position in y (mm)
  - getRightEyeZmm
```
public float getRightEyeZmm()
```
    Returns the user's right eye position. This is the Z position given in space coordinates (mm) relative to the center of the screen
    
    Returns:
    
    right eye position in z (mm)
  - getRightEyeX
```
public float getRightEyeX()
```
    Returns the user's right eye position (normalized X)
    
    Returns:
    
    right right eye position in x (normalized)
  - getRightEyeY
```
public float getRightEyeY()
```
    Returns the user's right eye position (Y)
    
    Returns:
    
    right eye position in y (normalized)
  - getRightEyeZ
```
public float getRightEyeZ()
```
    Returns the user's right eye position (normalized Z)
    
    Returns:
    
    right eye position in z (normalized)
  - getHeadPositionX
```
public float getHeadPositionX()
```
    Returns the user's head position (X)
    
    Returns:
    
    head position in x
  - getHeadPositionY
```
public float getHeadPositionY()
```
    Returns the user's head position (Y)
    
    Returns:
    
    head position in y
  - getHeadPositionZ
```
public float getHeadPositionZ()
```
    Returns the user's head position (Z)
    
    Returns:
    
    head position in z
  - getHeadPitch
```
public float getHeadPitch()
```
    Returns the user's head rotation (Pitch)
    
    Returns:
    
    head rotation (pitch)
  - getHeadYaw
```
public float getHeadYaw()
```
    Returns the user's head rotation (Yaw)
    
    Returns:
    
    head rotation (yaw)
  - getHeadRoll
```
public float getHeadRoll()
```
    Returns the user's head rotation (Roll)
    
    Returns:
    
    head rotation (roll)
  - dispose
```
public void dispose()
```
    Anything in here will be called automatically when the parent sketch shuts down. For instance, this might shut down a thread used by this library

Class GazeTrack

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GazeTrack

GazeTrack

Method Detail

getGazeX

getGazeY

getTimestamp

gazePresent

leftEyePresent

getLeftEyeXmm

getLeftEyeYmm

getLeftEyeZmm

getLeftEyeX

getLeftEyeY

getLeftEyeZ

rightEyePresent

getRightEyeXmm

getRightEyeYmm

getRightEyeZmm

getRightEyeX

getRightEyeY

getRightEyeZ

getHeadPositionX

getHeadPositionY

getHeadPositionZ

getHeadPitch

getHeadYaw

getHeadRoll

dispose