MaxstARSDK  3.5.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
maxstAR.TrackerManager Class Reference

Control AR Engine (Singletone) More...

Public Types

enum  TrackingOption {
  TrackingOption.NORMAL_TRACKING = 1, TrackingOption.EXTEND_TRACKING = 2, TrackingOption.MULTI_TRACKING = 4, TrackingOption.JITTER_REDUCTION_ACTIVATION = 8,
  TrackingOption.JITTER_REDUCTION_DEACTIVATION = 16
}
 Additional tracking option (Image tracker only) 1 : Normal Tracking 2 : Extended Tracking 4 : Multi Target Tracking More...
 

Public Member Functions

void StartTracker (int trackerType)
 Start Tracker. More...
 
void StopTracker ()
 Stop Tracker. More...
 
void DestroyTracker ()
 Destroy Tracker. More...
 
void AddTrackerData (string trackingFileName, bool isAndroidAssetFile=false)
 Add the Trackable data to the Map List. More...
 
void RemoveTrackerData (string trackingFileName="")
 Delete the Trackable data from the Map List. More...
 
void LoadTrackerData ()
 Load the Trackable data. More...
 
void SetTrackingOption (TrackingOption trackingOption)
 Change Image Tracke Mode. More...
 
bool IsTrackerDataLoadCompleted ()
 Check that the Trackable data loading is finished. More...
 
TrackingState UpdateTrackingState ()
 Upate tracking state. This function should be called before GetTrackingResult More...
 
TrackingState GetTrackingState ()
 Get saved TrackingState value More...
 
Vector3 GetWorldPositionFromScreenCoordinate (Vector2 screen)
 Gets the x, y, 0 coordinates on the world coordinate corresponding to x, y in the Screen coordinate. More...
 
void FindSurface ()
 Start SLAM learning. More...
 
void QuitFindingSurface ()
 SLAM stops learning. More...
 
GuideInfo GetGuideInfo ()
 Get guide information of the found surface on SLAM after the FindSurface method has been called More...
 
SurfaceThumbnail SaveSurfaceData (string outputFileName)
 Saves SLAM learning results. More...
 

Static Public Member Functions

static TrackerManager GetInstance ()
 Get TrackerManager instance More...
 

Public Attributes

const int TRACKER_TYPE_CODE_SCANNER = 0X01
 Code scanner More...
 
const int TRACKER_TYPE_IMAGE = 0X02
 Planar image Tracker More...
 
const int TRACKER_TYPE_MARKER = 0X04
 Marker Tracker More...
 
const int TRACKER_TYPE_OBJECT = 0X08
 Object Tracker(Object data should be created via SLAM tracker) More...
 
const int TRACKER_TYPE_SLAM = 0x10
 Visual slam tracker (Can create surface data and save it) More...
 
const int TRACKER_TYPE_INSTANT = 0x20
 Instant Tracker More...
 

Detailed Description

Control AR Engine (Singletone)

Definition at line 16 of file TrackerManager.cs.

Member Enumeration Documentation

◆ TrackingOption

enum maxstAR.TrackerManager.TrackingOption
strong

Additional tracking option (Image tracker only) 1 : Normal Tracking 2 : Extended Tracking 4 : Multi Target Tracking

Enumerator
NORMAL_TRACKING 

Normal Tracking

EXTEND_TRACKING 

Extended Tracking

MULTI_TRACKING 

Multiple Target Tracking

JITTER_REDUCTION_ACTIVATION 

Jitter Reduction Activation

JITTER_REDUCTION_DEACTIVATION 

Jitter Reduction Deactivation

Definition at line 57 of file TrackerManager.cs.

Member Function Documentation

◆ AddTrackerData()

void maxstAR.TrackerManager.AddTrackerData ( string  trackingFileName,
bool  isAndroidAssetFile = false 
)

Add the Trackable data to the Map List.

Parameters
trackingFileNameFile path of map for map addition.
isAndroidAssetFileMap file position for addition. True is in Asset folder.

Definition at line 153 of file TrackerManager.cs.

◆ DestroyTracker()

void maxstAR.TrackerManager.DestroyTracker ( )

Destroy Tracker.

Definition at line 138 of file TrackerManager.cs.

◆ FindSurface()

void maxstAR.TrackerManager.FindSurface ( )

Start SLAM learning.

Definition at line 434 of file TrackerManager.cs.

◆ GetGuideInfo()

GuideInfo maxstAR.TrackerManager.GetGuideInfo ( )

Get guide information of the found surface on SLAM after the FindSurface method has been called

Returns
SurfaceMesh instance

Definition at line 478 of file TrackerManager.cs.

◆ GetInstance()

static TrackerManager maxstAR.TrackerManager.GetInstance ( )
static

Get TrackerManager instance

Returns

Definition at line 89 of file TrackerManager.cs.

◆ GetTrackingState()

TrackingState maxstAR.TrackerManager.GetTrackingState ( )

Get saved TrackingState value

Returns
TrackingState instance

Definition at line 250 of file TrackerManager.cs.

◆ GetWorldPositionFromScreenCoordinate()

Vector3 maxstAR.TrackerManager.GetWorldPositionFromScreenCoordinate ( Vector2  screen)

Gets the x, y, 0 coordinates on the world coordinate corresponding to x, y in the Screen coordinate.

Parameters
screenInput screen coordinates 2d.
Returns
World coordinates 3d

Definition at line 292 of file TrackerManager.cs.

◆ IsTrackerDataLoadCompleted()

bool maxstAR.TrackerManager.IsTrackerDataLoadCompleted ( )

Check that the Trackable data loading is finished.

Returns
Return map loading status. True is completed.

Definition at line 213 of file TrackerManager.cs.

◆ LoadTrackerData()

void maxstAR.TrackerManager.LoadTrackerData ( )

Load the Trackable data.

Definition at line 181 of file TrackerManager.cs.

◆ QuitFindingSurface()

void maxstAR.TrackerManager.QuitFindingSurface ( )

SLAM stops learning.

Definition at line 447 of file TrackerManager.cs.

◆ RemoveTrackerData()

void maxstAR.TrackerManager.RemoveTrackerData ( string  trackingFileName = "")

Delete the Trackable data from the Map List.

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

Definition at line 168 of file TrackerManager.cs.

◆ SaveSurfaceData()

SurfaceThumbnail maxstAR.TrackerManager.SaveSurfaceData ( string  outputFileName)

Saves SLAM learning results.

Parameters
outputFileNameFile path of map for save.
Returns
Return save result of success or fail. True is saved.

Definition at line 492 of file TrackerManager.cs.

◆ SetTrackingOption()

void maxstAR.TrackerManager.SetTrackingOption ( TrackingOption  trackingOption)

Change Image Tracke Mode.

Definition at line 194 of file TrackerManager.cs.

◆ StartTracker()

void maxstAR.TrackerManager.StartTracker ( int  trackerType)

Start Tracker.

Parameters
trackerTypeBit mask of tracker type.

Definition at line 112 of file TrackerManager.cs.

◆ StopTracker()

void maxstAR.TrackerManager.StopTracker ( )

Stop Tracker.

Definition at line 125 of file TrackerManager.cs.

◆ UpdateTrackingState()

TrackingState maxstAR.TrackerManager.UpdateTrackingState ( )

Upate tracking state. This function should be called before GetTrackingResult

Returns
TrackingState instance

Definition at line 229 of file TrackerManager.cs.

Member Data Documentation

◆ TRACKER_TYPE_CODE_SCANNER

const int maxstAR.TrackerManager.TRACKER_TYPE_CODE_SCANNER = 0X01

Code scanner

Definition at line 21 of file TrackerManager.cs.

◆ TRACKER_TYPE_IMAGE

const int maxstAR.TrackerManager.TRACKER_TYPE_IMAGE = 0X02

Planar image Tracker

Definition at line 26 of file TrackerManager.cs.

◆ TRACKER_TYPE_INSTANT

const int maxstAR.TrackerManager.TRACKER_TYPE_INSTANT = 0x20

Instant Tracker

Definition at line 46 of file TrackerManager.cs.

◆ TRACKER_TYPE_MARKER

const int maxstAR.TrackerManager.TRACKER_TYPE_MARKER = 0X04

Marker Tracker

Definition at line 31 of file TrackerManager.cs.

◆ TRACKER_TYPE_OBJECT

const int maxstAR.TrackerManager.TRACKER_TYPE_OBJECT = 0X08

Object Tracker(Object data should be created via SLAM tracker)

Definition at line 36 of file TrackerManager.cs.

◆ TRACKER_TYPE_SLAM

const int maxstAR.TrackerManager.TRACKER_TYPE_SLAM = 0x10

Visual slam tracker (Can create surface data and save it)

Definition at line 41 of file TrackerManager.cs.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.14