PColorMap.h File Reference

#include <map>
#include "PString.h"

Include dependency graph for PColorMap.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PColorMap
	Describe a color map to adapt color with input value. More...
struct	PColorValue
	Color related to a value. More...

Typedefs
typedef unsigned char	color_t
	Type des of a color.
typedef std::map< float, PColorValue >	PMapColorValue
	Vector of a color value.

Functions
PColorValue	createColorValue (float value, color_t red, color_t green, color_t blue, color_t alpha=255)
	Create a PColorValue.
PColorValue	createColorValue (float value, const PString &color)
	Create a PColorValue.
void	getColorValue (color_t &red, color_t &green, color_t &blue, color_t &alpha, const PColorValue &color)
	Get the rgba values from PColorValue.
PColorValue	phoenix_interpolateColor (const PColorValue &colorMin, const PColorValue &colorMax, float value)
	Interpolate a color with a value by respect to min an max color.
void	phoenix_interpolateColor (PColorValue &output, const PColorValue &colorMin, const PColorValue &colorMax, float value)
	Interpolate a color with a value by respect to min an max color.

Typedef Documentation

color_t

typedef unsigned char color_t

Type des of a color.

Definition at line 14 of file PColorMap.h.

PMapColorValue

typedef std::map<float, PColorValue> PMapColorValue

Vector of a color value.

Definition at line 31 of file PColorMap.h.

Function Documentation

createColorValue() [1/2]

PColorValue createColorValue	(	float	value,
		color_t	red,
		color_t	green,
		color_t	blue,
		color_t	alpha )

Create a PColorValue.

Parameters

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

Returns

PColorValue

Definition at line 45 of file PColorMap.cpp.

                                                                                                  {
        PColorValue colorValue;
        colorValue.value = value;
        colorValue.r = red;
        colorValue.g = green;
        colorValue.b = blue;
        colorValue.a = alpha;
        return colorValue;
}

References PColorValue::a, PColorValue::b, PColorValue::g, PColorValue::r, and PColorValue::value.

createColorValue() [2/2]

PColorValue createColorValue	(	float	value,
		const PString &	color )

Create a PColorValue.

Parameters

value	: associated value with the given color
color	: associated color

Returns

PColorValue

Definition at line 15 of file PColorMap.cpp.

                                                                {
        size_t nbChannel(color.size());
        color_t red(0), green(0), blue(0), alpha(0);
        if(nbChannel >= 2lu){
                PString redHex(color.substr(0lu, 2lu));
                red = (color_t)strtol(redHex.c_str(), NULL, 16);
        }
        if(nbChannel >= 4lu){
                PString greenHex(color.substr(2lu, 2lu));
                green = (color_t)strtol(greenHex.c_str(), NULL, 16);
        }
        if(nbChannel >= 6lu){
                PString blueHex(color.substr(4lu, 2lu));
                blue = (color_t)strtol(blueHex.c_str(), NULL, 16);
        }
        if(nbChannel >= 8lu){
                PString alphaHex(color.substr(6lu, 2lu));
                alpha = (color_t)strtol(alphaHex.c_str(), NULL, 16);
        }
        return createColorValue(value, red, green, blue, alpha);
}

References createColorValue().

Referenced by PColorMap::addColor(), PColorMap::addColor(), and createColorValue().

Here is the call graph for this function:

Here is the caller graph for this function:

getColorValue()

void getColorValue	(	color_t &	red,
		color_t &	green,
		color_t &	blue,
		color_t &	alpha,
		const PColorValue &	color )

Get the rgba values from PColorValue.

Parameters

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

Definition at line 62 of file PColorMap.cpp.

                                                                                                              {
        red = color.r;
        green = color.g;
        blue = color.b;
        alpha = color.a;
}

References PColorValue::a, PColorValue::b, PColorValue::g, and PColorValue::r.

phoenix_interpolateColor() [1/2]

PColorValue phoenix_interpolateColor	(	const PColorValue &	colorMin,
		const PColorValue &	colorMax,
		float	value )

Interpolate a color with a value by respect to min an max color.

Parameters

colorMin	: color of the minimum value
colorMax	: color of the maximum value
value	: value between min and max

Returns

interpolated color

Definition at line 90 of file PColorMap.cpp.

                                                                                                             {
        PColorValue out;
        phoenix_interpolateColor(out, colorMin, colorMax, value);
        return out;
}

References phoenix_interpolateColor().

Here is the call graph for this function:

phoenix_interpolateColor() [2/2]

void phoenix_interpolateColor	(	PColorValue &	output,
		const PColorValue &	colorMin,
		const PColorValue &	colorMax,
		float	value )

Interpolate a color with a value by respect to min an max color.

Parameters

[out]	output	: interpolated color
	colorMin	: color of the minimum value
	colorMax	: color of the maximum value
	value	: value between min and max

Definition at line 75 of file PColorMap.cpp.

                                                                                                                            {
        float ratio((value - colorMin.value)/(colorMax.value - colorMin.value));
        
        output.r = colorMax.r*ratio + colorMin.r*(1.0f - ratio);
        output.g = colorMax.g*ratio + colorMin.g*(1.0f - ratio);
        output.b = colorMax.b*ratio + colorMin.b*(1.0f - ratio);
        output.a = colorMax.a*ratio + colorMin.a*(1.0f - ratio);
}

References PColorValue::a, PColorValue::b, PColorValue::g, PColorValue::r, and PColorValue::value.

Referenced by PColorMap::interpolate(), and phoenix_interpolateColor().

Here is the caller graph for this function: