Spinning Topp Logo BlackTopp Studios
inc
capsulecollisionshape.cpp
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 _physicscapsulecollisionshape_cpp
41 #define _physicscapsulecollisionshape_cpp
42 
43 #include "Physics/capsulecollisionshape.h"
44 #include "collisionshapemanager.h"
45 #include "stringtool.h"
46 
47 #include "btBulletDynamicsCommon.h"
48 
49 namespace Mezzanine
50 {
51  namespace Physics
52  {
53  /////////////////////////////////////////
54  // CapsuleCollisionShape Functions
55 
56  void CapsuleCollisionShape::Construct(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis)
57  {
58  this->Name = Name;
59  btCapsuleShape* CapsuleShape = 0;
60  if(Axis_Y == UpAxis) CapsuleShape = new btCapsuleShape(Radius,Height);
61  else if(Axis_X == UpAxis) CapsuleShape = new btCapsuleShapeX(Radius,Height);
62  else if(Axis_Z == UpAxis) CapsuleShape = new btCapsuleShapeZ(Radius,Height);
63  else { MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Non-supported up Axis passed into CapsuleCollisionShape constructor."); }
64  SetPointers(CapsuleShape);
65  }
66 
67  CapsuleCollisionShape::CapsuleCollisionShape(const String& Name, const Real& Radius, const Real& Height, const Vector3& UpAxis)
68  { this->Construct(Name,Radius,Height,UpAxis.IsStandardUnitAxis()); }
69 
70  CapsuleCollisionShape::CapsuleCollisionShape(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis)
71  { this->Construct(Name,Radius,Height,UpAxis); }
72 
74  {
75  if(OneNode.GetAttribute("Version").AsInt() == 1)
76  {
77  XML::Attribute OneName = OneNode.GetChild("PrimitiveCollisionShape").GetChild("CollisionShape").GetAttribute("Name"); // get name
78  if(!OneName) { MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Could not find Name Attribute on CollsionShape Node during preparation for deserialization"); }
79  String Name_(OneName.AsString());
80 
81  XML::Attribute Axis = OneNode.GetAttribute("Axis");
82  if (!Axis) { DeSerializeError("find Axis Attribute",CapsuleCollisionShape::GetSerializableName()); }
83  /*
84  XML::Attribute Radius = OneNode.GetAttribute("Radius");
85  if (!Radius) { DeSerializeError("find Radius Attribute",CapsuleCollisionShape::GetSerializableName()); }
86  XML::Attribute Height = OneNode.GetAttribute("Height");
87  if (!Height) { DeSerializeError("find Height Attribute",CapsuleCollisionShape::GetSerializableName()); }
88  //SetPointers(new CapsuleCollisionShape(Name_,Radius.AsReal(),Height.AsReal(), (StandardAxis)Axis.AsInteger()); // make and deserialize the shape
89  this->Construct(Name_,Radius.AsReal(),Height.AsReal(),(StandardAxis)Axis.AsInteger());
90  */
91  this->Construct(Name_,0,0,(StandardAxis)Axis.AsInteger());
92 
93  this->ProtoDeSerialize(OneNode);
94 
95  }else{
96  DeSerializeError("find usable serialization version",CapsuleCollisionShape::GetSerializableName());
97  }
98  }
99 
100  CapsuleCollisionShape::CapsuleCollisionShape(const String& Name, btCapsuleShape* BulletShape)
101  {
102  this->Name = Name;
103  SetPointers(BulletShape);
104  }
105 
107  {
108  delete GetBulletCapsuleShape();
109  }
110 
112  { return GetBulletCapsuleShape()->getRadius(); }
114  { return (GetBulletCapsuleShape()->getHalfHeight() * 2.0); }
115 
117  { return (this->GetRadius()+GetBulletCapsuleShape()->getMargin()) / GetScaling()[(StandardAxis)((this->GetUpStandardAxis()+2)%3)] - GetBulletCapsuleShape()->getMargin(); }
118  //{ return GetRadiusWithMargin() / GetScaling()[(StandardAxis)((this->GetUpStandardAxis()+2)%3)] - GetBulletCapsuleShape()->getMargin(); }
120  //{ return 2.0* ((GetBulletCapsuleShape()->getHalfHeight()+GetBulletCapsuleShape()->getMargin()) / GetScaling()[this->GetUpStandardAxis()] - GetBulletCapsuleShape()->getMargin()); }
121  { return 2.0* ((GetBulletCapsuleShape()->getHalfHeight()) / GetScaling()[this->GetUpStandardAxis()]); }
122  /* Real CapsuleCollisionShape::GetRadiusWithMargin() const
123  { return this->GetRadius()+GetBulletCapsuleShape()->getMargin(); }*/
124 
126  { return Vector3::UnitOnAxis( (StandardAxis)GetBulletCapsuleShape()->getUpAxis() ); }
127 
129  { return (StandardAxis)GetBulletCapsuleShape()->getUpAxis(); }
130 
132  {
134  }
135 
137  { return static_cast<btCapsuleShape*>(ShapeBase); }
138 
140  {
141  XML::Node CollisionNode = CurrentRoot.AppendChild(this->CapsuleCollisionShape::GetSerializableName());
142  if (!CollisionNode) { SerializeError("create CollisionNode",this->CapsuleCollisionShape::GetSerializableName());}
143 
144  XML::Attribute Version = CollisionNode.AppendAttribute("Version");
145  if (Version)
146  { Version.SetValue(1); }
147  else
148  { SerializeError("Create Version Attribute", GetSerializableName()); }
149 /*
150  XML::Attribute RadiusAttr = CollisionNode.AppendAttribute("Radius");
151  if (RadiusAttr)
152  { RadiusAttr.SetValue(this->GetCleanRadius()); }
153  else
154  { SerializeError("Create RadiusAttr Attribute", GetSerializableName()); }
155 
156  XML::Attribute HeightAttr = CollisionNode.AppendAttribute("Height");
157  if (HeightAttr)
158  { HeightAttr.SetValue(this->GetCleanHeight()); }
159  else
160  { SerializeError("Create HeightAttr Attribute", GetSerializableName()); }
161 */
162  XML::Attribute AxisAttr = CollisionNode.AppendAttribute("Axis");
163  if (AxisAttr)
164  { AxisAttr.SetValue(this->GetUpStandardAxis()); }
165  else
166  { SerializeError("Create AxisAttr Attribute", GetSerializableName()); }
167 
168  this->PrimitiveCollisionShape::ProtoSerialize(CollisionNode);
169  }
170 
172  {
174  {
175  if(OneNode.GetAttribute("Version").AsInt() == 1)
176  {
177  XML::Node CollisionNode = OneNode.GetChild(this->PrimitiveCollisionShape::GetSerializableName());
178  if(!CollisionNode)
179  { DeSerializeError("locate PrimitiveCollisionShape node",GetSerializableName()); }
180  this->PrimitiveCollisionShape::ProtoDeSerialize(CollisionNode);
181  }else{
182  DeSerializeError("find usable serialization version",GetSerializableName());
183  }
184  }else{
185  DeSerializeError(String("find correct class to deserialize, found a ")+OneNode.Name(),GetSerializableName());
186  }
187  }
188 
190  { return String("CapsuleCollisionShape"); }
191  }//Physics
192 }//Mezzanine
193 
194  std::ostream& operator << (std::ostream& stream, const Mezzanine::Physics::CapsuleCollisionShape& ShapeToSerialize)
195  { Mezzanine::Serialize(stream, ShapeToSerialize); return stream; }
196 
197  std::istream& operator >> (std::istream& stream, Mezzanine::Physics::CapsuleCollisionShape& x)
198  { return Mezzanine::DeSerialize(stream, x); }
199 
201  { x.ProtoDeSerialize(OneNode); }
202 
203 #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
Attribute AppendAttribute(const Char8 *Name)
Creates an Attribute and puts it at the end of this Nodes attributes.
CapsuleCollisionShape(const String &Name, const Real &Radius, const Real &Height, const Vector3 &UpAxis)
Class Constructor.
virtual Real GetHeight() const
Gets the height of the capsule, as used in collision checking, with scaling and margin subtracted...
A light-weight handle for manipulating attributes in DOM tree.
Definition: attribute.h:74
void Construct(const String &Name, const Real &Radius, const Real &Height, StandardAxis UpAxis)
Performed share contructor work.
virtual CollisionShape::ShapeType GetType() const
Gets the type of Collision shape this is.
virtual Vector3 GetUpAxis() const
Gets which axis this capsule is oriented along.
StandardAxis
Used to identify different Axis in a 3d coordinate system.
Definition: enumerations.h:119
virtual void ProtoDeSerialize(const XML::Node &OneNode)
virtual void ProtoDeSerialize(const XML::Node &OneNode)
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
std::ostream & Serialize(std::ostream &Stream, const T &Converted, const String &Indent=String(""))
Convert any class that supports serialization or has a serializer to a string of chars in a stream...
virtual Vector3 GetScaling() const
Gets the current scaling being applied to the collision shape.
static String GetSerializableName()
Get the name of the the XML tag this class will leave behind as its instances are serialized...
const Char8 * AsString(const Char8 *def="") const
Attempts to convert the value of the attribute to a String and returns the results.
virtual void ProtoSerialize(XML::Node &CurrentRoot) const
virtual btCapsuleShape * GetBulletCapsuleShape() const
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
bool SetValue(const Char8 *rhs)
Set the value of this.
A light-weight handle for manipulating nodes in DOM tree.
Definition: node.h:89
int AsInt(int def=0) const
Attempts to convert the value of the attribute to an int and returns the results. ...
ShapeType
This enum describes what kind of shape you are currently working with.
std::istream & DeSerialize(std::istream &Stream, T &Converted)
Deserialize the next xml tag in the stream into a specific in memory class instance.
virtual Real GetRadius() const
Gets the radius of the capsule, as used in collision checking, with scaling and margin subtracted...
virtual btScalar getMargin() const
Gets the collision margin of the sharable/global child collision shape.
virtual Real GetCleanRadius() const
Gets the radius of the capsule, as the original value passed, without scaling and margin applied...
void DeSerializeError(const String &FailedTo, const String &ClassName, Boole SOrD)
Simply does some string concatenation, then throws an Exception.
Thrown when parameters are checked at runtime and found invalid.
Definition: exception.h:108
static String GetSerializableName()
Get the name of the the XML tag this class will leave behind as its instances are serialized...
This is used to represent a point in space, or a vector through space.
Definition: vector3.h:77
void SetPointers(btConvexInternalShape *Shape)
Sets the internal pointers on the base classes.
String Name
Storage for the name of this class instance.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
std::istream & operator>>(std::istream &stream, Mezzanine::LinearInterpolator< T > &Lint)
Used to de-serialize an Mezzanine::LinearInterpolator from a stream.
Definition: interpolator.h:448
static Vector3 UnitOnAxis(StandardAxis Axis)
Get a Unit Vector along the given Axis.
Definition: vector3.cpp:149
btCollisionShape * ShapeBase
A pointer to the bullet collision this uses.
virtual Real GetCleanHeight() const
Gets the height of the capsule, as the original value passed, without scaling and margin applied...
const Char8 * Name() const
ptrdiff_tGet the name of this Node.
virtual StandardAxis GetUpStandardAxis() const
Gets which axis this capsule is oriented along.
void SerializeError(const String &FailedTo, const String &ClassName, Boole SOrD)
Simply does some string concatenation, then throws an Exception.
Node AppendChild(NodeType Type=NodeElement)
Creates a Node and makes it a child of this one.
virtual void ProtoSerialize(XML::Node &CurrentRoot) const
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
Attribute GetAttribute(const Char8 *Name) const
Attempt to get an Attribute on this Node with a given name.
Indicates the class is a CapsuleCollisionShape.
Node GetChild(const Char8 *Name) const
Attempt to get a child Node with a given name.
StandardAxis IsStandardUnitAxis() const
Get a Unit Vector along the given Axis.
Definition: vector3.cpp:160