Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Mezzanine::Physics::FieldCollisionShape Class Referenceabstract

This is the base class for all Field shapes. More...

#include <collisionshape.h>

+ Inheritance diagram for Mezzanine::Physics::FieldCollisionShape:
+ Collaboration diagram for Mezzanine::Physics::FieldCollisionShape:

Public Member Functions

 FieldCollisionShape ()
 Class Constructor.
 
virtual ~FieldCollisionShape ()
 Class Destructor.
 
virtual btConcaveShape * GetBulletConcaveShape () const
 
virtual CollisionShape::ShapeType GetType () const =0
 Gets the type of Collision shape this is. More...
 
virtual void ProtoDeSerialize (const XML::Node &OneNode)
 Take the data stored in an XML and overwrite this instance of this object with it. More...
 
virtual void ProtoSerialize (XML::Node &CurrentRoot) const
 Convert this class to an XML::Node ready for serialization. More...
 
- Public Member Functions inherited from Mezzanine::Physics::CollisionShape
 CollisionShape ()
 Class Constructor.
 
virtual ~CollisionShape ()
 Class Destructor.
 
virtual btCollisionShape * _GetInternalShape () const
 Gets the internal shape pointer this collision shape is based on. More...
 
virtual void _SetShapeName (const String &NewName)
 Sets the name of this collision shape. More...
 
virtual Real GetMargin () const
 Gets the amount of padding currently being applied to the collision shape. More...
 
virtual const StringGetName () const
 Gets the name of this shape. More...
 
virtual Vector3 GetScaling () const
 Gets the current scaling being applied to the collision shape. More...
 
virtual void SetMargin (const Real &Margin)
 Sets the padding that will be applied when checking for collisions. More...
 
virtual void SetScaling (const Vector3 &Scaling)
 Scales the collision shape on each of it's axes. More...
 

Static Public Member Functions

static String GetSerializableName ()
 Get the name of the the XML tag this class will leave behind as its instances are serialized. More...
 
- Static Public Member Functions inherited from Mezzanine::Physics::CollisionShape
static String GetSerializableName ()
 Get the name of the the XML tag this class will leave behind as its instances are serialized. More...
 

Protected Member Functions

void SetPointers (btConcaveShape *Shape)
 Sets the internal pointers on the base classes.
 

Additional Inherited Members

- Public Types inherited from Mezzanine::Physics::CollisionShape
enum  ShapeType {
  ST_Box = 0, ST_Capsule = 1, ST_Compound = 2, ST_Cone = 3,
  ST_ConvexHull = 4, ST_Cylinder = 5, ST_MultiSphere = 6, ST_Sphere = 7,
  ST_DynamicTriMesh = 8, ST_Heightfield = 9, ST_Plane = 10, ST_Soft = 11,
  ST_StaticTriMesh = 12
}
 This enum describes what kind of shape you are currently working with. More...
 
- Protected Attributes inherited from Mezzanine::Physics::CollisionShape
String Name
 Storage for the name of this class instance.
 
btCollisionShape * ShapeBase
 A pointer to the bullet collision this uses.
 

Detailed Description

This is the base class for all Field shapes.

A Mesh shape is any shape that is intended to be used as surface that extends for a a significant or even unending length. These can be used as the basis for ground and hills or as walls at the end of gameplay area. Performance is dependant on the complexity of the field, and are dependent on complexity.

Definition at line 61 of file fieldcollisionshape.h.

Member Function Documentation

btConcaveShape * Mezzanine::Physics::FieldCollisionShape::GetBulletConcaveShape ( ) const
virtual

Definition at line 66 of file fieldcollisionshape.cpp.

String Mezzanine::Physics::FieldCollisionShape::GetSerializableName ( )
static

Get the name of the the XML tag this class will leave behind as its instances are serialized.

Returns
A string containing "FieldCollisionShape".

Definition at line 102 of file fieldcollisionshape.cpp.

virtual CollisionShape::ShapeType Mezzanine::Physics::FieldCollisionShape::GetType ( ) const
pure virtual

Gets the type of Collision shape this is.

Returns
Returns an enum value indicating the type of collision shape this is.

Implements Mezzanine::Physics::CollisionShape.

Implemented in Mezzanine::Physics::PlaneCollisionShape, and Mezzanine::Physics::HeightfieldCollisionShape.

void Mezzanine::Physics::FieldCollisionShape::ProtoDeSerialize ( const XML::Node OneNode)
virtual

Take the data stored in an XML and overwrite this instance of this object with it.

Parameters
OneNodeand XML::Node containing the data.
Warning
A precondition of using this is that all of the actors intended for use must already be Deserialized.

Reimplemented from Mezzanine::Physics::CollisionShape.

Reimplemented in Mezzanine::Physics::PlaneCollisionShape.

Definition at line 84 of file fieldcollisionshape.cpp.

void Mezzanine::Physics::FieldCollisionShape::ProtoSerialize ( XML::Node CurrentRoot) const
virtual

Convert this class to an XML::Node ready for serialization.

Parameters
CurrentRootThe point in the XML hierarchy that all this collision shape should be appended to.

Reimplemented from Mezzanine::Physics::CollisionShape.

Reimplemented in Mezzanine::Physics::PlaneCollisionShape.

Definition at line 69 of file fieldcollisionshape.cpp.


The documentation for this class was generated from the following files: