FadeAnimation.hpp
Go to the documentation of this file.
1 //
3 // Thor C++ Library
4 // Copyright (c) 2011-2016 Jan Haller
5 //
6 // This software is provided 'as-is', without any express or implied
7 // warranty. In no event will the authors be held liable for any damages
8 // arising from the use of this software.
9 //
10 // Permission is granted to anyone to use this software for any purpose,
11 // including commercial applications, and to alter it and redistribute it
12 // freely, subject to the following restrictions:
13 //
14 // 1. The origin of this software must not be misrepresented; you must not
15 // claim that you wrote the original software. If you use this software
16 // in a product, an acknowledgment in the product documentation would be
17 // appreciated but is not required.
18 //
19 // 2. Altered source versions must be plainly marked as such, and must not be
20 // misrepresented as being the original software.
21 //
22 // 3. This notice may not be removed or altered from any source distribution.
23 //
25 
28 
29 #ifndef THOR_FADEANIMATION_HPP
30 #define THOR_FADEANIMATION_HPP
31 
32 #include <Thor/Config.hpp>
34 
35 
36 namespace thor
37 {
38 
41 
44 class THOR_API FadeAnimation
45 {
46  // ---------------------------------------------------------------------------------------------------------------------------
47  // Public member functions
48  public:
54  FadeAnimation(float inRatio, float outRatio);
55 
60  template <class Animated>
61  void operator() (Animated& animated, float progress) const;
62 
63 
64  // ---------------------------------------------------------------------------------------------------------------------------
65  // Private variables
66  private:
67  float mInRatio;
68  float mOutRatio;
69 };
70 
72 
73 // ---------------------------------------------------------------------------------------------------------------------------
74 
75 
76 template <class Animated>
77 void FadeAnimation::operator() (Animated& target, float progress) const
78 {
79  if (progress < mInRatio)
80  setAlpha(target, static_cast<sf::Uint8>(256 * progress / mInRatio));
81  else if (progress > 1.f - mOutRatio)
82  setAlpha(target, static_cast<sf::Uint8>(256 * (1.f-progress) / mOutRatio));
83 }
84 
85 } // namespace thor
86 
87 #endif // THOR_FADEANIMATION_HPP
void setAlpha(T &object, sf::Uint8 alpha)
Sets the alpha color value of a graphical object.
Global functions to access SFML and Thor objects uniformly.
Definition: AnimationMap.hpp:42
Configuration header of the library.
Lets an object fade in or out.
Definition: FadeAnimation.hpp:44
void operator()(Animated &animated, float progress) const
Animates the object.
Definition: FadeAnimation.hpp:77