MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
capsulecollisionshape.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 _physicscapsulecollisionshape_h
41 #define _physicscapsulecollisionshape_h
42 
43 #include "Physics/primitivecollisionshape.h"
44 
45 class btCapsuleShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class CapsuleCollisionShape
53  /// @headerfile collisionshape.h
54  /// @brief A capsule physics shape.
55  /// @details This shape is commonly used for characters. Keep in mind the total height of any
56  /// capsule is height+2*radius, since the height provided only applies to the cylinder portion
57  /// of the capsule. Like Cones and Cylinders, Capsules can be aligned to any of the 3 linear
58  /// axes(X, Y, or Z).
59  ///////////////////////////////////////
61  {
62  protected:
63  /// @internal
64  /// @brief Performed share contructor work.
65  /// @param Name The name of this Shape.
66  /// @param Radius The radius of the capsule.
67  /// @param Height The height of the cylindrical portion of the capsule. Total height would be Height+2*radius.
68  /// @param UpAxis Which axis the Capsule is to be oriented along. Typical usage is for
69  /// a capsule to be oriented on the Y axis(0,1,0), which would make it stand upright.
70  void Construct(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis);
71  public:
72  /// @brief Class Constructor.
73  /// @param Name The name of this Shape.
74  /// @param Radius The radius of the capsule.
75  /// @param Height The height of the cylindrical portion of the capsule. Total height would be Height+2*radius.
76  /// @param UpAxis Which axis the Capsule is to be oriented along. Typical usage is for
77  /// a capsule to be oriented on the Y axis(0,1,0), which would make it stand upright.
78  CapsuleCollisionShape(const String& Name, const Real& Radius, const Real& Height, const Vector3& UpAxis);
79  /// @brief Class Constructor.
80  /// @param Name The name of this Shape.
81  /// @param Radius The radius of the capsule.
82  /// @param Height The height of the cylindrical portion of the capsule. Total height would be Height+2*radius.
83  /// @param UpAxis Which axis the Capsule is to be oriented along. Uses StandardAxis enum, Axis_Y to make a
84  /// vertical capsule
85  CapsuleCollisionShape(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis);
86  /// @copydoc BoxCollisionShape::BoxCollisionShape(XML::Node OneNode)
88 
89  /// @internal
90  /// @brief Internal Constructor.
91  /// @param Name The name of this Shape.
92  /// @param BulletShape The internal shape this shape is based on.
93  CapsuleCollisionShape(const String& Name, btCapsuleShape* BulletShape);
94  /// @brief Class Destructor.
95  virtual ~CapsuleCollisionShape();
96 
97  /// @brief Gets the radius of the capsule, as used in collision checking, with scaling and margin subtracted.
98  /// @return Returns a real representing the radius of the capsule.
99  virtual Real GetRadius() const;
100  /// @brief Gets the height of the capsule, as used in collision checking, with scaling and margin subtracted.
101  /// @return Returns a real representing the length of the cylindrical portion of the capsule.
102  virtual Real GetHeight() const;
103  /// @brief Gets the radius of the capsule, as the original value passed, without scaling and margin applied.
104  /// @return Returns a real representing the radius of the capsule.
105  virtual Real GetCleanRadius() const;
106  /// @brief Gets the height of the capsule, as the original value passed, without scaling and margin applied.
107  /// @return Returns a real representing the length of the cylindrical portion of the capsule.
108  virtual Real GetCleanHeight() const;
109  /* /// @brief Gets the radius of the capsule, with the region of padding used to aid collision Detection, with scaling applied and margin re-added.
110  /// @return Returns a real representing the radius of the capsule.
111  virtual Real GetRadiusWithMargin() const; */
112 
113  /// @brief Gets which axis this capsule is oriented along.
114  /// @return Returns a Vector3 representing which local axis is oriented along the world up axis.
115  virtual Vector3 GetUpAxis() const;
116  /// @brief Gets which axis this capsule is oriented along.
117  /// @return Returns a StandardAxis representing which local axis is oriented along the world up axis.
118  virtual StandardAxis GetUpStandardAxis() const;
119  /// @copydoc CollisionShape::GetType()
120  virtual CollisionShape::ShapeType GetType() const;
121  /// @copydoc CollisionShape::GetBulletShape
122  virtual btCapsuleShape* GetBulletCapsuleShape() const;
123 
124  // Serializable
125  /// @copydoc CollisionShape::GetBulletShape
126  virtual void ProtoSerialize(XML::Node& CurrentRoot) const;
127  /// @copydoc CollisionShape::GetBulletShape
128  virtual void ProtoDeSerialize(const XML::Node& OneNode);
129  /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
130  /// @return A string containing "CapsuleCollisionShape"
131  static String SerializableName();
132  };// ©apsuleCollisionShape
133  }//Physics
134 }//Mezzanine
135 
136 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
137 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::CapsuleCollisionShape& ShapeToSerialize);
138 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
139 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::CapsuleCollisionShape& x);
140 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
141 void MEZZ_LIB operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CapsuleCollisionShape& x);
142 
143 
144 #endif