mrpt::img::TColorManager Struct Reference

Detailed Description

Manage R, G, B color triads and ask class instance of the next unique RGB combination.

Definition at line 25 of file TColorManager.h.

#include <mrpt/img/TColorManager.h>

Public Member Functions
	TColorManager (bool use_standard_colors_first=true)
	Constructor. More...
	~TColorManager ()
	Destructor. More...
mrpt::img::TColorf	getNextTColorf ()
	Get the next RGB triad in TColorf form. More...
mrpt::img::TColor	getNextTColor ()
	Get the next RGB triad in TColor form. More...
bool	checkStdColorsUsed ()
	Check if the standard colors have already been used. More...

Public Attributes
mrpt::img::TColor	curr_color
std::set< mrpt::img::TColor >	used_colors
bool	use_standard_colors_first
	Indicates if the standard colors are to be returned first. More...
bool	have_used_standard_colors
	Indicates if the standard colors have already been used. More...
uint8_t	color_step
const uint8_t	color_thresh
bool	have_exceeded_colors

Private Member Functions
void	reset ()
	Reset all class properties to their default values. More...
void	advanceRGBCounters ()
void	markColorAsUsed (mrpt::img::TColor color)
	Mark the given color as used. More...

Private Attributes
mrpt::img::TColor	color_step_triad

Constructor & Destructor Documentation

TColorManager()

TColorManager::TColorManager

(

bool

use_standard_colors_first = true

)

Constructor.

Definition at line 16 of file TColorManager.cpp.

References reset(), and use_standard_colors_first.

~TColorManager()

TColorManager::~TColorManager

(

)

Destructor.

Definition at line 23 of file TColorManager.cpp.

Member Function Documentation

advanceRGBCounters()

void TColorManager::advanceRGBCounters ( )

private

Definition at line 73 of file TColorManager.cpp.

References ASSERT_, mrpt::img::TColor::B, mrpt::img::TColor::blue(), color_step, color_step_triad, curr_color, mrpt::img::TColor::green(), have_used_standard_colors, mrpt::img::TColor::red(), THROW_EXCEPTION, and use_standard_colors_first.

Referenced by getNextTColor().

checkStdColorsUsed()

bool TColorManager::checkStdColorsUsed

(

)

Check if the standard colors have already been used.

\ret True if they have indeed been used.

Definition at line 128 of file TColorManager.cpp.

References mrpt::img::TColor::blue(), mrpt::img::TColor::green(), mrpt::img::TColor::red(), and used_colors.

getNextTColor()

TColor TColorManager::getNextTColor

(

)

Get the next RGB triad in TColor form.

Method automatically advances the current counters for RGB.

Definition at line 24 of file TColorManager.cpp.

References advanceRGBCounters(), mrpt::img::TColor::blue(), color_thresh, curr_color, mrpt::img::TColor::green(), have_exceeded_colors, have_used_standard_colors, markColorAsUsed(), mrpt::img::TColor::red(), use_standard_colors_first, and used_colors.

Referenced by getNextTColorf().

getNextTColorf()

TColorf TColorManager::getNextTColorf

(

)

Get the next RGB triad in TColorf form.

Method automatically advances the current counters for RGB.

Definition at line 68 of file TColorManager.cpp.

References getNextTColor().

Referenced by mrpt::graphs::detail::CMRVisualizer< CPOSE, MAPS_IMPLEMENTATION, TMRSlamNodeAnnotations, EDGE_ANNOTATIONS >::drawEdges(), and mrpt::graphs::detail::CMRVisualizer< CPOSE, MAPS_IMPLEMENTATION, TMRSlamNodeAnnotations, EDGE_ANNOTATIONS >::drawNodePoints().

markColorAsUsed()

void TColorManager::markColorAsUsed ( mrpt::img::TColor  color )

private

Mark the given color as used.

Definition at line 107 of file TColorManager.cpp.

References ASSERT_, and used_colors.

Referenced by getNextTColor().

reset()

void TColorManager::reset ( )

private

Reset all class properties to their default values.

Method called in the constructor of the class

Definition at line 116 of file TColorManager.cpp.

References color_step_triad, curr_color, have_exceeded_colors, have_used_standard_colors, use_standard_colors_first, and used_colors.

Referenced by TColorManager().

Member Data Documentation

color_step

uint8_t mrpt::img::TColorManager::color_step

Definition at line 63 of file TColorManager.h.

Referenced by advanceRGBCounters().

color_step_triad

mrpt::img::TColor mrpt::img::TColorManager::color_step_triad

private

Definition at line 70 of file TColorManager.h.

Referenced by advanceRGBCounters(), and reset().

color_thresh

const uint8_t mrpt::img::TColorManager::color_thresh

Definition at line 64 of file TColorManager.h.

Referenced by getNextTColor().

curr_color

mrpt::img::TColor mrpt::img::TColorManager::curr_color

Definition at line 42 of file TColorManager.h.

Referenced by advanceRGBCounters(), getNextTColor(), and reset().

have_exceeded_colors

bool mrpt::img::TColorManager::have_exceeded_colors

Definition at line 66 of file TColorManager.h.

Referenced by getNextTColor(), and reset().

have_used_standard_colors

bool mrpt::img::TColorManager::have_used_standard_colors

Indicates if the standard colors have already been used.

This is a cached version of the value returned from the checkStdColorsUsed method.

Note

Standard colors are: red, green, blue

See also

checkStdColorsUsed

Definition at line 56 of file TColorManager.h.

Referenced by advanceRGBCounters(), getNextTColor(), and reset().

use_standard_colors_first

bool mrpt::img::TColorManager::use_standard_colors_first

Indicates if the standard colors are to be returned first.

Definition at line 46 of file TColorManager.h.

Referenced by advanceRGBCounters(), getNextTColor(), reset(), and TColorManager().

used_colors

std::set<mrpt::img::TColor> mrpt::img::TColorManager::used_colors

Definition at line 43 of file TColorManager.h.

Referenced by checkStdColorsUsed(), getNextTColor(), markColorAsUsed(), and reset().