Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/collisionshapes/PlaneCollisionShape.h @ 11162

Last change on this file since 11162 was 10624, checked in by landauf, 9 years ago

merged branch core7 back to trunk

  • Property svn:eol-style set to native
File size: 3.6 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Martin Stypinski
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file PlaneCollisionShape.h
31    @brief Definition of the PlaneCollisionShape class.
32    @ingroup Collisionshapes
33*/
34
35#ifndef _PlaneCollisionShape_H__
36#define _PlaneCollisionShape_H__
37
38#include "objects/ObjectsPrereqs.h"
39
40#include "util/Math.h"
41#include "collisionshapes/CollisionShape.h"
42
43namespace orxonox
44{
45
46    /**
47    @brief
48        Wrapper for the bullet plane collision shape class btStaticPlaneShape.
49
50    @author
51        Martin Stypinski
52
53    @see btStaticPlaneShape
54    @ingroup Collisionshapes
55    */
56    class _ObjectsExport PlaneCollisionShape : public CollisionShape
57    {
58        public:
59            PlaneCollisionShape(Context* context);
60
61            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
62
63            /**
64            @brief Set the normal of the PlaneCollisionShape.
65                   If the normal changes, this causes the internal collision shape to be recreated.
66            @param normal The normal vector to be set.
67            @return Returns true if the normal has changed, false if not.
68            */
69            inline bool setNormal(const Vector3& normal)
70                { if(this->normal_ == normal) return false; this->normal_ = normal; updateShape(); return true; }
71            /**
72            @brief Get the normal of the PlaneCollisionShape.
73            @return Returns the normal vector of the PlaneCollisionShape.
74            */
75            inline const Vector3& getNormal() const
76                { return normal_;}
77
78            /**
79            @brief Set the offset of the PlaneCollisionShape.
80                   If the offset changes, this causes the internal collision shape to be recreated.
81            @param offset The offset to be set.
82            @return Returns true if the offset has changed, false if not.
83            */
84            inline bool setOffset(float offset)
85                { if(this->offset_ == offset) return false; this->offset_ = offset; updateShape(); return true; }
86            /**
87            @brief Get the offset of the PlaneCollisionShape.
88            @return Returns the offset of the PlaneCollisionShape.
89            */
90            inline float getOffset() const
91                { return this->offset_;}
92
93            virtual void changedScale(); // Is called when the scale of the PlaneCollisionShape has changed.
94
95        private:
96            void registerVariables();
97
98            btCollisionShape* createNewShape() const; // Creates a new internal collision shape for the PlaneCollisionShape.
99
100            Vector3 normal_; //!< The normal vector of the PlaneCollisionShape.
101            float   offset_; //!< The offset of the PlaneCollisionShape.
102     };
103}
104
105#endif /* _PlaneCollisionShape_H__ */
Note: See TracBrowser for help on using the repository browser.