Control AR Engine. More...

#include <TrackerManager.h>

Collaboration diagram for maxstAR::TrackerManager:

Public Types
enum	TrackingOption { NORMAL_TRACKING = 0x01, EXTENDED_TRACKING = 0x02, MULTI_TRACKING = 0x04 }
	Additional tracking option. 0x01 : Normal Tracking (Image Tracker Only) 0x02 : Extended Tracking (Image Tracker Only) 0x04 : Multi Target Tracking (Image Tracker Only) More...

Public Member Functions
virtual void	startTracker (int trackerMask)=0
	Start AR engine. Only one tracking engine could be run at one time. More...

virtual void	stopTracker ()=0
	Stop tracking engine. More...

virtual void	destroyTracker ()=0
	Remove all tracking data (Map data and tracking result) More...

virtual void	addTrackerData (std::string trackingFileName, bool isAndroidAssetFile=false)=0
	Add map file to candidate list. More...

virtual void	removeTrackerData (std::string trackingFileName=std::string())=0
	Remove map file from candidate list. More...

virtual void	loadTrackerData ()=0
	Load map files in candidate list to memory. This method don't block main(UI) thread. More...

virtual bool	isTrackerDataLoadCompleted ()=0
	Get map files loading state. This is for UI expression. More...

virtual TrackingState *	updateTrackingState ()=0

virtual ITrackingResult &	getTrackingResult (TrackingState *state)=0
	Get tracking result. More...

virtual string	getCodeScanResult ()=0
	Get QRCode / Barcode recognition result. More...

virtual void	findSurface ()=0
	Start to find the surface of an environment from a camera image. More...

virtual void	quitFindingSurface ()=0
	Stop to find the surface. More...

virtual SurfaceThumbnail *	saveSurfaceData (string outputFileName)=0
	Save the surface data to file. More...

virtual void	getWorldPositionFromScreenCoordinate (float screen, float world)=0
	Get 3d world coordinate corresponding to given 2d screen position. More...

virtual int	getKeyframeCount ()=0
	Get the number of keyframes included in surface data. More...

virtual int	getFeatureCount ()=0
	Get the number of features included in surface data. More...

virtual SurfaceMesh *	getSurfaceMesh ()=0
	Get surface mesh information of the found surface after the findSurface method has been called. More...

virtual void	setTrackingOption (int option)=0
	Set tracking options. 1, 2, 4 cannot run simultaneously. More...

virtual void	saveFrames ()=0

Static Public Member Functions
static TrackerManager *	getInstance ()

Detailed Description

Control AR Engine.

Member Enumeration Documentation

◆ TrackingOption

enum maxstAR::TrackerManager::TrackingOption

Additional tracking option. 0x01 : Normal Tracking (Image Tracker Only) 0x02 : Extended Tracking (Image Tracker Only) 0x04 : Multi Target Tracking (Image Tracker Only)

Enumerator
NORMAL_TRACKING
EXTENDED_TRACKING
MULTI_TRACKING

Member Function Documentation

◆ addTrackerData()

virtual void maxstAR::TrackerManager::addTrackerData	(	std::string	trackingFileName,
		bool	isAndroidAssetFile = `false`
	)

pure virtual

Add map file to candidate list.

Parameters

trackingFileName	absolute file path
isAndroidAssetFile	flag for notify map file is located in assets folder (Android only)

◆ destroyTracker()

virtual void maxstAR::TrackerManager::destroyTracker ( )

pure virtual

Remove all tracking data (Map data and tracking result)

◆ findSurface()

virtual void maxstAR::TrackerManager::findSurface ( )

pure virtual

Start to find the surface of an environment from a camera image.

◆ getCodeScanResult()

virtual string maxstAR::TrackerManager::getCodeScanResult ( )

pure virtual

Get QRCode / Barcode recognition result.

Returns: QRCode or barcode text

◆ getFeatureCount()

virtual int maxstAR::TrackerManager::getFeatureCount ( )

pure virtual

Get the number of features included in surface data.

Returns: feature point count

◆ getInstance()

static TrackerManager* maxstAR::TrackerManager::getInstance ( )

static

◆ getKeyframeCount()

virtual int maxstAR::TrackerManager::getKeyframeCount ( )

pure virtual

Get the number of keyframes included in surface data.

Returns: key frame count

◆ getSurfaceMesh()

virtual SurfaceMesh* maxstAR::TrackerManager::getSurfaceMesh ( )

pure virtual

Get surface mesh information of the found surface after the findSurface method has been called.

Returns: SurfaceMesh instance

◆ getTrackingResult()

virtual ITrackingResult& maxstAR::TrackerManager::getTrackingResult ( TrackingState * state )

pure virtual

Get tracking result.

Returns: Tracking result

◆ getWorldPositionFromScreenCoordinate()

virtual void maxstAR::TrackerManager::getWorldPositionFromScreenCoordinate	(	float *	screen,
		float *	world
	)

pure virtual

Get 3d world coordinate corresponding to given 2d screen position.

Parameters

screen	screen touch x, y position
world	world position x, y, z

◆ isTrackerDataLoadCompleted()

virtual bool maxstAR::TrackerManager::isTrackerDataLoadCompleted ( )

pure virtual

Get map files loading state. This is for UI expression.

Returns: true if map loading is completed

◆ loadTrackerData()

virtual void maxstAR::TrackerManager::loadTrackerData ( )

pure virtual

Load map files in candidate list to memory. This method don't block main(UI) thread.

◆ quitFindingSurface()

virtual void maxstAR::TrackerManager::quitFindingSurface ( )

pure virtual

Stop to find the surface.

◆ removeTrackerData()

virtual void maxstAR::TrackerManager::removeTrackerData ( std::string trackingFileName = std::string() )

pure virtual

Remove map file from candidate list.

Parameters

trackingFileName map file name. This name should be same which added. If set "" (empty) file list will be cleared.

◆ saveFrames()

virtual void maxstAR::TrackerManager::saveFrames ( )

pure virtual

◆ saveSurfaceData()

virtual SurfaceThumbnail* maxstAR::TrackerManager::saveSurfaceData ( string outputFileName )

pure virtual

Save the surface data to file.

Parameters

outputFileName file path (should be absolute path)

Returns: SurfaceThumbnail instance if true else null

◆ setTrackingOption()

virtual void maxstAR::TrackerManager::setTrackingOption ( int option )

pure virtual

Set tracking options. 1, 2, 4 cannot run simultaneously.

Parameters

option 1 : Normal Tracking (Image Tracker Only) 2 : Extended Tracking (Image Tracker Only) 4 : Multiple Target Tracking (Image Tracker Only)

◆ startTracker()

virtual void maxstAR::TrackerManager::startTracker ( int trackerMask )

pure virtual

Start AR engine. Only one tracking engine could be run at one time.

Parameters

trackerMask tracking engine type (Refer Types.h)

◆ stopTracker()

virtual void maxstAR::TrackerManager::stopTracker ( )

pure virtual

Stop tracking engine.

◆ updateTrackingState()

virtual TrackingState* maxstAR::TrackerManager::updateTrackingState ( )

pure virtual

Update tracking state. This function should be called before getTrackingResult and background rendering

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

E:/Workspace/MaxstARSDK/MaxstAR/include/TrackerManager.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ TrackingOption

Member Function Documentation

◆ addTrackerData()

◆ destroyTracker()

◆ findSurface()

◆ getCodeScanResult()

◆ getFeatureCount()

◆ getInstance()

◆ getKeyframeCount()

◆ getSurfaceMesh()

◆ getTrackingResult()

◆ getWorldPositionFromScreenCoordinate()

◆ isTrackerDataLoadCompleted()

◆ loadTrackerData()

◆ quitFindingSurface()

◆ removeTrackerData()

◆ saveFrames()

◆ saveSurfaceData()

◆ setTrackingOption()

◆ startTracker()

◆ stopTracker()

◆ updateTrackingState()