ForceField.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Aurelian Jaggi
 *   Co-authors:
 *      Damian 'Mozork' Frick
 *      Kevin Young
 *
 */

#ifndef _ForceField_H__
#define _ForceField_H__

#include "objects/ObjectsPrereqs.h"

#include "tools/interfaces/Tickable.h"
#include "worldentities/StaticEntity.h"

namespace orxonox
{

    enum class ForceFieldMode {
        tube, 
        sphere, 
        invertedSphere, 
        newtonianGravity, 
        homogen 
    };

    class _ObjectsExport ForceField : public StaticEntity, public Tickable
    {
        public:
            ForceField(Context* context);
            virtual ~ForceField();

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; 
            void registerVariables(); 
            virtual void tick(float dt) override; 
            

            inline void setFieldVelocity(float vel)
                { this->velocity_ = vel; }
            inline float getFieldVelocity()
                { return this->velocity_; }

            inline void setDiameter(float diam)
                { this->radius_ = diam/2; }
            inline float getDiameter()
                { return this->radius_*2; }
        
            inline void setMassDiameter(float massDiam)
                { this->massRadius_ = massDiam/2; }
        
            inline float getMassDiameter()
                { return this->massRadius_*2; }

            inline void setLength(float l)
                { this->halfLength_ = l/2; }
            inline float getLength()
                { return this->halfLength_*2; }

            inline void setForceDirection(Vector3 forcedir)
                { this->forceDirection_ = forcedir; }

            inline Vector3 getForceDirection()
                { return this->forceDirection_; }


            void setMode(const std::string& mode); 
            const std::string& getMode(void); 

            static const std::string modeTube_s;
            static const std::string modeSphere_s;
            static const std::string modeInvertedSphere_s;
            static const std::string modeNewtonianGravity_s;
            static const std::string modeHomogen_s;

        private:
            float velocity_; 
            float radius_; 
            float massRadius_; 
            float halfLength_; 
            ForceFieldMode mode_; 
            
            static const float gravConstant_;
            static const float attenFactor_;
            Vector3 forceDirection_;
  };
}

#endif