Beatmup::Color::Matrix Class Reference

RGBA color mapping. More...

#include <matrix.h>

Inheritance diagram for Beatmup::Color::Matrix:

Public Member Functions
color4f	r () const
color4f	g () const
color4f	b () const
color4f	a () const
color4f &	r ()
color4f &	g ()
color4f &	b ()
color4f &	a ()
	Matrix ()
	Initializes the color matrix to identity. More...
	Matrix (const color4f &r, const color4f &g, const color4f &b, const color4f &a)
	Constructs a matrix from four RGBA color values setting them as matrix rows. More...
	Matrix (float hDegrees, float saturationFactor=1.0f, float valueFactor=1.0f)
	Constructs a color matrix representing an HSV correction transformation. More...
	Matrix (const color3f &preservedColor, float saturationFactor=1.0f, float valueFactor=1.0f)
	Constructs a color matrix representing continuous color inversion with a fixed hue point. More...
color4f &	operator[] (int)
	Retrieves matrix rows by index in 0..3 range. More...
color4f	operator[] (int) const
Matrix	operator* (const Matrix &) const
	Computes the right-multiplication of the current Matrix and another Matrix. More...
void	operator= (const Matrix &)
Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Public Attributes
union {
float   elem [4][4]
struct {
color4f   rows [4]
}
};
	Matrix elements. More...

Detailed Description

RGBA color mapping.

A color value is mapped onto another color value by multiplying the 4x4 matrix by an RGBA input column.

Definition at line 29 of file matrix.h.

Constructor & Destructor Documentation

Matrix() [1/4]

Matrix::Matrix

(

)

Initializes the color matrix to identity.

Definition at line 28 of file matrix.cpp.

               {
    r() = color4f{ 1, 0, 0, 0 };
    g() = color4f{ 0, 1, 0, 0 };
    b() = color4f{ 0, 0, 1, 0 };
    a() = color4f{ 0, 0, 0, 1 };
}

Matrix() [2/4]

Matrix::Matrix	(	const color4f &	r,
		const color4f &	g,
		const color4f &	b,
		const color4f &	a
	)

Constructs a matrix from four RGBA color values setting them as matrix rows.

Parameters

r	First row of the color matrix.
g	Second row of the color matrix.
b	Third row of the color matrix.
a	Fourth row of the color matrix.

Definition at line 35 of file matrix.cpp.

                                                                                     {
    this->r() = r;
    this->g() = g;
    this->b() = b;
    this->a() = a;
}

Matrix() [3/4]

Matrix::Matrix	(	float	hDegrees,
		float	saturationFactor = 1.0f,
		float	valueFactor = 1.0f
	)

Constructs a color matrix representing an HSV correction transformation.

Parameters

hDegrees	hue offset in degrees (additive)
saturationFactor	saturation scaling factor
valueFactor	value scaling factor

Definition at line 69 of file matrix.cpp.

                                                                        {
    /*
        R = [1 0 0; 0 cos(H) -sin(H); 0 sin(H) cos(H)];
        A = [1 1 1; 1 / sqrt(2) - 1 / sqrt(2) 0; 1 / sqrt(6) 1 / sqrt(6) - 2 / sqrt(6)]';
        M = simplify(A *[V 0 0; 0 V*S 0; 0 0 V*S] * R * inv(A))
    */
    const float H = hDegrees * (float)pi / 180,
        S = saturationFactor, V = valueFactor;
    r() = { (V*(12 * S*cos(H) + 6)) / 18, -(V*(6 * S*cos(H) + 6 * sqrtf(3)*S*sin(H) - 6)) / 18, (V*(6 * sqrtf(3)*S*sin(H) - 6 * S*cos(H) + 6)) / 18, 0 };
    g() = { (V*(6 * sqrtf(3)*S*sin(H) - 6 * S*cos(H) + 6)) / 18, (V*(12 * S*cos(H) + 6)) / 18, -(V*(S*cos(H) + sqrtf(3)*S*sin(H) - 1)) / 3, 0 };
    b() = {-(V*(6 * S*cos(H) + 6 * sqrtf(3)*S*sin(H) - 6)) / 18, (V*(6 * sqrtf(3)*S*sin(H) - 6 * S*cos(H) + 6)) / 18, (V*(4 * S*cos(H) + 2)) / 6, 0 };
    a() = color4f{ 0, 0, 0, 1 };
}

Matrix() [4/4]

Matrix::Matrix	(	const color3f &	preservedColor,
		float	saturationFactor = 1.0f,
		float	valueFactor = 1.0f
	)

Constructs a color matrix representing continuous color inversion with a fixed hue point.

Parameters

preservedColor	color giving a hue value that remains unchanged by the transform.
saturationFactor	saturation scaling factor
valueFactor	value scaling factor

Definition at line 84 of file matrix.cpp.

                                                                                       {
    /*
        R = [1 0 0; 0 cos(H) -sin(H); 0 sin(H) cos(H)];
        A = [1 1 1; 1 / sqrt(2) - 1 / sqrt(2) 0; 1 / sqrt(6) 1 / sqrt(6) - 2 / sqrt(6)]';
        M = simplify(A * inv(R) * [V 0 0; 0 V*S 0; 0 0 -V*S] * R * inv(A))
    */
    const Color::hsva_t hsva(preservedColor);
    const float _2H = 2 * (-hsva.h * 2 * pi - pi / 6),
        S = saturationFactor, V = valueFactor;
    r() = { (V*(S*cos(_2H) - sqrtf(3)*S*sin(_2H) + 1)) / 3, -(V*(2 * S*cos(_2H) - 1)) / 3, (V*(S*cos(_2H) + sqrtf(3)*S*sin(_2H) + 1)) / 3, 0 };
    g() = {-(V*(2 * S*cos(_2H) - 1)) / 3, (V*(S*cos(_2H) + sqrtf(3)*S*sin(_2H) + 1)) / 3, (V*(S*cos(_2H) - sqrtf(3)*S*sin(_2H) + 1)) / 3, 0 };
    b() = { (V*(S*cos(_2H) + sqrtf(3)*S*sin(_2H) + 1)) / 3, (V*(S*cos(_2H) - sqrtf(3)*S*sin(_2H) + 1)) / 3, -(V*(4 * S*cos(_2H) - 2)) / 6, 0 };
    a() = color4f{ 0, 0, 0, 1 };
}

Member Function Documentation

r() [1/2]

color4f Beatmup::Color::Matrix::r ( ) const

inline

Definition at line 60 of file matrix.h.

{ return rows[0]; }

g() [1/2]

color4f Beatmup::Color::Matrix::g ( ) const

inline

Definition at line 61 of file matrix.h.

{ return rows[1]; }

b() [1/2]

color4f Beatmup::Color::Matrix::b ( ) const

inline

Definition at line 62 of file matrix.h.

{ return rows[2]; }

a() [1/2]

color4f Beatmup::Color::Matrix::a ( ) const

inline

Definition at line 63 of file matrix.h.

{ return rows[3]; }

r() [2/2]

color4f& Beatmup::Color::Matrix::r ( )

inline

Definition at line 64 of file matrix.h.

{ return rows[0]; }

g() [2/2]

color4f& Beatmup::Color::Matrix::g ( )

inline

Definition at line 65 of file matrix.h.

{ return rows[1]; }

b() [2/2]

color4f& Beatmup::Color::Matrix::b ( )

inline

Definition at line 66 of file matrix.h.

{ return rows[2]; }

a() [2/2]

color4f& Beatmup::Color::Matrix::a ( )

inline

Definition at line 67 of file matrix.h.

{ return rows[3]; }

operator[]() [1/2]

color4f & Matrix::operator[]

(

int

row

)

Retrieves matrix rows by index in 0..3 range.

Definition at line 42 of file matrix.cpp.

                                   {
    return rows[row];
}

operator[]() [2/2]

color4f Matrix::operator[]

(

int

row

)

const

Definition at line 47 of file matrix.cpp.

                                        {
    return rows[row];
}

operator*()

Matrix Matrix::operator*

(

const Matrix &

another

)

const

Computes the right-multiplication of the current Matrix and another Matrix.

Definition at line 52 of file matrix.cpp.

                                                     {
    Matrix _;
    for (int i = 0; i < 4; i++) {
        _.elem[i][0] = MUL(elem, another.elem, i, 0);
        _.elem[i][1] = MUL(elem, another.elem, i, 1);
        _.elem[i][2] = MUL(elem, another.elem, i, 2);
        _.elem[i][3] = MUL(elem, another.elem, i, 3);
    }
    return _;
}

operator=()

void Matrix::operator=

(

const Matrix &

source

)

Definition at line 64 of file matrix.cpp.

                                           {
    memcpy(elem, source.elem, sizeof(elem));
}

Member Data Documentation

elem

float Beatmup::Color::Matrix::elem[4][4]

Definition at line 36 of file matrix.h.

rows

color4f Beatmup::Color::Matrix::rows[4]

Definition at line 38 of file matrix.h.

union { ... }

Matrix elements.

---

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

• core/color/matrix.h
• core/color/matrix.cpp