Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Static Public Member Functions | List of all members
Mezzanine::Physics::SphereCollisionShape Class Reference

A sphere physics shape. More...

#include <collisionshape.h>

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

Public Member Functions

 SphereCollisionShape (const String &Name, const Real &Radius)
 Class Constructor. More...
 
 SphereCollisionShape (const String &Name, btSphereShape *BulletShape)
 Internal Constructor. More...
 
 SphereCollisionShape (XML::Node OneNode)
 DeSerializing Constructor. More...
 
virtual ~SphereCollisionShape ()
 Class Destructor.
 
virtual Real GetRadius () const
 Gets the radius of the sphere. More...
 
virtual btSphereShape * GetSphereShape () const
 
virtual CollisionShape::ShapeType GetType () const
 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::PrimitiveCollisionShape
 PrimitiveCollisionShape ()
 Class Constructor.
 
virtual ~PrimitiveCollisionShape ()
 Class Destructor.
 
virtual btConvexInternalShape * GetBulletConvexShape () 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 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::PrimitiveCollisionShape
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...
 

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

A sphere physics shape.

A simple sphere defined by it's radius. 'nuff said.

Definition at line 57 of file spherecollisionshape.h.

Constructor & Destructor Documentation

Mezzanine::Physics::SphereCollisionShape::SphereCollisionShape ( const String Name,
const Real Radius 
)

Class Constructor.

Parameters
NameThe name of this Shape.
RadiusThe radius of the sphere.

Definition at line 56 of file spherecollisionshape.cpp.

Mezzanine::Physics::SphereCollisionShape::SphereCollisionShape ( const String Name,
btSphereShape *  BulletShape 
)

Internal Constructor.

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

Definition at line 63 of file spherecollisionshape.cpp.

Mezzanine::Physics::SphereCollisionShape::SphereCollisionShape ( XML::Node  OneNode)

DeSerializing Constructor.

Parameters
OneNodeThe node to use for constructing this shape

Definition at line 70 of file spherecollisionshape.cpp.

Member Function Documentation

Real Mezzanine::Physics::SphereCollisionShape::GetRadius ( ) const
virtual

Gets the radius of the sphere.

Returns
Returns a real representing the radius of the sphere.

Definition at line 92 of file spherecollisionshape.cpp.

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

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

Returns
A string containing "SphereCollisionShape"

Definition at line 138 of file spherecollisionshape.cpp.

btSphereShape * Mezzanine::Physics::SphereCollisionShape::GetSphereShape ( ) const
virtual

Definition at line 102 of file spherecollisionshape.cpp.

CollisionShape::ShapeType Mezzanine::Physics::SphereCollisionShape::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::PrimitiveCollisionShape.

Definition at line 97 of file spherecollisionshape.cpp.

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

Reimplemented from Mezzanine::Physics::PrimitiveCollisionShape.

Definition at line 119 of file spherecollisionshape.cpp.

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

Reimplemented from Mezzanine::Physics::PrimitiveCollisionShape.

Definition at line 105 of file spherecollisionshape.cpp.


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