Tracker Device API module

Contents

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

Functions

auto zcGetNumTrackerDevices(ZCContext context, ZSInt32* numDevices) -> ZCError
auto zcGetTrackerDevice(ZCContext context, ZSInt32 index, ZCHandle* deviceHandle) -> ZCError
auto zcGetTrackerDeviceByName(ZCContext context, const char* deviceName, ZCHandle* deviceHandle) -> ZCError
auto zcSetTrackerDeviceEnabled(ZCHandle deviceHandle, ZSBool isEnabled) -> ZCError
auto zcIsTrackerDeviceEnabled(ZCHandle deviceHandle, ZSBool* isEnabled) -> ZCError
auto zcGetTrackerDeviceName(ZCHandle deviceHandle, char* buffer, ZSInt32 bufferSize) -> ZCError
auto zcGetTrackerDeviceNameSize(ZCHandle deviceHandle, ZSInt32* size) -> ZCError

Function documentation

ZCError zcGetNumTrackerDevices(ZCContext context, ZSInt32* numDevices)

Parameters
context in A handle to the internal state of the zSpace SDK.
numDevices out The number of available tracker devices.

Gets the number of available tracker devices.

ZCError zcGetTrackerDevice(ZCContext context, ZSInt32 index, ZCHandle* deviceHandle)

Parameters
context in A handle to the internal state of the zSpace SDK.
index in The index of the tracker device.
deviceHandle out A handle to the tracker device.

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

ZCError zcGetTrackerDeviceByName(ZCContext context, const char* deviceName, ZCHandle* deviceHandle)

Parameters
context in A handle to the internal state of the zSpace SDK.
deviceName in The tracker device's name.
deviceHandle out A handle to the tracker device.

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

ZCError zcSetTrackerDeviceEnabled(ZCHandle deviceHandle, ZSBool isEnabled)

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

Sets whether a tracker device is enabled.

ZCError zcIsTrackerDeviceEnabled(ZCHandle deviceHandle, ZSBool* isEnabled)

Parameters
deviceHandle in A handle to the tracker device.
isEnabled out True if enabled, false otherwise.

Checks whether a tracker device is enabled.

ZCError zcGetTrackerDeviceName(ZCHandle deviceHandle, char* buffer, ZSInt32 bufferSize)

Parameters
deviceHandle in A handle to the tracker device.
buffer out The user allocated character buffer to store the tracker device's name.
bufferSize in The size of the user allocated buffer.

Gets the name for the specified tracker device.

ZCError zcGetTrackerDeviceNameSize(ZCHandle deviceHandle, ZSInt32* size)

Parameters
deviceHandle in A handle to the tracker device.
size out The size of the name in bytes.

Gets the size of the tracker device's name in bytes.