robot_nav_rviz_plugins::NavGridPalette Class Reference

A simple datastructure representing a palette of up to 256 24-bit colors. More...

#include <nav_grid_palette.h>

Inheritance diagram for robot_nav_rviz_plugins::NavGridPalette:

Public Member Functions
virtual std::vector< color_util::ColorRGBA24 >	getColors () const =0
	The actual definition of the colors. More...
virtual std::string	getName () const =0
	Unique descriptive name for this particular palette. More...
virtual bool	hasTransparency () const
	See if the palette has any transparent colors. More...
virtual	~NavGridPalette ()

Static Public Attributes
static const unsigned int	NUM_CHANNELS = 4
static const unsigned int	NUM_COLORS = 256

Detailed Description

A simple datastructure representing a palette of up to 256 24-bit colors.

Designed to be loaded via pluginlib

Definition at line 50 of file nav_grid_palette.h.

Constructor & Destructor Documentation

virtual robot_nav_rviz_plugins::NavGridPalette::~NavGridPalette ( )

inlinevirtual

Definition at line 55 of file nav_grid_palette.h.

Member Function Documentation

virtual std::vector<color_util::ColorRGBA24> robot_nav_rviz_plugins::NavGridPalette::getColors ( ) const

pure virtual

The actual definition of the colors.

Returns

vector of up to 256 colors. Undefined behavior if more are returned.

Implemented in robot_nav_rviz_plugins::DistinctPalette, robot_nav_rviz_plugins::Rainbow2Palette, robot_nav_rviz_plugins::RainbowPalette, robot_nav_rviz_plugins::RawPalette, robot_nav_rviz_plugins::CostmapPalette, robot_nav_rviz_plugins::SpectrumPalette, and robot_nav_rviz_plugins::MapPalette.

virtual std::string robot_nav_rviz_plugins::NavGridPalette::getName ( ) const

pure virtual

Unique descriptive name for this particular palette.

Implemented in robot_nav_rviz_plugins::DistinctPalette, robot_nav_rviz_plugins::BluesPalette, robot_nav_rviz_plugins::Rainbow2Palette, robot_nav_rviz_plugins::RainbowPalette, robot_nav_rviz_plugins::RawPalette, robot_nav_rviz_plugins::CostmapPalette, and robot_nav_rviz_plugins::MapPalette.

virtual bool robot_nav_rviz_plugins::NavGridPalette::hasTransparency ( ) const

inlinevirtual

See if the palette has any transparent colors.

Can be overridden by implementing classes to save iterations

Reimplemented in robot_nav_rviz_plugins::DistinctPalette, robot_nav_rviz_plugins::Rainbow2Palette, robot_nav_rviz_plugins::RainbowPalette, robot_nav_rviz_plugins::RawPalette, robot_nav_rviz_plugins::CostmapPalette, robot_nav_rviz_plugins::SpectrumPalette, and robot_nav_rviz_plugins::MapPalette.

Definition at line 73 of file nav_grid_palette.h.

Member Data Documentation

const unsigned int robot_nav_rviz_plugins::NavGridPalette::NUM_CHANNELS = 4

static

Definition at line 53 of file nav_grid_palette.h.

const unsigned int robot_nav_rviz_plugins::NavGridPalette::NUM_COLORS = 256

static

Definition at line 53 of file nav_grid_palette.h.

---

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

• nav_grid_palette.h