MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
conecollisionshape.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 _physicsconecollisionshape_h
41 #define _physicsconecollisionshape_h
42 
43 #include "Physics/primitivecollisionshape.h"
44 
45 class btConeShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class ConeCollisionShape
53  /// @headerfile collisionshape.h
54  /// @brief A cone physics shape.
55  /// @details Keep in mind when building a cone shape, the provided radius is for the base of the cone,
56  /// but the pivot point of the shape is still at it's center and not it's base. Like Capsules and Cylinders,
57  /// Cones can be aligned to any of the 3 linear axes(X, Y, or Z).
58  ///////////////////////////////////////
60  {
61  protected:
62  /// @internal
63  /// @brief Performe shared contructor work.
64  /// @param Name The name of this Shape.
65  /// @param Radius The radius of the base of the Cone.
66  /// @param Height The height of the Cone.
67  /// @param UpAxis Which axis the Cone is to be oriented along. Uses StandardAxis enum, Axis_Y to make a
68  /// vertical capsule
69  void Construct(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis);
70  /// @internal
71  /// @brief Simulate some messed up the physics library does
72  /// @return A Vector3 containing some StandarAxis based on what needs to go where.
73  Vector3 GetAxisMathBS() const;
74  public:
75  /// @brief Class Constructor.
76  /// @param Name The name of this Shape.
77  /// @param Radius The radius of the base of the Cone.
78  /// @param Height The height of the Cone.
79  /// @param UpAxis Which axis the Cone is to be oriented along. Typical usage is for
80  /// a capsule to be oriented on the Y axis(0,1,0), which would make it stand upright.
81  ConeCollisionShape(const String& Name, const Real& Radius, const Real& Height, const Vector3& UpAxis);
82  /// @brief Class Constructor.
83  /// @param Name The name of this Shape.
84  /// @param Radius The radius of the base of the Cone.
85  /// @param Height The height of the Cone.
86  /// @param UpAxis Which axis the Cone is to be oriented along. Uses StandardAxis enum, Axis_Y to make a
87  /// vertical capsule
88  ConeCollisionShape(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis);
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  ConeCollisionShape(const String& Name, btConeShape* BulletShape);
94  /// @copydoc BoxCollisionShape::BoxCollisionShape(XML::Node OneNode)
96  /// @brief Class Destructor.
97  virtual ~ConeCollisionShape();
98 
99  /// @brief Gets the radius of the cone, as used for collision checking.
100  /// @return Returns a real representing the radius at the base of the cone.
101  virtual Real GetRadius() const;
102  /// @brief Gets the height of the cone, as used for collision checking.
103  /// @return Returns a real representing height of the cone.
104  virtual Real GetHeight() const;
105  /// @brief Gets the radius of the cone, as originally passed in.
106  /// @return Returns a real representing the radius at the base of the cone.
107  virtual Real GetCleanRadius() const;
108  /// @brief Gets the height of the cone, as originally passed in.
109  /// @return Returns a real representing height of the cone.
110  virtual Real GetCleanHeight() const;
111  /// @brief Which axis is up defines which 2 axis are used to scale the radius.
112  /// @return A value that represent the scaling that only the radius undergoes.
113  Real GetRadiusScaling() const;
114  /// @brief Which axis is up defines which axis is used to scale height.
115  /// @return A value that represent the scaling that only the height undergoes.
116  Real GetHeightScaling() const;
117 
118  /// @brief Gets which axis this cone is oriented along.
119  /// @return Returns a Vector3 representing which local axis is oriented along the world up axis.
120  virtual Vector3 GetUpAxis() const;
121  /// @brief Gets which axis this cone is oriented along.
122  /// @return Returns a StandardAxis representing which local axis is oriented along the world up axis.
123  virtual StandardAxis GetUpStandardAxis() const;
124  /// @copydoc CollisionShape::GetType()
125  virtual CollisionShape::ShapeType GetType() const;
126  /// @copydoc CollisionShape::GetBulletShape
127  virtual btConeShape* GetBulletConeShape() const;
128 
129  // Serializable
130  /// @copydoc CollisionShape::GetBulletShape
131  virtual void ProtoSerialize(XML::Node& CurrentRoot) const;
132  /// @copydoc CollisionShape::GetBulletShape
133  virtual void ProtoDeSerialize(const XML::Node& OneNode);
134  /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
135  /// @return A string containing "ConeCollisionShape"
136  static String SerializableName();
137  };// ©oneCollisionShape
138  }//Physics
139 }//Mezzanine
140 
141 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
142 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::ConeCollisionShape& ShapeToSerialize);
143 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
144 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::ConeCollisionShape& x);
145 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
146 void MEZZ_LIB operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::ConeCollisionShape& x);
147 
148 #endif