Target LED API module

Reference
- Functions

This set of functions controls the LED light on a tracker target. Currently, only the zSpace stylus has this capability.

Functions

auto zcSetTargetLedEnabled(ZCHandle targetHandle, ZSBool isLedEnabled) -> ZCError
auto zcIsTargetLedEnabled(ZCHandle targetHandle, ZSBool* isLedEnabled) -> ZCError
auto zcIsTargetLedOn(ZCHandle targetHandle, ZSBool* isLedOn) -> ZCError
auto zcSetTargetLedColor(ZCHandle targetHandle, ZSFloat r, ZSFloat g, ZSFloat b) -> ZCError
auto zcGetTargetLedColor(ZCHandle targetHandle, ZSFloat* r, ZSFloat* g, ZSFloat* b) -> ZCError

Function documentation

ZCError zcSetTargetLedEnabled(ZCHandle targetHandle, ZSBool isLedEnabled)

Parameters
targetHandle in	A handle to the tracker target.
isLedEnabled in	True to enable the LED, false otherwise.

Sets whether a tracker target's LED light is enabled.

ZCError zcIsTargetLedEnabled(ZCHandle targetHandle, ZSBool* isLedEnabled)

Parameters
targetHandle in	A handle to the tracker target.
isLedEnabled out	True if enabled, false otherwise.

Checks whether a tracker target's LED light is enabled.

ZCError zcIsTargetLedOn(ZCHandle targetHandle, ZSBool* isLedOn)

Parameters
targetHandle in	A handle to the tracker target.
isLedOn out	True if on, false otherwise.

Checks whether a tracker target's LED light is on.

ZCError zcSetTargetLedColor(ZCHandle targetHandle, ZSFloat r, ZSFloat g, ZSFloat b)

Parameters
targetHandle in	A handle to the tracker target.
r in	1 to turn red on, 0 to turn red off.
g in	1 to turn green on, 0 to turn green off.
b in	1 to turn blue on, 0 to turn blue off.

Sets the color of a tracker target's LED light.

Example:

// Assume the ZCContext has been properly initialized by zcInitialize().
ZCContext context = ...;

// Get a handle to the stylus target.
ZCHandle stylusHandle = NULL;
zcGetTargetByType(context, ZC_TARGET_TYPE_PRIMARY, 0, &stylusHandle);

// Enable the stylus' LED.
zcSetTargetLedEnabled(stylusHandle, true);

// Set LED to red.
zcSetTargetLedColor(stylusHandle, 1, 0, 0);

ZCError zcGetTargetLedColor(ZCHandle targetHandle, ZSFloat* r, ZSFloat* g, ZSFloat* b)

Parameters
targetHandle in	A handle to the tracker target.
r out	1 if red is on, 0 otherwise.
g out	1 if green is on, 0 otherwise.
b out	1 if blue is on, 0 otherwise.

Gets the rgb values of a tracker target's LED light.