TobiiStream (Javadocs: GazeTrack)

java.lang.Object
- java.lang.Thread
- - gazetrack.TobiiStream

All Implemented Interfaces:

Runnable
```
public class TobiiStream
extends Thread
```

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary
- Fields inherited from class java.lang.Thread
  MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description

TobiiStream(String socket)
a Constructor, usually called at the beginning of execution so it starts listening for the Tobii gaze data stream.

Constructors
Constructor and Description
`TobiiStream(String socket)` a Constructor, usually called at the beginning of execution so it starts listening for the Tobii gaze data stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`gazePresent()` Returns true if the eye-tracker is capturing the user's gaze
`float`	`getGazeX()` Returns the user's gaze position (X)
`float`	`getGazeY()` Returns the user's gaze position (Y)
`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`	`getHeadRotationX()` Returns the user's head rotation (X)
`float`	`getHeadRotationY()` Returns the user's head rotation (Y)
`float`	`getHeadRotationZ()` Returns the user's head rotation (Z)
`float`	`getLeftEyeNormX()` Returns the user's left eye position (normalized X)
`float`	`getLeftEyeNormY()` Returns the user's left eye position (normalized Y)
`float`	`getLeftEyeNormZ()` Returns the user's left eye position (normalized Z)
`float`	`getLeftEyeX()` Returns the user's left eye position.
`float`	`getLeftEyeY()` Returns the user's left eye position.
`float`	`getLeftEyeZ()` Returns the user's left eye position.
`float`	`getRightEyeNormX()` Returns the user's right eye position (normalized X)
`float`	`getRightEyeNormY()` Returns the user's right eye position (normalized Y)
`float`	`getRightEyeNormZ()` Returns the user's right eye position (normalized Z)
`float`	`getRightEyeX()` Returns the user's right eye position.
`float`	`getRightEyeY()` Returns the user's right eye position.
`float`	`getRightEyeZ()` Returns the user's right eye position.
`double`	`getTimestamp()` Returns the timestamp for the latest 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
`void`	`run()` Thread that listens for gaze data from the TobiiStream.exe
`void`	`start()` Starts the thread that listens for gaze data streams
`void`	`terminate()` Ends the thread that listens for GazeDataStreams.

Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, toString, yield

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

- Constructor Detail
  - TobiiStream
```
public TobiiStream(String socket)
```
    a Constructor, usually called at the beginning of execution so it starts listening for the Tobii gaze data stream. This requires 'TobiiStream.exe' to be running and displaying gaze data. You can download this application from: http://web.tecnico.ulisboa.pt/augusto.esteves/GazeTrack/TobiiStream.zip
    
    Parameters:
    
    socket -
- Method Detail
  - getGazeX
```
public float getGazeX()
```
    Returns the user's gaze position (X)
    
    Returns:
    
    gaze position in x
  - getGazeY
```
public float getGazeY()
```
    Returns the user's gaze position (Y)
    
    Returns:
    
    gaze position in y
  - getTimestamp
```
public double getTimestamp()
```
    Returns the timestamp for the latest 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
  - getLeftEyeX
```
public float getLeftEyeX()
```
    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)
  - getLeftEyeY
```
public float getLeftEyeY()
```
    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)
  - getLeftEyeZ
```
public float getLeftEyeZ()
```
    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)
  - getLeftEyeNormX
```
public float getLeftEyeNormX()
```
    Returns the user's left eye position (normalized X)
    
    Returns:
    
    left left eye position in x (normalized)
  - getLeftEyeNormY
```
public float getLeftEyeNormY()
```
    Returns the user's left eye position (normalized Y)
    
    Returns:
    
    left eye position in y (normalized)
  - getLeftEyeNormZ
```
public float getLeftEyeNormZ()
```
    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
  - getRightEyeX
```
public float getRightEyeX()
```
    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)
  - getRightEyeY
```
public float getRightEyeY()
```
    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)
  - getRightEyeZ
```
public float getRightEyeZ()
```
    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)
  - getRightEyeNormX
```
public float getRightEyeNormX()
```
    Returns the user's right eye position (normalized X)
    
    Returns:
    
    right eye position in x (normalized)
  - getRightEyeNormY
```
public float getRightEyeNormY()
```
    Returns the user's right eye position (normalized Y)
    
    Returns:
    
    right eye position in y (normalized)
  - getRightEyeNormZ
```
public float getRightEyeNormZ()
```
    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
  - getHeadRotationX
```
public float getHeadRotationX()
```
    Returns the user's head rotation (X)
    
    Returns:
    
    head rotation in x
  - getHeadRotationY
```
public float getHeadRotationY()
```
    Returns the user's head rotation (Y)
    
    Returns:
    
    head rotation in y
  - getHeadRotationZ
```
public float getHeadRotationZ()
```
    Returns the user's head rotation (Z)
    
    Returns:
    
    head rotation in z
  - start
```
public void start()
```
    Starts the thread that listens for gaze data streams
    
    Overrides:
    
    start in class Thread
  - run
```
public void run()
```
    Thread that listens for gaze data from the TobiiStream.exe
    
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread
  - terminate
```
public void terminate()
```
    Ends the thread that listens for GazeDataStreams. Executed automatically when the Processing sketch is closed

Class TobiiStream

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Constructor Detail

TobiiStream

Method Detail

getGazeX

getGazeY

getTimestamp

gazePresent

leftEyePresent

getLeftEyeX

getLeftEyeY

getLeftEyeZ

getLeftEyeNormX

getLeftEyeNormY

getLeftEyeNormZ

rightEyePresent

getRightEyeX

getRightEyeY

getRightEyeZ

getRightEyeNormX

getRightEyeNormY

getRightEyeNormZ

getHeadPositionX

getHeadPositionY

getHeadPositionZ

getHeadRotationX

getHeadRotationY

getHeadRotationZ

start

run

terminate