Particles/ParticleSystem.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2012 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_PARTICLESYSTEM_HPP
#define THOR_PARTICLESYSTEM_HPP

#include <Thor/Particles/ParticleInterfaces.hpp>
#include <Thor/Particles/Particle.hpp>
#include <Thor/Resources/ResourcePtr.hpp>
#include <Thor/Tools/NonCopyable.hpp>
#include <Thor/Detail/Swap.hpp>
#include <Thor/Config.hpp>

#include <SFML/Graphics/Rect.hpp>
#include <SFML/System/Vector2.hpp>

#include THOR_TR1_HEADER(functional)
#include <vector>
#include <utility>


namespace sf
{

    class RenderWindow;
    class Image;
    class Texture;

} // namespace sf


namespace thor
{


class THOR_API ParticleSystem : private NonCopyable, private Emitter::Adder
{       
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private types
    private:
        // Container typedefs
        typedef std::vector< Particle >                                     ParticleContainer;
        typedef std::vector< std::pair<Affector::Ptr, sf::Time> >           AffectorContainer;
        typedef std::vector< std::pair<Emitter::Ptr, sf::Time> >            EmitterContainer;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    ParticleSystem(ResourcePtr<const sf::Texture> texture);

                                    ParticleSystem(ResourcePtr<const sf::Texture> texture, const sf::IntRect& textureRect);

        void                        Swap(ParticleSystem& other);
                
        void                        AddAffector(Affector::Ptr affector);

        void                        AddAffector(Affector::Ptr affector, sf::Time timeUntilRemoval);

        void                        RemoveAffector(Affector::Ptr affector);

        void                        ClearAffectors();

        bool                        ContainsAffector(Affector::Ptr affector) const;

        void                        AddEmitter(Emitter::Ptr emitter);

        void                        AddEmitter(Emitter::Ptr emitter, sf::Time timeUntilRemoval);

        void                        RemoveEmitter(Emitter::Ptr emitter);

        void                        ClearEmitters();
        
        bool                        ContainsEmitter(Emitter::Ptr emitter) const;

        void                        Update(sf::Time dt);
        
        void                        Draw(sf::RenderWindow& target) const;
        
        void                        ClearParticles();
        
        void                        SetGlowing(bool glow);
        
        bool                        IsGlowing() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions
    private:
        virtual void                AddParticle(const Particle& particle);
                
        // Saves SFML's OpenGL state and prepares the particle system for rendering.
        void                        PushOpenGLStates(sf::RenderWindow& target) const;
        
        // Restores SFML's OpenGL state.
        void                        PopOpenGLStates() const;
            
        // Updates a single particle.
        void                        UpdateParticle(Particle& particle, sf::Time dt);

        // Draws a single particle.
        void                        DrawParticle(const Particle& particle) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        ParticleContainer               mParticles;
        AffectorContainer               mAffectors;
        EmitterContainer                mEmitters;

        ResourcePtr<const sf::Texture>  mTexture;
        sf::Vector2f                    mTexCoordsBegin;
        sf::Vector2f                    mTexCoordsEnd;
        sf::Vector2f                    mHalfSize;
        bool                            mGlow;
};

THOR_GLOBAL_SWAP(ParticleSystem)



} // namespace thor

#endif // THOR_PARTICLESYSTEM_HPP