diff ext/guichan-0.8.2/include/guichan/color.hpp @ 378:64738befdf3b

bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ext/guichan-0.8.2/include/guichan/color.hpp	Mon Jan 11 23:34:52 2010 +0000
@@ -0,0 +1,173 @@
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef GCN_COLOR_HPP
+#define GCN_COLOR_HPP
+
+#include "guichan/platform.hpp"
+
+#include <iostream>
+
+namespace gcn
+{
+    /**
+     * Represents a color with red, green, blue and alpha components.
+     */
+    class GCN_CORE_DECLSPEC Color
+    {
+    public:
+
+        /**
+         * Constructor. Initializes the color to black.
+         */
+        Color();
+
+        /**
+         * Constructor. Constructs a color from the bytes in an integer. 
+         * Call it with a hexadecimal constant for HTML-style color representation.
+         * The alpha component is 255 by default.
+         *
+         * EXAMPLE: Color(0xff50a0) constructs a very nice pinkish color.
+         *
+         * NOTE: Because of this constructor, integers will be automatically
+         *       casted to a color by your compiler.
+         *
+         * @param color The color to initialise the object with.
+         */
+        Color(int color);
+
+        /**
+         * Constructor. The default alpha value is 255.
+         *
+         * @param r Red color component (range 0-255).
+         * @param g Green color component  (range 0-255).
+         * @param b Blue color component (range 0-255).
+         * @param a Alpha, used for transparency. A value of 0 means
+         *          totaly transparent, 255 is totaly opaque.
+         */
+        Color(int r, int g, int b, int a = 255);
+
+        /**
+         * Adds the RGB values of two colors together. The values will be
+         * clamped if they go out of range. 
+         *
+         * WARNING: This function will reset the alpha value of the
+         *          returned color to 255.
+         *
+         * @param color A color to add to this color.
+         * @return The added colors with an alpha value set to 255.
+         */
+        Color operator+(const Color& color) const;
+
+        /**
+         * Subtracts the RGB values of one color from another.
+         * The values will be clamped if they go out of range.
+         *
+         * WARNING: This function will reset the alpha value of the
+         *          returned color to 255.
+         *
+         * @param color A color to subtract from this color.
+         * @return The subtracted colors with an alpha value set to 255.
+         */
+        Color operator-(const Color& color) const;
+
+        /**
+         * Multiplies the RGB values of a color with a float value.
+         * The values will be clamped if they go out of range.
+         *
+         * @param value The value to multiply the color with.
+         * @return The multiplied colors. The alpha value will, unlike
+         *         the add and subtract operations, be multiplied as
+         *         well.
+         */
+        Color operator*(float value) const;
+
+        /**
+         * Compares two colors.
+         *
+         * @return True if the two colors have the same RGBA components
+         *         false otherwise.
+         */
+        bool operator==(const Color& color) const;
+
+        /**
+         * Compares two colors.
+         *
+         * @return True if the two colors have different RGBA components,
+         *         false otherwise.
+         */
+        bool operator!=(const Color& color) const;
+
+		/**
+         * Output operator for output.
+         *
+         * @param out The stream to output to.
+         * @param color The color to output.
+         */
+        friend std::ostream& operator<<(std::ostream& out,
+                                        const Color& Color);
+
+        /**
+         * Holds the red color component (range 0-255).
+         */
+        int r;
+
+        /**
+         *  Holds the green color component (range 0-255).
+         */
+        int g;
+
+        /**
+         *  Holds the blue color component (range 0-255).
+         */
+        int b;
+
+        /**
+         * Holds the alpha color component. A value of 0 means totally
+         * transparent while a value of 255 is considered opaque.
+         */
+        int a;
+    };
+}
+
+#endif // end GCN_COLOR_HPP