A color representation with 4 components: red, green, blue, alpha. More...

#include <color4d.h>

Public Member Functions
	COLOR4D (double aRed, double aGreen, double aBlue, double aAlpha)

	COLOR4D (EDA_COLOR_T aColor)

COLOR4D &	FromCSSRGBA (int aRed, int aGreen, int aBlue, double aAlpha=1.0)
	Initialize the color from a RGBA value with 0-255 red/green/blue and 0-1 alpha. More...

void	ToHSL (double &aOutHue, double &aOutSaturation, double &aOutValue) const
	Converts current color (stored in RGB) to HSL format. More...

void	FromHSL (double aInHue, double aInSaturation, double aInLightness)
	Change currently used color to the one given by hue, saturation and lightness parameters. More...

COLOR4D &	Brighten (double aFactor)
	Makes the color brighter by a given factor. More...

COLOR4D &	Darken (double aFactor)
	Makes the color darker by a given factor. More...

COLOR4D &	Invert ()
	Makes the color inverted, alpha remains the same. More...

COLOR4D &	Saturate (double aFactor)
	Saturates the color to a given factor (in HSV model)

COLOR4D	Brightened (double aFactor) const
	Return a color that is brighter by a given factor, without modifying object. More...

COLOR4D	Darkened (double aFactor) const
	Return a color that is darker by a given factor, without modifying object. More...

COLOR4D	Mix (const COLOR4D &aColor, double aFactor) const
	Return a color that is mixed with the input by a factor. More...

COLOR4D	WithAlpha (double aAlpha) const
	Return a color with the same color, but the given alpha. More...

COLOR4D	Inverted () const
	Returns an inverted color, alpha remains the same. More...

double	GetBrightness () const
	Returns the brightness value of the color ranged from 0.0 to 1.0. More...

void	ToHSV (double &aOutHue, double &aOutSaturation, double &aOutValue, bool aAlwaysDefineHue=false) const
	Convert current color (stored in RGB) to HSV format. More...

void	FromHSV (double aInH, double aInS, double aInV)
	Changes currently used color to the one given by hue, saturation and value parameters. More...

int	Distance (const COLOR4D &other) const
	Returns the distance (in RGB space) between two colors.

Static Public Member Functions
static EDA_COLOR_T	FindNearestLegacyColor (int aR, int aG, int aB)
	Returns a legacy color ID that is closest to the given 8-bit RGB values.

Public Attributes
double	r
	Red component.

double	g
	Green component.

double	b
	Blue component.

double	a
	Alpha component.

Static Public Attributes
static const COLOR4D	UNSPECIFIED
	For legacy support; used as a value to indicate color hasn't been set yet.

static const COLOR4D	WHITE

static const COLOR4D	BLACK

static const COLOR4D	CLEAR

Detailed Description

A color representation with 4 components: red, green, blue, alpha.

Constructor & Destructor Documentation

◆ COLOR4D() [1/2]

KIGFX::COLOR4D::COLOR4D	(	double	aRed,
		double	aGreen,
		double	aBlue,
		double	aAlpha
	)

inline

Parameters

aRed	is the red component [0.0 .. 1.0].
aGreen	is the green component [0.0 .. 1.0].
aBlue	is the blue component [0.0 .. 1.0].
aAlpha	is the alpha value [0.0 .. 1.0].

◆ COLOR4D() [2/2]

COLOR4D::COLOR4D ( EDA_COLOR_T aColor )

Parameters

aColor is one of KiCad's palette colors.

See also: EDA_COLOR_T

Member Function Documentation

◆ Brighten()

COLOR4D & KIGFX::COLOR4D::Brighten ( double aFactor )

inline

Makes the color brighter by a given factor.

Parameters

aFactor Specifies how bright the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D& Brightened color.

◆ Brightened()

COLOR4D KIGFX::COLOR4D::Brightened ( double aFactor ) const

inline

Return a color that is brighter by a given factor, without modifying object.

Parameters

aFactor Specifies how bright the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D Highlighted color.

◆ Darken()

COLOR4D & KIGFX::COLOR4D::Darken ( double aFactor )

inline

Makes the color darker by a given factor.

Parameters

aFactor Specifies how dark the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D& Darkened color.

◆ Darkened()

COLOR4D KIGFX::COLOR4D::Darkened ( double aFactor ) const

inline

Return a color that is darker by a given factor, without modifying object.

Parameters

aFactor Specifies how dark the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D Darkened color.

◆ FromCSSRGBA()

COLOR4D & COLOR4D::FromCSSRGBA	(	int	aRed,
		int	aGreen,
		int	aBlue,
		double	aAlpha = `1.0`
	)

Initialize the color from a RGBA value with 0-255 red/green/blue and 0-1 alpha.

Suitable for taking the values directly from the "CSS syntax" from ToWxString.

Returns: this color.

◆ FromHSL()

void COLOR4D::FromHSL	(	double	aInHue,
		double	aInSaturation,
		double	aInLightness
	)

Change currently used color to the one given by hue, saturation and lightness parameters.

Parameters

aInHue	is hue component, in degrees (0.0 - 360.0).
aInSaturation	is saturation component (0.0 - 1.0).
aInLightness	is lightness component (0.0 - 1.0).

◆ FromHSV()

void COLOR4D::FromHSV	(	double	aInH,
		double	aInS,
		double	aInV
	)

Changes currently used color to the one given by hue, saturation and value parameters.

Parameters

aInH	is hue component, in degrees.
aInS	is saturation component.
aInV	is value component.

◆ GetBrightness()

double KIGFX::COLOR4D::GetBrightness ( ) const

inline

Returns the brightness value of the color ranged from 0.0 to 1.0.

Returns: The brightness value.

◆ Invert()

COLOR4D & KIGFX::COLOR4D::Invert ( )

inline

Makes the color inverted, alpha remains the same.

Returns: COLOR4D& Inverted color.

◆ Inverted()

COLOR4D KIGFX::COLOR4D::Inverted ( ) const

inline

Returns an inverted color, alpha remains the same.

Returns: COLOR4D& Inverted color.

◆ Mix()

COLOR4D KIGFX::COLOR4D::Mix	(	const COLOR4D &	aColor,
		double	aFactor
	)		const

inline

Return a color that is mixed with the input by a factor.

Parameters

aFactor Specifies how much of the original color to keep (valid values: 0.0 .. 1.0).

Returns: COLOR4D Mixed color.

◆ ToHSL()

void COLOR4D::ToHSL	(	double &	aOutHue,
		double &	aOutSaturation,
		double &	aOutValue
	)		const

Converts current color (stored in RGB) to HSL format.

Parameters

aOutHue	is the conversion result for hue component, in degrees 0 ... 360.0.
aOutSaturation	is the conversion result for saturation component (0 ... 1.0).
aOutLightness	is conversion result for value component (0 ... 1.0).

Note: saturation is set to 0.0 for black color if r = g = b,

◆ ToHSV()

void COLOR4D::ToHSV	(	double &	aOutHue,
		double &	aOutSaturation,
		double &	aOutValue,
		bool	aAlwaysDefineHue = `false`
	)		const

Convert current color (stored in RGB) to HSV format.

Parameters

aOutHue	is the conversion result for hue component, in degrees 0 ... 360.0.
aOutSaturation	is the conversion result for saturation component (0 ... 1.0).
aOutValue	is conversion result for value component (0 ... 1.0).
aAlwaysDefineHue	controls the way hue is defined when r = v = b

Note: saturation is set to 0.0 for black color (r = v = b = 0), and if r = v = b, hue is set to 0.0 if aAlwaysDefineHue = true, and set to NAN if aAlwaysDefineHue = false. this option is useful to convert a 4D color to a legacy color, because Red has hue = 0, therefore aAlwaysDefineHue = false makes difference between Red and Gray colors.

◆ WithAlpha()

COLOR4D KIGFX::COLOR4D::WithAlpha ( double aAlpha ) const

inline

Return a color with the same color, but the given alpha.

Parameters

aAlpha specifies the alpha of the new color

Returns: COLOR4D color with that alpha

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

3rd_party/router/color4d.h
3rd_party/router/color4d.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ COLOR4D() [1/2]

◆ COLOR4D() [2/2]

Member Function Documentation

◆ Brighten()

◆ Brightened()

◆ Darken()

◆ Darkened()

◆ FromCSSRGBA()

◆ FromHSL()

◆ FromHSV()

◆ GetBrightness()

◆ Invert()

◆ Inverted()

◆ Mix()

◆ ToHSL()

◆ ToHSV()

◆ WithAlpha()