All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
VuAreaTargetCaptureGenerationConfig Struct Reference

Public Attributes

const char * userAuth
 User name for authentication with the Vuforia server.
 
const char * secretAuth
 Secret key for authentication with the Vuforia server.
 
const char * outputDirectory
 Output directory path.
 
const char * targetName
 Target name.
 
VuBool generateAuthoringFiles
 Generate authoring files.
 
VuBool generateDatabase
 Generate Area Target database.
 
VuBool generatePackages
 Generate packages.
 
const char * alignmentDatabasePath
 Optional path to database containing an Area Target to use for alignment of the generated Area Target Capture.
 
const char * alignmentTargetName
 Optional name of an Area Target to use for alignment.
 

Detailed Description

Configuration options for Area Target generation.

Member Data Documentation

◆ userAuth

const char* userAuth

User name for authentication with the Vuforia server.

Note
The provided string is copied by vuAreaTargetCaptureGenerate and can be freed afterwards.

◆ secretAuth

const char* secretAuth

Secret key for authentication with the Vuforia server.

Note
The provided string is copied by vuAreaTargetCaptureGenerate and can be freed afterwards.

◆ outputDirectory

const char* outputDirectory

Output directory path.

The output directory path can be absolute or relative. The capture will store the files it was configured to generate to this path. The directory must exist and be writable throughout Area Target generation.

Note
The provided string is copied by vuAreaTargetCaptureGenerate and can be freed afterwards.

◆ targetName

const char* targetName

Target name.

The name of the generated Area Target is required to respect the following restrictions:

  • Length: 1 - 64 characters
  • Encoding: ASCII
  • Allowed characters: numerals (0-9), literals (a-zA-Z), dash (-), underscore (_)
Note
All generated files use the target name as first component for their respective filenames.
The provided string is copied by vuAreaTargetCaptureGenerate and can be freed afterwards.

◆ generateAuthoringFiles

VuBool generateAuthoringFiles

Generate authoring files.

If set to VU_TRUE, the following files are generated:

  • The authoring representation of the captured space as a 3DT Space file. The filename is prefixed with the target name and ends with authoring.3dt.
  • The navigation mesh source for the captured space as a binary GLTF file. The filename is prefixed with the target name and ends with navmesh.glb.

If set to VU_FALSE, the authoring representation and the navigation mesh source are not generated.

The authoring 3DT Space file can be used as input to external tools that support the editing and generation of Area Targets. The navigation mesh source file can be used as input to external tools or libraries to create a navigation or path finding representation for the captured space.

Note
Default value is VU_TRUE

◆ generateDatabase

VuBool generateDatabase

Generate Area Target database.

If set to VU_TRUE, the following files are generated:

  • The Area Target database for the captured space. The database files use the target name as filename.
  • The runtime occlusion mesh for the captured space. The filename is prefixed with the target name and ends with occlusion.3dt.

If set to VU_FALSE, the Area Target database and the runtime occlusion mesh are not generated.

The Area Target database can be used to create an Area Target observer. The runtime occlusion mesh can be used to create the matching Mesh observer for the Area Target observer.

Note
Area Target database generation requires a network connection and valid credentials for communication with the Vuforia server.
Default value is VU_TRUE

◆ generatePackages

VuBool generatePackages

Generate packages.

If set to VU_TRUE, an Area Target Unity Asset package to use with the Vuforia Engine Extension for Unity is generated. The package uses the target name as filename, and unitypackage as file extension.

If set to VU_FALSE, the Area Target Unity Asset package is not generated.

Note
If set to VU_TRUE, generateAuthoringFiles and generateDatabase are required to be set to VU_TRUE, otherwise Area Target generation will fail to start.
Default value is VU_FALSE.

◆ alignmentDatabasePath

const char* alignmentDatabasePath

Optional path to database containing an Area Target to use for alignment of the generated Area Target Capture.

If generation is successful, then the newly generated Area Target will be aligned to the alignment target coordinate system.

Note
The best results will be achieved using small alignment targets, i.e. up to 1000 square meters. Large alignment targets, especially those larger than 4000 square meters, will require significantly longer to align and may struggle to compute an accurate alignment if there are several areas in the target with similar appearance to the captured space.
Both alignmentDatabasePath and alignmentTargetName must be set for alignment to succeed. If alignmentDatabasePath is missing, then generation will fail with VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_ALIGNMENT_DATABASE_LOAD_ERROR.
This option defaults to NULL. If no path is provided, then alignment will not be performed.
The provided string is copied by vuAreaTargetCaptureGenerate and can be freed afterwards.

◆ alignmentTargetName

const char* alignmentTargetName

Optional name of an Area Target to use for alignment.

If generation is successful, then the newly generated Area Target will be aligned to the alignment target coordinate system.

Note
Both alignmentDatabasePath and alignmentTargetName must be set for alignment to succeed. If alignmentTargetName is missing, then generation will fail with VU_AREA_TARGET_CAPTURE_GENERATION_ERROR_INVALID_ALIGNMENT_TARGET_NAME.
This option defaults to NULL. If no name is provided, then alignment will not be performed.
The provided string is copied by vuAreaTargetCaptureGenerate and can be freed afterwards.