ValidationAreaObserver.h File Reference

Validation Area observer for the StepCheck feature. More...

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

Validation Area observer for the StepCheck feature.