VLAbstractApplicationWrapper Class Reference

The VLAbstractApplicationWrapper is a wrapper for the AbstractApplication. The AbstractApplication represents the tracking context. More...

Inherits IDisposable.

Public Member Functions
	VLAbstractApplicationWrapper ()
	Constructor of VLAbstractApplicationWrapper. More...
bool	AddCameraCalibrationDB (string uri)
	Adds a custom camera calibration database file. More...
void	Dispose ()
	Explicitly releases references to unmanaged resources. More...
bool	FoundBlockedFeatures ()
	Returns whether any features are used, which are not licensed. More...
VLDeviceInfo	GetDeviceInfo ()
	Retrieves the device info object from the AbstractApplication. More...
IntPtr	GetHandle ()
	Returns the handle to the native object. More...
bool	GetHostID (out string hostID)
	Returns the host ID of the current machine as string. More...
VLLicenseInformation	GetLicenseInformation ()
	Retrieves the license information object from the AbstractApplication. More...
bool	LoadProjectData (string filename)
	Loads the specified tracking configuration XML file. More...
bool	LoadProjectDataFromString (string str, string fakeFilename)
	Loads the given string as tracking configuration. More...
bool	SetLicenseFileData (string data)
	Allows to inject the license data from memory More...
bool	SetLicenseFilePath (string path)
	Sets the path of the license file in the system. More...

Detailed Description

The VLAbstractApplicationWrapper is a wrapper for the AbstractApplication. The AbstractApplication represents the tracking context.

Constructor & Destructor Documentation

VLAbstractApplicationWrapper()

VLAbstractApplicationWrapper.VLAbstractApplicationWrapper ( )

inline

Constructor of VLAbstractApplicationWrapper.

Member Function Documentation

AddCameraCalibrationDB()

bool VLAbstractApplicationWrapper.AddCameraCalibrationDB ( string  uri )

inline

Adds a custom camera calibration database file.

The calibration database must be added before loading a tracking configuration.

Returns

true, if the camera calibration database URI was added successfully; false otherwise. false will also be returned, if the URI was added already.

Parameters

uri	URI to the camera calibration database file

Dispose()

void VLAbstractApplicationWrapper.Dispose ( )

inline

Explicitly releases references to unmanaged resources.

Call Dispose when you are finished using the VLAbstractApplicationWrapper. The Dispose method leaves the VLAbstractApplicationWrapper in an unusable state. After calling Dispose, you must release all references to the VLAbstractApplicationWrapper so the garbage collector can reclaim the memory that the VLAbstractApplicationWrapper was occupying.

FoundBlockedFeatures()

bool VLAbstractApplicationWrapper.FoundBlockedFeatures ( )

inline

Returns whether any features are used, which are not licensed.

The 'blocked features' status will be re-evaluated from time to time.

Returns

true, if unlicensed features are used; false otherwise.

GetDeviceInfo()

VLDeviceInfo VLAbstractApplicationWrapper.GetDeviceInfo ( )

inline

Retrieves the device info object from the AbstractApplication.

Returns

VLDeviceInfo, if the device info was acquired successfully; null otherwise.

GetHandle()

IntPtr VLAbstractApplicationWrapper.GetHandle ( )

inline

Returns the handle to the native object.

Returns

Handle to native object.

GetHostID()

bool VLAbstractApplicationWrapper.GetHostID ( out string  hostID )

inline

Returns the host ID of the current machine as string.

The host ID is necessary for generating a license file.

Returns

true, if host ID was gotten; false otherwise.

Parameters

hostID

Output host ID string.

GetLicenseInformation()

VLLicenseInformation VLAbstractApplicationWrapper.GetLicenseInformation ( )

inline

Retrieves the license information object from the AbstractApplication.

Returns

VLLicenseInformation, if the license information was acquired successfully; null otherwise.

LoadProjectData()

bool VLAbstractApplicationWrapper.LoadProjectData ( string  filename )

inline

Loads the specified tracking configuration XML file.

Returns

true, if the tracking configuration was loaded successfully; false otherwise.

Parameters

filename

Filename of the tracking configuration

VLAbstractApplicationWrapper aap = new VLAbstractApplicationWrapper();
string trackingFile = VLPathUtility.CombinePaths(Application.streamingAssetsPath, "tracking.vl");
aap.LoadProjectData(trackingFile);

LoadProjectDataFromString()

bool VLAbstractApplicationWrapper.LoadProjectDataFromString ( string  str, string  fakeFilename  )

inline

Loads the given string as tracking configuration.

Returns

true, if the tracking configuration was loaded successfully; false otherwise.

Parameters

str	String with the tracking configuration
fakeFilename	Filename which will be used to determine the type of the tracking configuration (vl / PM) and for resolving relative file paths and the type of the tracking configuration.

SetLicenseFileData()

bool VLAbstractApplicationWrapper.SetLicenseFileData ( string  data )

inline

Allows to inject the license data from memory

Returns

true, if the given license data is valid; false otherwise.

Parameters

data	String with the license data.

SetLicenseFilePath()

bool VLAbstractApplicationWrapper.SetLicenseFilePath ( string  path )

inline

Sets the path of the license file in the system.

Calling of this function is mandatory for starting the tracking configuration.

Returns

true, if a valid license file could be found; false otherwise.

Parameters

path	The absolute location of the file.