All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Database Target info

Classes

struct  VuDatabaseTargetInfo
 Info about a target in a database. More...
 

Typedefs

typedef struct VuDatabaseTargetInfoList_ VuDatabaseTargetInfoList
 List for holding information about targets in database.
 

Enumerations

enum  VuDatabaseTargetInfoError : int32_t {
  VU_DATABASE_TARGET_INFO_ERROR_NONE = 0x0 ,
  VU_DATABASE_TARGET_INFO_ERROR_DATABASE_LOAD_ERROR = 0x1 ,
  VU_DATABASE_TARGET_INFO_ERROR_NO_TARGETS = 0x2 ,
  VU_DATABASE_TARGET_INFO_ERROR_DATABASE_XML_REQUIRED
}
 Database target info errors. More...
 

Functions

VuResult vuDatabaseTargetInfoListCreate (VuDatabaseTargetInfoList **list)
 Create a database target info list.
 
VuResult vuDatabaseTargetInfoListGetSize (const VuDatabaseTargetInfoList *list, int32_t *listSize)
 Get number of elements in database target info list.
 
VuResult vuDatabaseTargetInfoListGetElement (const VuDatabaseTargetInfoList *list, int32_t element, VuDatabaseTargetInfo *targetInfo)
 Get an element in a database target info list.
 
VuResult vuDatabaseTargetInfoListDestroy (VuDatabaseTargetInfoList *list)
 Destroy a database target info list.
 
VuResult vuEngineGetDatabaseTargetInfo (const VuEngine *engine, const char *databasePath, VuDatabaseTargetInfoList *targetInfos, VuDatabaseTargetInfoError *errorCode)
 Extract info on all targets from a database from which observers can be created.
 

Detailed Description

Utilities to extract information on all targets from a database from which observers can be created.

Enumeration Type Documentation

◆ VuDatabaseTargetInfoError

enum VuDatabaseTargetInfoError : int32_t

Database target info errors.

Enumerator
VU_DATABASE_TARGET_INFO_ERROR_NONE 

No error.

VU_DATABASE_TARGET_INFO_ERROR_DATABASE_LOAD_ERROR 

Could not find database file or read data from it (potentially unknown or corrupted file)

VU_DATABASE_TARGET_INFO_ERROR_NO_TARGETS 

Could not find any targets in the database from which an observer could be created.

VU_DATABASE_TARGET_INFO_ERROR_DATABASE_XML_REQUIRED 

The database contains targets that could not be loaded directly from the database's DAT file. Image Target or VuMark databases generated prior to Vuforia 10.15 must be loaded from the database's XML file. To query the target infos from this database, and subsequently create observers, either provide the database XML file instead or regenerate the database to the latest version.

Function Documentation

◆ vuEngineGetDatabaseTargetInfo()

VuResult vuEngineGetDatabaseTargetInfo ( const VuEngine * engine,
const char * databasePath,
VuDatabaseTargetInfoList * targetInfos,
VuDatabaseTargetInfoError * errorCode )

Extract info on all targets from a database from which observers can be created.

Note
Note that loading the database may take a significant amount of time, it is therefore recommended that this method is not called on the main/UI thread.