Spinning Topp Logo BlackTopp Studios
inc
planecollisionshape.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 _physicsplanecollisionshape_cpp
41 #define _physicsplanecollisionshape_cpp
42 
43 #include "Physics/planecollisionshape.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  // PlaneCollisionShape Functions
55 
57  {
58  this->Name = Name;
59  this->PlaneShape = new btStaticPlaneShape(Other.Normal.GetBulletVector3(),-(Other.Distance));
60  this->SetPointers(this->PlaneShape);
61  }
62 
63  PlaneCollisionShape::PlaneCollisionShape(const String& Name, const Vector3& Norm, const Real Constant)
64  {
65  this->Name = Name;
66  this->PlaneShape = new btStaticPlaneShape(Norm.GetBulletVector3(),Constant);
67  this->SetPointers(this->PlaneShape);
68  }
69 
70  PlaneCollisionShape::PlaneCollisionShape(const String& Name, btStaticPlaneShape* BulletShape)
71  {
72  this->Name = Name;
73  this->PlaneShape = BulletShape;
74  this->SetPointers(this->PlaneShape);
75  }
76 
78  {
79  this->ProtoDeSerialize(XMLNode);
80  }
81 
83  { delete this->PlaneShape; }
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Utility
87 
89  { return Vector3( this->PlaneShape->getPlaneNormal() ); }
90 
92  { return this->PlaneShape->getPlaneConstant(); }
93 
95  { return CollisionShape::ST_Plane; }
96 
97  ///////////////////////////////////////////////////////////////////////////////
98  // Serialization
99 
101  {
102  XML::Node CollisionNode = CurrentRoot.AppendChild(this->PlaneCollisionShape::GetSerializableName());
103  if (!CollisionNode) { SerializeError("create CollisionNode",this->PlaneCollisionShape::GetSerializableName());}
104 
105  XML::Attribute Version = CollisionNode.AppendAttribute("Version");
106  XML::Attribute Constant = CollisionNode.AppendAttribute("Constant");
107  XML::Node Normal = CollisionNode.AppendChild("Normal");
108  if (Version && Normal && Constant) {
109  Version.SetValue(1);
110  Constant.SetValue(this->PlaneShape->getPlaneConstant());
111 
112  Vector3 Norm(this->PlaneShape->getPlaneNormal());
113  Norm.ProtoSerialize(Normal);
114  }else{
115  SerializeError("Create Version Attribute", GetSerializableName());
116  }
117 
118  this->FieldCollisionShape::ProtoSerialize(CollisionNode);
119  }
120 
122  {
124  {
125  if(OneNode.GetAttribute("Version").AsInt() == 1)
126  {
127  XML::Attribute Constant = OneNode.GetAttribute("Constant");
128  if(Constant)
129  { this->PlaneShape->setPlaneConstant( Constant.AsReal() ); }
130 
131  XML::Node Normal = OneNode.GetChild("Normal").GetFirstChild();
132  if(Normal)
133  { this->PlaneShape->setPlaneNormal( Vector3(Normal).GetBulletVector3() ); }
134 
135  XML::Node CollisionNode = OneNode.GetChild(this->FieldCollisionShape::GetSerializableName());
136  if(!CollisionNode)
137  { DeSerializeError("locate FieldCollisionShape node",GetSerializableName()); }
138  this->FieldCollisionShape::ProtoDeSerialize(CollisionNode);
139 
140  }else{
141  DeSerializeError("find usable serialization version",GetSerializableName());
142  }
143  }else{
144  DeSerializeError(String("find correct class to deserialize, found a ")+OneNode.Name(),GetSerializableName());
145  }
146  }
147 
149  { return "PlaneCollisionShape"; }
150  }//Physics
151 }//Mezzanine
152 
153 std::ostream& operator << (std::ostream& stream, const Mezzanine::Physics::PlaneCollisionShape& ShapeToSerialize)
154  { Mezzanine::Serialize(stream, ShapeToSerialize); return stream; }
155 
156 std::istream& operator >> (std::istream& stream, Mezzanine::Physics::PlaneCollisionShape& x)
157  { return Mezzanine::DeSerialize(stream, x); }
158 
160  { x.ProtoDeSerialize(OneNode); }
161 
162 #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
PlaneCollisionShape(const String &Name, const Plane &Other)
Math Constructor.
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 void ProtoSerialize(XML::Node &CurrentRoot) const
Convert this class to an XML::Node ready for serialization.
Real GetConstant() const
Gets the constant with which to project the plane.
virtual void ProtoSerialize(XML::Node &CurrentRoot) const
Convert this class to an XML::Node ready for serialization.
virtual ~PlaneCollisionShape()
Class Destructor.
Node GetFirstChild() const
Get the first child Node of this Node.
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...
btStaticPlaneShape * PlaneShape
A pointer to the internal shape.
virtual void ProtoDeSerialize(const XML::Node &OneNode)
Take the data stored in an XML and overwrite this instance of this object with it.
This is used to represent a flat infinite slice of the game world.
Definition: plane.h:65
Real Distance
How from from the origin the plane is.
Definition: plane.h:87
Vector3 GetNormal() const
Gets the positive direction of the plane.
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.
Indicates the class is a PlaneCollisionShape.
void SetPointers(btConcaveShape *Shape)
Sets the internal pointers on the base classes.
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 CollisionShape::ShapeType GetType() const
Gets the type of Collision shape this is.
ShapeType
This enum describes what kind of shape you are currently working with.
Real AsReal(Real def=0) const
Attempts to convert the value of the attribute to a Real and returns the results. ...
std::istream & DeSerialize(std::istream &Stream, T &Converted)
Deserialize the next xml tag in the stream into a specific in memory class instance.
Vector3 Normal
The rotation of the plane.
Definition: plane.h:85
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...
This is used to represent a point in space, or a vector through space.
Definition: vector3.h:77
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
A Flat wall/floor of limitless size.
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.
virtual void ProtoDeSerialize(const XML::Node &OneNode)
Take the data stored in an XML and overwrite this instance of this object with it.
static String GetSerializableName()
Get the name of the the XML tag this class will leave behind as its instances are serialized...
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.
void ProtoSerialize(XML::Node &CurrentRoot) const
Convert this class to an XML::Node ready for serialization.
Definition: vector3.cpp:588
Node GetChild(const Char8 *Name) const
Attempt to get a child Node with a given name.