C++ Java Unity
Unity Reference
ObjectRecoBehaviour Class Referenceabstract

This is the base class that encapsulates generic "object recognition" behaviour, such as Cloud Reocgnition of Image Targets and Model Recognition. Specialized implementations of Cloud Recognition and Model Recognition are in their respective classes. More...

Inheritance diagram for ObjectRecoBehaviour:
VuforiaMonoBehaviour CloudRecoBehaviour

Public Member Functions

void RegisterEventHandler (IObjectRecoEventHandler eventHandler)
 Registers an event handler with this ObjectRecoBehaviour which will be called on events More...
 
void RegisterOnInitErrorEventHandler (Action< TargetFinder.InitState > handler)
 Register for event that's called when an error is reported during initialization More...
 
void RegisterOnInitializedEventHandler (Action< TargetFinder > handler)
 Register for event that's called when the RecoBehaviour has finished initializing More...
 
void RegisterOnNewSearchResultEventHandler (Action< TargetFinder.TargetSearchResult > handler)
 Register for event that's called when a new search result is found More...
 
void RegisterOnStateChangedEventHandler (Action< bool > handler)
 Register for event that's called when the RecoBehaviour starts or stops scanning More...
 
void RegisterOnUpdateErrorEventHandler (Action< TargetFinder.UpdateState > handler)
 Register for event that's called when an error is reported while updating More...
 
bool UnregisterEventHandler (IObjectRecoEventHandler eventHandler)
 Unregisters an event handler More...
 
bool UnregisterOnInitErrorEventHandler (Action< TargetFinder.InitState > handler)
 Unregister from event that's called when an error is reported during initialization More...
 
bool UnregisterOnInitializedEventHandler (Action< TargetFinder > handler)
 Unregister from event that's called when the RecoBehaviour has finished initializing More...
 
bool UnregisterOnNewSearchResultEventHandler (Action< TargetFinder.TargetSearchResult > handler)
 Unregister from event that's called when a new search result is found More...
 
bool UnregisterOnStateChangedEventHandler (Action< bool > handler)
 Unregister from event that's called when the RecoBehaviour starts or stops scanning More...
 
bool UnregisterOnUpdateErrorEventHandler (Action< TargetFinder.UpdateState > handler)
 Unregister from event that's called when an error is reported while updating More...
 

Protected Member Functions

abstract void Deinitialize ()
 
abstract void Initialize ()
 Initializes the TargetFinder More...
 
abstract bool IsRecoAvailable ()
 

Protected Attributes

bool mCurrentlyInitializing = false
 
bool mInitSuccess = false
 
ObjectTracker mObjectTracker
 
TargetFinder mTargetFinder
 

Properties

bool RecoEnabled [get, set]
 If cloud has been enabled in the menu More...
 
bool RecoInitialized [get]
 If cloud reco has been initialized yet More...
 

Detailed Description

This is the base class that encapsulates generic "object recognition" behaviour, such as Cloud Reocgnition of Image Targets and Model Recognition. Specialized implementations of Cloud Recognition and Model Recognition are in their respective classes.

Member Function Documentation

abstract void Deinitialize ( )
protectedpure virtual

Implemented in CloudRecoBehaviour.

abstract void Initialize ( )
protectedpure virtual

Initializes the TargetFinder

Implemented in CloudRecoBehaviour.

abstract bool IsRecoAvailable ( )
protectedpure virtual

Implemented in CloudRecoBehaviour.

void RegisterEventHandler ( IObjectRecoEventHandler  eventHandler)

Registers an event handler with this ObjectRecoBehaviour which will be called on events

void RegisterOnInitErrorEventHandler ( Action< TargetFinder.InitState handler)

Register for event that's called when an error is reported during initialization

void RegisterOnInitializedEventHandler ( Action< TargetFinder handler)

Register for event that's called when the RecoBehaviour has finished initializing

void RegisterOnNewSearchResultEventHandler ( Action< TargetFinder.TargetSearchResult handler)

Register for event that's called when a new search result is found

void RegisterOnStateChangedEventHandler ( Action< bool >  handler)

Register for event that's called when the RecoBehaviour starts or stops scanning

void RegisterOnUpdateErrorEventHandler ( Action< TargetFinder.UpdateState handler)

Register for event that's called when an error is reported while updating

bool UnregisterEventHandler ( IObjectRecoEventHandler  eventHandler)

Unregisters an event handler

bool UnregisterOnInitErrorEventHandler ( Action< TargetFinder.InitState handler)

Unregister from event that's called when an error is reported during initialization

bool UnregisterOnInitializedEventHandler ( Action< TargetFinder handler)

Unregister from event that's called when the RecoBehaviour has finished initializing

bool UnregisterOnNewSearchResultEventHandler ( Action< TargetFinder.TargetSearchResult handler)

Unregister from event that's called when a new search result is found

bool UnregisterOnStateChangedEventHandler ( Action< bool >  handler)

Unregister from event that's called when the RecoBehaviour starts or stops scanning

bool UnregisterOnUpdateErrorEventHandler ( Action< TargetFinder.UpdateState handler)

Unregister from event that's called when an error is reported while updating

Member Data Documentation

bool mCurrentlyInitializing = false
protected
bool mInitSuccess = false
protected
ObjectTracker mObjectTracker
protected
TargetFinder mTargetFinder
protected

Property Documentation

bool RecoEnabled
getset

If cloud has been enabled in the menu

bool RecoInitialized
get

If cloud reco has been initialized yet