Spinning Topp Logo BlackTopp Studios
inc
compoundcollisionshape.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 _physicscompoundcollisionshape_h
41 #define _physicscompoundcollisionshape_h
42 
43 #include "Physics/collisionshape.h"
44 
45 class btCompoundShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class CompoundCollisionShape
53  /// @headerfile collisionshape.h
54  /// @brief A collision shape composed of many other collision shapes placed and oriented in local space.
55  /// @details This shape is the sum of all it's child shapes. Unlike the MultiSphereCollisionShape and the
56  /// ConvexHullCollisionShape, this shape does not form a convex hull of it's children. When populating with
57  /// primitives, Compound shapes offer the most flexibility with the best performace that you can get. @n @n
58  /// When deleted a CompoundCollisionShape will clean up all of it's child shapes.
59  ///////////////////////////////////////
61  {
62  protected:
63  /// @brief Storage for Child shapes.
64  std::vector<CollisionShape*> ChildShapes;
65  public:
66  /// @brief Class Constructor.
67  /// @param Name The name of this Shape.
68  CompoundCollisionShape(const String& Name);
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  CompoundCollisionShape(const String& Name, btCompoundShape* BulletShape);
74  /// @brief Class Destructor.
75  virtual ~CompoundCollisionShape();
76 
77  /// @brief Adds a shape to this compound shape.
78  /// @param Child The shape to be added to this shape.
79  /// @param ChildLocation The location this child is to have in local space.
80  /// @param ChildRotation The rotation to apply to this child in local space.
81  virtual void AddChildShape(CollisionShape* Child, const Vector3& ChildLocation, const Quaternion& ChildRotation);
82  /// @brief Adds a shape to this compound shape.
83  /// @param Child The shape to be added to this shape.
84  /// @param ChildLocation The location this child is to have in local space.
85  virtual void AddChildShape(CollisionShape* Child, const Vector3& ChildLocation);
86  /// @brief Adds a shape to this compound shape.
87  /// @param Child The shape to be added to this shape.
88  /// @param ChildLocation The location and Rotation this child is to have in local space.
89  virtual void AddChildShape(CollisionShape* Child, const Transform& ChildLocation);
90  /// @brief Gets the number of children belonging to this compound shape.
91  /// @return Returns the number of children belonging to this shape.
92  virtual Whole GetNumChildren() const;
93  /// @brief Get a specific child
94  /// @param Index A number indicating which CollisionShape you want a pointer to.
95  /// @return A pointer to the Specified CollisionShape
96  virtual CollisionShape* GetChild(Whole Index) const;
97  /// @brief Removes a Child shape from this compound shape.
98  /// @param Child The child shape to be removed.
99  virtual void RemoveChildShape(CollisionShape* Child);
100  /// @brief Removed a Child shape from this compound shape by index.
101  /// @param ChildIndex The index of the child shape to be removed.
102  virtual void RemoveChildShape(const Whole& ChildIndex);
103 
104  /// @copydoc CollisionShape::GetType()
105  virtual CollisionShape::ShapeType GetType() const;
106  /// @copydoc CollisionShape::GetBulletShape
107  virtual btCompoundShape* GetBulletCompoundShape() const;
108 
109  /// @copydoc CollisionShape::GetBulletShape
110  virtual void ProtoSerialize(XML::Node& CurrentRoot) const;
111  /// @copydoc CollisionShape::GetBulletShape
112  virtual void ProtoDeSerialize(const XML::Node& OneNode);
113  /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
114  /// @return A string containing "CompoundCollisionShape"
115  static String GetSerializableName();
116  };// CompoundCollisionShape
117  }//Physics
118 }//Mezzanine
119 
120 #ifndef SWIG
121 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
122 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::CompoundCollisionShape& ShapeToSerialize);
123 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
124 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::CompoundCollisionShape& x);
125 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
127 #endif
128 
129 #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.
std::vector< CollisionShape * > ChildShapes
Storage for Child 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.
Stores information about relative location and rotation in 3d space.
Definition: transform.h:62
This is used to represent a point in space, or a vector through space.
Definition: vector3.h:77
#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
unsigned long Whole
Whole is an unsigned integer, it will be at least 32bits in size.
Definition: datatypes.h:151
std::istream & operator>>(std::istream &stream, Mezzanine::LinearInterpolator< T > &Lint)
Used to de-serialize an Mezzanine::LinearInterpolator from a stream.
Definition: interpolator.h:448
This is used to store information about rotation in 3d space.
Definition: quaternion.h:68
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
A collision shape composed of many other collision shapes placed and oriented in local space...