Bromeon
Multimedia/Colors.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011 Jan Haller
00005 // 
00006 // This software is provided 'as-is', without any express or implied
00007 // warranty. In no event will the authors be held liable for any damages
00008 // arising from the use of this software.
00009 // 
00010 // Permission is granted to anyone to use this software for any purpose,
00011 // including commercial applications, and to alter it and redistribute it
00012 // freely, subject to the following restrictions:
00013 // 
00014 // 1. The origin of this software must not be misrepresented; you must not
00015 //    claim that you wrote the original software. If you use this software
00016 //    in a product, an acknowledgment in the product documentation would be
00017 //    appreciated but is not required.
00018 // 
00019 // 2. Altered source versions must be plainly marked as such, and must not be
00020 //    misrepresented as being the original software.
00021 // 
00022 // 3. This notice may not be removed or altered from any source distribution.
00023 //
00025 
00028 
00029 #ifndef THOR_COLORS_HPP
00030 #define THOR_COLORS_HPP
00031 
00032 #include <Thor/Detail/ColorImpl.hpp>
00033 #include <Thor/Config.hpp>
00034 
00035 #include <SFML/Graphics/Color.hpp>
00036 
00037 
00038 namespace thor
00039 {
00040 namespace detail
00041 {
00042 
00043     class ColorGradientConvertible;
00044 
00045 } // namespace detail
00046 
00047 
00050 
00053 extern const sf::Color Transparency;
00054 
00061 sf::Color                   BlendColors(const sf::Color& firstColor, const sf::Color& secondColor, float interpolation);
00062 
00076 THOR_DETAIL ColorGradientConvertible THOR_API CreateGradient(const sf::Color& color);
00077 
00082 class THOR_API ColorGradient
00083 {
00084     // ---------------------------------------------------------------------------------------------------------------------------
00085     // Public member functions
00086     public:
00089                                     ColorGradient(const sf::Color& color);
00090 
00095         sf::Color                   GetColor(float interpolation) const;
00096 
00097 
00098     // ---------------------------------------------------------------------------------------------------------------------------
00099     // Implementation details
00100     public:
00101         // Construct from temporary color gradient
00102                                     ColorGradient(detail::ColorGradientConvertible origin);
00103 
00104 
00105     // ---------------------------------------------------------------------------------------------------------------------------
00106     // Private variables
00107     private:
00108         // Normalizes the transition times so that their sum is 1
00109         void                        Normalize();
00110 
00111 
00112     // ---------------------------------------------------------------------------------------------------------------------------
00113     // Private variables
00114     private:
00115         std::vector<sf::Color>      mColors;
00116         std::vector<float>          mTransitionTimes;
00117 };
00118 
00119 
00121 
00122 } // namespace thor
00123 
00124 #endif // THOR_COLORS_HPP