MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
convexhullcollisionshape.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 _physicsconvexhullcollisionshape_h
41 #define _physicsconvexhullcollisionshape_h
42 
43 #include "Physics/primitivecollisionshape.h"
44 
45 class btConvexHullShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class ConvexHullCollisionShape
53  /// @headerfile collisionshape.h
54  /// @brief A simple convex shape built from a low number of points in local space.
55  /// @details A convex hull is commonly used to generate a simple approximation of another, and
56  /// more complicated, shape. Usually the number of points in a convex hull doesn't exceed 32. @n @n
57  /// When a convex hull is generated automatically from an algorithm, the best way to think of
58  /// the resulting shape in relation to the original shape is if you were to wrap a rubber band
59  /// around it on one plane. Then do this for all planes and all surfaces. The resulting shape looks
60  /// and behaves similar to that.
61  ///////////////////////////////////////
63  {
64  public:
65  /// @brief Class Constructor.
66  /// @param Name The name of this Shape.
67  /// @param Points A vector of vector3's containing all the points in local space to construct this shape from.
68  ConvexHullCollisionShape(const String& Name, const std::vector<Vector3>& Points);
69  /// @internal
70  /// @brief Internal Constructor.
71  /// @param Name The name of this Shape.
72  /// @param BulletShape The internal shape this shape is based on.
73  ConvexHullCollisionShape(const String& Name, btConvexHullShape* BulletShape);
74  /// @copydoc BoxCollisionShape::BoxCollisionShape(XML::Node OneNode)
76  /// @brief Class Destructor.
77  virtual ~ConvexHullCollisionShape();
78  /// @brief Adds a point to this shape.
79  /// @param Point The location in local space to be added.
80  virtual void AddPoint(const Vector3& Point);
81 
82  /// @brief Gets an unscaled stored point in this ConvexHull.
83  /// @return Returns a Vector3 representing the unscaled location in local space of the specified point.
84  /// @param Index The index of the point desired.
85  virtual Vector3 GetUnscaledPoint(const Whole& Index) const;
86  /// @brief Gets a stored point as it is scaled in this ConvexHull.
87  /// @return Returns a Vector3 representing the scaled location in local space of the specified point.
88  /// @param Index The index of the point desired.
89  virtual Vector3 GetPoint(const Whole& Index) const;
90  /// @brief Gets the total number of points being stored in this shape.
91  /// @return Returns a whole representing the current number of points in this shape.
92  virtual Whole GetNumPoints() const;
93  /// @brief Checks to see if a point in local space is inside this shape.
94  /// @return Returns a bool indicating whether or not the specified point is inside the shape.
95  /// @param Location The specified point to perform the check.
96  /// @param Tolerance The amount of leeway to give in the check. If the distance from the
97  /// specified point is equal or less then the Tolorance provided then this will return true.
98  virtual bool IsInside(const Vector3& Location, const Real& Tolerance) const;
99  /// @copydoc CollisionShape::GetType()
100  virtual CollisionShape::ShapeType GetType() const;
101  /// @copydoc CollisionShape::GetBulletShape
102  virtual btConvexHullShape* GetBulletHullShape() const;
103 
104  /// @copydoc CollisionShape::GetBulletShape
105  virtual void ProtoSerialize(XML::Node& CurrentRoot) const;
106  /// @copydoc CollisionShape::GetBulletShape
107  virtual void ProtoDeSerialize(const XML::Node& OneNode);
108  /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
109  /// @return A string containing "ConeCollisionShape"
110  static String SerializableName();
111  };// ©onvexHullCollisionShape
112  }//Physics
113 }//Mezzanine
114 
115 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
116 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::ConvexHullCollisionShape& ShapeToSerialize);
117 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
118 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::ConvexHullCollisionShape& x);
119 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
121 
122 
123 #endif