Particles/Affector.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_AFFECTOR_HPP
#define THOR_AFFECTOR_HPP

#include <Thor/Particles/ParticleInterfaces.hpp>
#include <Thor/Multimedia/Colors.hpp>
#include <Thor/Config.hpp>

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


namespace thor
{


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


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:
        static Ptr                  Create(sf::Vector2f acceleration);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    ForceAffector(sf::Vector2f acceleration);

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

        void                        SetAcceleration(sf::Vector2f acceleration);

        sf::Vector2f                GetAcceleration() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        sf::Vector2f                mAcceleration;
};


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

        
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:
        static Ptr                  Create(float angularAcceleration);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    TorqueAffector(float angularAcceleration);

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

        void                        SetAngularAcceleration(float angularAcceleration);

        float                       GetAngularAcceleration() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        float                       mAngularAcceleration;
};


class THOR_API ScaleAffector : public Affector
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:
        typedef std::tr1::shared_ptr<ScaleAffector> Ptr;
        
        
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:
        static Ptr                  Create(sf::Vector2f scaleFactor);

        
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    ScaleAffector(sf::Vector2f scaleFactor);

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

        void                        SetScaleFactor(sf::Vector2f scaleFactor);

        sf::Vector2f                GetScaleFactor() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        sf::Vector2f                mScaleFactor;
};


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


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:
        static Ptr                  Create(float timeRatio = 1.f);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    FadeInAffector(float timeRatio = 1.f);

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

        void                        SetTimeRatio(float timeRatio);
    
        float                       GetTimeRatio() const;

    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        float                       mTimeRatio;
};


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


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:     
        static Ptr                  Create(float timeRatio = 1.f);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    FadeOutAffector(float timeRatio = 1.f);

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

        void                        SetTimeRatio(float timeRatio);
    
        float                       GetTimeRatio() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        float                       mTimeRatio;
};


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


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:
        static Ptr                  Create(const ColorGradient& gradient);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    ColorAffector(const ColorGradient& gradient);

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

        void                        SetGradient(const ColorGradient& gradient);

        const ColorGradient&        GetGradient() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        ColorGradient               mGradient;
};


} // namespace thor

#endif // THOR_AFFECTOR_HPP