MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
spherecollisionshape.h
1 // © Copyright 2010 - 2014 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 _physicsspherecollisionshape_h
41 #define _physicsspherecollisionshape_h
42 
43 #include "Physics/primitivecollisionshape.h"
44 
45 class btSphereShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class SphereCollisionShape
53  /// @headerfile collisionshape.h
54  /// @brief A sphere physics shape.
55  /// @details A simple sphere defined by it's radius. 'nuff said.
56  ///////////////////////////////////////
58  {
59  public:
60  /// @brief Class Constructor.
61  /// @param Name The name of this Shape.
62  /// @param Radius The radius of the sphere.
63  SphereCollisionShape(const String& Name, const Real& Radius);
64  /// @internal
65  /// @brief Internal Constructor.
66  /// @param Name The name of this Shape.
67  /// @param BulletShape The internal shape this shape is based on.
68  SphereCollisionShape(const String& Name, btSphereShape* BulletShape);
69 
70  /// @copydoc BoxCollisionShape::BoxCollisionShape(XML::Node OneNode)
72 
73  /// @brief Class Destructor.
74  virtual ~SphereCollisionShape();
75  /// @brief Gets the radius of the sphere.
76  /// @return Returns a real representing the radius of the sphere.
77  virtual Real GetRadius() const;
78  /// @copydoc CollisionShape::GetType()
79  virtual CollisionShape::ShapeType GetType() const;
80  /// @copydoc CollisionShape::GetBulletShape
81  virtual btSphereShape* GetSphereShape() const;
82 
83  /// @copydoc CollisionShape::GetBulletShape
84  virtual void ProtoSerialize(XML::Node& CurrentRoot) const;
85  /// @copydoc CollisionShape::GetBulletShape
86  virtual void ProtoDeSerialize(const XML::Node& OneNode);
87  /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
88  /// @return A string containing "SphereCollisionShape"
89  static String SerializableName();
90  };//SphereCollisionShape
91  }//Physics
92 }//Mezzanine
93 
94 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
95 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::SphereCollisionShape& ShapeToSerialize);
96 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
97 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::SphereCollisionShape& x);
98 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
99 void MEZZ_LIB operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::SphereCollisionShape& x);
100 
101 #endif