All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
AreaTargetObserver.h File Reference

Observer for the AreaTarget feature. More...

Classes

struct  VuAreaTargetConfig
 Configuration for creating an Area Target observer. More...
 
struct  VuAreaTargetObservationTargetInfo
 Target info for Area Target from its respective observation. More...
 
struct  VuMeshAreaTargetConfig
 Configuration for creating a Mesh observer associated with an Area Target observer. More...
 

Enumerations

enum  VuAreaTargetCreationError : int32_t {
  VU_AREA_TARGET_CREATION_ERROR_NONE = 0x0 ,
  VU_AREA_TARGET_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_AREA_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED ,
  VU_AREA_TARGET_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_AREA_TARGET_CREATION_ERROR_INVALID_DEVICE_POSE_OBSERVER = 0x4 ,
  VU_AREA_TARGET_CREATION_ERROR_DATABASE_LOAD_ERROR = 0x5 ,
  VU_AREA_TARGET_CREATION_ERROR_INVALID_TARGET_NAME = 0x6 ,
  VU_AREA_TARGET_CREATION_ERROR_TARGET_NOT_FOUND ,
  VU_AREA_TARGET_CREATION_ERROR_REQUIRES_EXTERNAL_POSITIONS = 0x8
}
 Configuration error for Area Target creation from VuAreaTargetConfig. More...
 
enum  VuAreaTargetObservationStatusInfo : int32_t {
  VU_AREA_TARGET_OBSERVATION_STATUS_INFO_NORMAL ,
  VU_AREA_TARGET_OBSERVATION_STATUS_INFO_NOT_OBSERVED ,
  VU_AREA_TARGET_OBSERVATION_STATUS_INFO_RELOCALIZING ,
  VU_AREA_TARGET_OBSERVATION_STATUS_INFO_MISSING_DATA
}
 Status info for the pose of Area Target observations. More...
 
enum  { VU_OBSERVER_AREA_TARGET_TYPE = 0x7 }
 
enum  { VU_OBSERVATION_AREA_TARGET_TYPE = 0x7 }
 
enum  VuMeshAreaTargetCreationError : int32_t {
  VU_MESH_AREA_TARGET_CREATION_ERROR_NONE = 0x00 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_INTERNAL = 0x01 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x02 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_INVALID_OBSERVER = 0x03 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_FILE_LOAD_ERROR ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_LOAD_ERROR = 0x04 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED = 0x05
}
 Configuration error for Mesh observer creation with Area Target observer. More...
 

Functions

VuAreaTargetConfig vuAreaTargetConfigDefault ()
 Default Area Target configuration.
 
VuResult vuEngineCreateAreaTargetObserver (VuEngine *engine, VuObserver **observer, const VuAreaTargetConfig *config, VuAreaTargetCreationError *errorCode)
 Create an Area Target observer from database.
 
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.
 
VuMeshAreaTargetConfig vuMeshAreaTargetConfigDefault ()
 Default Mesh observer configuration with Area Target observer.
 
VuResult vuEngineCreateMeshObserverFromAreaTargetConfig (VuEngine *engine, VuObserver **observer, const VuMeshAreaTargetConfig *config, VuMeshAreaTargetCreationError *errorCode)
 Create a Mesh observer with an Area Target observer as source.
 

Detailed Description

Observer for the AreaTarget feature.