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

A base factory type for the creation of non-deformable Debris objects. More...

#include <rigiddebris.h>

+ Inheritance diagram for Mezzanine::RigidDebrisFactory:
+ Collaboration diagram for Mezzanine::RigidDebrisFactory:

Public Member Functions

 RigidDebrisFactory ()
 Class constructor.
 
virtual ~RigidDebrisFactory ()
 Class destructor.
 
virtual DebrisCreateDebris (const String &Name, World *TheWorld, const NameValuePairMap &Params)
 Creates a Debris of the type represented by this factory. More...
 
virtual DebrisCreateDebris (const XML::Node &XMLNode, World *TheWorld)
 Creates a Debris from XML. More...
 
virtual RigidDebrisCreateRigidDebris (const String &Name, const Real Mass, World *TheWorld)
 Creates a RigidDebris object. More...
 
virtual RigidDebrisCreateRigidDebris (const XML::Node &XMLNode, World *TheWorld)
 Creates a RigidDebris object. More...
 
virtual void DestroyDebris (Debris *ToBeDestroyed)
 Destroys a Debris created by this factory. More...
 
virtual String GetTypeName () const
 Gets the name of the Debris that is created by this factory. More...
 
- Public Member Functions inherited from Mezzanine::DebrisFactory
 DebrisFactory ()
 Class constructor.
 
virtual ~DebrisFactory ()
 Class destructor.
 

Detailed Description

A base factory type for the creation of non-deformable Debris objects.

Definition at line 201 of file rigiddebris.h.

Member Function Documentation

Debris * Mezzanine::RigidDebrisFactory::CreateDebris ( const String Name,
World TheWorld,
const NameValuePairMap Params 
)
virtual

Creates a Debris of the type represented by this factory.

Parameters
NameThe name to be given to this object.
TheWorldA pointer to the world this object belongs to.
ParamsA NameValuePairList containing the params to be applied during construction.
Returns
Returns a pointer to the Debris created.

Implements Mezzanine::DebrisFactory.

Definition at line 413 of file rigiddebris.cpp.

Debris * Mezzanine::RigidDebrisFactory::CreateDebris ( const XML::Node XMLNode,
World TheWorld 
)
virtual

Creates a Debris from XML.

Parameters
XMLNodeThe node of the xml document to construct from.
TheWorldA pointer to the world this object belongs to.
Returns
Returns a pointer to the Debris created.

Implements Mezzanine::DebrisFactory.

Definition at line 423 of file rigiddebris.cpp.

RigidDebris * Mezzanine::RigidDebrisFactory::CreateRigidDebris ( const String Name,
const Real  Mass,
World TheWorld 
)
virtual

Creates a RigidDebris object.

Parameters
NameThe name to be given to this object.
MassThe mass of the debris object.
TheWorldA pointer to the world this object belongs to.

Definition at line 407 of file rigiddebris.cpp.

RigidDebris * Mezzanine::RigidDebrisFactory::CreateRigidDebris ( const XML::Node XMLNode,
World TheWorld 
)
virtual

Creates a RigidDebris object.

Parameters
XMLNodeThe node of the xml document to construct from.
TheWorldA pointer to the world this object belongs to.

Definition at line 410 of file rigiddebris.cpp.

void Mezzanine::RigidDebrisFactory::DestroyDebris ( Debris ToBeDestroyed)
virtual

Destroys a Debris created by this factory.

Parameters
ToBeDestroyedA pointer to the Debris to be destroyed.

Implements Mezzanine::DebrisFactory.

Definition at line 426 of file rigiddebris.cpp.

String Mezzanine::RigidDebrisFactory::GetTypeName ( ) const
virtual

Gets the name of the Debris that is created by this factory.

Returns
Returns the typename of the Debris created by this factory.

Implements Mezzanine::DebrisFactory.

Definition at line 404 of file rigiddebris.cpp.


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