Engine.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:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#ifndef _Engine_H__
#define _Engine_H__

#include "OrxonoxPrereqs.h"

#include "util/OrxAssert.h"

#include "Item.h"

namespace orxonox
{

    class _OrxonoxExport Engine : public Item
    {
        public:
            Engine(Context* context);
            virtual ~Engine();

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
            void setConfigValues();

            virtual void run(float dt); // Run the engine for a given time interval.

            virtual void addToSpaceShip(SpaceShip* ship); // Adds the Engine to the input SpaceShip.
            inline SpaceShip* getShip() const
                { return this->ship_; }

            inline void setRelativePosition(const Vector3 &position)
                { this->relativePosition_ = position; }
            inline const Vector3& getRelativePosition() const
                { return this->relativePosition_; }

            //TODO: Better OrxVerify()?
            inline void setMaxSpeedFront(float speed)
                { OrxAssert(speed >= 0.0f, "The input speed must be non-negative."); this->maxSpeedFront_ = speed; }
            inline void setMaxSpeedBack(float speed)
                { OrxAssert(speed >= 0.0f, "The input speed must be non-negative."); this->maxSpeedBack_ = speed; }
            inline void setMaxSpeedLeftRight(float speed)
                { OrxAssert(speed >= 0.0f, "The input speed must be non-negative."); this->maxSpeedLeftRight_ = speed; }
            inline void setMaxSpeedUpDown(float speed)
                { OrxAssert(speed >= 0.0f, "The input speed must be non-negative."); this->maxSpeedUpDown_ = speed; }

            inline float getMaxSpeedFront() const
                { return this->maxSpeedFront_; }
            inline float getMaxSpeedBack() const
                { return this->maxSpeedBack_; }
            inline float getMaxSpeedLeftRight() const
                { return this->maxSpeedLeftRight_; }
            inline float getMaxSpeedUpDown() const
                { return this->maxSpeedUpDown_; }

            inline void setAccelerationFront(float acceleration)
                { OrxAssert(acceleration >= 0.0f, "The input acceleration must be non-negative."); this->accelerationFront_ = acceleration; }
            inline void setAccelerationBrake(float acceleration)
                { OrxAssert(acceleration >= 0.0f, "The input acceleration must be non-negative."); this->accelerationBrake_ = acceleration; }
            inline void setAccelerationBack(float acceleration)
                { OrxAssert(acceleration >= 0.0f, "The input acceleration must be non-negative."); this->accelerationBack_ = acceleration; }
            inline void setAccelerationLeftRight(float acceleration)
                { OrxAssert(acceleration >= 0.0f, "The input acceleration must be non-negative."); this->accelerationLeftRight_ = acceleration; }
            inline void setAccelerationUpDown(float acceleration)
                { OrxAssert(acceleration >= 0.0f, "The input acceleration must be non-negative."); this->accelerationUpDown_ = acceleration; }

            inline float getAccelerationFront() const
                { return this->accelerationFront_; }
            inline float getAccelerationBrake() const
                { return this->accelerationBrake_; }
            inline float getAccelerationBack() const
                { return this->accelerationBack_; }
            inline float getAccelerationLeftRight() const
                { return this->accelerationLeftRight_; }
            inline float getAccelerationUpDown() const
                { return this->accelerationUpDown_; }

            inline void setBoostFactor(float factor)
                { OrxAssert(factor > 0.0f, "The input factor must be positive."); this->boostFactor_ = factor; }
            inline float getBoostFactor() const
                { return this->boostFactor_; }

            inline void addSpeedAdd(float speed)
                { this->speedAdd_ += speed; }
            inline void addSpeedMultiply(float factor)
                { OrxAssert(factor >= 0.0f, "The factor must be non-negative."); this->speedMultiply_ *= factor; }

            inline float getSpeedAdd(void)
                { return this->speedAdd_; }
            inline float getSpeedMultiply(void)
                { return this->speedMultiply_; }

            inline void setEngineTemplate(const std::string& temp)
                { this->engineTemplate_ = temp; this->loadEngineTemplate(); }
            inline const std::string& getEngineTemplate() const
                { return this->engineTemplate_; }

        protected:
            void loadEngineTemplate(); // Load the engine template.

            virtual const Vector3& getSteering() const; // Get the steering direction imposed upon the Engine.

        private:
            void registerVariables();
            void networkcallback_shipID();

            std::string engineTemplate_; 

            SpaceShip* ship_; 
            unsigned int shipID_; 
            Vector3 relativePosition_; 

            float boostFactor_; 

            float speedAdd_; 
            float speedMultiply_; 

            float maxSpeedFront_; 
            float maxSpeedBack_; 
            float maxSpeedLeftRight_; 
            float maxSpeedUpDown_; 

            float accelerationFront_; 
            float accelerationBrake_; 
            float accelerationBack_; 
            float accelerationLeftRight_; 
            float accelerationUpDown_; 

    };
}

#endif /* _Engine_H__ */