Added -Wnon-virtual-dtor and -Wcast-qual warning flags
[supertux.git] / src / video / color.hpp
index e94b362..9155157 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
 //
-//  This program 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 2
-//  of the License, or (at your option) any later version.
+//  This program 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.
 //
 //  This program is distributed in the hope that it will be useful,
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
 //  GNU General Public License for more details.
 //
 //  You should have received a copy of the GNU General Public License
-//  along with this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#ifndef __COLOR_HPP__
-#define __COLOR_HPP__
+#ifndef HEADER_SUPERTUX_VIDEO_COLOR_HPP
+#define HEADER_SUPERTUX_VIDEO_COLOR_HPP
 
-#include <vector>
 #include <assert.h>
-#include "log.hpp"
+#include <vector>
+
+#include "util/log.hpp"
 
 class Color
 {
 public:
-  Color()
-    : red(0), green(0), blue(0), alpha(1.0)
-  { }
-  Color(float red, float green, float blue, float alpha = 1.0)
-    : red(red), green(green), blue(blue), alpha(alpha)
+  Color() :
+    red(0),
+    green(0),
+    blue(0),
+    alpha(1.0f)
+  {}
+
+  Color(float red_, float green_, float blue_, float alpha_ = 1.0) :
+    red(red_),
+    green(green_),
+    blue(blue_),
+    alpha(alpha_)
   {
-#ifdef DEBUG
-    check_color_ranges();
-#endif
+    assert(0 <= red   && red <= 1.0);
+    assert(0 <= green && green <= 1.0);
+    assert(0 <= blue  && blue <= 1.0);
   }
-  Color(const std::vector<float>& vals)
+
+  Color(const std::vector<float>& vals) :
+    red(),
+    green(),
+    blue(),
+    alpha()
   {
     assert(vals.size() >= 3);
-    red = vals[0];
+    red   = vals[0];
     green = vals[1];
-    blue = vals[2];
+    blue  = vals[2];
     if(vals.size() > 3)
       alpha = vals[3];
     else
       alpha = 1.0;
-#ifdef DEBUG
-    check_color_ranges();
-#endif
+    assert(0 <= red   && red <= 1.0);
+    assert(0 <= green && green <= 1.0);
+    assert(0 <= blue  && blue <= 1.0);
   }
 
   bool operator==(const Color& other) const
   {
     return red == other.red && green == other.green && blue == other.blue
-           && alpha == other.alpha;
+      && alpha == other.alpha;
+  }
+
+  float greyscale() const
+  {
+    return red * 0.30f + green * 0.59f + blue * 0.11f;
   }
 
-  void check_color_ranges()
+  bool operator < (const Color& other) const
   {
-    if(red < 0 || red > 1.0 || green < 0 || green > 1.0
-            || blue < 0 || blue > 1.0
-            || alpha < 0 || alpha > 1.0)
-      log_warning << "color value out of range: " << red << ", " << green << ", " << blue << ", " << alpha << std::endl;
+    return greyscale() < other.greyscale();
   }
 
   float red, green, blue, alpha;
+
+  static const Color BLACK;
+  static const Color RED;
+  static const Color GREEN;
+  static const Color BLUE;
+  static const Color CYAN;
+  static const Color MAGENTA;
+  static const Color YELLOW;
+  static const Color WHITE;
 };
 
 #endif
+
+/* EOF */