MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
softcollisionshape.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 _physicssoftcollisionshape_h
41 #define _physicssoftcollisionshape_h
42 
43 #include "Physics/meshcollisionshape.h"
44 
45 class btSoftBodyCollisionShape;
46 
47 namespace Mezzanine
48 {
49  namespace Physics
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @class SoftCollisionShape
53  /// @headerfile softcollisionshape.h
54  /// @brief A collision shape for soft proxies.
55  /// @details This collision shape is different from all the other collision shapes because it's
56  /// meant to be used for only one type of object: SoftProxys. This shape doesn't use triangles
57  /// in the traditional manner other mesh shapes do, but rather it uses the individual internal
58  /// nodes that make the SoftProxy as points for building triangles to process collisions with. As
59  /// a result a SoftBodyCollisionShape should never be reused and should be kept unique to the Actor
60  /// it applies to. @n @n
61  /// Normally the SoftProxy will be responsible for the creation of it's own collision shape, so
62  /// the user should never have to. So there are no non-internal constructors provided for this class.
63  ///////////////////////////////////////
65  {
66  protected:
67  btSoftBodyCollisionShape* SoftShape;
68  public:
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  SoftCollisionShape(const String& Name, btSoftBodyCollisionShape* BulletShape);
74  /// @brief Class Destructor.
75  virtual ~SoftCollisionShape();
76  /// @copydoc CollisionShape::GetType()
77  virtual CollisionShape::ShapeType GetType() const;
78  };//SoftCollisionShape
79  }//Physics
80 }//Mezzanine
81 
82 /// @copydoc operator << (std::ostream& stream, const Mezzanine::Physics::CollisionShape& ShapeToSerialize)
83 std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::Physics::SoftCollisionShape& ShapeToSerialize);
84 /// @copydoc operator >> (std::istream& stream, Mezzanine::Physics::CollisionShape& x)
85 std::istream& MEZZ_LIB operator >> (std::istream& stream, Mezzanine::Physics::SoftCollisionShape& x);
86 /// @copydoc operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::CollisionShape& x)
87 void MEZZ_LIB operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::Physics::SoftCollisionShape& x);
88 
89 #endif