The VLModelTrackerBehaviour_v1 contains all functions, which are specific for the ModelTracker_v1. More...

Inherits VLWorkerReferenceBehaviour.

Data Structures
class	OnSetModelURIEvent

class	OnSetModelURIFinishedEvent

Public Member Functions
void	SetModelURI (string modelURI)
	Sets the modelURI to a new value and thus loads a new model. More...

void	ResetTrackingHard ()
	Reset the tracking and all keyframes. More...

void	ResetTrackingSoft ()
	Reset the tracking. More...

delegate void	WriteInitDataAction (bool success)
	Delegate for WriteInitDataAction events. More...

delegate void	ReadInitDataAction (bool success)
	Delegate for ReadInitDataAction events. More...

delegate void	ResetInitDataAction (bool success)
	Delegate for ResetInitDataAction events. More...

void	WriteInitData ()
	Write the captured initialization data as file to default location with default name. More...

void	WriteInitData (string filePrefix)
	Write the captured initialization data as file to custom location with custom name. More...

void	ReadInitData (string uri)
	Loads the captured initialization data as file from a custom location. More...

void	ResetInitData ()
	Reset the offline initialization data. More...

bool	HasWorkerReference ()

bool	SetModelProperty (string name, string property, bool state)

bool	GetModelProperties ()

delegate void	GetModelPropertiesAction (VLModelProperties[] properties)
	Delegate for OnGetModelProperties events. More...

void	RemoveModel (string name)

Data Fields
OnSetModelURIEvent	OnSetModelURI
	Event which will be emitted before "SetModelURI" has been called. More...

OnSetModelURIFinishedEvent	OnSetModelURIFinished
	Event which will be emitted after "SetModelURI" has been finished More...

Data Fields inherited from VLWorkerReferenceBehaviour
VLWorkerBehaviour	workerBehaviour
	Reference to used VLWorkerBehaviour. More...

Events
static WriteInitDataAction	OnWriteInitData
	Event which will be emitted after a the initialization were written to disk. More...

static ReadInitDataAction	OnReadInitData
	Event which will be emitted after a the initialization data has been loaded from an uri. More...

static ResetInitDataAction	OnResetInitData
	Event which will be emitted after a the initialization data has been reset from an uri. More...

static GetModelPropertiesAction	OnGetModelProperties
	Event which will be emitted when the model properties have been rquested by GetModelStateProperties. More...

Additional Inherited Members
Protected Member Functions inherited from VLWorkerReferenceBehaviour
bool	InitWorkerReference ()
	Initializes the workerBehaviour and worker member variables. More...

Protected Attributes inherited from VLWorkerReferenceBehaviour
VLWorker	worker

Detailed Description

The VLModelTrackerBehaviour_v1 contains all functions, which are specific for the ModelTracker_v1.

Member Function Documentation

◆ GetModelProperties()

bool VLModelTrackerBehaviour_v1.GetModelProperties ( )

inline

◆ GetModelPropertiesAction()

delegate void VLModelTrackerBehaviour_v1.GetModelPropertiesAction ( VLModelProperties [] properties )

Delegate for OnGetModelProperties events.

Parameters

properties VLModelProperties as an Array of actual Model Properties

◆ HasWorkerReference()

bool VLModelTrackerBehaviour_v1.HasWorkerReference ( )

inline

◆ ReadInitData()

void VLModelTrackerBehaviour_v1.ReadInitData ( string uri )

inline

Loads the captured initialization data as file from a custom location.

In order to load init data at best use a static uri. A common way is for each platform, is using "local_storage_dir" scheme which can be used as file prefix. This scheme points to different locations depending on the platform:

Windows: Current users home directory
MacOS: Current users document directory
iOS / Android: The current applications document directory

Parameters

uri	Will be used as filename and path. A time stamp and the file extension will be appended automatically. A plausible value could be for example "local_storage_dir:MyInitData_".

◆ ReadInitDataAction()

delegate void VLModelTrackerBehaviour_v1.ReadInitDataAction ( bool success )

Delegate for ReadInitDataAction events.

Parameters

success true, on success; false, otherwise.

◆ RemoveModel()

void VLModelTrackerBehaviour_v1.RemoveModel ( string name )

inline

◆ ResetInitData()

void VLModelTrackerBehaviour_v1.ResetInitData ( )

inline

Reset the offline initialization data.

In order to reset the initialization data loaded at the beginning this fuction can be called. The init data learned on the fly, will still be maintained and can be reset by issuing a hard reset.

◆ ResetInitDataAction()

delegate void VLModelTrackerBehaviour_v1.ResetInitDataAction ( bool success )

Delegate for ResetInitDataAction events.

Parameters

success true, on success; false, otherwise.

◆ ResetTrackingHard()

void VLModelTrackerBehaviour_v1.ResetTrackingHard ( )

inline

Reset the tracking and all keyframes.

◆ ResetTrackingSoft()

void VLModelTrackerBehaviour_v1.ResetTrackingSoft ( )

inline

Reset the tracking.

◆ SetModelProperty()

bool VLModelTrackerBehaviour_v1.SetModelProperty	(	string	name,
		string	property,
		bool	state
	)

inline

◆ SetModelURI()

void VLModelTrackerBehaviour_v1.SetModelURI ( string modelURI )

inline

Sets the modelURI to a new value and thus loads a new model.

Parameters

modelURI URI of the model, which should be used for tracking.

◆ WriteInitData() [1/2]

void VLModelTrackerBehaviour_v1.WriteInitData ( )

inline

Write the captured initialization data as file to default location with default name.

A default name will be used for the file ("InitData_timestamp.binz"). The file will be written to different locations depending on the platform:

Windows: Current users home directory
MacOS: Current users document directory
iOS / Android: The current applications document directory

◆ WriteInitData() [2/2]

void VLModelTrackerBehaviour_v1.WriteInitData ( string filePrefix )

inline

Write the captured initialization data as file to custom location with custom name.

In order to avoid having to use a different file path for each platform, the "local_storage_dir" scheme can be used as file prefix. This scheme points to different locations depending on the platform:

Windows: Current users home directory
MacOS: Current users document directory
iOS / Android: The current applications document directory

Parameters

filePrefix Will be used as filename and path. A time stamp and the file extension will be appended automatically. A plausible value could be for example "local_storage_dir:MyInitData_".

◆ WriteInitDataAction()

delegate void VLModelTrackerBehaviour_v1.WriteInitDataAction ( bool success )

Delegate for WriteInitDataAction events.

Parameters

success true, on success; false, otherwise.

Field Documentation

◆ OnSetModelURI

OnSetModelURIEvent VLModelTrackerBehaviour_v1.OnSetModelURI

Event which will be emitted before "SetModelURI" has been called.

◆ OnSetModelURIFinished

OnSetModelURIFinishedEvent VLModelTrackerBehaviour_v1.OnSetModelURIFinished

Event which will be emitted after "SetModelURI" has been finished

Event Documentation

◆ OnGetModelProperties

GetModelPropertiesAction VLModelTrackerBehaviour_v1.OnGetModelProperties

static

Event which will be emitted when the model properties have been rquested by GetModelStateProperties.

◆ OnReadInitData

ReadInitDataAction VLModelTrackerBehaviour_v1.OnReadInitData

static

Event which will be emitted after a the initialization data has been loaded from an uri.

◆ OnResetInitData

ResetInitDataAction VLModelTrackerBehaviour_v1.OnResetInitData

static

Event which will be emitted after a the initialization data has been reset from an uri.

◆ OnWriteInitData

WriteInitDataAction VLModelTrackerBehaviour_v1.OnWriteInitData

static

Event which will be emitted after a the initialization were written to disk.

documentation

Data Structures

Public Member Functions

Data Fields

Events

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetModelProperties()

◆ GetModelPropertiesAction()

◆ HasWorkerReference()

◆ ReadInitData()

◆ ReadInitDataAction()

◆ RemoveModel()

◆ ResetInitData()

◆ ResetInitDataAction()

◆ ResetTrackingHard()

◆ ResetTrackingSoft()

◆ SetModelProperty()

◆ SetModelURI()

◆ WriteInitData() [1/2]

◆ WriteInitData() [2/2]

◆ WriteInitDataAction()

Field Documentation

◆ OnSetModelURI

◆ OnSetModelURIFinished

Event Documentation

◆ OnGetModelProperties

◆ OnReadInitData

◆ OnResetInitData

◆ OnWriteInitData