Particles/ParticleInterfaces.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_PARTICLEINTERFACES_HPP
#define THOR_PARTICLEINTERFACES_HPP

#include <Thor/SmartPtr/CopiedPtr.hpp>
#include <Thor/SmartPtr/MovedPtr.hpp>
#include <Thor/Geometry/Zone.hpp>
#include <Thor/Config.hpp>

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

#include THOR_TR1_HEADER(memory)


namespace thor
{

class Particle;
class Zone;



class THOR_API Affector
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:
        typedef std::tr1::shared_ptr<Affector>  Ptr;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        virtual                     ~Affector();

        virtual void                Affect(Particle& particle, sf::Time dt) = 0; 
};


class THOR_API Emitter
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:
        typedef std::tr1::shared_ptr<Emitter>   Ptr;


        typedef MovedPtr<Zone, VirtualClone>    ZonePtr;


        struct THOR_API Adder
        {
            virtual                     ~Adder() {}

            virtual void                AddParticle(const Particle& particle) = 0;
        };

    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        virtual                     ~Emitter();

        virtual void                Emit(Adder& system, sf::Time dt) = 0;

        void                        SetEmissionZone(Emitter::ZonePtr zone);

        Zone&                       GetEmissionZone();

        const Zone&                 GetEmissionZone() const;

        void                        SetEmissionRate(float particlesPerSecond);

        float                       GetEmissionRate() const;

        void                        SetParticleScale(sf::Vector2f scale);

        sf::Vector2f                GetParticleScale() const;

        void                        SetParticleColor(const sf::Color& color);

        const sf::Color&            GetParticleColor() const;

        void                        SetParticleLifetime(sf::Time lifetime);

        sf::Time                        GetParticleLifetime() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Protected member functions
    protected:
                                    Emitter(float particlesPerSecond, sf::Time particleLifetime);

        unsigned int                ComputeNbParticles(sf::Time dt);

        Particle                    CreateParticlePrototype() const;

    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        CopiedPtr<Zone, VirtualClone> mEmissionZone;
        float                       mEmissionRate;
        float                       mEmissionDifference;

        sf::Time                    mParticleLifetime;
        sf::Vector2f                mParticleScale;
        sf::Color                   mParticleColor;
};


} // namespace thor

#endif // THOR_PARTICLEINTERFACES_HPP