CollisionShape.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:
 *      Reto Grieder
 *   Co-authors:
 *      ...
 *
 */

#ifndef _CollisionShape_H__
#define _CollisionShape_H__

#include "OrxonoxPrereqs.h"

#include "util/Math.h"
#include "core/BaseObject.h"
#include "network/synchronisable/Synchronisable.h"

namespace orxonox
{

    class _OrxonoxExport CollisionShape : public BaseObject, public Synchronisable
    {
        public:
            CollisionShape(Context* context);
            virtual ~CollisionShape();

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

            inline void setPosition(const Vector3& position)
                { if(this->position_ == position) return; this->position_ = position; this->updateParent(); }
            inline const Vector3& getPosition() const
                { return this->position_; }

            inline void setOrientation(const Quaternion& orientation)
                { if(this->orientation_ == orientation) return; this->orientation_ = orientation; this->updateParent(); }
            inline const Quaternion& getOrientation() const
                { return this->orientation_; }

            void yaw(const Degree& angle)
                { this->setOrientation(this->orientation_ * Quaternion(angle, Vector3::UNIT_Y)); }
            void pitch(const Degree& angle)
                { this->setOrientation(this->orientation_ * Quaternion(angle, Vector3::UNIT_X)); }
            void roll(const Degree& angle)
                { this->setOrientation(this->orientation_ * Quaternion(angle, Vector3::UNIT_Z)); }

            inline void scale3D(const Vector3& scale)
                { this->setScale3D(this->getScale3D()*scale); }
            void setScale3D(const Vector3& scale); // Set the scale of the CollisionShape.
            inline const Vector3& getScale3D() const
                { return this->scale_; }

            inline void scale(float scale)
                { this->setScale3D(this->getScale3D()*scale); }
            void setScale(float scale); // Set the (uniform) scale of the CollisionShape.
            inline float getScale()
                { if(this->hasUniformScaling()) return this->scale_.x; return 0.0f; }

            inline bool hasUniformScaling()
                { return this->uniformScale_; }
            virtual void changedScale(); // Is called when the scale of the CollisionShape has changed.

            void updateShape(); // Updates the shape.

            void calculateLocalInertia(float mass, btVector3& inertia) const; // Calculates the local inertia of the collision shape.

            inline btCollisionShape* getCollisionShape() const
                { return this->collisionShape_; }

            bool hasTransform() const; // Check whether the CollisionShape has been either moved or rotated or both.

            bool notifyBeingAttached(CompoundCollisionShape* newParent); // Notifies the CollisionShape of being attached to a CompoundCollisionShape.
            void notifyDetached(); // Notifies the CollisionShape of being detached from a CompoundCollisionShape.

        protected:
            virtual void updateParent(); // Updates the CompoundCollisionShape the CollisionShape belongs to, after the CollisionShape has changed.
            virtual void parentChanged(); // Is called when the parentID of the CollisionShape has changed.

            virtual btCollisionShape* createNewShape() const = 0;

            btCollisionShape*       collisionShape_; 
            CompoundCollisionShape* parent_; 
            unsigned int            parentID_; 

        private:
            void registerVariables();

            Vector3                 position_; 
            Quaternion              orientation_; 
            Vector3                 scale_; 
            bool                    uniformScale_; 
    };
}

#endif /* _CollisionShape_H__ */