MaxstAR Unity
Public Types | Public Member Functions | Static Public Member Functions | Static 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, TrackingOption.CLOUD_RECOGNITION_AUTO_DEACTIVATION = 32, TrackingOption.CLOUD_RECOGNITION_AUTO_ACTIVATION = 64, TrackingOption.ENHANCED_MODE = 128
}
 Additional tracking option 1 : Normal Tracking (Image tracker only) 2 : Extended Tracking (Image tracker only) 4 : Multi Target Tracking (Image tracker only) 8 : Jitter Reduction Activation (Marker, Image and Object) 16 : Jitter Reduction Deactivation (Marker, Image and Object) 16 : Cloud Recognition Auto Deactivation (Cloud Recognizer) 16 : Cloud Recognition Auto Activation (Cloud Recognizer) More...
 

Public Member Functions

void SetCloudRecognitionSecretIdAndSecretKey (string secretId, string secretKey)
 Set secret ID and key for access of cloud recognition. More...
 
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...
 
bool IsFusionSupported ()
 Get the device supports Fusion. More...
 
void RequestARCoreApk ()
 
int GetFusionTrackingState ()
 Get tracking fusion state. More...
 
void SetVocabulary (string vocFilename, bool isAndroidAssetFile=false)
 Set Vocabulary. 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...
 
void FindImageOfCloudRecognition ()
 Find Cloud Image (works on Cloud Recognizer) Must to set CLOUD_RECOGNITION_AUTO_DEACTIVATION at setTrackingOption Use before startTracker. 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...
 

Static 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...
 
const int TRACKER_TYPE_CLOUD_RECOGNIZER = 0x30
 Cloud Recognizer More...
 
const int TRACKER_TYPE_QR_TRACKER = 0x40
 QRCode Tracker More...
 
const int TRACKER_TYPE_IMAGE_FUSION = 0x80
 Image Fusion Tracker (need ARKit, ARCore) More...
 
const int TRACKER_TYPE_OBJECT_FUSION = 0X100
 Object Fusion Tracker (need ARKit, ARCore) More...
 
const int TRACKER_TYPE_QR_FUSION = 0x400
 QRCode Fusion Tracker (need ARKit, ARCore) More...
 
const int TRACKER_TYPE_MARKER_FUSION = 0x800
 Marker Fusion Tracker (need ARKit, ARCore) More...
 
const int TRACKER_TYPE_INSTANT_FUSION = 0x10000
 Instant Fusion Tracker (need ARKit, ARCore) More...
 

Detailed Description

Control AR Engine (Singletone)

Member Enumeration Documentation

◆ TrackingOption

Additional tracking option 1 : Normal Tracking (Image tracker only) 2 : Extended Tracking (Image tracker only) 4 : Multi Target Tracking (Image tracker only) 8 : Jitter Reduction Activation (Marker, Image and Object) 16 : Jitter Reduction Deactivation (Marker, Image and Object) 16 : Cloud Recognition Auto Deactivation (Cloud Recognizer) 16 : Cloud Recognition Auto Activation (Cloud Recognizer)

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

CLOUD_RECOGNITION_AUTO_DEACTIVATION 

Cloud Recognition Auto Deactivation

CLOUD_RECOGNITION_AUTO_ACTIVATION 

Cloud Recognition Auto Activation

ENHANCED_MODE 

Enhanced tracking

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.

◆ DestroyTracker()

void maxstAR.TrackerManager.DestroyTracker ( )

Destroy Tracker.

◆ FindImageOfCloudRecognition()

void maxstAR.TrackerManager.FindImageOfCloudRecognition ( )

Find Cloud Image (works on Cloud Recognizer) Must to set CLOUD_RECOGNITION_AUTO_DEACTIVATION at setTrackingOption Use before startTracker.

◆ FindSurface()

void maxstAR.TrackerManager.FindSurface ( )

Start SLAM learning.

◆ GetFusionTrackingState()

int maxstAR.TrackerManager.GetFusionTrackingState ( )

Get tracking fusion state.

Returns
tracking status 'Success' is 1 or not -1

◆ GetGuideInfo()

GuideInfo maxstAR.TrackerManager.GetGuideInfo ( )

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

Returns
SurfaceMesh instance

◆ GetInstance()

static TrackerManager maxstAR.TrackerManager.GetInstance ( )
static

Get TrackerManager instance

Returns

◆ GetTrackingState()

TrackingState maxstAR.TrackerManager.GetTrackingState ( )

Get saved TrackingState value

Returns
TrackingState instance

◆ 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

◆ IsFusionSupported()

bool maxstAR.TrackerManager.IsFusionSupported ( )

Get the device supports Fusion.

Returns
true if device supports Fusion.

◆ IsTrackerDataLoadCompleted()

bool maxstAR.TrackerManager.IsTrackerDataLoadCompleted ( )

Check that the Trackable data loading is finished.

Returns
Return map loading status. True is completed.

◆ LoadTrackerData()

void maxstAR.TrackerManager.LoadTrackerData ( )

Load the Trackable data.

◆ QuitFindingSurface()

void maxstAR.TrackerManager.QuitFindingSurface ( )

SLAM stops learning.

◆ 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

◆ 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.

◆ SetCloudRecognitionSecretIdAndSecretKey()

void maxstAR.TrackerManager.SetCloudRecognitionSecretIdAndSecretKey ( string  secretId,
string  secretKey 
)

Set secret ID and key for access of cloud recognition.

Parameters
secretIdsecret ID
secretKeysecret key

◆ SetTrackingOption()

void maxstAR.TrackerManager.SetTrackingOption ( TrackingOption  trackingOption)

Change Image Tracke Mode.

◆ SetVocabulary()

void maxstAR.TrackerManager.SetVocabulary ( string  vocFilename,
bool  isAndroidAssetFile = false 
)

Set Vocabulary.

◆ StartTracker()

void maxstAR.TrackerManager.StartTracker ( int  trackerType)

Start Tracker.

Parameters
trackerTypeBit mask of tracker type.

◆ StopTracker()

void maxstAR.TrackerManager.StopTracker ( )

Stop Tracker.

◆ UpdateTrackingState()

TrackingState maxstAR.TrackerManager.UpdateTrackingState ( )

Upate tracking state. This function should be called before GetTrackingResult

Returns
TrackingState instance

Member Data Documentation

◆ TRACKER_TYPE_CLOUD_RECOGNIZER

const int maxstAR.TrackerManager.TRACKER_TYPE_CLOUD_RECOGNIZER = 0x30
static

Cloud Recognizer

◆ TRACKER_TYPE_CODE_SCANNER

const int maxstAR.TrackerManager.TRACKER_TYPE_CODE_SCANNER = 0X01
static

Code scanner

◆ TRACKER_TYPE_IMAGE

const int maxstAR.TrackerManager.TRACKER_TYPE_IMAGE = 0X02
static

Planar image Tracker

◆ TRACKER_TYPE_IMAGE_FUSION

const int maxstAR.TrackerManager.TRACKER_TYPE_IMAGE_FUSION = 0x80
static

Image Fusion Tracker (need ARKit, ARCore)

◆ TRACKER_TYPE_INSTANT

const int maxstAR.TrackerManager.TRACKER_TYPE_INSTANT = 0x20
static

Instant Tracker

◆ TRACKER_TYPE_INSTANT_FUSION

const int maxstAR.TrackerManager.TRACKER_TYPE_INSTANT_FUSION = 0x10000
static

Instant Fusion Tracker (need ARKit, ARCore)

◆ TRACKER_TYPE_MARKER

const int maxstAR.TrackerManager.TRACKER_TYPE_MARKER = 0X04
static

Marker Tracker

◆ TRACKER_TYPE_MARKER_FUSION

const int maxstAR.TrackerManager.TRACKER_TYPE_MARKER_FUSION = 0x800
static

Marker Fusion Tracker (need ARKit, ARCore)

◆ TRACKER_TYPE_OBJECT

const int maxstAR.TrackerManager.TRACKER_TYPE_OBJECT = 0X08
static

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

◆ TRACKER_TYPE_OBJECT_FUSION

const int maxstAR.TrackerManager.TRACKER_TYPE_OBJECT_FUSION = 0X100
static

Object Fusion Tracker (need ARKit, ARCore)

◆ TRACKER_TYPE_QR_FUSION

const int maxstAR.TrackerManager.TRACKER_TYPE_QR_FUSION = 0x400
static

QRCode Fusion Tracker (need ARKit, ARCore)

◆ TRACKER_TYPE_QR_TRACKER

const int maxstAR.TrackerManager.TRACKER_TYPE_QR_TRACKER = 0x40
static

QRCode Tracker

◆ TRACKER_TYPE_SLAM

const int maxstAR.TrackerManager.TRACKER_TYPE_SLAM = 0x10
static

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


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