All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
ImageTargetObserver.h File Reference

Observer for the Image Target feature. More...

Classes

struct  VuImageTargetConfig
 Configuration for Image Target using a database target. More...
 
struct  VuImageTargetFileConfig
 Configuration for Image Target using a File input. More...
 
struct  VuImageTargetBufferConfig
 Configuration for creating an Image Target using an image buffer. More...
 
struct  VuImageTargetObservationTargetInfo
 Target info for an Image Target from its respective observation. More...
 

Enumerations

enum  VuImageTargetCreationError : int32_t {
  VU_IMAGE_TARGET_CREATION_ERROR_NONE = 0x0 ,
  VU_IMAGE_TARGET_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_IMAGE_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_IMAGE_TARGET_CREATION_ERROR_DATABASE_LOAD_ERROR = 0x3 ,
  VU_IMAGE_TARGET_CREATION_ERROR_INVALID_TARGET_NAME = 0x4 ,
  VU_IMAGE_TARGET_CREATION_ERROR_TARGET_NOT_FOUND ,
  VU_IMAGE_TARGET_CREATION_ERROR_INVALID_SCALE = 0x6 ,
  VU_IMAGE_TARGET_CREATION_ERROR_DATABASE_XML_REQUIRED
}
 Configuration error for Image Target creation. More...
 
enum  VuImageTargetBufferCreationError : int32_t {
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_NONE = 0x0 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_INVALID_DATA = 0x4 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_INVALID_FORMAT ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_INVALID_SIZE = 0x6 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_INVALID_TARGET_WIDTH = 0x7 ,
  VU_IMAGE_TARGET_BUFFER_CREATION_ERROR_INVALID_TARGET_NAME = 0x8
}
 Configuration error for Image Target creation with buffer config. More...
 
enum  VuImageTargetFileCreationError : int32_t {
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_NONE = 0x0 ,
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_FILE_LOAD_ERROR = 0x4 ,
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_INVALID_TARGET_WIDTH = 0x5 ,
  VU_IMAGE_TARGET_FILE_CREATION_ERROR_INVALID_TARGET_NAME = 0x6
}
 Configuration error for Image Target creation with file config. More...
 
enum  VuImageTargetObservationStatusInfo : int32_t {
  VU_IMAGE_TARGET_OBSERVATION_STATUS_INFO_NORMAL ,
  VU_IMAGE_TARGET_OBSERVATION_STATUS_INFO_NOT_OBSERVED ,
  VU_IMAGE_TARGET_OBSERVATION_STATUS_INFO_RELOCALIZING
}
 Status info for the pose of Image Target observations. More...
 
enum  { VU_OBSERVER_IMAGE_TARGET_TYPE = 0x1 }
 
enum  { VU_OBSERVATION_IMAGE_TARGET_TYPE = 0x1 }
 

Functions

VuImageTargetConfig vuImageTargetConfigDefault ()
 Default Image Target configuration.
 
VuImageTargetFileConfig vuImageTargetFileConfigDefault ()
 Default Image Target file configuration.
 
VuImageTargetBufferConfig vuImageTargetBufferConfigDefault ()
 Configuration for an Image Target using a Cloud Image Target observation.
 
VuResult vuEngineCreateImageTargetObserver (VuEngine *engine, VuObserver **observer, const VuImageTargetConfig *config, VuImageTargetCreationError *errorCode)
 Create an Image Target observer from database.
 
VuResult vuEngineCreateImageTargetObserverFromFileConfig (VuEngine *engine, VuObserver **observer, const VuImageTargetFileConfig *config, VuImageTargetFileCreationError *errorCode)
 Create an Image Target observer from file configuration.
 
VuResult vuEngineCreateImageTargetObserverFromBufferConfig (VuEngine *engine, VuObserver **observer, const VuImageTargetBufferConfig *config, VuImageTargetBufferCreationError *errorCode)
 Create an Image Target observer from buffer configuration.
 
VuResult vuEngineGetImageTargetObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all Image Target observers.
 
VuResult vuImageTargetObserverGetTargetUniqueId (const VuObserver *observer, const char **targetId)
 Get the unique ID associated to an Image Target from its respective observer.
 
VuResult vuImageTargetObserverGetTargetName (const VuObserver *observer, const char **targetName)
 Get the name associated to an Image Target from its respective observer.
 
VuResult vuImageTargetObserverGetAABB (const VuObserver *observer, VuAABB *bbox)
 Get the axis-aligned bounding box associated to an Image Target from its respective observer, relative to the target's frame of reference.
 
VuResult vuImageTargetObserverGetTargetSize (const VuObserver *observer, VuVector2F *size)
 Get the size in meters associated with an Image Target from its respective observer.
 
VuResult vuImageTargetObserverSetTargetScale (VuObserver *observer, float scale)
 Re-scale the size of an Image Target via its respective observer.
 
VuResult vuImageTargetObserverGetTargetPoseOffset (const VuObserver *observer, VuMatrix44F *poseOffset)
 Get the pose transformation offset associated with an Image Target from its respective observer.
 
VuResult vuImageTargetObserverSetTargetPoseOffset (VuObserver *observer, const VuMatrix44F *poseOffset)
 Set the pose transformation offset associated with an Image Target via its respective observer.
 
VuResult vuImageTargetObserverSetTrackingOptimization (VuObserver *observer, VuTrackingOptimization optimization)
 Set the tracking optimization of the target associated to the Image Target observer.
 
VuResult vuImageTargetObserverGetTrackingOptimization (const VuObserver *observer, VuTrackingOptimization *optimization)
 Get the tracking optimization of the target associated to the Image Target observer.
 
VuResult vuEngineSetMaximumSimultaneousTrackedImages (VuEngine *engine, int32_t maxNumberOfTargets)
 Set the maximum number of image-based targets tracked at the same time.
 
VuResult vuEngineGetMaximumSimultaneousTrackedImages (const VuEngine *engine, int32_t *maxNumberOfTargets)
 Get the maximum number of image-based targets tracked at the same time.
 
VuResult vuStateGetImageTargetObservations (const VuState *state, VuObservationList *list)
 Get all Image Target observations.
 
VuResult vuImageTargetObservationGetTargetInfo (const VuObservation *observation, VuImageTargetObservationTargetInfo *targetInfo)
 Get target info associated with an Image Target observation.
 
VuResult vuImageTargetObservationGetStatusInfo (const VuObservation *observation, VuImageTargetObservationStatusInfo *statusInfo)
 Get status info associated to the pose status of an Image Target observation.
 

Detailed Description

Observer for the Image Target feature.