Classes | |
struct | VuAreaTargetCaptureConfig |
Configuration options for Area Target Capture instance creation. More... | |
struct | VuAreaTargetCaptureGenerationConfig |
Configuration options for Area Target generation. More... | |
Typedefs | |
typedef struct VuAreaTargetCapture_ | VuAreaTargetCapture |
Area Target Capture instance. | |
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. | |
This controller provides functionality to generate Area Targets by capturing all required data with Vuforia Engine.
enum VuAreaTargetCaptureCreationError : int32_t |
Area Target Capture creation error.
enum VuAreaTargetCaptureStatus : int32_t |
Area Target Capture status.
enum VuAreaTargetCaptureStatusInfo : int32_t |
Area Target Capture status info.
enum VuAreaTargetCaptureGenerationError : int32_t |
Area Target Capture generation error.
VuAreaTargetCaptureConfig vuAreaTargetCaptureConfigDefault | ( | ) |
Default capture configuration.
VuAreaTargetCaptureGenerationConfig vuAreaTargetCaptureGenerationConfigDefault | ( | ) |
Default generation configuration.
VuResult vuAreaTargetCaptureControllerCreateAreaTargetCapture | ( | VuController * | controller, |
const VuAreaTargetCaptureConfig * | config, | ||
VuAreaTargetCapture ** | capture, | ||
VuAreaTargetCaptureCreationError * | error ) |
Create a new capture with the specified configuration.
Any previously created capture has to be destroyed before creating a new capture.
This function creates an Area Target capture based on the specified configuration. On successful creation the capture has status VU_AREA_TARGET_CAPTURE_STATUS_INITIALIZED, unless the configuration's start flag is VU_TRUE, then the capture has status VU_AREA_TARGET_CAPTURE_STATUS_PREPARING. If creation of the capture fails, then VU_FAILED is returned and the optional error parameter will hold an error code that reflects the cause of the error.
controller | Area Target Capture Controller |
config | The configuration for the new capture |
capture | Output variable storing the newly created capture |
error | Optional output variable providing additional error information. Can be NULL. |
VuResult vuAreaTargetCaptureStart | ( | VuAreaTargetCapture * | capture | ) |
Start a capture.
The capture starts data acquisition and switches to status VU_AREA_TARGET_CAPTURE_STATUS_PREPARING.
VuResult vuAreaTargetCaptureStop | ( | VuAreaTargetCapture * | capture | ) |
Stop a running or paused capture.
The capture stops data acquisition, and switches to status VU_AREA_TARGET_CAPTURE_STATUS_STOPPED.
VuResult vuAreaTargetCapturePause | ( | VuAreaTargetCapture * | capture | ) |
Pause a running capture.
Data acquisition of the capture can be paused and resumed. vuAreaTargetCapturePause() pauses data acquisition and switches the capture to status VU_AREA_TARGET_CAPTURE_STATUS_PAUSED. vuAreaTargetCaptureResume() resumes data acquisition and switches the capture to the status it was in before the pause.
VuResult vuAreaTargetCaptureResume | ( | VuAreaTargetCapture * | capture | ) |
Resume a paused capture.
The capture resumes data acquisition, and switches to the status it was in before the pause.
VuResult vuAreaTargetCaptureGenerate | ( | VuAreaTargetCapture * | capture, |
const VuAreaTargetCaptureGenerationConfig * | config, | ||
VuAreaTargetCaptureGenerationError * | error ) |
Start Area Target generation from a stopped capture.
This function starts Area Target generation based on the specified configuration. Once successfully started, Area Target generation runs in the background. For Area Target generation to successfully start, the following requirements have to be met:
If all the requirements are met, this function starts Area Target generation in the background, switches the capture to status VU_AREA_TARGET_CAPTURE_STATUS_GENERATING, and returns VU_SUCCESS. If any of the requirements are not met, VU_FAILED is returned and the optional error parameter will hold an error code that reflects the cause of the error.
Area Target generation runs in the background. When it completes, the capture switches back to status VU_AREA_TARGET_CAPTURE_STATUS_STOPPED. On successful Area Target generation, status info reports VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_SUCCESS. If Area Target generation failed, then status info holds one of the values prefixed with VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_ERROR to report on the failure cause. If Area Target generation was canceled, status info holds the value VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_CANCELED.
capture | The Area Target Capture instance |
config | The configuration for the Area Target generation |
error | Optional output variable providing additional error information. Can be NULL. |
VuResult vuAreaTargetCaptureCancelGeneration | ( | VuAreaTargetCapture * | capture | ) |
Cancel Area Target generation.
A helper function to abort a running target generation. If the target generation has been canceled successfully, then status info will hold the value VU_AREA_TARGET_CAPTURE_STATUS_INFO_GENERATION_CANCELED.
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.
It may take few seconds after the Area Target generation started for the time estimate to become available.
VuResult vuAreaTargetCaptureDestroy | ( | VuAreaTargetCapture * | capture | ) |
Destroy the given capture instance.
If the capture is running data acquisition, it is automatically stopped. If the capture is running target generation, it is automatically canceled.