C++ Java Unity
Unity Reference
ImageTargetFinder Class Reference

This class represents a service that retrieves image targets using cloud-based recognition. More...

Inheritance diagram for ImageTargetFinder:
TargetFinder

Public Member Functions

 ImageTargetFinder (IntPtr targetFinderPtr)
 
bool StartInit (string userAuth, string secretAuth)
 Starts initialization of the cloud-based recognition system. More...
 
- Public Member Functions inherited from TargetFinder
void ClearTrackables (bool destroyGameObjects=true)
 Clears all targets enabled for tracking More...
 
bool Deinit ()
 Deinitializes the cloud-based recognition system More...
 
TrackableBehaviour EnableTracking (TargetSearchResult result, string gameObjectName)
 Enable this search result for tracking More...
 
TrackableBehaviour EnableTracking (TargetSearchResult result, GameObject gameObject)
 Enable this search result for tracking. More...
 
InitState GetInitState ()
 Returns the current state of the initialization process More...
 
IEnumerable< ObjectTargetGetObjectTargets ()
 Returns the Object Targets currently enabled for tracking. More...
 
IEnumerable< TargetSearchResultGetResults ()
 Returns new search results More...
 
bool IsRequesting ()
 Returns true if the TargetFinder is in 'requesting' mode More...
 
bool StartRecognition ()
 Starts cloud recognition More...
 
bool Stop ()
 Stops cloud recognition More...
 
UpdateState Update ()
 Update cloud reco results More...
 
UpdateState Update (FilterMode filterMode)
 Update cloud reco results More...
 

Additional Inherited Members

- Public Types inherited from TargetFinder
enum  FilterMode {
  FILTER_NONE = 0,
  FILTER_CURRENTLY_TRACKED = 1
}
 Filter modes to be passed into Update() function More...
 
enum  InitState {
  INIT_DEFAULT = 0,
  INIT_RUNNING = 1,
  INIT_SUCCESS = 2,
  INIT_ERROR_NO_NETWORK_CONNECTION = -1,
  INIT_ERROR_SERVICE_NOT_AVAILABLE = -2,
  INIT_ERROR_DEVICE_DATABASE_ERROR = -3
}
 Status codes returned by the init() function More...
 
enum  UpdateState {
  UPDATE_NO_MATCH = 0,
  UPDATE_NO_REQUEST = 1,
  UPDATE_RESULTS_AVAILABLE = 2,
  UPDATE_ERROR_AUTHORIZATION_FAILED = -1,
  UPDATE_ERROR_PROJECT_SUSPENDED = -2,
  UPDATE_ERROR_NO_NETWORK_CONNECTION = -3,
  UPDATE_ERROR_SERVICE_NOT_AVAILABLE = -4,
  UPDATE_ERROR_BAD_FRAME_QUALITY = -5,
  UPDATE_ERROR_UPDATE_SDK = -6,
  UPDATE_ERROR_TIMESTAMP_OUT_OF_RANGE = -7,
  UPDATE_ERROR_REQUEST_TIMEOUT = -8
}
 Status codes returned by the Update() function More...
 

Detailed Description

This class represents a service that retrieves image targets using cloud-based recognition.

Constructor & Destructor Documentation

ImageTargetFinder ( IntPtr  targetFinderPtr)

Member Function Documentation

bool StartInit ( string  userAuth,
string  secretAuth 
)

Starts initialization of the cloud-based recognition system.

Initialization of the cloud-based recognition system may take significant time and is thus handled in a background process. Use GetInitState() to query the initialization progress and result. Pass in the user/password for authenticating with the cloud reco server.