Classes | |
struct | VuAreaTargetConfig |
Configuration for creating an Area Target observer. More... | |
struct | VuAreaTargetCloudConfig |
Configuration for creating an Area Target observer working with Cloud Area Target. More... | |
struct | VuAreaTargetObservationTargetInfo |
Target info for Area Target from its respective observation. More... | |
Functions | |
VuAreaTargetConfig | vuAreaTargetConfigDefault () |
Default Area Target configuration. | |
VuAreaTargetCloudConfig | vuAreaTargetCloudConfigDefault () |
Default Area Target Cloud configuration. | |
VuResult | vuEngineCreateAreaTargetObserver (VuEngine *engine, VuObserver **observer, const VuAreaTargetConfig *config, VuAreaTargetCreationError *errorCode) |
Create an Area Target observer from database. | |
VuResult | vuEngineCreateAreaTargetObserverFromCloudConfig (VuEngine *engine, VuObserver **observer, const VuAreaTargetCloudConfig *config, VuAreaTargetCloudCreationError *errorCode) |
Create an Area Target observer for a Cloud Area Target. | |
VuResult | vuEngineGetAreaTargetObservers (const VuEngine *engine, VuObserverList *observerList) |
Get all Area Target observers. | |
VuResult | vuAreaTargetObserverGetTargetUniqueId (const VuObserver *observer, const char **targetId) |
Get the unique ID associated to the target from an Area Target observer. | |
VuResult | vuAreaTargetObserverGetTargetName (const VuObserver *observer, const char **targetName) |
Get the name associated to the target from an Area Target observer. | |
VuResult | vuAreaTargetObserverGetTargetSize (const VuObserver *observer, VuVector3F *size) |
Get the size in meters associated to the target from an Area Target observer. | |
VuResult | vuAreaTargetObserverGetTargetPoseOffset (const VuObserver *observer, VuMatrix44F *offset) |
Get the pose transformation offset associated to the target from an Area Target observer. | |
VuResult | vuAreaTargetObserverSetTargetPoseOffset (VuObserver *observer, const VuMatrix44F *poseOffset) |
Set the pose transformation offset associated to the target from an Area Target observer. | |
VuResult | vuAreaTargetObserverGetAABB (const VuObserver *observer, VuAABB *bbox) |
Get the axis-aligned bounding box associated to the target from an Area Target observer, relative to the target's frame of reference. | |
VuResult | vuAreaTargetObserverSetExternalPosition (VuObserver *observer, VuVector2F position, float horizontalAccuracy) |
Set approximate 2D position within an Area Target from an external localization source (DEPRECATED) | |
VuResult | vuAreaTargetObserverSetExternalPositionFrom2D (VuObserver *observer, VuVector2F position, float horizontalAccuracy) |
Set approximate 2D position within an Area Target from an external localization source. | |
VuResult | vuAreaTargetObserverSetExternalPositionFrom3D (VuObserver *observer, VuVector3F position, float horizontalAccuracy, float verticalAccuracy) |
Set approximate 3D position within an Area Target from an external localization source. | |
VuResult | vuAreaTargetObserverRequiresExternalPositions (const VuObserver *observer, VuBool *requiresExternalPositions) |
Check whether the target requires external positions for initial detection. | |
VuResult | vuStateGetAreaTargetObservations (const VuState *state, VuObservationList *observationList) |
Get all Area Target observations. | |
VuResult | vuAreaTargetObservationGetStatusInfo (const VuObservation *observation, VuAreaTargetObservationStatusInfo *statusInfo) |
Get status info associated to the pose status of an Area Target observation. | |
VuResult | vuAreaTargetObservationGetTargetInfo (const VuObservation *observation, VuAreaTargetObservationTargetInfo *targetInfo) |
Get target info associated with an Area Target observation. | |
VuResult | vuEngineClearAreaTargetObserverCloudCache (VuEngine *engine) |
Remove all data cached by Area Target observers. | |
enum VuAreaTargetCreationError : int32_t |
Configuration error for Area Target creation from VuAreaTargetConfig.
Enumerator | |
---|---|
VU_AREA_TARGET_CREATION_ERROR_NONE | No error. |
VU_AREA_TARGET_CREATION_ERROR_INTERNAL | An internal error occurred while creating the observer. |
VU_AREA_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED | Observer auto-activation failed (probably due to the total target size limit) |
VU_AREA_TARGET_CREATION_ERROR_FEATURE_NOT_SUPPORTED | Feature not supported (e.g. if Vuforia is not running on a platform-based Fusion Provider such as ARKit, ARCore) |
VU_AREA_TARGET_CREATION_ERROR_INVALID_DEVICE_POSE_OBSERVER | Device pose observer is null or invalid. |
VU_AREA_TARGET_CREATION_ERROR_DATABASE_LOAD_ERROR | Database file not found or an error occurred when reading data from it (potentially unknown or corrupted file) |
VU_AREA_TARGET_CREATION_ERROR_INVALID_TARGET_NAME | Invalid target name. |
VU_AREA_TARGET_CREATION_ERROR_TARGET_NOT_FOUND | Target with the specified name AND matching target type for this observer not found in database. |
VU_AREA_TARGET_CREATION_ERROR_REQUIRES_EXTERNAL_POSITIONS | This target does not support the default loading and detection behavior. The requireExternalPositions option in VuAreaTargetConfig must be set to VU_TRUE to use this target. |
enum VuAreaTargetCloudCreationError : int32_t |
Configuration error for Area Target creation from VuAreaTargetCloudConfig.
Enumerator | |
---|---|
VU_AREA_TARGET_CLOUD_CREATION_ERROR_NONE | No error. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_INTERNAL | An internal error occurred while creating the observer. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_AUTOACTIVATION_FAILED | Observer auto-activation failed (probably due to the total target size limit) |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_FEATURE_NOT_SUPPORTED | Feature not supported (e.g. if Vuforia is not running on a platform-based Fusion Provider such as ARKit, ARCore) |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_TARGET_NOT_FOUND | Cloud Area Target under the given targetId was not found. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_REQUIRES_EXTERNAL_POSITIONS | This target does not support the default loading and detection behavior. The requireExternalPositions option in VuAreaTargetCloudConfig must be set to VU_TRUE to use this target. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_AUTHENTICATION_FAILED | Failed to authenticate with the Cloud Area Target service. Verify the provided credentials. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_NETWORK_TIMEOUT | A request time out occured while we tried to contact the server. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_NETWORK_CERTIFICATE_ERROR | A certificate error occured while establishing a secure connection. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_NETWORK_DOMAIN_NAME_RESOLUTION_FAILED | A domain name resolution via the DNS service failed. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_NO_NETWORK_CONNECTION | Device has no connection to the internet. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_NETWORK_ERROR | Communication with the server failed for other reason (not listed here). Consult the device network status or device logs for further details. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_TARGET_NOT_READY | The target is not in "ready" status. The target is likely still generating. Try again later. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_SERVICE_NOT_AVAILABLE | Vuforia Engine Cloud services are not available at this moment. Please try again later. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED | Area target observer for this Cloud Area Target ID already exists. |
VU_AREA_TARGET_CLOUD_CREATION_ERROR_INVALID_DEVICE_POSE_OBSERVER | Device pose observer is null or invalid. |
enum VuAreaTargetObservationStatusInfo : int32_t |
Status info for the pose of Area Target observations.
Provides further information on the pose status reported as part of VuPoseInfo. The status info is retrieved with vuAreaTargetObservationGetStatusInfo.
Enumerator | |
---|---|
VU_AREA_TARGET_OBSERVATION_STATUS_INFO_NORMAL | Tracking is working normally. Reported for VU_OBSERVATION_POSE_STATUS_EXTENDED_TRACKED. |
VU_AREA_TARGET_OBSERVATION_STATUS_INFO_NOT_OBSERVED | Target is not observed. Reported for VU_OBSERVATION_POSE_STATUS_NO_POSE. |
VU_AREA_TARGET_OBSERVATION_STATUS_INFO_RELOCALIZING | The tracking system is currently relocalizing. Reported for VU_OBSERVATION_POSE_STATUS_LIMITED. |
VU_AREA_TARGET_OBSERVATION_STATUS_INFO_MISSING_DATA | Asynchronous loading of the tracking data failed. Tracking quality might decrease or the tracking might be lost. Reported for VU_OBSERVATION_POSE_STATUS_LIMITED. |
anonymous enum |
VuAreaTargetConfig vuAreaTargetConfigDefault | ( | ) |
Default Area Target configuration.
VuAreaTargetCloudConfig vuAreaTargetCloudConfigDefault | ( | ) |
Default Area Target Cloud configuration.
VuResult vuEngineCreateAreaTargetObserver | ( | VuEngine * | engine, |
VuObserver ** | observer, | ||
const VuAreaTargetConfig * | config, | ||
VuAreaTargetCreationError * | errorCode ) |
Create an Area Target observer from database.
VuResult vuEngineCreateAreaTargetObserverFromCloudConfig | ( | VuEngine * | engine, |
VuObserver ** | observer, | ||
const VuAreaTargetCloudConfig * | config, | ||
VuAreaTargetCloudCreationError * | errorCode ) |
Create an Area Target observer for a Cloud Area Target.
The Area Target observer will store certain data of Cloud Area Targets locally to improve the experience and optimize the number of network transfers. The target data will be stored in a platform-specific cache directory that may persist across Vuforia Engine sessions. The system may delete the cache directory to free up disk space, but outside these relatively rare events the data will be persistent.
Use vuEngineClearAreaTargetObserverCloudCache to delete this cache directory manually when the stored Cloud Area Target data is no longer needed.
VuResult vuAreaTargetObserverGetTargetPoseOffset | ( | const VuObserver * | observer, |
VuMatrix44F * | offset ) |
Get the pose transformation offset associated to the target from an Area Target observer.
VuResult vuAreaTargetObserverSetTargetPoseOffset | ( | VuObserver * | observer, |
const VuMatrix44F * | poseOffset ) |
Set the pose transformation offset associated to the target from an Area Target observer.
VuResult vuAreaTargetObserverSetExternalPosition | ( | VuObserver * | observer, |
VuVector2F | position, | ||
float | horizontalAccuracy ) |
Set approximate 2D position within an Area Target from an external localization source (DEPRECATED)
Setting up the external position only succeeds when the target is activated.
observer | Observer handle |
position | Position (x, z) in target coordinate system (which is y-up). |
horizontalAccuracy | Horizontal accuracy (radial) of the position in meters. Must be positive. |
VuResult vuAreaTargetObserverSetExternalPositionFrom2D | ( | VuObserver * | observer, |
VuVector2F | position, | ||
float | horizontalAccuracy ) |
Set approximate 2D position within an Area Target from an external localization source.
Setting up the external position only succeeds when the target is activated.
observer | Observer handle |
position | Position (x, z) in target coordinate system (which is y-up). |
horizontalAccuracy | Horizontal accuracy (radial) of the position in meters. Must be positive. |
VuResult vuAreaTargetObserverSetExternalPositionFrom3D | ( | VuObserver * | observer, |
VuVector3F | position, | ||
float | horizontalAccuracy, | ||
float | verticalAccuracy ) |
Set approximate 3D position within an Area Target from an external localization source.
Setting up the external position only succeeds when the target is activated.
observer | Observer handle |
position | Position (x, y, z) in target coordinate system (which is y-up). |
horizontalAccuracy | Horizontal accuracy (radial) of the position in meters. Must be positive. |
verticalAccuracy | Vertical accuracy of the position in meters. Must be positive. |
VuResult vuAreaTargetObserverRequiresExternalPositions | ( | const VuObserver * | observer, |
VuBool * | requiresExternalPositions ) |
Check whether the target requires external positions for initial detection.
Checks the value of the requireExternalPositions option in VuAreaTargetConfig. If a target requires external positions, then it will not be detected until an external position is provided. This is also the case after an extended loss of tracking, e.g. after pausing the app and moving to a new location.
observer | Observer handle |
requiresExternalPositions | Gives VU_TRUE if the target needs external positions for initial detection or after extended loss of tracking, VU_FALSE otherwise. |
VuResult vuAreaTargetObservationGetStatusInfo | ( | const VuObservation * | observation, |
VuAreaTargetObservationStatusInfo * | statusInfo ) |
Get status info associated to the pose status of an Area Target observation.
The status info is intended to be used in combination with VuObservationPoseStatus retrieved via vuObservationGetPoseInfo.
Remove all data cached by Area Target observers.
Use this function to decrease the disk space usage by removing all Cloud Area Target data cached by Area Target observer.