documentation

Visometry.VisionLib.SDK.Core.ModelTracker Class Reference

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

Inherits Visometry.VisionLib.SDK.Core.TrackingManagerReference.

Public Member Functions

Task< ModelPropertiesStructureGetModelPropertiesAsync ()
 
void ReadInitData (string uri)
 Loads the captured initialization data as file from a custom location. More...
 
async Task ReadInitDataAsync (string uri)
 
void RemoveModel (string name)
 Removes a specific model from the current tracker. More...
 
async Task RemoveModelAsync (string name)
 
void ResetInitData ()
 Reset the offline initialization data. More...
 
async Task ResetInitDataAsync ()
 
void ResetTrackingHard ()
 Reset the tracking and all keyframes. More...
 
async Task ResetTrackingHardAsync ()
 
void ResetTrackingSoft ()
 Reset the tracking. More...
 
async Task ResetTrackingSoftAsync ()
 
void SetModelPropertyEnabled (string name, bool state)
 Enables/Disables a specific model in the current tracker. More...
 
async Task SetModelPropertyEnabledAsync (string name, bool state)
 
void SetModelPropertyOccluder (string name, bool state)
 Sets a specific model as occluder in the current tracker. More...
 
async Task SetModelPropertyOccluderAsync (string name, bool state)
 
void SetModelURI (string modelURI)
 Sets the modelURI to a new value and thus loads a new model. More...
 
async Task SetModelURIAsync (string modelURI)
 Sets the modelURI to a new value and thus loads a new model. More...
 
void WriteInitData (string filePrefix=null)
 Write the captured initialization data as file to custom location with custom name. More...
 
async Task WriteInitDataAsync (string filePrefix=null)
 

Additional Inherited Members

- Protected Member Functions inherited from Visometry.VisionLib.SDK.Core.TrackingManagerReference
virtual bool InitWorkerReference ()
 Initializes the trackingManager and Worker member variables. More...
 
virtual void ResetReference ()
 
- Properties inherited from Visometry.VisionLib.SDK.Core.TrackingManagerReference
TrackingManager trackingManager [get]
 Reference to used TrackingManager. More...
 
Worker worker [get]
 

Detailed Description

The ModelTracker contains all functions, which are specific for the ModelTracker.

Member Function Documentation

◆ ReadInitData()

void Visometry.VisionLib.SDK.Core.ModelTracker.ReadInitData ( string  uri)
inline

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

This function will be performed asynchronously.

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
uriWill 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_".

◆ RemoveModel()

void Visometry.VisionLib.SDK.Core.ModelTracker.RemoveModel ( string  name)
inline

Removes a specific model from the current tracker.

This function will be performed asynchronously.

Parameters
nameName of the model

◆ ResetInitData()

void Visometry.VisionLib.SDK.Core.ModelTracker.ResetInitData ( )
inline

Reset the offline initialization data.

This function will be performed asynchronously.

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

◆ ResetTrackingHard()

void Visometry.VisionLib.SDK.Core.ModelTracker.ResetTrackingHard ( )
inline

Reset the tracking and all keyframes.

This function will be performed asynchronously.

◆ ResetTrackingSoft()

void Visometry.VisionLib.SDK.Core.ModelTracker.ResetTrackingSoft ( )
inline

Reset the tracking.

This function will be performed asynchronously.

◆ SetModelPropertyEnabled()

void Visometry.VisionLib.SDK.Core.ModelTracker.SetModelPropertyEnabled ( string  name,
bool  state 
)
inline

Enables/Disables a specific model in the current tracker.

This function will be performed asynchronously.

Parameters
nameName of the model
stateEnabled (true/false)

◆ SetModelPropertyOccluder()

void Visometry.VisionLib.SDK.Core.ModelTracker.SetModelPropertyOccluder ( string  name,
bool  state 
)
inline

Sets a specific model as occluder in the current tracker.

This function will be performed asynchronously.

Parameters
nameName of the model
stateOccluder (true/false)

◆ SetModelURI()

void Visometry.VisionLib.SDK.Core.ModelTracker.SetModelURI ( string  modelURI)
inline

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

This function will be performed asynchronously.

Parameters
modelURIURI of the model, which should be used for tracking.

◆ SetModelURIAsync()

async Task Visometry.VisionLib.SDK.Core.ModelTracker.SetModelURIAsync ( string  modelURI)
inline

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

Parameters
modelURIURI of the model, which should be used for tracking.

◆ WriteInitData()

void Visometry.VisionLib.SDK.Core.ModelTracker.WriteInitData ( string  filePrefix = null)
inline

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

This function will be performed asynchronously.

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
filePrefixWill 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_".