Bromeon
Particles/Particle.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_PARTICLE_HPP
00030 #define THOR_PARTICLE_HPP
00031 
00032 #include <Thor/Config.hpp>
00033 
00034 #include <SFML/System/Vector2.hpp>
00035 #include <SFML/Graphics/Color.hpp>
00036 
00037 
00038 namespace thor
00039 {
00040 
00043 
00048 class THOR_API Particle
00049 {
00050     // ---------------------------------------------------------------------------------------------------------------------------
00051     // Public member functions
00052     public:
00055         explicit                    Particle(float totalLifetime);
00056 
00057 
00058     // ---------------------------------------------------------------------------------------------------------------------------
00059     // Public variables
00060     public:
00061         sf::Vector2f                Position;           
00062         sf::Vector2f                Velocity;           
00063         float                       Rotation;           
00064         float                       RotationSpeed;      
00065         sf::Vector2f                Scale;              
00066         sf::Color                   Color;              
00067     
00068     
00069     // ---------------------------------------------------------------------------------------------------------------------------
00070     // Private variables
00071     private:
00072         float                       PassedLifetime;     // Time passed since emitted.
00073         float                       TotalLifetime;      // Total time to live.
00074 
00075 
00076     // ---------------------------------------------------------------------------------------------------------------------------
00077     // Friends
00079     friend class ParticleSystem;
00080     friend float THOR_API GetPassedLifetime(const Particle& particle);
00081     friend float THOR_API GetTotalLifetime(const Particle& particle);
00083 };
00084 
00087 float THOR_API              GetPassedLifetime(const Particle& particle);
00088 
00091 float THOR_API              GetTotalLifetime(const Particle& particle);
00092 
00095 float THOR_API              GetRemainingLifetime(const Particle& particle);
00096 
00099 float THOR_API              GetPassedRatio(const Particle& particle);
00100 
00103 float THOR_API              GetRemainingRatio(const Particle& particle);
00104 
00106 
00107 } // namespace thor
00108 
00109 #endif // THOR_PARTICLE_HPP