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

Public Attributes

VuObserverdevicePoseObserver
 Pointer to a device pose observer.
 
const char * databasePath
 Path to database containing targets.
 
const char * targetName
 Target name.
 
VuBool activate
 Observer activation.
 
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 requireExternalPositions
 Require external positions to be set before the observer will begin tracking or recover from loss of tracking.
 

Detailed Description

Configuration for creating an Area Target observer.

Member Data Documentation

◆ devicePoseObserver

VuObserver* devicePoseObserver

Pointer to a device pose observer.

The Area Target observer will only report observations to the state while there is an active device pose observer.

◆ activate

VuBool activate

Observer activation.

Note
The default value is VU_TRUE.

◆ 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 identity matrix.

◆ requireExternalPositions

VuBool requireExternalPositions

Require external positions to be set before the observer will begin tracking or recover from loss of tracking.

If this option is set to VU_TRUE, then the target is forced to wait for an external position before loading any target data. This enables simultaneous activation of many targets without the usual restrictions on the total size of the activated targets, since the external position can be used as a hint to limit the data loaded from each target.

The limitation of this setting is that it will not be possible to detect the target until a valid external position has been received. This is also the case after an extended loss of tracking, e.g. after pausing the app and moving to a new location.

Note
The external position should be set using either vuAreaTargetObserverSetExternalPositionFrom2D() or vuAreaTargetObserverSetExternalPositionFrom3D().
Activation of multiple Area Targets is only possible if this setting is consistent for all the targets being activated.
Some targets do not support setting this option to VU_FALSE, e.g. targets that are too large to be fully loaded into memory. This will result in a VU_AREA_TARGET_CREATION_ERROR_REQUIRES_EXTERNAL_POSITIONS creation error.
Area Targets created with Vuforia Engine 9.4 or earlier do not support setting this option to VU_TRUE. This will result in a VU_AREA_TARGET_CREATION_ERROR_INTERNAL creation error.
This option defaults to VU_FALSE.