AreaTracker Class Reference

Detailed Description

A type of Tracker that tracks scanned physical environments.

An AreaTracker tracks AreaTargets.

The data for these Trackable instances is stored in DataSet instances, which are owned and managed by the AreaTracker.

The AreaTracker class provides methods for creating, activating and deactivating DataSets.

Note

Calls to activateDataSet() and deactivateDataSet() should be avoided while the AreaTracker is actively processing a frame, as such calls will block until the AreaTracker has finished.

AreaTracker requires Platform fusion provider and won't work with Vuforia Sensor Fusion and Vuforia Vision Only.

If you do need to call these methods during execution, the suggested way of doing so is via the UpdateCallback mechanism, as the callback is done at a point where the AreaTracker is guaranteed to be idle. Alternatively, the AreaTracker can be explicitly stopped and then restarted. However this is a very expensive operation.

Inheritance diagram for AreaTracker:

Public Member Functions
virtual DataSet *	createDataSet ()=0
	Create an empty DataSet. More...
virtual bool	destroyDataSet (DataSet *dataset)=0
	Destroy the given DataSet and release allocated resources. More...
virtual bool	activateDataSet (DataSet *dataset)=0
	Activate the given DataSet. More...
virtual bool	deactivateDataSet (DataSet *dataset)=0
	Deactivate the given DataSet. More...
virtual List< DataSet >	getActiveDataSets ()=0
	Provides access to the list of currently active datasets. More...
Public Member Functions inherited from Tracker
virtual Type	getType () const =0
	Get the Type of this instance (may be a subclass of Tracker). More...
virtual bool	isOfType (Type type) const =0
	Get whether this Tracker instance's type equals or has been derived from the given type. More...
virtual bool	start ()=0
	Start the Tracker. More...
virtual void	stop ()=0
	Stop the Tracker. More...
virtual	~Tracker ()

Static Public Member Functions
static Type	getClassType ()
	Returns the Type for class 'AreaTracker'. More...
Static Public Member Functions inherited from Tracker
static Type	getClassType ()
	Get the Type for class 'Tracker'. More...

Member Function Documentation

static Type getClassType ( )

static

Returns the Type for class 'AreaTracker'.

virtual DataSet* createDataSet ( )

pure virtual

Create an empty DataSet.

Returns

the new instance on success, NULL otherwise.

Use destroyDataSet() to destroy a DataSet that is no longer needed.

virtual bool destroyDataSet ( DataSet *  dataset )

pure virtual

Destroy the given DataSet and release allocated resources.

Returns

true on success, or false if the DataSet is active.

virtual bool activateDataSet ( DataSet *  dataset )

pure virtual

Activate the given DataSet.

Returns

true if the DataSet was successfully activated, otherwise false (check application log for failure details).

Note

Activating a DataSet during live processing can be a blocking operation. To avoid this, call activateDataSet via the UpdateCallback mechanism (which guarantees that the AreaTracker will be idle), or explicitly stop the AreaTracker first, and then start it again when finished.

virtual bool deactivateDataSet ( DataSet *  dataset )

pure virtual

Deactivate the given DataSet.

Returns

true if the DataSet was successfully deactivated, otherwise false (e.g. because the DataSet is not currently active) (check application log for failure details).

Note

Deactivating a DataSet during live processing can be a blocking operation. To avoid this, call deactivateDataSet via the UpdateCallback mechanism (which guarantees that the AreaTracker will be idle), or explicitly stop the AreaTracker first, and then start it again when finished.

virtual List<DataSet> getActiveDataSets ( )

pure virtual

Provides access to the list of currently active datasets.