Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Attributes | List of all members
Mezzanine::Physics::HeightfieldCollisionShape Class Reference

A series of values that store hieght in a grid like fashion. More...

#include <collisionshape.h>

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

Public Member Functions

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

Protected Attributes

btHeightfieldTerrainShape * HeightfieldShape
 The internal implementation. 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.
 

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

Detailed Description

A series of values that store hieght in a grid like fashion.

A fast terrain implementation that comes at the cost of overhangs and fine detail. This can be worked around by adding actors for additional terrain.

Definition at line 59 of file heightfieldcollisionshape.h.

Constructor & Destructor Documentation

Mezzanine::Physics::HeightfieldCollisionShape::HeightfieldCollisionShape ( const String Name)

Class Constructor.

Parameters
NameThe name of this Shape.

Definition at line 57 of file heightfieldcollisionshape.cpp.

Mezzanine::Physics::HeightfieldCollisionShape::HeightfieldCollisionShape ( const String Name,
btHeightfieldTerrainShape *  BulletShape 
)

Internal Constructor.

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

Definition at line 62 of file heightfieldcollisionshape.cpp.

Member Function Documentation

CollisionShape::ShapeType Mezzanine::Physics::HeightfieldCollisionShape::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::FieldCollisionShape.

Definition at line 74 of file heightfieldcollisionshape.cpp.

Member Data Documentation

btHeightfieldTerrainShape* Mezzanine::Physics::HeightfieldCollisionShape::HeightfieldShape
protected

The internal implementation.

Definition at line 64 of file heightfieldcollisionshape.h.


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