PST SDK  6.0.0.0-272350a
examples.dox File Reference
PSTech.Pstsdk.Point.Position
float[] Position
3D marker location.
Definition: Tracker.cs:45
PSTech.Pstsdk.Tracker.DisableFiltering
void DisableFiltering()
Disable filtering of the tracking results.
Definition: Tracker.cs:601
PSTech.Pstsdk.Tracker.DisableImageTransfer
void DisableImageTransfer()
Disable image transfer from the PST Tracker.
Definition: Tracker.cs:679
PSTech.Pstsdk.Tracker.ExportJSONModel
string ExportJSONModel(string modelName)
Export a tracking target model as a JSON-formatted string.
Definition: Tracker.cs:1057
PSTech.Pstsdk.TargetPose.MatchedPoints
Point[] MatchedPoints
Definition: TargetPose.cs:43
PSTech.InvalidDataException
Data provided did not match the requirements.
Definition: TrackerExceptions.cs:159
PSTech.Pstsdk.TargetStatus
Tracking target status.
Definition: Tracker.cs:59
PSTech.Pstsdk.Tracker.EnableLogging
static void EnableLogging()
Write plug-in status information to the standard error stream.
Definition: Tracker.cs:1003
PSTech.Pstsdk.Tracker.SetFramerate
void SetFramerate(double fps)
Set tracker frame rate.
Definition: Tracker.cs:489
PSTech.Pstsdk.Tracker.LoadCalibrationFromLocalPath
void LoadCalibrationFromLocalPath(string path)
Load calibration information from a given path.
Definition: Tracker.cs:262
PSTech.Pstsdk.Tracker.SetTargetId
void SetTargetId(string targetName, int id)
Set the id of the tracking target.
Definition: Tracker.cs:801
PSTech.Pstsdk.TrackerData.TargetPoseList
TargetPose[] TargetPoseList
Definition: TrackerData.cs:58
PSTech.Pstsdk.Tracker.Systemcheck
StatusMessage Systemcheck()
Check if the tracker is running correctly.
Definition: Tracker.cs:478
PSTech.Pstsdk.Tracker.DisableTremorFilter
void DisableTremorFilter()
Disable the tremor filter.
Definition: Tracker.cs:653
PSTech.Pstsdk.Tracker.GetTargetStatus
bool GetTargetStatus(string targetName)
Get status of a single tracking Target.
Definition: Tracker.cs:762
PSTech.Pstsdk.Tracker.GetConfigPath
string GetConfigPath()
Get the path to the current configuration directory.
Definition: Tracker.cs:342
PSTech.Pstsdk
Definition: CApi.cs:8
PSTech.Pstsdk.TargetMarker.Coordinates
float[] Coordinates
3D marker position of a tracking Target.
Definition: Tracker.cs:76
PSTech.Pstsdk.Image.Width
int Width
Definition: Image.cs:45
PSTech.Pstsdk.Tracker.GetConnectedCameraUrls
string[] GetConnectedCameraUrls(bool silent=false)
Get URLs of the calibration information for the connected PST Tracker.
Definition: Tracker.cs:274
PSTech.JSONException
A JSON parsing error was thrown by the Rest server.
Definition: TrackerExceptions.cs:191
PSTech.Pstsdk.Tracker.GetTargetMarkers
TargetMarker[] GetTargetMarkers(string targetName)
Get 3D marker positions of stored tracking Target.
Definition: Tracker.cs:779
PSTech.Pstsdk.Tracker.GetReference
float[] GetReference()
Gets the transformation matrix for the current reference system.
Definition: Tracker.cs:848
PSTech.Pstsdk.TrackerListener.OnTrackerMode
virtual void OnTrackerMode(ETrackerMode trackerMode)
Callback function receiving mode updates from the the tracker.
Definition: Tracker.cs:109
PSTech.Pstsdk.Tracker.GetTargetList
TargetStatus[] GetTargetList()
Get TargetStatuses object containing all tracking targets and their status.
Definition: Tracker.cs:716
PSTech.Pstsdk.Tracker.Dispose
void Dispose()
Dispose method.
Definition: Tracker.cs:960
PSTech.Pstsdk.ErrorStatus
ErrorStatus
Tracker error messages enum class.
Definition: ErrorHandler.cs:16
PSTech.Pstsdk.StatusMessage
StatusMessage
Tracker status messages enum class.
Definition: ErrorHandler.cs:50
PSTech.Pstsdk.Target
Tracking target information.
Definition: Tracker.cs:18
PSTech.Pstsdk.Tracker.GetExposure
double GetExposure()
Get the current exposure time.
Definition: Tracker.cs:552
PSTech.Pstsdk.TargetMarker
3D marker positions of a single marker of a tracking Target.
Definition: Tracker.cs:72
PSTech.Pstsdk.TrackerListener.OnTrackerData
virtual void OnTrackerData(TrackerData trackerData, ErrorStatus errorStatus)
Callback function receiving tracking information from the tracker.
Definition: Tracker.cs:100
PSTech.Pstsdk.Tracker.StartTracker
void StartTracker()
Start tracking.
Definition: Tracker.cs:434
PSTech.Pstsdk.Tracker.AddTrackerListener
void AddTrackerListener(ref TrackerListener listener)
Add a listener for tracker data and/or mode change reporting.
Definition: Tracker.cs:391
PSTech.Pstsdk.TrackerData.PointList
Point[] PointList
Definition: TrackerData.cs:60
PSTech.Pstsdk.TargetStatus.Target
Target Target
Tracking target information.
Definition: Tracker.cs:62
PSTech.Pstsdk.Image
Images retrieved from the tracker.
Definition: Image.cs:19
PSTech.OutOfRangeException
The supplied value is outside of the accepted range.
Definition: TrackerExceptions.cs:63
Exception
PSTech.Pstsdk.Point.Id
int Id
Marker identifier.
Definition: Tracker.cs:42
PSTech.Pstsdk.Tracker.GetUncalibratedCameraUrls
string[] GetUncalibratedCameraUrls(bool silent=false)
Check if cameras of the connected PST Tracker are calibrated.
Definition: Tracker.cs:299
IDisposable
PSTech.Pstsdk.Tracker.GetSingleMeasurement
TrackerData GetSingleMeasurement()
Retrieve latest available data from the connected PST Tracker.
Definition: Tracker.cs:368
PSTech.Pstsdk.TrackerData
Tracking information retrieved from tracker.
Definition: TrackerData.cs:24
PSTech.Pstsdk.TargetPose.Target
Target Target
Definition: TargetPose.cs:39
PSTech.Pstsdk.Tracker.GetVersionInfo
string GetVersionInfo()
Get version information of the SDK.
Definition: Tracker.cs:319
PSTech.NotInitializedException
Data provided did not match the requirements.
Definition: TrackerExceptions.cs:31
PSTech.Pstsdk.Tracker.SetDefaultReference
void SetDefaultReference()
Reset the reference system to the default reference system.
Definition: Tracker.cs:833
PSTech.Pstsdk.TrackerData.Seqnumber
int Seqnumber
Definition: TrackerData.cs:56
PSTech.NotSupportedException
The requested functionality is not supported by this tracker.
Definition: TrackerExceptions.cs:47
PSTech.Pstsdk.Tracker.DisableSharedMemory
static void DisableSharedMemory()
Disable shared memory communication layer.
Definition: Tracker.cs:896
PSTech.Pstsdk.TargetPose.PoseMatrix
float[] PoseMatrix
Definition: TargetPose.cs:41
PSTech.OutOfMemoryException
Failed to allocate memory.
Definition: TrackerExceptions.cs:111
PSTech.Pstsdk.Tracker.EnableTremorFilter
void EnableTremorFilter()
Enable the tremor filter.
Definition: Tracker.cs:644
PSTech.Pstsdk.Tracker.GetTargetInfo
Target GetTargetInfo(string targetName)
Get basic tracking target information.
Definition: Tracker.cs:738
PSTech.Pstsdk.TargetPose
Estimated tracking target pose.
Definition: TargetPose.cs:23
PSTech.Pstsdk.Tracker.DisableRestServer
static void DisableRestServer()
Disable the REST server communication layer.
Definition: Tracker.cs:943
PSTech.Pstsdk.Tracker.SetPositionFilter
void SetPositionFilter(double value)
Set the strength of the position filter.
Definition: Tracker.cs:614
PSTech.Pstsdk.Tracker.EnableFiltering
void EnableFiltering()
Enable filtering of the tracking results.
Definition: Tracker.cs:590
PSTech.Pstsdk.Tracker.RemoveTargetModel
void RemoveTargetModel(string modelName)
Remove a tracking target model from the target model database.
Definition: Tracker.cs:1077
PSTech.Pstsdk.Tracker.GetSupportedFramerates
float[] GetSupportedFramerates()
Get array of available frame rates.
Definition: Tracker.cs:516
PSTech.Pstsdk.Tracker.RemoveTrackerListener
void RemoveTrackerListener(ref TrackerListener listener)
Remove a listener for tracker data and/or mode change reporting.
Definition: Tracker.cs:418
PSTech.Pstsdk.Target.Uuid
string Uuid
Unique identifier, automatically assigned to the tracking target.
Definition: Tracker.cs:25
PSTech.Pstsdk.Tracker.GetExposureRange
void GetExposureRange(ref double min, ref double max)
Get the allowed exposure range.
Definition: Tracker.cs:571
PSTech.Pstsdk.Tracker.SetTargetStatus
void SetTargetStatus(string targetName, bool active)
Set status of a single tracking Target.
Definition: Tracker.cs:752
PSTech.Pstsdk.Tracker.EnableImageTransfer
void EnableImageTransfer()
Enable image transfer from the PST Tracker.
Definition: Tracker.cs:668
PSTech.Pstsdk.Tracker.SetReference
void SetReference(float[] creference, bool relative=false)
Set the reference system in which tracking results are reported
Definition: Tracker.cs:820
PSTech.Pstsdk.ETrackerMode
ETrackerMode
Tracker mode enum class.
Definition: ErrorHandler.cs:81
PSTech.Pstsdk.Point
Estimated 3D marker location.
Definition: Tracker.cs:39
PSTech.Pstsdk.TrackerData.Timestamp
double Timestamp
Definition: TrackerData.cs:54
PSTech.Pstsdk.TrackerListener
Implements the TrackerListener class to receive tracking information and tracking mode updates.
Definition: Tracker.cs:91
PSTech.Pstsdk.Tracker.GetFramerate
double GetFramerate()
Get current frame rate.
Definition: Tracker.cs:499
PSTech.AlreadyExistsException
The request could not be executed because the object alreay exists.
Definition: TrackerExceptions.cs:175
PSTech.Pstsdk.Image.NumberOfImages
int NumberOfImages
Definition: Image.cs:49
PSTech.HttpException
An HTTP error was thrown by the Rest server.
Definition: TrackerExceptions.cs:95
PSTech
Definition: CApi.cs:8
PSTech.ImageRetrievalException
Image retrieval failed.
Definition: TrackerExceptions.cs:143
PSTech.Pstsdk.Tracker
Main PST SDK class implementing tracker communication.
Definition: Tracker.cs:120
PSTech.Pstsdk.Target.Name
string Name
User given name of the tracking target as listed in the PST-Client software
Definition: Tracker.cs:22
PSTech.Pstsdk.Target.Id
int Id
User provided tracking id assigned to the tacking target as listed in the PST-Client software
Definition: Tracker.cs:27
PSTech.Pstsdk.Tracker.SetExposure
void SetExposure(double exposure)
Set the exposure time.
Definition: Tracker.cs:543
PSTech.Pstsdk.TargetStatus.Status
bool Status
Status of the tracking target (active or inactive) as listed in the PST-Client software.
Definition: Tracker.cs:65
PSTech.Pstsdk.Tracker.EnableSharedMemory
static void EnableSharedMemory()
Enable shared memory communication layer.
Definition: Tracker.cs:878
PSTech.Pstsdk.Tracker.ImportJSONModel
void ImportJSONModel(string jsonModel)
Import a tracking target model into the target model database.
Definition: Tracker.cs:1043
PSTech.NullReferenceException
Internal error.
Definition: TrackerExceptions.cs:127
PSTech.Pstsdk.Image.Images
IntPtr[] Images
Definition: Image.cs:51
PSTech.Pstsdk.Tracker.GetImage
Image GetImage()
Retrieve images from the connected PST Tracker.
Definition: Tracker.cs:693
PSTech.TrackerException
Generic tracker exception.
Definition: TrackerExceptions.cs:15
PSTech.Pstsdk.Tracker.Tracker
Tracker()
Tracker constructor.
Definition: Tracker.cs:139
PSTech.Pstsdk.Tracker.Shutdown
static void Shutdown()
Shutdown the tracking system, stopping tracking.
Definition: Tracker.cs:458
PSTech.Pstsdk.Tracker.EnableRestServer
static void EnableRestServer(string serverAddress="localhost", string serverPort="7278", int eventStreamRetryTimeout=3000)
Enable a REST Server using the HTTP protocol on a local area network.
Definition: Tracker.cs:922
PSTech.NotFoundException
The requested data could not be found.
Definition: TrackerExceptions.cs:79
PSTech.Pstsdk.Tracker.SetOrientationFilter
void SetOrientationFilter(double value)
Set the strength of the orientation filter.
Definition: Tracker.cs:627
PSTech.Pstsdk.Image.Height
int Height
Definition: Image.cs:47
PSTech.Pstsdk.Tracker.GetSDKVersion
static string GetSDKVersion()
Retrieve the SDK version string.
Definition: Tracker.cs:1019
PSTech.Pstsdk.Tracker.PauseTracker
void PauseTracker()
Pause tracking.
Definition: Tracker.cs:445