Target LED

Detailed Description

Use these functions to control the LED light on a tracker target. Currently, only the zSpace stylus has this capability.

List of Functions

void  ZSCore::SetTrackerTargetLedEnabled (TrackerTargetType trackerTargetType, bool isLedEnabled)
  Set whether the tracker target's LED is enabled.
bool  ZSCore::IsTrackerTargetLedEnabled (TrackerTargetType trackerTargetType)
  Check whether the tracker target's LED is enabled.
bool  ZSCore::IsTrackerTargetLedOn (TrackerTargetType trackerTargetType)
  Check whether the tracker target's LED is on.
void  ZSCore::SetTrackerTargetLedColor (TrackerTargetType trackerTargetType, LedColor ledColor)
  Set the tracker target's LED color.
LedColor  ZSCore::GetTrackerTargetLedColor (TrackerTargetType trackerTargetType)
  Get the tracker target's LED color.

List of Enumerations

enum   ZSCore::LedColor {
  ZSCore::Black = 0,
  ZSCore::White = 1,
  ZSCore::Red = 2,
  ZSCore::Green = 3,
  ZSCore::Blue = 4,
  ZSCore::Cyan = 5,
  ZSCore::Magenta = 6,
  ZSCore::Yellow = 7
}

Function Descriptions

LedColor ZSCore:: GetTrackerTargetLedColor ( TrackerTargetType  trackerTargetType ) [inline]

Get the tracker target's LED color.

Parameters:
trackerTargetType The type of tracker target.
Returns:
The color of the LED.
bool ZSCore:: IsTrackerTargetLedEnabled ( TrackerTargetType  trackerTargetType ) [inline]

Check whether the tracker target's LED is enabled.

Parameters:
trackerTargetType The type of tracker target.
Returns:
True if the LED is enabled. False if not.
bool ZSCore:: IsTrackerTargetLedOn ( TrackerTargetType  trackerTargetType ) [inline]

Check whether the tracker target's LED is on.

Parameters:
trackerTargetType The type of tracker target.
Returns:
True if the LED is on. False if not.
void ZSCore:: SetTrackerTargetLedColor ( TrackerTargetType  trackerTargetType,
LedColor  ledColor 
) [inline]

Set the tracker target's LED color.

Parameters:
trackerTargetType The type of tracker target.
ledColor The color of the LED.
void ZSCore:: SetTrackerTargetLedEnabled ( TrackerTargetType  trackerTargetType,
bool  isLedEnabled 
) [inline]

Set whether the tracker target's LED is enabled.

Parameters:
trackerTargetType The type of tracker target.
isLedEnabled True to enable the LED. False if not.

Enumeration Descriptions

enum ZSCore::LedColor

Defines a color to be displayed by the stylus' LED.

Enumerator:
Black 
White 
Red 
Green 
Blue 
Cyan 
Magenta 
Yellow