Mezzanine::SphereCollisionShape Class Reference

A sphere physics shape. More...

#include <collisionshape.h>

Inheritance diagram for Mezzanine::SphereCollisionShape:

List of all members.

Public Member Functions
	SphereCollisionShape (const String &Name, const Real &Radius)
	Class Constructor.
	SphereCollisionShape (const String &Name, btSphereShape *BulletShape)
	Internal Constructor.
	SphereCollisionShape (xml::Node OneNode)
virtual	~SphereCollisionShape ()
	Class Destructor.
virtual Real	GetRadius () const
	Gets the radius of the sphere.
virtual btSphereShape *	GetSphereShape () const
virtual CollisionShape::ShapeType	GetType () const
virtual void	ProtoDeSerialize (const xml::Node &OneNode)
virtual void	ProtoSerialize (xml::Node &CurrentRoot) const
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.

---

Detailed Description

A sphere physics shape.

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

Definition at line 796 of file collisionshape.h.

---

Constructor & Destructor Documentation

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

Class Constructor.

Parameters:

Name	The name of this Shape.
Radius	The radius of the sphere.

Definition at line 1398 of file collisionshape.cpp.

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

Internal Constructor.

Parameters:

Name	The name of this Shape.
BulletShape	The internal shape this shape is based on.

Definition at line 1405 of file collisionshape.cpp.

Mezzanine::SphereCollisionShape::SphereCollisionShape

(

xml::Node

OneNode

)

DeSerializing Constructor.

Parameters:

OneNode

The node to use for constructing this shape

Definition at line 1413 of file collisionshape.cpp.

---

Member Function Documentation

Real Mezzanine::SphereCollisionShape::GetRadius

(

)

const [virtual]

Gets the radius of the sphere.

Returns:

Returns a real representing the radius of the sphere.

Definition at line 1436 of file collisionshape.cpp.

btSphereShape * Mezzanine::SphereCollisionShape::GetSphereShape

(

)

const [virtual]

Gets the internal shape pointer this collision shape is based on.

Returns:

Returns a pointer to the internal collision shape.

Definition at line 1446 of file collisionshape.cpp.

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

Definition at line 1441 of file collisionshape.cpp.

void Mezzanine::SphereCollisionShape::ProtoDeSerialize

(

const xml::Node &

OneNode

)

[virtual]

Gets the internal shape pointer this collision shape is based on.

Returns:

Returns a pointer to the internal collision shape.

Reimplemented from Mezzanine::PrimitiveCollisionShape.

Definition at line 1464 of file collisionshape.cpp.

void Mezzanine::SphereCollisionShape::ProtoSerialize

(

xml::Node &

CurrentRoot

)

const [virtual]

Gets the internal shape pointer this collision shape is based on.

Returns:

Returns a pointer to the internal collision shape.

Reimplemented from Mezzanine::PrimitiveCollisionShape.

Definition at line 1450 of file collisionshape.cpp.

String Mezzanine::SphereCollisionShape::SerializableName

(

)

[static]

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

Returns:

A string containing "SphereCollisionShape"

Reimplemented from Mezzanine::PrimitiveCollisionShape.

Definition at line 1483 of file collisionshape.cpp.

---

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

• collisionshape.h
• collisionshape.cpp