Spinning Topp Logo BlackTopp Studios
inc
boxcollisionshape.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 _physicsboxcollisionshape_cpp
41 #define _physicsboxcollisionshape_cpp
42 
43 #include "Physics/boxcollisionshape.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  // BoxCollisionShape Functions
55 
56  BoxCollisionShape::BoxCollisionShape(const String& Name, const Vector3& HalfExtents)
57  {
58  this->Name = Name;
59  SetPointers(new btBoxShape(HalfExtents.GetBulletVector3()));
60  }
61 
62  BoxCollisionShape::BoxCollisionShape(const String& Name, btBoxShape* BulletShape)
63  {
64  this->Name = Name;
65  SetPointers(BulletShape);
66  }
67 
69  {
70  if(OneNode.GetAttribute("Version").AsInt() == 1)
71  {
72  XML::Attribute OneName = OneNode.GetChild("PrimitiveCollisionShape").GetChild("CollisionShape").GetAttribute("Name"); // get name
73  if(!OneName) { MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Could not find Name Attribute on CollsionShape Node during preparation for deserialization"); }
74  this->Name=OneName.AsString();
75 
76  /*XML::Node HalfExtentsNode = OneNode.GetChild("HalfExtents").GetFirstChild();
77  if (!HalfExtentsNode) { DeSerializeError("find HalfExtentsNode",BoxCollisionShape::GetSerializableName()); }
78  SetPointers(new btBoxShape(Vector3(HalfExtentsNode).GetBulletVector3()));
79  // */
80  SetPointers(new btBoxShape(Vector3().GetBulletVector3()));
81 
82  this->ProtoDeSerialize(OneNode);
83  }else{
84  DeSerializeError("find usable serialization version",BoxCollisionShape::GetSerializableName());
85  }
86  }
87 
89  {
90  delete GetBulletBoxShape();
91  }
92 
94  {
95  return (this->GetHalfExtentsWithMargin()/this->GetScaling());
96  }
97 
99  {
100  return Vector3(GetBulletBoxShape()->getHalfExtentsWithoutMargin());
101  }
102 
104  {
105  return Vector3(GetBulletBoxShape()->getHalfExtentsWithMargin());
106  }
107 
108  Boole BoxCollisionShape::IsInside(const Vector3& Location, const Real& Tolerance) const
109  {
110  return GetBulletBoxShape()->isInside(Location.GetBulletVector3(),Tolerance);
111  }
112 
114  {
115  return CollisionShape::ST_Box;
116  }
117 
119  { return static_cast<btBoxShape*>(ShapeBase); }
120 
122  {
123  XML::Node CollisionNode = CurrentRoot.AppendChild(this->BoxCollisionShape::GetSerializableName());
124  if (!CollisionNode) { SerializeError("create CollisionNode",this->BoxCollisionShape::GetSerializableName());}
125 
126  /*
127  XML::Node HalfExtentsNode = CollisionNode.AppendChild("HalfExtents");
128  if (!HalfExtentsNode) { SerializeError("create HalfExtentsNode",this->BoxCollisionShape::GetSerializableName());}
129  //this->GetHalfExtents().ProtoSerialize(HalfExtentsNode);
130  this->GetCleanHalfExtents().ProtoSerialize(HalfExtentsNode);
131  */
132 
133  XML::Attribute Version = CollisionNode.AppendAttribute("Version");
134  if (Version)
135  { Version.SetValue(1); }
136  else
137  { SerializeError("Create Version Attribute", GetSerializableName()); }
138 
139  this->PrimitiveCollisionShape::ProtoSerialize(CollisionNode);
140  }
141 
143  {
145  {
146  if(OneNode.GetAttribute("Version").AsInt() == 1)
147  {
148  XML::Node CollisionNode = OneNode.GetChild(this->PrimitiveCollisionShape::GetSerializableName());
149  if(!CollisionNode)
150  { DeSerializeError("locate PrimitiveCollisionShape node",GetSerializableName()); }
151  this->PrimitiveCollisionShape::ProtoDeSerialize(CollisionNode);
152  }else{
153  DeSerializeError("find usable serialization version",GetSerializableName());
154  }
155  }else{
156  DeSerializeError(String("find correct class to deserialize, found a ")+OneNode.Name(),GetSerializableName());
157  }
158  }
159 
161  { return String("BoxCollisionShape"); }
162 
163  }//Physics
164 }//Mezzanine
165 
166 std::ostream& operator << (std::ostream& stream, const Mezzanine::Physics::BoxCollisionShape& ShapeToSerialize)
167  { Mezzanine::Serialize(stream, ShapeToSerialize); return stream; }
168 
169 std::istream& operator >> (std::istream& stream, Mezzanine::Physics::BoxCollisionShape& x)
170  { return Mezzanine::DeSerialize(stream, x); }
171 
173  { x.ProtoDeSerialize(OneNode); }
174 
175 #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
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
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 CollisionShape::ShapeType GetType() const
Gets the type of Collision shape this is.
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 ProtoDeSerialize(const XML::Node &OneNode)
BoxCollisionShape(const String &Name, const Vector3 &HalfExtents)
Class Constructor.
virtual Vector3 GetHalfExtents() const
Gets the current half extents used in collision checking.
virtual void ProtoSerialize(XML::Node &CurrentRoot) const
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.
virtual Vector3 GetCleanHalfExtents() const
Gets the half extents used to construct this box.
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
int AsInt(int def=0) const
Attempts to convert the value of the attribute to an int and returns the results. ...
virtual Vector3 GetHalfExtentsWithMargin() const
Gets the half extents with padding, this is the size the shape will appear to be. ...
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.
void DeSerializeError(const String &FailedTo, const String &ClassName, Boole SOrD)
Simply does some string concatenation, then throws an Exception.
static String GetSerializableName()
Get the name of the the XML tag this class will leave behind as its instances are serialized...
Thrown when parameters are checked at runtime and found invalid.
Definition: exception.h:108
Indicates the class is a BoxCollisionShape.
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
btCollisionShape * ShapeBase
A pointer to the bullet collision this uses.
virtual Boole IsInside(const Vector3 &Location, const Real &Tolerance) const
Checks to see if a point in local space is inside this shape.
virtual ~BoxCollisionShape()
Class Destructor.
virtual btBoxShape * GetBulletBoxShape() const
const Char8 * Name() const
ptrdiff_tGet the name of this Node.
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.
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.
Node GetChild(const Char8 *Name) const
Attempt to get a child Node with a given name.