gelColor.h

Go to the documentation of this file.

/*
Gel2D Game Engine - Cross-platform 2D gaming middleware
Copyright (C) 2010-2011 Mark D. Procarione

Gel2D is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Gel2D is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
*/

#ifndef __GELCOLOR_H__
#define __GELCOLOR_H__

#include "gelNamespace.h"

#define GEL_WHITE   GelColor(1.0f, 1.0f, 1.0f, 1.0f)
#define GEL_BLACK   GelColor(0.0f, 0.0f, 0.0f, 1.0f)
#define GEL_RED     GelColor(1.0f, 0.0f, 0.0f, 1.0f)
#define GEL_GREEN   GelColor(0.0f, 1.0f, 0.0f, 1.0f)
#define GEL_BLUE    GelColor(0.0f, 0.0f, 1.0f, 1.0f)
#define GEL_PURPLE  GelColor(0.75f, 0.25f, 1.0f, 1.0f)
#define GEL_YELLOW  GelColor(1.0f, 1.0f, 0.0f, 1.0f)
#define GEL_ORANGE  GelColor(1.0f, 0.5f, 0.0f, 1.0f)
#define GEL_PINK    GelColor(1.0f, 0.5f, 0.75f, 1.0f)
#define GEL_BROWN   GelColor(0.3f, 0.2f, 0.1f, 1.0f)
#define GEL_GREY    GelColor(0.5f, 0.5f, 0.5f, 1.0f)
#define GEL_SKYBLUE GelColor(0.0f, 1.0f, 1.0f, 1.0f)

namespace gel
{
    // Define these ahead of time so all color classes
    // can interact with each other.
    class GelHWColor;
    class GelRGBA;
    class GelHSLA;
    class GelColor;



    class GelHWColor
    {
        public:
            GelHWColor() : c(0xffffffff) {}


            GelHWColor( int red, int green, int blue, int alpha );


            GelHWColor( GELCOLOR col ) : c(col) {}


            GelHWColor( const GelRGBA &col );


            GelHWColor( const GelHSLA &col );


            GelHWColor( const GelColor &col );

        public:
            GELCOLOR c;
    };


    class GelRGBA
    {
        public:
            GelRGBA() { r = g = b = a = 255; }


            GelRGBA( int red, int green, int blue, int alpha ) { r = red; g = green; b = blue; a = alpha; }


            GelRGBA( int value ) { r = g = b = a = value; }


            GelRGBA( const GelHWColor &col );


            GelRGBA( const GelColor &col );


            GelRGBA( const GelHSLA &col );

            GelRGBA operator+ ( const GelRGBA &c ) const { return GelRGBA( r+c.r, g+c.g, b+c.b, a+c.a ); }
            GelRGBA operator- ( const GelRGBA &c ) const { return GelRGBA( r-c.r, g-c.g, b-c.b, a-c.a ); }
            GelRGBA operator* ( const GelRGBA &c ) const { return GelRGBA( r*c.r, g*c.g, b*c.b, a*c.a ); }
            GelRGBA operator/ ( const GelRGBA &c ) const { return GelRGBA( r/c.r, g/c.g, b/c.b, a/c.a ); }
            GelRGBA operator= ( const GelRGBA &c )  { r=c.r; g=c.g; b=c.b; a=c.a; return *this; }
            GelRGBA operator+=( const GelRGBA &c ) { r+=c.r; g+=c.g; b+=c.b; a+=c.a; return *this; }
            GelRGBA operator-=( const GelRGBA &c ) { r-=c.r; g-=c.g; b-=c.b; a-=c.a; return *this; }
            GelRGBA operator*=( const GelRGBA &c ) { r*=c.r; g*=c.g; b*=c.b; a*=c.a; return *this; }
            GelRGBA operator/=( const GelRGBA &c ) { r/=c.r; g/=c.g; b/=c.b; a/=c.a; return *this; }

            bool operator==( const GelRGBA &c ) const { return (r==c.r && g==c.g && b==c.b && a==c.a); }
            bool operator!=( const GelRGBA &c ) const { return (r!=c.r || g!=c.g || b!=c.b || a!=c.a); }

        public:
            int r;
            int g;
            int b;
            int a;
    };


    class GelHSLA
    {
        public:
            GelHSLA() { h = s = l = a = 255; }


            GelHSLA( int hue, int sat, int lum, int alpha ) { h = hue; s = sat; l = lum; a = alpha; }


            GelHSLA( int value ) { h = s = l = a = value; }


            GelHSLA( const GelRGBA &col );

            GelHSLA operator+ ( const GelHSLA &c ) const { return GelHSLA( h+c.h, s+c.s, l+c.l, a+c.a ); }
            GelHSLA operator- ( const GelHSLA &c ) const { return GelHSLA( h-c.h, s-c.s, l-c.l, a-c.a ); }
            GelHSLA operator* ( const GelHSLA &c ) const { return GelHSLA( h*c.h, s*c.s, l*c.l, a*c.a ); }
            GelHSLA operator/ ( const GelHSLA &c ) const { return GelHSLA( h/c.h, s/c.s, l/c.l, a/c.a ); }
            GelHSLA operator= ( const GelHSLA &c ) { h=c.h; s=c.s; l=c.l; a=c.a; return *this; }
            GelHSLA operator+=( const GelHSLA &c ) { h+=c.h; s+=c.s; l+=c.l; a+=c.a; return *this; }
            GelHSLA operator-=( const GelHSLA &c ) { h-=c.h; s-=c.s; l-=c.l; a-=c.a; return *this; }
            GelHSLA operator*=( const GelHSLA &c ) { h*=c.h; s*=c.s; l*=c.l; a*=c.a; return *this; }
            GelHSLA operator/=( const GelHSLA &c ) { h/=c.h; s/=c.s; l/=c.l; a/=c.a; return *this; }

            bool operator==( const GelHSLA &c ) const { return (h==c.h && s==c.s && l==c.l && a==c.a); }
            bool operator!=( const GelHSLA &c ) const { return (h!=c.h || s!=c.s || l!=c.l || a!=c.a); }

        public:
            int h;
            int s;
            int l;
            int a;
    };


    class GelColor
    {
        public:
            GelColor() { r = g = b = a = 1.0f; }


            GelColor( float red, float green, float blue, float alpha ) { r = red; g = green; b = blue; a = alpha; }


            GelColor( float value ) { r = g = b = a = value; }


            GelColor( const GelHWColor &col );


            GelColor( const GelRGBA &col );


            GelColor( const GelHSLA &col );

            void clamp() { cClamp(r); cClamp(g); cClamp(b); cClamp(a); }


            void setRGB( float red, float green, float blue ) { r = red; g = green; b = blue; }

            GelColor operator+ ( const GelColor &c ) const { return GelColor( r+c.r, g+c.g, b+c.b, a+c.a ); }
            GelColor operator- ( const GelColor &c ) const { return GelColor( r-c.r, g-c.g, b-c.b, a-c.a ); }
            GelColor operator* ( const GelColor &c ) const { return GelColor( r*c.r, g*c.g, b*c.b, a*c.a ); }
            GelColor operator/ ( const GelColor &c ) const { return GelColor( r/c.r, g/c.g, b/c.b, a/c.a ); }
            GelColor operator= ( const GelColor &c ) { r=c.r; g=c.g; b=c.b; a=c.a; return *this; }
            GelColor operator+=( const GelColor &c ) { r+=c.r; g+=c.g; b+=c.b; a+=c.a; return *this; }
            GelColor operator-=( const GelColor &c ) { r-=c.r; g-=c.g; b-=c.b; a-=c.a; return *this; }
            GelColor operator*=( const GelColor &c ) { r*=c.r; g*=c.g; b*=c.b; a*=c.a; return *this; }
            GelColor operator/=( const GelColor &c ) { r/=c.r; g/=c.g; b/=c.b; a/=c.a; return *this; }

            bool operator==( const GelColor &c ) const { return (r==c.r && g==c.g && b==c.b && a==c.a); }
            bool operator!=( const GelColor &c ) const { return (r!=c.r || g!=c.g || b!=c.b || a!=c.a); }

        private:
            void cClamp(float &x) { if(x<0.0f) x=0.0f; if(x>1.0f) x=1.0f; }

        public:
            float r;
            float g;
            float b;
            float a;
    };

    class GelColorTool
    {
        public:
            static GelHWColor RGBAtoHW( const GelRGBA &col );
            static GelHWColor HSLAtoHW( const GelHSLA &col );
            static GelHWColor ScalarToHW( const GelColor &col );

            static GelRGBA HSLAtoRGBA( const GelHSLA &col );
            static GelRGBA HWtoRGBA( const GelHWColor &col );
            static GelRGBA ScalarToRGBA( const GelColor &col );

            static GelHSLA HWtoHSLA( const GelHWColor &col );
            static GelHSLA RGBAtoHSLA( const GelRGBA &col );
            static GelHSLA ScalarToHSLA( const GelColor &col );

            static GelColor HWtoScalar( const GelHWColor &col );
            static GelColor RGBAtoScalar( const GelRGBA &col );
            static GelColor HSLAtoScalar( const GelHSLA &col );
    };

}

#endif // __GELCOLOR_H__