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

A collision shape for soft proxies. More...

#include <softcollisionshape.h>

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

Public Member Functions

 SoftCollisionShape (const String &Name, btSoftBodyCollisionShape *BulletShape)
 Internal Constructor. More...
 
virtual ~SoftCollisionShape ()
 Class Destructor.
 
virtual CollisionShape::ShapeType GetType () const
 Gets the type of Collision shape this is. More...
 
- Public Member Functions inherited from Mezzanine::Physics::MeshCollisionShape
 MeshCollisionShape ()
 Class Constructor.
 
virtual ~MeshCollisionShape ()
 Class Destructor.
 
virtual btConcaveShape * GetBulletConcaveShape () const
 
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...
 

Protected Attributes

btSoftBodyCollisionShape * SoftShape
 

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...
 
- Static Public Member Functions inherited from Mezzanine::Physics::MeshCollisionShape
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 inherited from Mezzanine::Physics::MeshCollisionShape
void SetPointers (btConcaveShape *Shape)
 Sets the internal pointers on the base classes.
 

Detailed Description

A collision shape for soft proxies.

This collision shape is different from all the other collision shapes because it's meant to be used for only one type of object: SoftProxys. This shape doesn't use triangles in the traditional manner other mesh shapes do, but rather it uses the individual internal nodes that make the SoftProxy as points for building triangles to process collisions with. As a result a SoftBodyCollisionShape should never be reused and should be kept unique to the Actor it applies to.

Normally the SoftProxy will be responsible for the creation of it's own collision shape, so the user should never have to. So there are no non-internal constructors provided for this class.

Definition at line 64 of file softcollisionshape.h.

Constructor & Destructor Documentation

Mezzanine::Physics::SoftCollisionShape::SoftCollisionShape ( const String Name,
btSoftBodyCollisionShape *  BulletShape 
)

Internal Constructor.

Parameters
NameThe name of this Shape.
BulletShapeThe internal shape this shape is based on.

Definition at line 57 of file softcollisionshape.cpp.

Member Function Documentation

CollisionShape::ShapeType Mezzanine::Physics::SoftCollisionShape::GetType ( ) const
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::MeshCollisionShape.

Definition at line 69 of file softcollisionshape.cpp.


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