ProjectInterface.h File Reference

Defines ProjectInterface namespace - a collection of the global variables which should be set by a project to use the Tekkotsu framework. More...

#include "Vision/colors.h"
#include <string>

Include dependency graph for ProjectInterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	std
	STL namespace.
namespace	ProjectInterface
	A collection of the global variables which should be set by a project to use the Tekkotsu framework.
Functions
BehaviorBase &	ProjectInterface::startupBehavior ()
	REQUIRED: you must define a behavior which will be started when the boot is complete.
bool	ProjectInterface::displayException (const char *file, int line, const char *message, const std::exception *ex)
	Displays information about an exception on serr, provides a default value for uncaughtException.
color_index	ProjectInterface::getColorIndex (const std::string &name)
	Returns the index corresponding to a color of specified name by calling lookupColorIndexByName().
color_index	ProjectInterface::getColorIndex (const rgb rgbval)
	Returns the index corresponding to an rgb value by calling lookupColorIndexByRgb().
rgb	ProjectInterface::getColorRGB (const std::string &name)
	Returns rgb value corresponding to a color of specified name by calling lookupColorRGB(lookupColorIndexByName()).
rgb	ProjectInterface::getColorRGB (color_index cindex)
	Returns rgb value corresponding to a color of specified name by calling lookupColorRGB().
const char *	ProjectInterface::getColorName (color_index cindex)
	Returns color name corresponding to specified color index by calling lookupColorName().
const char *	ProjectInterface::getColorName (const rgb rgbval)
	Returns color name corresponding to specified rgb value by calling lookupColorName().
unsigned int	ProjectInterface::getNumColors ()
	Returns the number of colors, obtained from defSegmentedColorGenerator.

---

Detailed Description

Defines ProjectInterface namespace - a collection of the global variables which should be set by a project to use the Tekkotsu framework.

Author:

ejt (Creator)

Definition in file ProjectInterface.h.