SR::EyeTracker Class Reference

Sense class which provides face tracking functionality to the SR system. More...

#include <eyetracker.h>

Inheritance diagram for SR::EyeTracker:

Collaboration diagram for SR::EyeTracker:

Public Member Functions
virtual std::shared_ptr< EyePairStream >	openEyePairStream (EyePairListener *listener)=0
	Creates a EyePairStream for listener to be connected to. More...
virtual void	streamClosed (EyePairStream *stream)=0
	Closes a specific EyePairStream. More...
Public Member Functions inherited from SR::Sense
void	setCalibration (Transformation calibration)
	Sets a Transformation object to represent the sense's calibration with respect to the display. More...
Transformation	getCalibration ()
	Gets callibration. More...
virtual	~Sense ()
	Ensures the proper destruction of the sense implementation. More...
virtual std::string	getName ()=0
	Return the name of the sense. More...
virtual std::string	getDescription ()=0
	Return a description of the sense. More...
virtual void	start ()=0
	Start continuous updates, default behaviour is defined in the updater() function. More...
virtual void	stop ()=0
	Stop continuous updates. More...

Static Public Member Functions
static EyeTracker *	create (SRContext &context)
	Creates a functional EyeTracker instance. More...
static EyeTracker *	createRaw (SRContext &context)
	Creates a functional EyeTracker instance providing unfiltered data. More...

Additional Inherited Members
Protected Attributes inherited from SR::Sense
Transformation	calibration

Detailed Description

Sense class which provides face tracking functionality to the SR system.

Member Function Documentation

create()

static EyeTracker * SR::EyeTracker::create ( SRContext &  context )

static

Creates a functional EyeTracker instance.

Parameters

context

is the environment in which created senses are kept track of

Returns

EyeTracker* which can provide streams of eye position data

The EyeTracker class is abstract and requires a device specific implementation to be used in applications. This function constructs an EyeTracker suitable for use in your application on the current device.

createRaw()

static EyeTracker * SR::EyeTracker::createRaw ( SRContext &  context )

static

Creates a functional EyeTracker instance providing unfiltered data.

Parameters

context

is the environment in which created senses are kept track of

Returns

EyeTracker* which can provide streams of eye position data

The EyeTracker class is abstract and requires a device specific implementation to be used in applications. This function constructs an EyeTracker suitable for use in your application on the current device.

openEyePairStream()

virtual std::shared_ptr< EyePairStream > SR::EyeTracker::openEyePairStream ( EyePairListener *  listener )

pure virtual

Creates a EyePairStream for listener to be connected to.

Parameters

listener

will receive eyepair updates from now on

Returns

std::shared_ptr<EyePairStream> to be used to close the stream correctly when it is no longer required

Implemented in SR::PredictingEyeTracker.

streamClosed()

virtual void SR::EyeTracker::streamClosed ( EyePairStream *  stream )

pure virtual

Closes a specific EyePairStream.

Parameters

stream

will no longer supply eyepair updates

Implemented in SR::PredictingEyeTracker.

---

The documentation for this class was generated from the following file:

• eyetracker.h