VLTrackingConfiguration Class Reference

Use this component to save a reference to the used tracking configuration (vl-file), license and calibration file and to start tracking with the options: auto start, input selection and external SLAM. More...

Inherits VLWorkerReferenceBehaviour.

Data Structures
class	FilePathReference

Public Member Functions
void	ExtendTrackingWithSLAM (bool useSLAM)
	If SLAM (e.g. ARKit/ ARCore or internal SLAM) is enabled. Will restart the tracking if it is alreading running to apply the changes. More...
string	GetCalibrationPath ()
	Get the URI of the used calibration file. More...
string	GetConfigurationPath ()
	Get the URI of the tracking configuration file, which is used to start tracking. More...
string	GetLicensePath ()
	Get the URI of the used license file. More...
void	SetCalibrationPath (string newURI)
	Set the URI of the calibration file. Will be applied on the next tracking start. More...
void	SetConfigurationPath (string newURI)
	Set the URI of the tracking configuration file, which is used for the next tracking start. More...
void	SetLicensePath (string newURI)
	Set the URI of the used license file. Will be applied on the next tracking start. More...
void	StartTracking ()
	Start tracking using the tracking configuration, license, and calibration that are set in this component. More...
void	StartTracking (bool? extendTrackingWithSLAMOverride=null, bool? useInputSelectionOverride=null, bool? useResolutionSelectionOverride=null, bool? showOnMobileDevicesOverride=null)
	Start tracking with arguments that are only applied for this tracking start. More...

Data Fields
bool	autoStartTracking = false
FilePathReference	configurationFileReference = null
bool	extendTrackingWithSLAM = false
bool	showOnMobileDevices = false
bool	useInputSelection = false
bool	useResolutionSelection = false

Additional Inherited Members
Protected Member Functions inherited from VLWorkerReferenceBehaviour
virtual bool	InitWorkerReference ()
	Initializes the workerBehaviour and Worker member variables. More...
Protected Attributes inherited from VLWorkerReferenceBehaviour
VLWorker	worker
VLWorkerBehaviour	workerBehaviour
	Reference to used VLWorkerBehaviour. More...

Detailed Description

Use this component to save a reference to the used tracking configuration (vl-file), license and calibration file and to start tracking with the options: auto start, input selection and external SLAM.

Member Function Documentation

ExtendTrackingWithSLAM()

void VLTrackingConfiguration.ExtendTrackingWithSLAM ( bool  useSLAM )

inline

If SLAM (e.g. ARKit/ ARCore or internal SLAM) is enabled. Will restart the tracking if it is alreading running to apply the changes.

GetCalibrationPath()

string VLTrackingConfiguration.GetCalibrationPath ( )

inline

Get the URI of the used calibration file.

GetConfigurationPath()

string VLTrackingConfiguration.GetConfigurationPath ( )

inline

Get the URI of the tracking configuration file, which is used to start tracking.

GetLicensePath()

string VLTrackingConfiguration.GetLicensePath ( )

inline

Get the URI of the used license file.

SetCalibrationPath()

void VLTrackingConfiguration.SetCalibrationPath ( string  newURI )

inline

Set the URI of the calibration file. Will be applied on the next tracking start.

Example: streaming-assets-dir:VisionLib/calibration.json

SetConfigurationPath()

void VLTrackingConfiguration.SetConfigurationPath ( string  newURI )

inline

Set the URI of the tracking configuration file, which is used for the next tracking start.

Example: streaming-assets-dir:VisionLib/MyTracking.vl

SetLicensePath()

void VLTrackingConfiguration.SetLicensePath ( string  newURI )

inline

Set the URI of the used license file. Will be applied on the next tracking start.

Example: streaming-assets-dir:VisionLib/license.xml

StartTracking() [1/2]

void VLTrackingConfiguration.StartTracking ( )

inline

Start tracking using the tracking configuration, license, and calibration that are set in this component.

StartTracking() [2/2]

void VLTrackingConfiguration.StartTracking ( bool?  extendTrackingWithSLAMOverride = null, bool?  useInputSelectionOverride = null, bool?  useResolutionSelectionOverride = null, bool?  showOnMobileDevicesOverride = null  )

inline

Start tracking with arguments that are only applied for this tracking start.