MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Mezzanine::Physics::PrimitiveCollisionShape Class Referenceabstract

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

#include <collisionshape.h>

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

Public Member Functions

 PrimitiveCollisionShape ()
 Class Constructor.
 
virtual ~PrimitiveCollisionShape ()
 Class Destructor.
 
virtual btConvexInternalShape * GetBulletConvexShape () const
 
virtual CollisionShape::ShapeType GetType () const =0
 Gets the type of Collision shape this is. More...
 
virtual void ProtoDeSerialize (const XML::Node &OneNode)
 
virtual void ProtoSerialize (XML::Node &CurrentRoot) const
 
- 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 SerializableName ()
 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 SerializableName ()
 Get the name of the the XML tag this class will leave behind as its instances are serialized. More...
 

Protected Member Functions

void SetPointers (btConvexInternalShape *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 Primitive shapes.

A primitive shape is any shape that has a simple rule for determining it's bounds. As a rule all Primitive shapes are Convex. Primitive shapes are ideal for performace reasons and as such you should always try to appoximate objects with primitives, or a compound shape of primitives if at all possible.

Definition at line 60 of file primitivecollisionshape.h.

Member Function Documentation

btConvexInternalShape * Mezzanine::Physics::PrimitiveCollisionShape::GetBulletConvexShape ( ) const
virtual

Definition at line 67 of file primitivecollisionshape.cpp.

virtual CollisionShape::ShapeType Mezzanine::Physics::PrimitiveCollisionShape::GetType ( ) const
pure virtual
void Mezzanine::Physics::PrimitiveCollisionShape::ProtoDeSerialize ( const XML::Node OneNode)
virtual
void Mezzanine::Physics::PrimitiveCollisionShape::ProtoSerialize ( XML::Node CurrentRoot) const
virtual
String Mezzanine::Physics::PrimitiveCollisionShape::SerializableName ( )
static

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

Returns
A string containing "PrimitiveCollisionShape"

Definition at line 112 of file primitivecollisionshape.cpp.


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