SR::PredictingWeaverTracker Class Reference

Sense class which provides predictive weaver position tracking functionality. More...

#include <predictingweavertracker.h>

Inheritance diagram for SR::PredictingWeaverTracker:

Collaboration diagram for SR::PredictingWeaverTracker:

Public Member Functions
	PredictingWeaverTracker (EyeTracker *rawEyeTracker)
	Constructs a PredictingWeaverTracker. More...
	~PredictingWeaverTracker ()
void	predict (uint64_t latency, SR_weaverPosition &output)
	Predict for a certain latency and trigger stream output Should not be used directly, for weaving use DX11Weaver/DX12Weaver/GLWeaver instead. More...
void	predict (uint64_t latency)
	Predict for a certain latency and trigger stream output Should not be used directly, for weaving use DX11Weaver/DX12Weaver/GLWeaver instead. More...
virtual std::string	getName () override
	Return the name of the sense. More...
virtual std::string	getDescription () override
	Return a description of the sense. More...
virtual void	start () override
	Start continuous updates, default behaviour is defined in the updater() function. More...
virtual void	stop () override
	Stop continuous updates. More...
virtual std::shared_ptr< WeaverPositionStream >	openWeaverPositionStream (WeaverPositionListener *listener) override
	Creates a WeaverPositionStream for listener to be connected to. More...
virtual void	streamClosed (WeaverPositionStream *stream) override
	Closes a specific WeaverPositionStream. More...
virtual void	accept (const SR_eyePair &frame) override
	Receives SR_eyePair to filter and use in predictions. 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...

Static Public Member Functions
static PredictingWeaverTracker *	create (SRContext &context)
	Returns a class of PredictingWeaverTracker. More...
Static Public Member Functions inherited from SR::WeaverTracker
static WeaverTracker *	create (SRContext &context)
	Creates a functional WeaverTracker instance. More...

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

Detailed Description

Sense class which provides predictive weaver position tracking functionality.

Constructor & Destructor Documentation

PredictingWeaverTracker()

SR::PredictingWeaverTracker::PredictingWeaverTracker

(

EyeTracker *

rawEyeTracker

)

Constructs a PredictingWeaverTracker.

~PredictingWeaverTracker()

SR::PredictingWeaverTracker::~PredictingWeaverTracker

(

)

Member Function Documentation

accept()

virtual void SR::PredictingWeaverTracker::accept ( const SR_eyePair &  frame )

overridevirtual

Receives SR_eyePair to filter and use in predictions.

Parameters

frame

of incoming SR_eyePair

Implements SR::EyePairListener.

create()

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

static

Returns a class of PredictingWeaverTracker.

Only one PredictingWeaverTracker can be created per context, if one has already been created a pointer to that one is returned. If one had not been created yet, a new one will be added to the context.

Parameters

context

to contain the PredictingWeaverTracker

getDescription()

virtual std::string SR::PredictingWeaverTracker::getDescription ( )

overridevirtual

Return a description of the sense.

Implements SR::Sense.

getName()

virtual std::string SR::PredictingWeaverTracker::getName ( )

overridevirtual

Return the name of the sense.

Implements SR::Sense.

openWeaverPositionStream()

virtual std::shared_ptr< WeaverPositionStream > SR::PredictingWeaverTracker::openWeaverPositionStream ( WeaverPositionListener *  listener )

overridevirtual

Creates a WeaverPositionStream for listener to be connected to.

Parameters

listener

will receive weaver position updates from now on

Returns

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

Implements SR::WeaverTracker.

predict() [1/2]

void SR::PredictingWeaverTracker::predict

(

uint64_t

latency

)

Predict for a certain latency and trigger stream output Should not be used directly, for weaving use DX11Weaver/DX12Weaver/GLWeaver instead.

Listeners will receive a new SR_weaverPosition after predict is called

Parameters

uint64_t

latency in microseconds to predict for

predict() [2/2]

void SR::PredictingWeaverTracker::predict	(	uint64_t	latency,
		SR_weaverPosition &	output
	)

Predict for a certain latency and trigger stream output Should not be used directly, for weaving use DX11Weaver/DX12Weaver/GLWeaver instead.

Listeners will receive a new SR_weaverPosition after predict is called

Parameters

uint64_t	latency in microseconds to predict for
SR_weaverPosition	to output

start()

virtual void SR::PredictingWeaverTracker::start ( )

overridevirtual

Start continuous updates, default behaviour is defined in the updater() function.

Implements SR::Sense.

stop()

virtual void SR::PredictingWeaverTracker::stop ( )

overridevirtual

Stop continuous updates.

Implements SR::Sense.

streamClosed()

virtual void SR::PredictingWeaverTracker::streamClosed ( WeaverPositionStream *  stream )

overridevirtual

Closes a specific WeaverPositionStream.

Parameters

stream

will no longer supply weaverposition updates

Implements SR::WeaverTracker.

---

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

• predictingweavertracker.h