All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Step Check Feature

Classes

struct  VuValidationAreaFileConfig
 Configuration for creating a Validation Area observer using an image file. More...
 
struct  VuValidationAreaBufferConfig
 Configuration for creating a Validation Area observer using an image buffer. More...
 
struct  VuValidationAreaObservationAreaInfo
 Validation Area info from its respective observation. More...
 
struct  VuValidationAreaObservationValidationInfo
 Validation info of a Validation Area observation. More...
 

Enumerations

enum  VuValidationAreaFileCreationError : int32_t {
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_NONE = 0x0 ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_FEATURE_NOT_SUPPORTED_PLATFORM = 0x3 ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_FEATURE_NOT_SUPPORTED_LICENSE ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_PLUGIN_LOAD_ERROR = 0x5 ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_INVALID_AREA_NAME = 0x6 ,
  VU_VALIDATION_AREA_FILE_CREATION_ERROR_FILE_LOAD_ERROR
}
 Configuration error for Validation Area creation with file config. More...
 
enum  VuValidationAreaBufferCreationError : int32_t {
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_NONE = 0x0 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_FEATURE_NOT_SUPPORTED_PLATFORM = 0x3 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_FEATURE_NOT_SUPPORTED_LICENSE ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_PLUGIN_LOAD_ERROR = 0x5 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INVALID_AREA_NAME = 0x6 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INVALID_DATA = 0x7 ,
  VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INVALID_SIZE = 0x8
}
 Configuration error for Validation Area creation with buffer config. More...
 
enum  { VU_OBSERVER_VALIDATION_AREA_TYPE = 0x0E }
 
enum  { VU_OBSERVATION_VALIDATION_AREA_TYPE = 0x0E }
 
enum  VuValidationAreaObservationStatusInfo : int32_t {
  VU_VALIDATION_AREA_OBSERVATION_STATUS_INFO_NORMAL ,
  VU_VALIDATION_AREA_OBSERVATION_STATUS_INFO_NOT_OBSERVED ,
  VU_VALIDATION_AREA_OBSERVATION_STATUS_INFO_RELOCALIZING
}
 Status info for Validation Area observations. More...
 
enum  VuValidationAreaObservationValidationStatus : int32_t {
  VU_VALIDATION_AREA_OBSERVATION_VALIDATION_STATUS_NORMAL ,
  VU_VALIDATION_AREA_OBSERVATION_VALIDATION_STATUS_UNDECIDABLE
}
 Validation status for Validation Area observation. More...
 

Functions

VuValidationAreaFileConfig vuValidationAreaFileConfigDefault ()
 Default Validation Area from image file configuration.
 
VuResult vuEngineCreateValidationAreaObserverFromFileConfig (VuEngine *engine, VuObserver **observer, const VuValidationAreaFileConfig *config, VuValidationAreaFileCreationError *errorCode)
 Create Validation Area observer from file configuration.
 
VuValidationAreaBufferConfig vuValidationAreaBufferConfigDefault ()
 Configuration for an Validation Area from image buffer.
 
VuResult vuEngineCreateValidationAreaObserverFromBufferConfig (VuEngine *engine, VuObserver **observer, const VuValidationAreaBufferConfig *config, VuValidationAreaBufferCreationError *errorCode)
 Create Validation Area observer from buffer configuration.
 
VuResult vuEngineGetValidationAreaObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all Validation Area observers.
 
VuResult vuValidationAreaObserverGetUniqueId (const VuObserver *observer, const char **areaId)
 Get the unique ID associated to the area from a Validation Area observer.
 
VuResult vuValidationAreaObserverGetAreaName (const VuObserver *observer, const char **areaName)
 Get the name associated to the area from a Validation Area observer.
 
VuResult vuValidationAreaObserverGetSize (const VuObserver *observer, VuVector3F *size)
 Get the size in meters associated to the area from a Validation Area observer.
 
VuResult vuValidationAreaObserverGetPoseOffset (const VuObserver *observer, VuMatrix44F *poseOffset)
 Get the pose transformation offset associated to the area from a Validation Area observer.
 
VuResult vuValidationAreaObserverSetPoseOffset (VuObserver *observer, const VuMatrix44F *poseOffset)
 Set the pose transformation offset associated to the area from a Validation Area observer.
 
VuResult vuValidationAreaObservationGetAreaInfo (const VuObservation *observation, VuValidationAreaObservationAreaInfo *areaInfo)
 Get area info associated with a Validation Area observation.
 
VuResult vuValidationAreaObservationGetStatusInfo (const VuObservation *observation, VuValidationAreaObservationStatusInfo *statusInfo)
 Get status info associated to the pose status of a Validation Area observation.
 
VuResult vuValidationAreaObservationGetValidationInfo (const VuObservation *observation, VuValidationAreaObservationValidationInfo *validationInfo)
 Get validation info associated with a Validation Area observation.
 
VuResult vuStateGetValidationAreaObservations (const VuState *state, VuObservationList *list)
 Get all Validation Area observations.
 

Detailed Description

The Validation Area observer observes different appearances of a distinct area depicted in the provided image data.

Enumeration Type Documentation

◆ VuValidationAreaFileCreationError

Configuration error for Validation Area creation with file config.

Enumerator
VU_VALIDATION_AREA_FILE_CREATION_ERROR_NONE 

No error.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_AUTOACTIVATION_FAILED 

An error occurred while auto-activating the observer.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_FEATURE_NOT_SUPPORTED_PLATFORM 

Feature not supported on the current platform.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_FEATURE_NOT_SUPPORTED_LICENSE 

Feature not supported without an appropriate Vuforia license.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_PLUGIN_LOAD_ERROR 

Failed to load plugin necessary for this feature.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_INVALID_AREA_NAME 

Invalid Validation Area name.

VU_VALIDATION_AREA_FILE_CREATION_ERROR_FILE_LOAD_ERROR 

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

◆ VuValidationAreaBufferCreationError

Configuration error for Validation Area creation with buffer config.

Enumerator
VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_NONE 

No error.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INTERNAL 

An internal error occurred during observer creation.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_AUTOACTIVATION_FAILED 

Observer auto-activation failed.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_FEATURE_NOT_SUPPORTED_PLATFORM 

Feature not supported on the current platform.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_FEATURE_NOT_SUPPORTED_LICENSE 

Feature not supported without an appropriate Vuforia license.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_PLUGIN_LOAD_ERROR 

Failed to load plugin necessary for this feature.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INVALID_AREA_NAME 

Invalid Validation Area name.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INVALID_DATA 

Invalid pixel data buffer pointer.

VU_VALIDATION_AREA_BUFFER_CREATION_ERROR_INVALID_SIZE 

Invalid pixel buffer size.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVER_VALIDATION_AREA_TYPE 

Type identifier for Validation Area observers.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVATION_VALIDATION_AREA_TYPE 

Type identifier for Validation Area observations.

◆ VuValidationAreaObservationStatusInfo

Status info for Validation Area observations.

Provides further information on the pose status reported as part of VuPoseInfo. The status info is retrieved with vuValidationAreaObservationGetStatusInfo.

Note
All enum values defined by VuObservationPoseStatus may be reported as part of a Validation Area observation.
See also
VuPoseInfo
VuObservationPoseStatus
vuObservationHasPoseInfo
vuObservationGetPoseInfo
vuStateGetObservationsWithPoseInfo
vuStateGetObservationsWithPoseInfo
Enumerator
VU_VALIDATION_AREA_OBSERVATION_STATUS_INFO_NORMAL 

Tracking is working normally. Reported for VU_OBSERVATION_POSE_STATUS_EXTENDED_TRACKED.

VU_VALIDATION_AREA_OBSERVATION_STATUS_INFO_NOT_OBSERVED 

Validation Area is not observed. Reported for VU_OBSERVATION_POSE_STATUS_NO_POSE.

VU_VALIDATION_AREA_OBSERVATION_STATUS_INFO_RELOCALIZING 

The tracking system is currently relocalizing. Reported for VU_OBSERVATION_POSE_STATUS_LIMITED.

◆ VuValidationAreaObservationValidationStatus

Validation status for Validation Area observation.

Enumerator
VU_VALIDATION_AREA_OBSERVATION_VALIDATION_STATUS_NORMAL 

Validation Area appearance was distinguished, label name associated with the observed appearance is reported.

VU_VALIDATION_AREA_OBSERVATION_VALIDATION_STATUS_UNDECIDABLE 

Validation Area appearance could not be distinguished (Validation Area is occluded, image is too blurry, low confidence)

Function Documentation

◆ vuValidationAreaFileConfigDefault()

VuValidationAreaFileConfig vuValidationAreaFileConfigDefault ( )

Default Validation Area from image file configuration.

Note
Use this function to initialize the VuValidationAreaFileConfig data structure with default values.

◆ vuEngineCreateValidationAreaObserverFromFileConfig()

VuResult vuEngineCreateValidationAreaObserverFromFileConfig ( VuEngine * engine,
VuObserver ** observer,
const VuValidationAreaFileConfig * config,
VuValidationAreaFileCreationError * errorCode )

Create Validation Area observer from file configuration.

Note
Images with width or height bigger than 2048 pixels are not supported.

◆ vuValidationAreaBufferConfigDefault()

VuValidationAreaBufferConfig vuValidationAreaBufferConfigDefault ( )

Configuration for an Validation Area from image buffer.

Note
Use this function to initialize the VuValidationAreaBufferConfig data structure with default values.

◆ vuEngineCreateValidationAreaObserverFromBufferConfig()

VuResult vuEngineCreateValidationAreaObserverFromBufferConfig ( VuEngine * engine,
VuObserver ** observer,
const VuValidationAreaBufferConfig * config,
VuValidationAreaBufferCreationError * errorCode )

Create Validation Area observer from buffer configuration.

Note
Images with width or height bigger than 2048 pixels are not supported.

◆ vuValidationAreaObserverGetPoseOffset()

VuResult vuValidationAreaObserverGetPoseOffset ( const VuObserver * observer,
VuMatrix44F * poseOffset )

Get the pose transformation offset associated to the area from a Validation Area observer.

Note
The offset is represented as a pose matrix using the OpenGL convention.

◆ vuValidationAreaObserverSetPoseOffset()

VuResult vuValidationAreaObserverSetPoseOffset ( VuObserver * observer,
const VuMatrix44F * poseOffset )

Set the pose transformation offset associated to the area from a Validation Area observer.

Note
The offset is represented as a pose matrix using the OpenGL convention.

◆ vuValidationAreaObservationGetStatusInfo()

VuResult vuValidationAreaObservationGetStatusInfo ( const VuObservation * observation,
VuValidationAreaObservationStatusInfo * statusInfo )

Get status info associated to the pose status of a Validation Area observation.

The status info is intended to be used in combination with VuObservationPoseStatus retrieved via vuObservationGetPoseInfo.

◆ vuValidationAreaObservationGetValidationInfo()

VuResult vuValidationAreaObservationGetValidationInfo ( const VuObservation * observation,
VuValidationAreaObservationValidationInfo * validationInfo )

Get validation info associated with a Validation Area observation.

Note
Prediction for the Validation Area is typically performed at a lower frequency than the actual camera framerate. Validation info returned by this method is the result of the latest validation attempt.