PColorMap Class Reference

Describe a color map to adapt color with input value. More...

#include <PColorMap.h>

Public Member Functions
void	addColor (float value, color_t red, color_t green, color_t blue, color_t alpha=255)
	Add a color in the PColorMap.
void	addColor (float value, const PString &color)
	Add a color in the PColorMap.
void	interpolate (color_t &red, color_t &green, color_t &blue, color_t &alpha, float value) const
	Interpolate color by respect to the given value.
void	interpolate (color_t &red, color_t &green, color_t &blue, float value) const
	Interpolate color by respect to the given value.
void	interpolate (PColorValue &output, float value) const
	Interpolate color by respect to the given value.
PColorMap &	operator= (const PColorMap &other)
	Definition of equal operator of PColorMap.
	PColorMap ()
	Default constructor of PColorMap.
	PColorMap (const PColorMap &other)
	Copy constructor of PColorMap.
virtual	~PColorMap ()
	Destructor of PColorMap.

Protected Member Functions
void	copyPColorMap (const PColorMap &other)
	Copy function of PColorMap.

Private Member Functions
void	initialisationPColorMap ()
	Initialisation function of the class PColorMap.

Private Attributes
PMapColorValue	p_mapColor
	Vector of the value.

Detailed Description

Describe a color map to adapt color with input value.

Definition at line 38 of file PColorMap.h.

Constructor & Destructor Documentation

PColorMap() [1/2]

PColorMap::PColorMap

(

)

Default constructor of PColorMap.

Definition at line 97 of file PColorMap.cpp.

                    {
        initialisationPColorMap();
}

References initialisationPColorMap().

Referenced by copyPColorMap(), operator=(), and PColorMap().

Here is the call graph for this function:

Here is the caller graph for this function:

PColorMap() [2/2]

PColorMap::PColorMap

(

const PColorMap &

other

)

Copy constructor of PColorMap.

Parameters

other

: class to copy

Definition at line 104 of file PColorMap.cpp.

                                           {
        copyPColorMap(other);
}

References copyPColorMap(), and PColorMap().

Here is the call graph for this function:

~PColorMap()

PColorMap::~PColorMap ( )

virtual

Destructor of PColorMap.

Definition at line 109 of file PColorMap.cpp.

                     {
        
}

Member Function Documentation

addColor() [1/2]

void PColorMap::addColor	(	float	value,
		color_t	red,
		color_t	green,
		color_t	blue,
		color_t	alpha = 255 )

Add a color in the PColorMap.

Parameters

value	: associated value with the given color
red	: red proportion
green	: green proportion
blue	: blue proportion
alpha	: transparent proportion

Definition at line 138 of file PColorMap.cpp.

                                                                                            {
        PColorValue colorValue = createColorValue(value, red, green, blue, alpha);
        p_mapColor[value] = colorValue;
}

References createColorValue(), and p_mapColor.

Here is the call graph for this function:

addColor() [2/2]

void PColorMap::addColor	(	float	value,
		const PString &	color )

Add a color in the PColorMap.

Parameters

value	: associated value with the given color
color	: hexadecimal color associated to the given value (FF000000, 00FF0000, 0000FF00, 000000FF, etc)

Definition at line 126 of file PColorMap.cpp.

                                                          {
        PColorValue colorValue = createColorValue(value, color);
        p_mapColor[value] = colorValue;
}

References createColorValue(), and p_mapColor.

Here is the call graph for this function:

copyPColorMap()

void PColorMap::copyPColorMap ( const PColorMap & other )

protected

Copy function of PColorMap.

Parameters

other

: class to copy

Definition at line 204 of file PColorMap.cpp.

                                                    {
        p_mapColor = other.p_mapColor;
}

References p_mapColor, and PColorMap().

Referenced by operator=(), and PColorMap().

Here is the call graph for this function:

Here is the caller graph for this function:

initialisationPColorMap()

void PColorMap::initialisationPColorMap ( )

private

Initialisation function of the class PColorMap.

Definition at line 209 of file PColorMap.cpp.

                                       {
        
}

Referenced by PColorMap().

Here is the caller graph for this function:

interpolate() [1/3]

void PColorMap::interpolate	(	color_t &	red,
		color_t &	green,
		color_t &	blue,
		color_t &	alpha,
		float	value ) const

Interpolate color by respect to the given value.

Parameters

[out]	red	: red proportion
[out]	green	: green proportion
[out]	blue	: blue proportion
[out]	alpha	: transparent proportion
	value	: given value

Definition at line 164 of file PColorMap.cpp.

                                                                                                             {
        PColorValue out;
        interpolate(out, value);
        red = out.r;
        green = out.g;
        blue = out.b;
        alpha = out.a;
}

References PColorValue::a, PColorValue::b, PColorValue::g, interpolate(), and PColorValue::r.

Here is the call graph for this function:

interpolate() [2/3]

void PColorMap::interpolate	(	color_t &	red,
		color_t &	green,
		color_t &	blue,
		float	value ) const

Interpolate color by respect to the given value.

Parameters

[out]	red	: red proportion
[out]	green	: green proportion
[out]	blue	: blue proportion
	value	: given value

Definition at line 149 of file PColorMap.cpp.

                                                                                            {
        PColorValue out;
        interpolate(out, value);
        red = out.r;
        green = out.g;
        blue = out.b;
}

References PColorValue::b, PColorValue::g, interpolate(), and PColorValue::r.

Referenced by interpolate(), interpolate(), and PImagePng::setColor().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolate() [3/3]

void PColorMap::interpolate	(	PColorValue &	output,
		float	value ) const

Interpolate color by respect to the given value.

Parameters

[out]	output	: output color
	value	: given value

Definition at line 177 of file PColorMap.cpp.

                                                                  {
        if(p_mapColor.size() == 0lu){return;} //No color
        PMapColorValue::const_iterator itMin(p_mapColor.begin());
        if(value <= itMin->second.value){       //If the value is smaller than the first colored one
                output = itMin->second;         //We copy this value
                return;
        }
        PMapColorValue::const_reverse_iterator rit(p_mapColor.rbegin());
        if(value >= rit->second.value){ //If the value is greater than the last colored one
                output = rit->second;           //We copy this value
                return;
        }
        PMapColorValue::const_iterator itMax(itMin);
        ++itMax;
        while(itMax != p_mapColor.end()){
                if(value > itMin->second.value && value < itMax->second.value){
                        phoenix_interpolateColor(output, itMin->second, itMax->second, value);
                        break;
                }
                ++itMax;
                ++itMin;
        }
}

References p_mapColor, and phoenix_interpolateColor().

Here is the call graph for this function:

operator=()

PColorMap & PColorMap::operator=

(

const PColorMap &

other

)

Definition of equal operator of PColorMap.

Parameters

other

: class to copy

Returns

copied class

Definition at line 117 of file PColorMap.cpp.

                                                         {
        copyPColorMap(other);
        return *this;
}

References copyPColorMap(), and PColorMap().

Here is the call graph for this function:

Member Data Documentation

p_mapColor

PMapColorValue PColorMap::p_mapColor

private

Vector of the value.

Definition at line 58 of file PColorMap.h.

Referenced by addColor(), addColor(), copyPColorMap(), and interpolate().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/static-site-generator/PhoenixPNG/src/PColorMap.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/static-site-generator/PhoenixPNG/src/PColorMap.cpp