Colour.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCORECOLOUR_H
00029 #define ROCKETCORECOLOUR_H
00030 
00031 #include <Rocket/Core/Header.h>
00032 
00033 namespace Rocket {
00034 namespace Core {
00035 
00042 template < typename ColourType, int AlphaDefault >
00043 class Colour
00044 {
00045 public:
00047         inline Colour();
00053         inline Colour(ColourType red, ColourType green, ColourType blue, ColourType alpha = AlphaDefault);
00054 
00058         inline Colour operator+(const Colour& rhs) const;
00062         inline Colour operator-(const Colour& rhs) const;
00066         Colour operator*(const Colour& rhs) const;
00070         inline Colour operator*(float rhs) const;
00074         inline Colour operator/(float rhs) const;
00075 
00078         inline void operator+=(const Colour& rhs);
00081         inline void operator-=(const Colour& rhs);
00085         void operator*=(const Colour& rhs);
00088         inline void operator*=(float rhs);
00091         inline void operator/=(float rhs);
00092 
00096         inline bool operator==(const Colour& rhs)       { return red == rhs.red && green == rhs.green && blue == rhs.blue && alpha == rhs.alpha; }
00100         inline bool operator!=(const Colour& rhs)       { return red != rhs.red || green != rhs.green || blue != rhs.blue || alpha != rhs.alpha; }
00101 
00104         inline operator const ColourType*() const { return &red; }
00107         inline operator ColourType*() { return &red; }
00108 
00109         ColourType red, green, blue, alpha;
00110 };
00111 
00112 }
00113 }
00114 
00115 //#include <Rocket/Core/Types.h>
00116 
00117 namespace Rocket {
00118 namespace Core {
00119 
00120 #include "Colour.inl"
00121 
00122 }
00123 }
00124 
00125 #endif