PSTech.Pstsdk Namespace Reference

Classes
class	CApi
class	ErrorHandler
	This class is responsible for handling errors.
struct	CTracker
	Main PstSdk struct for tracker communication.
struct	CTargetPose
	Estimated tracking target pose.
struct	CTrackerData
	Tracking information retrieved from tracker.
struct	CCameraURLs
	Struct to request urls for calibration information.
struct	CImage
	Images retrieved from the tracker.
struct	CTargetMarkers
	Collection struct for PstTargetMarker.
interface	ICApi
	Interface which contains non static mapping functions of CApi.
class	Image
	Images retrieved from the tracker. More...
class	TargetPose
	Estimated tracking target pose. More...
struct	Target
	Tracking target information. More...
struct	Point
	Estimated 3D marker location. More...
struct	TargetStatus
	Tracking target status. More...
struct	TargetMarker
	3D marker positions of a single marker of a tracking Target. More...
struct	CameraInfo
	Information for a single camera of the connected PST Tracker. More...
class	TrackerListener
	Implements the TrackerListener class to receive tracking information and tracking mode updates. More...
class	Tracker
	Main PST SDK class implementing tracker communication. More...
class	TrackerData
	Tracking information retrieved from tracker. More...
class	Utils
	This class contains common functions.

Enumerations
enum	ErrorStatus {   Ok , TrackerError , NotInitializedError , NotSupportedError ,   OutOfRangeError , NotFoundError , HttpError , FailedToAllocateMemoryError ,   NullptrError , ImageRetrivalFailedError , InvalidDataError , AlreadyExistsError ,   JSONError }
	Tracker error messages enum class. More...
enum	StatusMessage {   Ok , NotInitialized , Disconnected , ErrGeneral ,   ErrTimeout , ErrNoCamsFound , ErrNotEnoughCamsFound , ErrInitError ,   ErrCanNotStartCams , ErrCanNotSetupCams , ErrNullTrackerHandle , ErrUnknownStatus }
	Tracker status messages enum class. More...
enum	ETrackerMode {   ModeLowpower , ModeSetup , ModeTracking , ModeTraining ,   ModeDisconnect , ModeReconnect , ModeError , ModeUnknown }
	Tracker mode enum class. More...
enum	TrackingRegion { Optimal , Full }
	Region of the tracking working space in which markers are reported. More...

Enumeration Type Documentation

ErrorStatus

enum PSTech.Pstsdk.ErrorStatus

This enum class lists all error states that can be reported by the tracker.

Enumerator
Ok	No error.
TrackerError	General tracker error.
NotInitializedError	A call was made to an uninitialized tracker.
NotSupportedError	The requested functionality is not supported by this tracker.
OutOfRangeError	The supplied value is outside of the accepted range.
NotFoundError	The requested data could not be found.
HttpError	An HTTP error was thrown by the Rest server.
FailedToAllocateMemoryError	Failed to allocate memory.
NullptrError	The supplied tracker was a null pointer.
ImageRetrivalFailedError	Image retrieval failed.
InvalidDataError	Data provided did not match the requirements.
AlreadyExistsError	The request could not be executed because the object alreay exists.
JSONError	An error occurred while processing JSON information.

Examples

exposure/exposure.cs, images/images.cs, listener/listener.cs, minimal/minimal.cs, reference/reference.cs, and trackingtarget/trackingtarget.cs.

ETrackerMode

enum PSTech.Pstsdk.ETrackerMode

This enum class lists all modes that can be reported by the tracker.

Enumerator
ModeLowpower	Tracker is in lowpower mode waiting for activity to resume.
ModeSetup	Tracker is in setup mode.
ModeTracking	Tracker is in tracking mode.
ModeTraining	Tracker is in training mode.
ModeDisconnect	Tracker has been disconnected.
ModeReconnect	Tracker has been reconnected.
ModeError	Tracker has encountered an error.
ModeUnknown	Tracker is in an unknown state.

Examples

listener/listener.cs.

StatusMessage

enum PSTech.Pstsdk.StatusMessage

This enum class lists all status messages that can be reported by the tracker.

See also

Tracker.Systemcheck()

Enumerator
Ok	The system is running OK.
NotInitialized	Tracker failed to initialize correctly.
Disconnected	The grabber has been disconnected.
ErrGeneral	Unspecified grabber error.
ErrTimeout	Grabber timeout error.
ErrNoCamsFound	Grabber could not detect any cameras.
ErrNotEnoughCamsFound	Grabber could not detect sufficient cameras.
ErrInitError	Grabber did not initialize correctly.
ErrCanNotStartCams	Grabber could not start cameras.
ErrCanNotSetupCams	Grabber failed setting up cameras.
ErrNullTrackerHandle	Tracker not created or freed.
ErrUnknownStatus	Unknown status message.

TrackingRegion

enum PSTech.Pstsdk.TrackingRegion

The TrackingRegion enum defines the possible regions in the tracker working space where markers can be reported. Markers reported in the Optimal region of the working space are tracked with high accuracy. Markers reported in the Full region of the working space are outside of the Optimal region and have no guaranteed accuracy.

Enumerator
Optimal	Only markers detected in the calibrated optimal region are reported.
Full	All detected markers are reported, regardless of region.