documentation

Visometry.VisionLib.SDK.Core.SynchronousTrackingManager Class Reference

Inherits Visometry.VisionLib.SDK.Core.TrackingManager.

Public Member Functions

bool IsReady ()
 
void Push (InputFrame frame)
 
bool RunOnceSync ()
 
override void StartTracking (string path)
 Start the tracking using a vl-file. More...
 
override void StopTracking ()
 Stop the tracking (releases all tracking resources).
 
Frame TrackFrame (Frame frame)
 
- Public Member Functions inherited from Visometry.VisionLib.SDK.Core.TrackingManager
bool AddCameraCalibrationDB (string uri)
 Adds the camera calibration DataBase using the URI. It will not be loaded at this point but only the possibility to add it will be checked. The loading of the actual database happens when starting the tracking pipe! More...
 
delegate void CalibratedImageAction (CalibratedImage calibratedImage)
 Delegate for OnCalibratedImage events. More...
 
delegate void ExtrinsicDataAction (ExtrinsicData extrinsicData)
 Delegate for OnExtrinsicData events. More...
 
DeviceInfo GetDeviceInfo ()
 Returns the device info, when the worker object has been initialized. You can call this function in order to get useful system information before starting the tracking pipe You might use this structure for retrieving the available cameras in the system. More...
 
string GetDeviceType ()
 Returns the type of the loaded device pipeline. Works for tracking configurations loaded from a vl-file or vl-string. More...
 
LicenseInformation GetLicenseInformation ()
 
Texture2D GetStreamTexture (ImageStream streamType)
 
bool GetTrackerInitialized ()
 
string GetTrackerType ()
 Returns the type of the loaded tracking pipeline. Works for tracking configurations loaded from a vl-file or vl-string. More...
 
bool GetTrackerType (out string trackerType)
 Returns the type of the loaded tracking pipeline. Works for tracking configurations loaded from a vl-file or vl-string. More...
 
bool GetTrackingRunning ()
 
Worker GetWorker ()
 Returns the owned Worker object. More...
 
delegate void ImageAction (Image image)
 Delegate for OnImage events. More...
 
delegate void IntrinsicDataAction (IntrinsicData intrinsicData)
 Delegate for OnIntrinsicData events. More...
 
delegate void IssueTriggeredAction (Issue issue)
 Delegate for OnIssueTriggered events. More...
 
void PauseTracking ()
 Pause the tracking.
 
delegate void PerformanceInfoAction (PerformanceInfo state)
 Delegate for OnPerformanceInfo events. More...
 
void ResetTrackingHard ()
 Reset the tracking and all key frames. More...
 
void ResetTrackingSoft ()
 Reset the tracking. More...
 
void ResumeTracking ()
 Resume the tracking.
 
void SetFPS (int newFPS)
 Sets the frame rate of the tracking algorithm. This might limit the performance consumed by VisionLib. More...
 
async Task SetFPSAsync (int newFPS)
 Sets target number of frames per second for the tracking thread.
 
void SetWaitForEvents (bool wait)
 Set waitForEvents to the given value. More...
 
void StartTrackingFromString (string trackingConfig, string projectDir, string overrideParameter=null)
 Start the tracking using a tracking configuration as string. More...
 
delegate void TrackingStatesAction (TrackingState state)
 Delegate for OnTrackingStates events. More...
 

Protected Member Functions

override void CreateWorker ()
 
override void OnDestroy ()
 
override void RegisterListeners ()
 
override void RegisterTrackerListeners ()
 
override void UnregisterListeners ()
 
override void UnregisterTrackerListeners ()
 
override void Update ()
 
override void UpdateAnchorTransformListeners ()
 
- Protected Member Functions inherited from Visometry.VisionLib.SDK.Core.TrackingManager
void CreateLogger ()
 

Additional Inherited Members

- Public Types inherited from Visometry.VisionLib.SDK.Core.TrackingManager
enum class  ImageStream { None , CameraImage , DebugImage }
 
- Static Public Member Functions inherited from Visometry.VisionLib.SDK.Core.TrackingManager
static EventWrapper< SimilarityTransformAnchorTransform (string anchorName)
 
static async void CatchCommandErrors (Task task, MonoBehaviour caller=null)
 This function should be used when awaiting a Task created anywhere within the vlUnitySDK. It will await the Task while treating all VisionLib specific errors which might arise from calling a command. Using this function also preserves the call stack, so you will still be able to identify the function which causes the logged error. More...
 
static void EmitEvents (Frame frame)
 
static void InvokeOnTrackerResetHard ()
 
static void InvokeOnTrackerResetSoft ()
 
- Data Fields inherited from Visometry.VisionLib.SDK.Core.TrackingManager
string calibrationDataBaseURI
 
LicenseFile licenseFile
 Path of the license file.
 
VLSDK.LogLevel logLevel = VLSDK.LogLevel.Warning
 VisionLib log level. More...
 
int targetFPS = 30
 Target number of frames per second for the tracking thread. More...
 
bool waitForEvents = false
 Whether to wait for tracking events. More...
 
- Protected Attributes inherited from Visometry.VisionLib.SDK.Core.TrackingManager
Worker worker = null
 
object workerLock = new object()
 
- Properties inherited from Visometry.VisionLib.SDK.Core.TrackingManager
Worker Worker [get]
 
- Events inherited from Visometry.VisionLib.SDK.Core.TrackingManager
static CalibratedImageAction OnCalibratedDepthImage
 Event with the current calibrated depth image. This Event will be emitted for each tracking frame.
 
static ExtrinsicDataAction OnCameraTransform
 Event with the current extrinsic data slam. This Event will be emitted for each tracking frame.
 
static ImageAction OnDebugImage
 Event with the current debug image. This Event will be emitted for each tracking frame, if debugLevel is at least 1
 
static ExtrinsicDataAction OnExtrinsicData
 Event with the current extrinsic data. This Event will be emitted for each tracking frame.
 
static ImageAction OnImage
 Event with the current tracking image. This Event will be emitted for each tracking frame.
 
static IntrinsicDataAction OnIntrinsicData
 Event with the current intrinsic data. This Event will be emitted for each tracking frame.
 
static IssueTriggeredAction OnIssueTriggered
 Event which will be emitted if an Issue was triggered
 
static PerformanceInfoAction OnPerformanceInfo
 Event with the current tracking performance. This Event will be emitted for each tracking frame.
 
static VLSDK.VoidDelegate OnTrackerInitialized
 Event which will be emitted after the tracking configuration was loaded.
 
static VLSDK.VoidDelegate OnTrackerInitializing
 Event which will be emitted once after calling the StartTracking function.
 
static VLSDK.VoidDelegate OnTrackerPaused
 Event which will be emitted after the tracking was paused.
 
static VLSDK.VoidDelegate OnTrackerResetHard
 Event which will be emitted after a hard reset was executed.
 
static VLSDK.VoidDelegate OnTrackerResetSoft
 Event which will be emitted after a soft reset was executed.
 
static VLSDK.VoidDelegate OnTrackerRunning
 Event which will be emitted once after the tracking was stopped or paused and is now running again.
 
static VLSDK.VoidDelegate OnTrackerStopped
 Event which will be emitted after the tracking was stopped or the initialization of the tracker has failed.
 
static TrackingStatesAction OnTrackingStates
 Event with the current tracking state of all tracked objects. This Event will be emitted for each tracking frame.
 
static VLSDK.VoidDelegate OnWorkerCreated
 Event which will be emitted once after the worker has been created.
 

Member Function Documentation

◆ StartTracking()

override void Visometry.VisionLib.SDK.Core.SynchronousTrackingManager.StartTracking ( string  filename)
inlinevirtual

Start the tracking using a vl-file.

The type of the tracker will be derived from the vl-file.

Reimplemented from Visometry.VisionLib.SDK.Core.TrackingManager.