Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
mrpt::utils::TColorManager Struct Reference

Detailed Description

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

Definition at line 26 of file TColorManager.h.

#include <mrpt/utils/TColorManager.h>

Public Member Functions

 TColorManager (bool use_standard_colors_first=true)
 Constructor. More...
 
 ~TColorManager ()
 Destructor. More...
 
mrpt::utils::TColorf getNextTColorf ()
 Get the next RGB triad in TColorf form. More...
 
mrpt::utils::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::utils::TColor curr_color
 
std::set< mrpt::utils::TColorused_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::utils::TColor color)
 Mark the given color as used. More...
 

Private Attributes

mrpt::utils::TColor color_step_triad
 

Constructor & Destructor Documentation

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 ( )

Destructor.

Definition at line 24 of file TColorManager.cpp.

Member Function Documentation

void TColorManager::advanceRGBCounters ( )
private
bool TColorManager::checkStdColorsUsed ( )

Check if the standard colors have already been used.

True if they have indeed been used.

Definition at line 123 of file TColorManager.cpp.

References mrpt::utils::TColor::blue, mrpt::utils::TColor::green, mrpt::utils::TColor::red, and used_colors.

TColor TColorManager::getNextTColor ( )

Get the next RGB triad in TColor form.

Method automatically advances the current counters for RGB.

Definition at line 26 of file TColorManager.cpp.

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

Referenced by getNextTColorf().

TColorf TColorManager::getNextTColorf ( )

Get the next RGB triad in TColorf form.

Method automatically advances the current counters for RGB.

Definition at line 64 of file TColorManager.cpp.

References getNextTColor().

void TColorManager::markColorAsUsed ( mrpt::utils::TColor  color)
private

Mark the given color as used.

Definition at line 102 of file TColorManager.cpp.

References ASSERT_, and used_colors.

Referenced by getNextTColor().

void TColorManager::reset ( )
private

Reset all class properties to their default values.

Method called in the constructor of the class

Definition at line 112 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

uint8_t mrpt::utils::TColorManager::color_step

Definition at line 65 of file TColorManager.h.

Referenced by advanceRGBCounters().

mrpt::utils::TColor mrpt::utils::TColorManager::color_step_triad
private

Definition at line 72 of file TColorManager.h.

Referenced by advanceRGBCounters(), and reset().

const uint8_t mrpt::utils::TColorManager::color_thresh

Definition at line 66 of file TColorManager.h.

Referenced by getNextTColor().

mrpt::utils::TColor mrpt::utils::TColorManager::curr_color

Definition at line 44 of file TColorManager.h.

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

bool mrpt::utils::TColorManager::have_exceeded_colors

Definition at line 68 of file TColorManager.h.

Referenced by getNextTColor(), and reset().

bool mrpt::utils::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 58 of file TColorManager.h.

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

bool mrpt::utils::TColorManager::use_standard_colors_first

Indicates if the standard colors are to be returned first.

Definition at line 48 of file TColorManager.h.

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

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

Definition at line 45 of file TColorManager.h.

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




Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018