All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
VuModelTargetConfig Struct Reference

Public Attributes

const char * databasePath
 Path to database containing targets.
 
const char * targetName
 Target name.
 
const char * activeGuideViewName
 Name of the Guide View to be active.
 
VuBool activate
 Observer activation.
 
float scale
 Scale multiplication factor.
 
VuMatrix44F poseOffset
 Offset from the origin of the target to the pose reported by an observation, relative to the target's frame of reference.
 
VuBool enhanceRuntimeDetection
 Enhance detection performance by caching local detection data for the model target.
 

Detailed Description

Configuration for creating a Model Target observer.

Member Data Documentation

◆ activeGuideViewName

const char* activeGuideViewName

Name of the Guide View to be active.

Set to NULL to keep the default Guide View defined for this Model Target in the database activated

Note
Advanced Model Targets do not support Guide Views and creation will fail if the value is not set to NULL.

◆ activate

VuBool activate

Observer activation.

Note
The default value is VU_TRUE.
If the Model Target observer was successfully activated, the active guide view's image is generated as well.
Model Target observers from different databases cannot be active at the same time. Observer creation will fail if "activate" is set to VU_TRUE while a Model Target observer from another database is active.

◆ scale

float scale

Scale multiplication factor.

Note
The default value is 1.0f.

◆ poseOffset

VuMatrix44F poseOffset

Offset from the origin of the target to the pose reported by an observation, relative to the target's frame of reference.

Note
The pose offset is represented as a pose matrix using the OpenGL convention. The default value is an identity matrix.

◆ enhanceRuntimeDetection

VuBool enhanceRuntimeDetection

Enhance detection performance by caching local detection data for the model target.

If this option is enabled, then local detection data captured during each tracking session of the target will be cached locally to enhance detection performance in future sessions.

If exists, the cached data is loaded into memory when the Model Target observer is created to enhance the observer's detection performance.

The cached data is updated when the Model Target observer is deactivated.

Calling vuModelTargetObserverReset - e.g. in case of tracking issues - will remove any existing cached data for a target. The caching will automatically restart if the the target is detected again. It is also possible to clear the cached data for all previously tracked Model Target observers to free up disk space. This can be done using the provided vuEngineClearModelTargetObserverDetectionCache function.

Note
The cached data is stored in the private storage location of the application in a folder named ModelTargetDetectionCache. The data for a specific target can be found in a subfolder named with the target unique ID. This can be acquired using the vuModelTargetObserverGetTargetUniqueId function.
While this feature primarily targets enhanced detection performance for untrained Model Targets, it is also available for Advanced Model Targets. Note that the effects of the enhanced detection performance might not be as prominent for Advanced Model Targets as for untrained Model Targets.
The cached data is updated asynchronuously when the Model Target observer is deactivated. An immediate call to vuObserverActivate must await any pending cache updates of the Model Target observer, potentially causing a delay during observer activation.
If a cache update fails due to insufficient free space, an error message will be logged. Vuforia Engine will not clear the Model Target detection cache automatically and it is up to the user to free up disk space on the device.
If the tracking optimization of the Model Target observer is set to VU_TRACKING_OPTIMIZATION_LOW_FEATURE_OBJECTS, then the target does not use or store detection data and will not benefit from enabling this option.
The default value is VU_FALSE.