bpp::MolscriptColorSet Class Reference

Molscript color definitions. More...

#include <Bpp/Graphics/Molscript/MolscriptColorSet.h>

Inheritance diagram for bpp::MolscriptColorSet:

Collaboration diagram for bpp::MolscriptColorSet:

Public Member Functions
	MolscriptColorSet ()
virtual	~MolscriptColorSet ()
const RGBColor &	getColor (const std::string &name) const
	Get the color object corresponding to a given name. More...
const RGBColor &	getColor (unsigned int index) const
	Get the ith color object in the set. More...
std::vector< std::string >	getColorNames () const
size_t	getNumberOfColors () const

Protected Attributes
std::map< std::string, RGBColor >	colors_

Detailed Description

Molscript color definitions.

Definition at line 16 of file MolscriptColorSet.h.

Constructor & Destructor Documentation

MolscriptColorSet()

MolscriptColorSet::MolscriptColorSet

(

)

Definition at line 9 of file MolscriptColorSet.cpp.

References bpp::AbstractColorSet::colors_.

~MolscriptColorSet()

virtual bpp::MolscriptColorSet::~MolscriptColorSet ( )

inlinevirtual

Definition at line 21 of file MolscriptColorSet.h.

Member Function Documentation

getColor() [1/2]

const RGBColor& bpp::AbstractColorSet::getColor ( const std::string &  name ) const

inlinevirtualinherited

Get the color object corresponding to a given name.

Parameters

name	The name of the color to look for.

Returns

The color associated to the given name.

Exceptions

Exception

if the name is not assigned to any color.

Implements bpp::ColorSet.

Definition at line 73 of file ColorSet.h.

getColor() [2/2]

const RGBColor& bpp::AbstractColorSet::getColor ( unsigned int  index ) const

inlinevirtualinherited

Get the ith color object in the set.

Parameters

index

The index of the color to look for.

Returns

The color associated to the given index.

Exceptions

IndexOutOfBoundsException

if the index is not assigned to any color.

Implements bpp::ColorSet.

Definition at line 80 of file ColorSet.h.

getColorNames()

std::vector<std::string> bpp::AbstractColorSet::getColorNames ( ) const

inlinevirtualinherited

Returns

All valid color names.

Implements bpp::ColorSet.

Definition at line 88 of file ColorSet.h.

References bpp::MapTools::getKeys().

getNumberOfColors()

size_t bpp::AbstractColorSet::getNumberOfColors ( ) const

inlinevirtualinherited

Returns

The total number of colors available.

Implements bpp::ColorSet.

Definition at line 90 of file ColorSet.h.

Member Data Documentation

colors_

std::map<std::string, RGBColor> bpp::AbstractColorSet::colors_

protectedinherited

Definition at line 66 of file ColorSet.h.

Referenced by bpp::DefaultColorSet::DefaultColorSet(), bpp::DvipsColorSet::DvipsColorSet(), MolscriptColorSet(), and bpp::RColorSet::RColorSet().

---

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

• Bpp/Graphics/Molscript/MolscriptColorSet.h
• Bpp/Graphics/Molscript/MolscriptColorSet.cpp