Tracker Device API

Detailed Description

Tracker devices represent the hardware and software that tracks individual targets.

List of Functions

ZSError  zsGetNumTrackerDevices (ZSContext context, ZSInt32* numDevices)
ZSError  zsFindTrackerDevice (ZSContext context, ZSInt32 index, ZSHandle* deviceHandle)
ZSError  zsFindTrackerDeviceByName (ZSContext context, const char* deviceName, ZSHandle* deviceHandle)
ZSError  zsSetTrackerDeviceEnabled (ZSHandle deviceHandle, ZSBool isEnabled)
ZSError  zsIsTrackerDeviceEnabled (ZSHandle deviceHandle, ZSBool* isEnabled)
ZSError  zsGetTrackerDeviceName (ZSHandle deviceHandle, char* buffer, ZSInt32 bufferSize)

Function Descriptions

ZSError zsFindTrackerDevice ( ZSContext  context,
ZSInt32  index,
ZSHandle*   deviceHandle 
)

Gets the handle to a tracker device at a specified index.

Parameters:
[in] context A handle to the internal state of the zSpace SDK.
[in] index The index of the tracker device.
[out] deviceHandle A handle to the tracker device.
ZSError zsFindTrackerDeviceByName ( ZSContext  context,
const char*   deviceName,
ZSHandle*   deviceHandle 
)

Gets the handle to a tracker device for a specified device name.

Parameters:
[in] context A handle to the internal state of the zSpace SDK.
[in] deviceName The tracker device's name.
[out] deviceHandle A handle to the tracker device.
ZSError zsGetNumTrackerDevices ( ZSContext  context,
ZSInt32*   numDevices 
)

Gets the number of available tracker devices.

Parameters:
[in] context A handle to the internal state of the zSpace SDK.
[out] numDevices The number of available tracker devices.
ZSError zsGetTrackerDeviceName ( ZSHandle  deviceHandle,
char*   buffer,
ZSInt32  bufferSize 
)

Gets the name for the specified tracker device.

Parameters:
[in] deviceHandle A handle to the tracker device.
[out] buffer The user allocated character buffer to store the tracker device's name.
[in] bufferSize The size of the user allocated buffer.
ZSError zsIsTrackerDeviceEnabled ( ZSHandle  deviceHandle,
ZSBool*   isEnabled 
)

Checks whether a tracker device is enabled.

Parameters:
[in] deviceHandle A handle to the tracker device.
[out] isEnabled True if enabled, false otherwise.
ZSError zsSetTrackerDeviceEnabled ( ZSHandle  deviceHandle,
ZSBool  isEnabled 
)

Sets whether a tracker device is enabled.

Parameters:
[in] deviceHandle A handle to the tracker device.
[in] isEnabled True to enable the device, false otherwise.