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

Controller to access the Area Target Capture functionality in the Vuforia Engine. More...

Classes

struct  VuAreaTargetCaptureConfig
 Configuration options for Area Target Capture instance creation. More...
 
struct  VuAreaTargetCaptureGenerationConfig
 Configuration options for Area Target generation. More...
 
struct  VuMeshAreaTargetCaptureConfig
 Configuration for creating a Mesh observer using an Area Target Capture instance. More...
 

Typedefs

typedef struct VuAreaTargetCapture_ VuAreaTargetCapture
 Area Target Capture instance.
 

Enumerations

enum  VuAreaTargetCaptureCreationError : int32_t {
  VU_AREA_TARGET_CAPTURE_CREATION_ERROR_NONE = 0x0 ,
  VU_AREA_TARGET_CAPTURE_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_AREA_TARGET_CAPTURE_CREATION_ERROR_AUTOSTART_FAILED = 0x2 ,
  VU_AREA_TARGET_CAPTURE_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_AREA_TARGET_CAPTURE_CREATION_ERROR_MULTIPLE_INSTANCES_NOT_SUPPORTED ,
  VU_AREA_TARGET_CAPTURE_CREATION_ERROR_INVALID_DEVICE_POSE_OBSERVER = 0x5
}
 Area Target Capture creation error. More...
 
enum  VuAreaTargetCaptureStatus : int32_t {
  VU_AREA_TARGET_CAPTURE_STATUS_INITIALIZED = 0x1 ,
  VU_AREA_TARGET_CAPTURE_STATUS_PREPARING = 0x2 ,
  VU_AREA_TARGET_CAPTURE_STATUS_CAPTURING = 0x3 ,
  VU_AREA_TARGET_CAPTURE_STATUS_PAUSED = 0x4 ,
  VU_AREA_TARGET_CAPTURE_STATUS_STOPPED = 0x5 ,
  VU_AREA_TARGET_CAPTURE_STATUS_GENERATING = 0x6
}
 Area Target Capture status. More...
 
enum  VuAreaTargetCaptureStatusInfo : int32_t {
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_NORMAL = 0x1 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_RELOCALIZING = 0x2 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_EXCESSIVE_MOTION = 0x3 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_CAPACITY_WARNING ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_INTERRUPTED = 0x5 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_SUSPENDED = 0x6 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_TRACKING_DATA_GENERATION = 0x7 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_AUTHORING_DATA_GENERATION = 0x8 ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_DEVICE_DATABASE_GENERATION ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_PACKAGE_GENERATION = 0xA ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_SUCCESS = 0xB ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_CANCELED = 0xC ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR_INTERNAL = 0xD ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR_NO_NETWORK_CONNECTION ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR_SERVICE_NOT_AVAILABLE ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR_AUTHORIZATION_FAILED ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR_MISSING_ALIGNMENT_DATA ,
  VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR_ALIGNMENT_FAILED
}
 Area Target Capture status info. More...
 
enum  VuAreaTargetCaptureGenerationError : int32_t {
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_NONE = 0x0 ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INTERNAL = 0x1 ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_ENGINE_NOT_RUNNING = 0x2 ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INVALID_STATUS = 0x3 ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INSUFFICIENT_DATA ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_MISSING_AUTHENTICATION ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INVALID_OUTPUT_DIRECTORY ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INVALID_TARGET_NAME ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_AUTHORING_FILES_GENERATION_REQUIRED ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_DATABASE_GENERATION_REQUIRED ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_ALIGNMENT_DATABASE_LOAD_ERROR ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INVALID_ALIGNMENT_TARGET_NAME ,
  VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_ALIGNMENT_TARGET_NOT_FOUND
}
 Area Target Capture generation error. More...
 
enum  VuMeshAreaTargetCaptureCreationError : int32_t {
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_NONE = 0x0 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_INVALID_CAPTURE = 0x4 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED
}
 Configuration error for Mesh observer creation with Area Target Capture. More...
 

Functions

VuAreaTargetCaptureConfig vuAreaTargetCaptureConfigDefault ()
 Default capture configuration.
 
VuAreaTargetCaptureGenerationConfig vuAreaTargetCaptureGenerationConfigDefault ()
 Default generation configuration.
 
VuResult vuEngineGetAreaTargetCaptureController (const VuEngine *engine, VuController **controller)
 Retrieve Area Target Capture Controller to get access to Area Target Capture functionality in Engine.
 
VuResult vuAreaTargetCaptureControllerCreateAreaTargetCapture (VuController *controller, const VuAreaTargetCaptureConfig *config, VuAreaTargetCapture **capture, VuAreaTargetCaptureCreationError *error)
 Create a new capture with the specified configuration.
 
VuResult vuAreaTargetCaptureStart (VuAreaTargetCapture *capture)
 Start a capture.
 
VuResult vuAreaTargetCaptureStop (VuAreaTargetCapture *capture)
 Stop a running or paused capture.
 
VuResult vuAreaTargetCapturePause (VuAreaTargetCapture *capture)
 Pause a running capture.
 
VuResult vuAreaTargetCaptureResume (VuAreaTargetCapture *capture)
 Resume a paused capture.
 
VuResult vuAreaTargetCaptureGenerate (VuAreaTargetCapture *capture, const VuAreaTargetCaptureGenerationConfig *config, VuAreaTargetCaptureGenerationError *error)
 Start Area Target generation from a stopped capture.
 
VuResult vuAreaTargetCaptureGetStatus (const VuAreaTargetCapture *capture, VuAreaTargetCaptureStatus *status)
 Get status of the capture.
 
VuResult vuAreaTargetCaptureGetStatusInfo (const VuAreaTargetCapture *capture, VuAreaTargetCaptureStatusInfo *statusInfo)
 Get status info for the capture.
 
VuResult vuAreaTargetCaptureCancelGeneration (VuAreaTargetCapture *capture)
 Cancel Area Target generation.
 
VuResult vuAreaTargetCaptureGetGenerationProgress (const VuAreaTargetCapture *capture, float *progress)
 Get progress information of the current Area Target generation in the range [0.0f, 1.0f].
 
VuResult vuAreaTargetCaptureGetGenerationTimeEstimate (const VuAreaTargetCapture *capture, int32_t *remainingTimeSeconds)
 Get estimated time remaining to complete the current Area Target generation in seconds.
 
VuResult vuAreaTargetCaptureDestroy (VuAreaTargetCapture *capture)
 Destroy the given capture instance.
 
VuMeshAreaTargetCaptureConfig vuMeshAreaTargetCaptureConfigDefault ()
 Default Mesh observer configuration with Area Target Capture source.
 
VuResult vuEngineCreateMeshObserverFromAreaTargetCaptureConfig (VuEngine *engine, VuObserver **observer, const VuMeshAreaTargetCaptureConfig *config, VuMeshAreaTargetCaptureCreationError *errorCode)
 Create a Mesh observer with an Area Target Capture instance as source.
 

Detailed Description

Controller to access the Area Target Capture functionality in the Vuforia Engine.