ArDrawingData Class Reference

#include <ArDrawingData.h>

List of all members.

Public Member Functions
	ArDrawingData (const char *shape, ArColor primaryColor, int size, int layer, unsigned int defaultRefreshTime=200, ArColor secondaryColor=ArColor(255, 255, 255))
	Constructor.
unsigned int	getDefaultRefreshTime (void)
	Gets how often this data should be drawn (0 == only when explicitly sent).
int	getLayer (void)
	Gets the layer to draw at (see MobileEyes docs for what layer means).
ArColor	getPrimaryColor (void)
	Gets the primary color (meaning depending on shape).
ArColor	getSecondaryColor (void)
	Gets the secondary color (meaning depends on shape).
const char *	getShape (void)
	Returns the shape of data to draw.
int	getSize (void)
	Gets the size (meaning depends on shape, but its in mm).
void	setDefaultRefreshTime (unsigned int refreshTime)
	Gets how often this data should be drawn (0 == only when explicitly sent).
void	setLayer (int layer)
	Sets the layer (see MobileEyes for docs on what layer means).
void	setPrimaryColor (ArColor color)
	Sets the primary color (meaning depends on shape).
void	setSecondaryColor (ArColor color)
	Sets the secondary color (meaning depends on shape).
void	setShape (const char *shape)
	Sets the shape of data to draw.
void	setSize (int size)
	Sets the size (meaning depends on shape, but its in mm).
virtual	~ArDrawingData ()
	Destructor.
Protected Attributes
unsigned int	myDefaultRefreshTime
int	myLayer
ArColor	myPrimaryColor
ArColor	mySecondaryColor
std::string	myShape
int	mySize

---

Detailed Description

The following shapes are currently recognized:

• "polyDots" - a set of small ellipses centered on each point. Each ellipse is "size" mm in diameter. (Example: laser)
• "polyArrows" - a set of small arrows that terminate on each point. Each arrow is "size" mm in length. (Example: sonar)
• "polyLine" - a line through each of the points. The line is "size" pixels wide. (Example: path)
• "polyPoints" - a set of one pixel points. (Example: localization)
• "polySegments" - a set of line segments. For an array of n points, n/2 segments are drawn. Each segment is drawn from array[i] to array[i+1] (with i starting at 0). The segments are "size" pixels wide.

The layer is an arbitrary int identifier that must be greater than 0 and less than 100. The robot is currently drawn on layer #50. Any items that are to be drawn on top of the robot should have a layer number greater than 50.

Definition at line 81 of file ArDrawingData.h.

---

Constructor & Destructor Documentation

ArDrawingData::ArDrawingData (  const char *  shape, ArColor  primaryColor, int  size, int  layer, unsigned int  defaultRefreshTime = 200, ArColor  secondaryColor = ArColor(255, 255, 255) )  [inline]

Constructor. Parameters: shape  the name of the shape to draw (see above / MobileEyes docs for meaning) primaryColor  the main color (meaning depending on shape) size  the size (meaning varies depending on shape) layer  the layer to draw on (see above / MobileEyes docs for meaning) defaultRefreshTime  how often we want to draw it in ms secondaryColor  the secondary color (meaning depending on shape) Definition at line 93 of file ArDrawingData.h.

---

The documentation for this class was generated from the following file:

• ArDrawingData.h

---