Particle.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2016 Jan Haller
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef THOR_PARTICLE_HPP
#define THOR_PARTICLE_HPP

#include <Thor/Config.hpp>

#include <SFML/System/Time.hpp>
#include <SFML/System/Vector2.hpp>
#include <SFML/Graphics/Color.hpp>


namespace thor
{


class THOR_API Particle
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    Particle(sf::Time totalLifetime);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public variables
    public:
        sf::Vector2f                position;           
        sf::Vector2f                velocity;           
        float                       rotation;           
        float                       rotationSpeed;      
        sf::Vector2f                scale;              
        sf::Color                   color;              
        unsigned int                textureIndex;       


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        sf::Time                    passedLifetime;     // Time passed since emitted.
        sf::Time                    totalLifetime;      // Total time to live.


    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    friend class ParticleSystem;
    friend sf::Time THOR_API getElapsedLifetime(const Particle& particle);
    friend sf::Time THOR_API getTotalLifetime(const Particle& particle);
    friend void THOR_API abandonParticle(Particle& particle);
};

sf::Time THOR_API           getElapsedLifetime(const Particle& particle);

sf::Time THOR_API           getTotalLifetime(const Particle& particle);

sf::Time THOR_API           getRemainingLifetime(const Particle& particle);

float THOR_API              getElapsedRatio(const Particle& particle);

float THOR_API              getRemainingRatio(const Particle& particle);

void THOR_API               abandonParticle(Particle& particle);


} // namespace thor

#endif // THOR_PARTICLE_HPP