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

Observer for the VuMark feature. More...

Classes

struct  VuVuMarkConfig
 Configuration for creating a VuMark Observer. More...
 
struct  VuVuMarkObservationTemplateInfo
 Template info for a VuMark from its respective observation. More...
 
struct  VuVuMarkObservationInstanceInfo
 Instance info for a VuMark from its respective observation. More...
 
struct  VuVuMarkObservationInfo
 VuMark-specific observation information. More...
 

Enumerations

enum  VuVuMarkCreationError : int32_t {
  VU_VUMARK_CREATION_ERROR_NONE = 0x0 ,
  VU_VUMARK_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_VUMARK_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_VUMARK_CREATION_ERROR_DATABASE_LOAD_ERROR = 0x3 ,
  VU_VUMARK_CREATION_ERROR_INVALID_TARGET_NAME = 0x4 ,
  VU_VUMARK_CREATION_ERROR_TARGET_NOT_FOUND ,
  VU_VUMARK_CREATION_ERROR_INVALID_SCALE = 0x6 ,
  VU_VUMARK_CREATION_ERROR_DATABASE_XML_REQUIRED = 0x7
}
 Configuration error for VuMark creation. More...
 
enum  VuVuMarkObservationStatusInfo : int32_t {
  VU_VUMARK_OBSERVATION_STATUS_INFO_NORMAL = 0x1 ,
  VU_VUMARK_OBSERVATION_STATUS_INFO_NOT_OBSERVED = 0x2 ,
  VU_VUMARK_OBSERVATION_STATUS_INFO_RELOCALIZING
}
 Status info for the pose of VuMark observations. More...
 
enum  VuMarkInstanceIdType : int32_t {
  VU_VUMARK_INSTANCE_ID_BYTE = 0x1 ,
  VU_VUMARK_INSTANCE_ID_STRING = 0x2 ,
  VU_VUMARK_INSTANCE_ID_NUMERIC = 0x3
}
 Status info for VuMark observation. More...
 
enum  { VU_OBSERVER_VUMARK_TYPE = 0x4 }
 
enum  { VU_OBSERVATION_VUMARK_TYPE = 0x4 }
 

Functions

VuVuMarkConfig vuVuMarkConfigDefault ()
 Default VuMark configuration.
 
VuResult vuEngineCreateVuMarkObserver (VuEngine *engine, VuObserver **observer, const VuVuMarkConfig *config, VuVuMarkCreationError *errorCode)
 Create a VuMark observer from a database.
 
VuResult vuEngineGetVuMarkObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all VuMark observers.
 
VuResult vuVuMarkObserverGetTargetUniqueId (const VuObserver *observer, const char **targetId)
 Get the unique id associated to the template from a VuMark observer.
 
VuResult vuVuMarkObserverGetTemplateName (const VuObserver *observer, const char **templateName)
 Get the name associated to the VuMark template from a VuMark observer.
 
VuResult vuVuMarkObserverGetTemplateAABB (const VuObserver *observer, VuAABB *bbox)
 Get the axis-aligned bounding box associated to the VuMark template from a VuMark observer, relative to its frame of reference.
 
VuResult vuVuMarkObserverGetTemplateSize (const VuObserver *observer, VuVector2F *size)
 Get the size in meters associated to the VuMark template from a VuMark observer.
 
VuResult vuVuMarkObserverSetTemplateScale (VuObserver *observer, float scale)
 Re-scale the VuMark template size associated to a VuMark observer.
 
VuResult vuVuMarkObserverGetTemplatePoseOffset (const VuObserver *observer, VuMatrix44F *poseOffset)
 Get the pose transformation offset associated to the VuMark template from a VuMark observer.
 
VuResult vuVuMarkObserverSetTemplatePoseOffset (VuObserver *observer, const VuMatrix44F *poseOffset)
 Set the pose transformation offset associated to the VuMark template from a VuMark observer.
 
VuResult vuVuMarkObserverGetUserData (const VuObserver *observer, const char **userData)
 Get the user data for a VuMark template from a VuMark observer's underlying database.
 
VuResult vuVuMarkObserverGetOrigin (const VuObserver *observer, VuVector2F *origin)
 Get the position of the origin of a VuMark template from a VuMark observer.
 
VuResult vuVuMarkObserverGetTrackingFromRuntimeAppearance (const VuObserver *observer, VuBool *isEnabled)
 Get whether tracking should use the VuMark template's background image or not.
 
VuResult vuVuMarkObserverSetTrackingFromRuntimeAppearance (VuObserver *observer, VuBool enable)
 Set whether tracking should use the VuMark template's background image or not.
 
VuResult vuVuMarkObserverSetTrackingOptimization (VuObserver *observer, VuTrackingOptimization optimization)
 Set the tracking optimization of the target associated to the VuMark observer.
 
VuResult vuVuMarkObserverGetTrackingOptimization (const VuObserver *observer, VuTrackingOptimization *optimization)
 Get the tracking optimization of the target associated to the VuMark observer.
 
VuResult vuStateGetVuMarkObservations (const VuState *state, VuObservationList *observationList)
 Get all VuMark observations.
 
VuResult vuVuMarkObservationGetStatusInfo (const VuObservation *observation, VuVuMarkObservationStatusInfo *statusInfo)
 Get status info associated to the pose status of a VuMark observation.
 
VuResult vuVuMarkObservationGetInfo (const VuObservation *observation, VuVuMarkObservationInfo *info)
 Get VuMark-specific info associated with a VuMark observation.
 
VuResult vuVuMarkObservationGetTemplateInfo (const VuObservation *observation, VuVuMarkObservationTemplateInfo *templateInfo)
 Get VuMark template info associated with a VuMark observation.
 
VuResult vuVuMarkObservationGetInstanceInfo (const VuObservation *observation, VuVuMarkObservationInstanceInfo *instanceInfo)
 Get VuMark instance info associated with a VuMark observation.
 
VuResult vuVuMarkObservationGetInstanceImage (const VuObservation *observation, VuImage **instanceImage)
 Get VuMark instance image info associated with a VuMark observation.
 

Detailed Description

Observer for the VuMark feature.