SpaceShip.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 _SpaceShip_H__
#define _SpaceShip_H__

#include "OrxonoxPrereqs.h"

#include <string>
#include <LinearMath/btVector3.h>

#include "tools/Timer.h"
#include "util/Math.h"
#include "util/OrxAssert.h"

#include "Pawn.h"

namespace orxonox
{

    class _OrxonoxExport SpaceShip : public Pawn
    {
        public:
            SpaceShip(Context* context);
            virtual ~SpaceShip();

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

            virtual void moveFrontBack(const Vector2& value)
                { this->steering_.z -= (0.6)*value.x; }
            virtual void moveRightLeft(const Vector2& value)
                { this->steering_.x += (0.6)*value.x; }
            virtual void moveUpDown(const Vector2& value)
                { this->steering_.y += (0.6)*value.x; }

            inline void moveFrontBack(float value)
                { this->moveFrontBack(Vector2(value, 0)); }
            inline void moveRightLeft(float value)
                { this->moveRightLeft(Vector2(value, 0)); }
            inline void moveUpDown(float value)
                { this->moveUpDown(Vector2(value, 0)); }    

            virtual void rotateYaw(const Vector2& value); // Rotate in yaw direction.
            virtual void rotatePitch(const Vector2& value); // Rotate in pitch direction.
            virtual void rotateRoll(const Vector2& value); // Rotate in roll direction.

            virtual void fire();
            virtual void boost(bool bBoost); // Starts or stops boosting.

            void addEngine(Engine* engine); // Add an Engine to the SpaceShip.
            bool hasEngine(Engine* engine) const; // Check whether the SpaceShip has a particular Engine.
            Engine* getEngine(unsigned int i); // Get the i-th Engine of the SpaceShip.
            Engine* getEngineByName(const std::string& name);
            inline const std::vector<Engine*>& getEngineList() const
                { return this->engineList_; }
            void removeEngine(Engine* engine); // Remove and destroy all Engines of the SpaceShip.
            void removeAllEngines(); // Remove a particular Engine from the SpaceShip.

            void addSpeedFactor(float factor); // Add to the speed factor for all engines of the SpaceShip.
            void addSpeed(float speed); // Add to the speed of all engines of the SpaceShip.
            float getSpeedFactor() const; // Get the mean speed factor over all engines of the SpaceShip.
    
            float getMaxSpeedFront() const; // Get the largest maximal forward speed over all engines of the SpaceShip.
            float getBoostFactor() const; // Get the mean boost factor over all engines of the SpaceShip.

            inline void setSteeringDirection(const Vector3& direction)
                { this->steering_ = direction; }
            inline const Vector3& getSteeringDirection() const
                { return this->steering_; }

            inline bool isBoosting() const
                { return this->bBoost_; }
            inline bool isBoostCoolingDown() const
                { return bBoostCooldown_; }

            inline void setInitialBoostPower(float power)
                { OrxAssert(power >= 0.0f, "The boost power must be non-negative."); this->initialBoostPower_ = power; this->boostPower_ = power; }
            inline void setBoostPowerRate(float rate)
                { OrxAssert(rate >= 0.0f, "The boost power rate must be non-negative."); this->boostPowerRate_ = rate; }
            inline void setBoostRate(float rate)
                { OrxAssert(rate >= 0.0f, "The boost rate must be non-negative."); this->boostRate_ = rate; }
            inline void setBoostCooldownDuration(float duration)
                { OrxAssert(duration >= 0.0f, "The boost cooldown duration must be non-negative."); this->boostCooldownDuration_ = duration; }
            inline void setShakeFrequency(float frequency)
                { OrxAssert(frequency >= 0.0f, "The shake frequency must be non-negative."); this->shakeFrequency_ = frequency; }
            inline void setShakeAmplitude(float amplitude)
                { OrxAssert(amplitude >= 0.0f, "The shake amplitude must be non-negative."); this->shakeAmplitude_ = amplitude; }

            inline float getInitialBoostPower() const
                { return this->initialBoostPower_; }
            inline float getBoostPower() const
                { return this->boostPower_; }
            inline float getBoostPowerRate() const
                { return this->boostPowerRate_; }
            inline float getBoostRate() const
                { return this->boostRate_; }
            inline float getBoostCooldownDuration() const
                { return this->boostCooldownDuration_; }
            inline float getShakeFrequency() const
                { return this->shakeFrequency_; }
            inline float getShakeAmplitude() const
                { return this->shakeAmplitude_; }
            void gainBoostPower(float gainedBoostPower);

        protected:
            bool bInvertYAxis_;

            Vector3 steering_; 

            float rotationThrust_;               
            btVector3 localAngularAcceleration_; 

            bool bBoost_;                 
            bool bBoostCooldown_;         
            float initialBoostPower_;     
            float boostPower_;            
            float boostPowerRate_;        
            float boostRate_;             
            float boostCooldownDuration_; 
            float shakeFrequency_;        
            float shakeAmplitude_;        

            float lift_;       
            float stallSpeed_; 

        private:
            void registerVariables();
            virtual bool isCollisionTypeLegal(WorldEntity::CollisionType type) const;

            void changedEnableMotionBlur(); // Is called when the enableMotionBlur config value has changed.
            void boostCooledDown(void)
                { this->bBoostCooldown_ = false; }

            void shakeCamera(float dt); // Shake the camera for a given time interval.
            void backupCamera(); // Save the original position and orientation of the camera.
            void resetCamera(); // Reset the camera to its original position.

            std::vector<Engine*> engineList_; 

            Timer timer_;                          
            float shakeDt_;                        
            Vector3 cameraOriginalPosition_;       
            Quaternion cameraOriginalOrientation_; 

            Shader* boostBlur_;      
            float blurStrength_;     
            bool bEnableMotionBlur_; 
        
    };
}

#endif /* _SpaceShip_H__ */