VirtualRenderingSystem: color.h Source File

00001 /******************************************************************************
00002  * VRS - The Virtual Rendering System
00003  * Copyright (C) 2003 Computer Graphics Systems Group at the 
00004  * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
00005  *
00006  * This  library  is  free  software; you can redistribute it and/or  modify it
00007  * under the terms of the GNU Lesser General Public  License  as  published  by
00008  * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
00009  * your option) any later version. This library  is  distributed  in  the  hope
00010  * that  it will be useful, but  WITHOUT ANY WARRANTY; without even the implied
00011  * warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE.  See  the
00012  * GNU Lesser General Public License for more details. You should have received
00013  * a copy of the GNU Lesser+ General Public License along with this library; if
00014  * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
00015  * Boston, MA, 02111-1307, USA.
00016  ******************************************************************************/
00017 
00018 // $Id: color.h 5897 2007-06-13 14:35:21Z Konstantin_Baumann $
00019 
00020 #ifndef VRS_COLOR_H
00021 #define VRS_COLOR_H
00022 
00023 #include <vrs/vertexdata.h>
00024 
00025 namespace VRS {
00026 
00033 class VRS_CORE_API Color : public VertexData<4, float> {
00034 
00035 public:
00036     explicit Color(float grey = 0.0f);
00037     explicit Color(double grey);
00039     Color(float red, float green, float blue, float alpha = 1.0f);
00040     Color(double red, double green, double blue, double alpha = 1.0);
00042 
00043     bool operator==(const Color& other) const;
00045     bool operator!=(const Color& other) const;
00047     bool operator<(const Color& other) const;
00049 
00050     float& operator[](unsigned int i);
00052     float operator[](unsigned int i) const;
00054 
00055     Color& operator+=(const Color& col);
00057 
00060     Color& operator-=(const Color& col);
00062 
00065     Color& operator*=(float coef);
00066     Color& operator*=(double coef);
00068 
00071     Color& operator/=(float coef);
00072     Color& operator/=(double coef);
00074 
00078     Color operator+(const Color& col) const;
00080 
00083     Color operator-(const Color& col) const;
00085 
00088     Color operator*(float coef) const;
00089     Color operator*(double coef) const;
00091 
00094     Color operator/(float coef) const;
00095     Color operator/(double coef) const;
00097 
00101     static Color hsv(float hue, float saturation, float value, float alpha = 1.0f);
00102     static Color hsv(double hue, double saturation, double value, double alpha = 1.0);
00104 
00110     float hue() const;
00112     float saturation() const;
00114     float value() const;
00116 
00117     float luminance() const;
00119 
00122     static const Color aquamarine;
00123     static const Color black;
00124     static const Color blue;
00125     static const Color blue_violet;
00126     static const Color brilliant_red;
00127     static const Color brown;
00128     static const Color cadet_blue;
00129     static const Color coral;
00130     static const Color cornflower_blue;
00131     static const Color cyan;
00132     static const Color dk_brown;
00133     static const Color dk_gray;
00134     static const Color dk_green;
00135     static const Color dk_olive_green;
00136     static const Color dk_orchid;
00137     static const Color dk_plum;
00138     static const Color dk_slate_blue;
00139     static const Color dk_slate_gray;
00140     static const Color dk_tan;
00141     static const Color dk_turquoise;
00142     static const Color dim_brown;
00143     static const Color dim_gray;
00144     static const Color firebrick;
00145     static const Color forest_green;
00146     static const Color gold;
00147     static const Color goldenrod;
00148     static const Color gray;
00149     static const Color green;
00150     static const Color green_yellow;
00151     static const Color grey;
00152     static const Color indian_red;
00153     static const Color khaki;
00154     static const Color lt_blue;
00155     static const Color lt_gray;
00156     static const Color lt_sky_blue;
00157     static const Color lt_steel_blue;
00158     static const Color lime_green;
00159     static const Color magenta;
00160     static const Color maroon;
00161     static const Color med_aquamarine;
00162     static const Color med_blue;
00163     static const Color med_brown;
00164     static const Color med_forest_green;
00165     static const Color med_goldenrod;
00166     static const Color med_gray;
00167     static const Color med_grey;
00168     static const Color med_orchid;
00169     static const Color med_plum;
00170     static const Color med_sea_green;
00171     static const Color med_slate_blue;
00172     static const Color med_spring_green;
00173     static const Color med_turquoise;
00174     static const Color med_violet_red;
00175     static const Color midnight_blue;
00176     static const Color navy;
00177     static const Color navy_blue;
00178     static const Color orange;
00179     static const Color orange_red;
00180     static const Color orchid;
00181     static const Color pale_green;
00182     static const Color pink;
00183     static const Color plum;
00184     static const Color red;
00185     static const Color salmon;
00186     static const Color sea_green;
00187     static const Color sienna;
00188     static const Color silver;
00189     static const Color sky_blue;
00190     static const Color slate_blue;
00191     static const Color slate_gray;
00192     static const Color spring_green;
00193     static const Color steel_blue;
00194     static const Color med_tan;
00195     static const Color thistle;
00196     static const Color turquoise;
00197     static const Color violet;
00198     static const Color violet_red;
00199     static const Color wheat;
00200     static const Color white;
00201     static const Color yellow;
00202     static const Color yellow_green;        
00203 
00204 private:
00205     typedef VertexData<4, float> BASE;
00206 };
00207 
00208 inline bool Color::operator==(const Color& c) const { return BASE::operator==(c); }
00209 inline bool Color::operator!=(const Color& c) const { return BASE::operator!=(c); }
00210 inline bool Color::operator< (const Color& c) const { return BASE::operator< (c); }
00211 
00212 inline float& Color::operator[](unsigned int i)       { return BASE::operator[](i); }
00213 inline float  Color::operator[](unsigned int i) const { return BASE::operator[](i); }
00214 
00215 inline Color operator*(float coef, const Color& col) { return (col * coef); }
00216 inline Color operator*(double coef, const Color& col) { return (col * coef); }
00217 inline Color Color::operator/(float d) const { return operator*(1.0f / d); }
00218 inline Color Color::operator/(double d) const { return operator*(1.0 / d); }
00219 
00220 inline Color& Color::operator/=(float d) { return operator*=(1.0f / d); }
00221 inline Color& Color::operator/=(double d) { return operator*=(1.0 / d); }
00222 
00223 inline Color Color::operator+(const Color& c) const {
00224     return Color(data_[0]+c.data_[0], data_[1]+c.data_[1], data_[2]+c.data_[2], data_[3]);
00225 }
00226 
00227 inline Color Color::operator-(const Color& c) const {
00228     return Color(data_[0]-c.data_[0], data_[1]-c.data_[1], data_[2]-c.data_[2], data_[3]);
00229 }
00230 
00231 inline Color Color::operator*(float c) const {
00232     return Color(data_[0]*c, data_[1]*c, data_[2]*c, data_[3]);
00233 }
00234 inline Color Color::operator*(double c) const {
00235     return (*this * static_cast<float>(c));
00236 }
00237 
00238 extern VRS_CORE_API std::ostream& operator<<(std::ostream&, const Color&);
00239 extern VRS_CORE_API std::istream& operator>>(std::istream&, Color&);
00240 
00241 } // namespace VRS
00242 
00243 #endif // VRS_COLOR_H