A Flat wall/floor of limitless size. More...

#include <planecollisionshape.h>

Inheritance diagram for Mezzanine::Physics::PlaneCollisionShape:

Collaboration diagram for Mezzanine::Physics::PlaneCollisionShape:

Public Member Functions
	PlaneCollisionShape (const String &Name, const Plane &Other)
	Math Constructor. More...

	PlaneCollisionShape (const String &Name, const Vector3 &Norm, const Real Constant)
	Descriptive constructor. More...

	PlaneCollisionShape (const String &Name, btStaticPlaneShape *BulletShape)
	Internal Constructor. More...

	PlaneCollisionShape (const XML::Node &XMLNode)
	XML constructor. More...

virtual	~PlaneCollisionShape ()
	Class Destructor.

Real	GetConstant () const
	Gets the constant with which to project the plane. More...

Vector3	GetNormal () const
	Gets the positive direction of the plane. More...

virtual CollisionShape::ShapeType	GetType () const
	Gets the type of Collision shape this is. More...

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::FieldCollisionShape
	FieldCollisionShape ()
	Class Constructor.

virtual	~FieldCollisionShape ()
	Class Destructor.

virtual btConcaveShape *	GetBulletConcaveShape () 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 String &	GetName () 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::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 Attributes
btStaticPlaneShape *	PlaneShape
	A pointer to the internal shape. 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...

Protected Member Functions inherited from Mezzanine::Physics::FieldCollisionShape
void	SetPointers (btConcaveShape *Shape)
	Sets the internal pointers on the base classes.

Detailed Description

A Flat wall/floor of limitless size.

Definition at line 56 of file planecollisionshape.h.

Constructor & Destructor Documentation

Mezzanine::Physics::PlaneCollisionShape::PlaneCollisionShape	(	const String &	Name,
		const Plane &	Other
	)

Math Constructor.

Parameters

Name	The name of this Shape.
Other	A plane math class to copy the plane dimensions from.

Definition at line 56 of file planecollisionshape.cpp.

Mezzanine::Physics::PlaneCollisionShape::PlaneCollisionShape	(	const String &	Name,
		const Vector3 &	Norm,
		const Real	Constant
	)

Descriptive constructor.

Parameters

Norm	The positive direction of the plane.
Constant	The Constant with which to project the plane.

Definition at line 63 of file planecollisionshape.cpp.

Mezzanine::Physics::PlaneCollisionShape::PlaneCollisionShape	(	const String &	Name,
		btStaticPlaneShape *	BulletShape
	)

Internal Constructor.

Parameters

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

Definition at line 70 of file planecollisionshape.cpp.

Mezzanine::Physics::PlaneCollisionShape::PlaneCollisionShape ( const XML::Node & XMLNode )

XML constructor.

Parameters

XMLNode The node of the xml document to construct from.

Definition at line 77 of file planecollisionshape.cpp.

Member Function Documentation

Real Mezzanine::Physics::PlaneCollisionShape::GetConstant ( ) const

Gets the constant with which to project the plane.

Returns: Returns a Real expressing the constant used to project the plane.

Definition at line 91 of file planecollisionshape.cpp.

Vector3 Mezzanine::Physics::PlaneCollisionShape::GetNormal ( ) const

Gets the positive direction of the plane.

Returns: Returns a Vector3 expressing the positive direction of this plane.

Definition at line 88 of file planecollisionshape.cpp.

String Mezzanine::Physics::PlaneCollisionShape::GetSerializableName ( )

static

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

Returns: A string containing "PlaneCollisionShape".

Definition at line 148 of file planecollisionshape.cpp.

CollisionShape::ShapeType Mezzanine::Physics::PlaneCollisionShape::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 94 of file planecollisionshape.cpp.

void Mezzanine::Physics::PlaneCollisionShape::ProtoDeSerialize ( const XML::Node & OneNode )

virtual

Take the data stored in an XML and overwrite this instance of this object with it.

Parameters

OneNode and XML::Node containing the data.

Warning: A precondition of using this is that all of the actors intended for use must already be Deserialized.

Reimplemented from Mezzanine::Physics::FieldCollisionShape.

Definition at line 121 of file planecollisionshape.cpp.

void Mezzanine::Physics::PlaneCollisionShape::ProtoSerialize ( XML::Node & CurrentRoot ) const

virtual

Convert this class to an XML::Node ready for serialization.

Parameters

CurrentRoot The point in the XML hierarchy that all this collision shape should be appended to.

Reimplemented from Mezzanine::Physics::FieldCollisionShape.

Definition at line 100 of file planecollisionshape.cpp.

Member Data Documentation

btStaticPlaneShape* Mezzanine::Physics::PlaneCollisionShape::PlaneShape

protected

A pointer to the internal shape.

Definition at line 61 of file planecollisionshape.h.

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

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Physics/planecollisionshape.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Physics/planecollisionshape.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation