Spinning Topp Logo BlackTopp Studios
inc
cylindercollisionshape.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 _physicscylindercollisionshape_cpp
41 #define _physicscylindercollisionshape_cpp
42 
43 #include "Physics/cylindercollisionshape.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  // CylinderCollisionShape Functions
55 
56  void CylinderCollisionShape::Construct(const String& Name, const Vector3& HalfExtents, StandardAxis UpAxis)
57  {
58  btCylinderShape* CylinderShape;
59 
60  switch (UpAxis)
61  {
62  case Axis_Y:
63  CylinderShape = new btCylinderShape(HalfExtents.GetBulletVector3());
64  break;
65  case Axis_X:
66  CylinderShape = new btCylinderShapeX(HalfExtents.GetBulletVector3());
67  break;
68  case Axis_Z:
69  CylinderShape = new btCylinderShapeZ(HalfExtents.GetBulletVector3());
70  break;
71  default: { MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Non-supported up Axis passed into CylinderCollisionShape constructor."); }
72  }
73  Construct(Name, CylinderShape);
74  }
75 
76  void CylinderCollisionShape::Construct(const String& Name, btCylinderShape* BulletShape)
77  {
78  this->Name = Name;
79  SetPointers(BulletShape);
80  }
81 
82  CylinderCollisionShape::CylinderCollisionShape(const String& Name, const Real& Radius, const Real& Height, const Vector3& UpAxis)
83  { Construct(Name, CreateHalfExtents(Radius,Height,UpAxis.IsStandardUnitAxis()), UpAxis.IsStandardUnitAxis()); }
84 
85  CylinderCollisionShape::CylinderCollisionShape(const String& Name, const Real& Radius, const Real& Height, StandardAxis UpAxis)
86  { Construct(Name, CreateHalfExtents(Radius,Height,UpAxis), UpAxis); }
87 
88  CylinderCollisionShape::CylinderCollisionShape(const String& Name, const Vector3& HalfExtents, const Vector3& UpAxis)
89  { Construct(Name, HalfExtents, UpAxis.IsStandardUnitAxis()); }
90 
92  { Construct(Name, HalfExtents, UpAxis); }
93 
94  CylinderCollisionShape::CylinderCollisionShape(const String& Name, btCylinderShape* BulletShape)
95  { Construct(Name,BulletShape); }
96 
98  {
99  if(OneNode.GetAttribute("Version").AsInt() == 1)
100  {
101  XML::Attribute OneName = OneNode.GetChild("PrimitiveCollisionShape").GetChild("CollisionShape").GetAttribute("Name"); // get name
102  if(!OneName) { MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Could not find Name Attribute on CollsionShape Node during preparation for deserialization"); }
103 
104  /*XML::Node HalfExtentsNode = OneNode.GetChild("HalfExtents").GetFirstChild();
105  if (!HalfExtentsNode) { DeSerializeError("find HalfExtentsNode",CylinderCollisionShape::GetSerializableName()); }
106  SetPointers(new CylinderShape(Vector3(HalfExtentsNode).GetBulletVector3()));
107  // */
108 
109  XML::Attribute Axis = OneNode.GetAttribute("Axis");
110  if (!Axis) { DeSerializeError("find Axis Attribute",CylinderCollisionShape::GetSerializableName()); }
111 
112  Construct(OneName.AsString(), Vector3(), (StandardAxis)Axis.AsInteger());
113 
114  this->ProtoDeSerialize(OneNode);
115  }else{
116  DeSerializeError("find usable serialization version", CylinderCollisionShape::GetSerializableName());
117  }
118  }
119 
121  {
122  delete GetBulletCylinderShape();
123  }
124 
126  {
127  switch (UpAxis)
128  {
129  case Axis_Y: return Vector3(Radius,Height,Radius);
130  case Axis_X: return Vector3(Height,Radius,Radius);
131  case Axis_Z: return Vector3(Radius,Radius,Height);
132  default: { MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Non-supported up Axis passed into CylinderCollisionShape::CreateHalfExtents."); }
133  }
134  }
135 
137  {
138  Vector3 HalfExtents(GetBulletCylinderShape()->getHalfExtentsWithoutMargin());
139  return HalfExtents;
140  }
141 
143  {
144  Vector3 HalfExtents(GetBulletCylinderShape()->getHalfExtentsWithMargin());
145  return HalfExtents;
146  }
147 
149  { return GetBulletCylinderShape()->getRadius(); }
150 
152  { return Vector3::UnitOnAxis((StandardAxis)GetBulletCylinderShape()->getUpAxis()); }
153 
155  { return CollisionShape::ST_Cylinder; }
156 
158  { return static_cast<btCylinderShape*>(ShapeBase); }
159 
161  {
162  XML::Node CollisionNode = CurrentRoot.AppendChild(this->CylinderCollisionShape::GetSerializableName());
163  if (!CollisionNode) { SerializeError("create CollisionNode",this->CylinderCollisionShape::GetSerializableName());}
164 
165  /*
166  XML::Node HalfExtentsNode = CollisionNode.AppendChild("HalfExtents");
167  if (!HalfExtentsNode) { SerializeError("create HalfExtentsNode",this->CylinderCollisionShape::GetSerializableName());}
168  //this->GetHalfExtents().ProtoSerialize(HalfExtentsNode);
169  this->GetCleanHalfExtents().ProtoSerialize(HalfExtentsNode);
170  */
171 
172  XML::Attribute Version = CollisionNode.AppendAttribute("Version");
173  if (Version)
174  { Version.SetValue(1); }
175  else
176  { SerializeError("Create Version Attribute", GetSerializableName()); }
177 
178  XML::Attribute Axis = CollisionNode.AppendAttribute("Axis");
179  if (Axis)
180  { Axis.SetValue((StandardAxis)GetBulletCylinderShape()->getUpAxis()); }
181  else
182  { SerializeError("Create Axis Attribute", GetSerializableName()); }
183 
184  this->PrimitiveCollisionShape::ProtoSerialize(CollisionNode);
185  }
186 
188  {
190  {
191  if(OneNode.GetAttribute("Version").AsInt() == 1)
192  {
193  XML::Node CollisionNode = OneNode.GetChild(this->PrimitiveCollisionShape::GetSerializableName());
194  if(!CollisionNode)
195  { DeSerializeError("locate PrimitiveCollisionShape node",GetSerializableName()); }
196  this->PrimitiveCollisionShape::ProtoDeSerialize(CollisionNode);
197  }else{
198  DeSerializeError("find usable serialization version",GetSerializableName());
199  }
200  }else{
201  DeSerializeError(String("find correct class to deserialize, found a ")+OneNode.Name(),GetSerializableName());
202  }
203  }
204 
206  { return String("CylinderCollisionShape"); }
207 
208  }//Physics
209 }//Mezzanine
210 
211 std::ostream& operator << (std::ostream& stream, const Mezzanine::Physics::CylinderCollisionShape& ShapeToSerialize)
212  { Mezzanine::Serialize(stream, ShapeToSerialize); return stream; }
213 
214 std::istream& operator >> (std::istream& stream, Mezzanine::Physics::CylinderCollisionShape& x)
215  { return Mezzanine::DeSerialize(stream, x); }
216 
218  { x.ProtoDeSerialize(OneNode); }
219 
220 #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.
A light-weight handle for manipulating attributes in DOM tree.
Definition: attribute.h:74
virtual Real GetRadius() const
Gets the radius of the cylinder.
virtual Vector3 GetHalfExtentsWithMargin() const
Gets the half extents with padding.
StandardAxis
Used to identify different Axis in a 3d coordinate system.
Definition: enumerations.h:119
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 btCylinderShape * GetBulletCylinderShape() const
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
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.
btVector3 GetBulletVector3() const
Gets a Bullet vector3.
Definition: vector3.cpp:555
A light-weight handle for manipulating nodes in DOM tree.
Definition: node.h:89
CylinderCollisionShape(const String &Name, const Real &Radius, const Real &Height, const Vector3 &UpAxis)
Verbose Vector Constructor.
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.
Integer AsInteger(Integer def=0) const
Attempts to convert the value of the attribute to a Integer and returns the results.
Indicates the class is a CylinderCollisionShape.
void Construct(const String &Name, const Vector3 &HalfExtents, StandardAxis UpAxis)
Does the initialization for a Cylinder.
std::istream & DeSerialize(std::istream &Stream, T &Converted)
Deserialize the next xml tag in the stream into a specific in memory class instance.
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
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.
virtual void ProtoDeSerialize(const XML::Node &OneNode)
virtual Vector3 GetUpAxis() const
Gets which axis this cylinder is oriented along.
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 Vector3 GetHalfExtents() const
Gets the half extents used to construct this cylinder.
const Char8 * Name() const
ptrdiff_tGet the name of this Node.
virtual CollisionShape::ShapeType GetType() const
Gets the type of Collision shape this is.
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.
static Vector3 CreateHalfExtents(const Real &Radius, const Real &Height, StandardAxis UpAxis)
A (very) simple way to create a Vector3 containing the Half Extents of a Cylinder with given dimenion...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
static String GetSerializableName()
Get the name of the the XML tag this class will leave behind as its instances are serialized...
Attribute GetAttribute(const Char8 *Name) const
Attempt to get an Attribute on this Node with a given name.
virtual void ProtoSerialize(XML::Node &CurrentRoot) const
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