documentation

VLSynchronousWorkerBehaviour Class Reference

Inherits VLWorkerBehaviour.

Public Member Functions

bool IsReady ()
 
void Push (VLInputFrame 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). More...
 
VLFrame TrackFrame (VLFrame frame)
 
- Public Member Functions inherited from VLWorkerBehaviour
bool AddCameraCalibrationDB (string uri)
 Adds the camera calibration DataBase using the URI. It will not be loaded at this point but only the addability checked. The loading of the actual database happens when starting the tracking pipe! More...
 
delegate void CalibrationDataAction (VLCameraCalibration result)
 
delegate void ExtrinsicDataAction (VLExtrinsicDataWrapper extrinsicData)
 Delegate for OnExtrinsicData events. More...
 
VLDeviceInfo 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 retreiving 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...
 
VLLicenseInformation 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 ()
 
VLWorker GetWorker ()
 Returns the owned VLWorker object. More...
 
delegate void ImageAction (VLImageWrapper image)
 Delegate for OnImage events. More...
 
delegate void IntrinsicDataAction (VLIntrinsicDataWrapper intrinsicData)
 Delegate for OnIntrinsicData events. More...
 
delegate void IssuesTriggeredAction (VLIssues errors, VLIssues warnings)
 Delegate for OnIssuesTriggered events. More...
 
void PauseTracking ()
 Pause the tracking. More...
 
delegate void PerformanceInfoAction (VLPerformanceInfo state)
 Delegate for OnPerformanceInfo events. More...
 
void ResetTrackingHard ()
 Reset the tracking and all keyframes. More...
 
void ResetTrackingSoft ()
 Reset the tracking. More...
 
void ResumeTracking ()
 Resume the tracking. More...
 
void RunTrackingOnce ()
 Runs the tracking once while the tracking is paused. More...
 
bool SetCameraCalibrationState (string camCalibState)
 
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 TrackerInitializedAction (bool success)
 Delegate for OnTrackerInitialized events. More...
 
delegate void TrackerInitializedWithIssuesAction (VLTrackingIssues errors, VLTrackingIssues warnings)
 Delegate for OnTrackerInitializedWithIssues events. More...
 
delegate void TrackerInitializingAction ()
 Delegate for OnTrackerInitializing events. More...
 
delegate void TrackerPausedAction (bool success)
 Delegate for OnTrackerPaused events. More...
 
delegate void TrackerRanOnceAction (bool success)
 Delegate for OnTrackerRanOnce events. More...
 
delegate void TrackerResetHardAction (bool success)
 Delegate for TrackerResetHardAction events. More...
 
delegate void TrackerResetSoftAction (bool success)
 Delegate for OnTrackerResetSoft events. More...
 
delegate void TrackerRunningAction (bool success)
 Delegate for OnTrackerRunning events. More...
 
delegate void TrackerStoppedAction (bool success)
 Delegate for OnTrackerStopped events. More...
 
delegate void TrackingStatesAction (VLTrackingState state)
 Delegate for OnTrackingStates events. More...
 
delegate void WorkerCreatedAction ()
 Delegate for OnWorkerCreated events. More...
 
bool WriteCameraCalibration (string uri)
 

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 ()
 

Additional Inherited Members

- Public Types inherited from VLWorkerBehaviour
enum  ImageStream { None, CameraImage, DebugImage }
 
- Static Public Member Functions inherited from VLWorkerBehaviour
static EventWrapper< VLSimilarityTransformWrapperAnchorTransform (string anchorName)
 
static void EmitEvents (VLFrame frame)
 
- Data Fields inherited from VLWorkerBehaviour
string calibrationDataBaseURI
 
VLLicenseFile licenseFile
 Path of the license file. More...
 
VLUnitySdk.LogLevel logLevel = VLUnitySdk.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 VLWorkerBehaviour
VLWorker worker = null
 
object workerLock = new object()
 
- Static Protected Attributes inherited from VLWorkerBehaviour
static VLAnchorObservableMap anchorObservableMap = new VLAnchorObservableMap()
 
- Events inherited from VLWorkerBehaviour
static CalibrationDataAction OnCameraCalibrationData
 
static ExtrinsicDataAction OnCameraTransform
 Event with the current extrinsic data slam. This Event will be emitted for each tracking frame. More...
 
static ImageAction OnDebugImage
 Event with the current debug image. This Event will be emitted for each tracking frame, if debugLevel is at least 1 More...
 
static ExtrinsicDataAction OnExtrinsicData
 Event with the current extrinsic data. This Event will be emitted for each tracking frame. More...
 
static ImageAction OnImage
 Event with the current tracking image. This Event will be emitted for each tracking frame. More...
 
static IntrinsicDataAction OnIntrinsicData
 Event with the current intrinsic data. This Event will be emitted for each tracking frame. More...
 
static IssuesTriggeredAction OnIssuesTriggered
 Event which will be emitted if an VLIssue was triggered More...
 
static PerformanceInfoAction OnPerformanceInfo
 Event with the current tracking performance. This Event will be emitted for each tracking frame. More...
 
static TrackerInitializedAction OnTrackerInitialized
 Event which will be emitted after the tracking configuration was loaded. More...
 
static TrackerInitializedWithIssuesAction OnTrackerInitializedWithIssues
 Event which will be emitted after the tracking configuration was loaded. More...
 
static TrackerInitializingAction OnTrackerInitializing
 Event which will be emitted once after calling the StartTracking function. More...
 
static TrackerPausedAction OnTrackerPaused
 Event which will be emitted after the tracking was paused. More...
 
static TrackerRanOnceAction OnTrackerRanOnce
 Event which will be emitted once after the tracking was explicitly ran once. More...
 
static TrackerResetHardAction OnTrackerResetHard
 Event which will be emitted after a hard reset was executed. More...
 
static TrackerResetSoftAction OnTrackerResetSoft
 Event which will be emitted after a soft reset was executed. More...
 
static TrackerRunningAction OnTrackerRunning
 Event which will be emitted once after the tracking was stopped or paused and is now running again. More...
 
static TrackerStoppedAction OnTrackerStopped
 Event which will be emitted after the tracking was stopped. More...
 
static TrackingStatesAction OnTrackingStates
 Event with the current tracking state of all tracked objects. This Event will be emitted for each tracking frame. More...
 
static WorkerCreatedAction OnWorkerCreated
 Event which will be emitted once after the worker has been created. More...
 

Member Function Documentation

◆ StartTracking()

override void VLSynchronousWorkerBehaviour.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 VLWorkerBehaviour.

◆ StopTracking()

override void VLSynchronousWorkerBehaviour.StopTracking ( )
inlinevirtual

Stop the tracking (releases all tracking resources).

Reimplemented from VLWorkerBehaviour.