Spinning Topp Logo BlackTopp Studios
inc
primitivecollisionshape.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _physicsprimitivecollisionshape_h
41 #define _physicsprimitivecollisionshape_h
42 
43 #include "Physics/collisionshape.h"
44 
45 class btConvexInternalShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class PrimitiveCollisionShape
53  /// @headerfile collisionshape.h
54  /// @brief This is the base class for all Primitive shapes.
55  /// @details A primitive shape is any shape that has a simple rule for determining it's bounds.
56  /// As a rule all Primitive shapes are Convex. Primitive shapes are ideal for performace
57  /// reasons and as such you should always try to appoximate objects with primitives, or a
58  /// compound shape of primitives if at all possible.
59  ///////////////////////////////////////
61  {
62  protected:
63  /// @brief Sets the internal pointers on the base classes.
64  void SetPointers(btConvexInternalShape* Shape);
65  public:
66  /// @brief Class Constructor.
68  /// @brief Class Destructor.
69  virtual ~PrimitiveCollisionShape();
70  /// @copydoc CollisionShape::GetType()
71  virtual CollisionShape::ShapeType GetType() const = 0;
72  /// @copydoc CollisionShape::GetBulletShape
73  virtual btConvexInternalShape* GetBulletConvexShape() const;
74 
75  /// @copydoc CollisionShape::GetBulletShape
76  virtual void ProtoSerialize(XML::Node& CurrentRoot) const;
77  /// @copydoc CollisionShape::GetBulletShape
78  virtual void ProtoDeSerialize(const XML::Node& OneNode);
79  /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
80  /// @return A string containing "PrimitiveCollisionShape"
81  static String GetSerializableName();
82  };//PrimitiveCollisionShape
83  }//Physics
84 }//Mezzanine
85 
86 #ifndef SWIG
87 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
88 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::PrimitiveCollisionShape& ShapeToSerialize);
89 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
90 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::PrimitiveCollisionShape& x);
91 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
93 #endif
94 
95 #endif
std::ostream & operator<<(std::ostream &stream, const Mezzanine::LinearInterpolator< T > &Lint)
Used to Serialize an Mezzanine::LinearInterpolator to a human readable stream.
Definition: interpolator.h:433
This is the base class for all collision shapes.
A light-weight handle for manipulating nodes in DOM tree.
Definition: node.h:89
ShapeType
This enum describes what kind of shape you are currently working with.
This is the base class for all Primitive shapes.
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
std::istream & operator>>(std::istream &stream, Mezzanine::LinearInterpolator< T > &Lint)
Used to de-serialize an Mezzanine::LinearInterpolator from a stream.
Definition: interpolator.h:448
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159