Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::DebrisFactory Class Referenceabstract

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

#include <debris.h>

+ Inheritance diagram for Mezzanine::DebrisFactory:

Public Member Functions

 DebrisFactory ()
 Class constructor.
 
virtual ~DebrisFactory ()
 Class destructor.
 
virtual DebrisCreateDebris (const String &Name, World *TheWorld, const NameValuePairMap &Params)=0
 Creates a Debris of the type represented by this factory. More...
 
virtual DebrisCreateDebris (const XML::Node &XMLNode, World *TheWorld)=0
 Creates a Debris from XML. More...
 
virtual void DestroyDebris (Debris *ToBeDestroyed)=0
 Destroys a Debris created by this factory. More...
 
virtual String GetTypeName () const =0
 Gets the name of the Debris that is created by this factory. More...
 

Detailed Description

A base factory type for the creation of Debris objects.

Definition at line 95 of file debris.h.

Member Function Documentation

virtual Debris* Mezzanine::DebrisFactory::CreateDebris ( const String Name,
World TheWorld,
const NameValuePairMap Params 
)
pure 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.

Implemented in Mezzanine::RigidDebrisFactory, and Mezzanine::SoftDebrisFactory.

virtual Debris* Mezzanine::DebrisFactory::CreateDebris ( const XML::Node XMLNode,
World TheWorld 
)
pure 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.

Implemented in Mezzanine::RigidDebrisFactory, and Mezzanine::SoftDebrisFactory.

virtual void Mezzanine::DebrisFactory::DestroyDebris ( Debris ToBeDestroyed)
pure virtual

Destroys a Debris created by this factory.

Parameters
ToBeDestroyedA pointer to the Debris to be destroyed.

Implemented in Mezzanine::RigidDebrisFactory, and Mezzanine::SoftDebrisFactory.

virtual String Mezzanine::DebrisFactory::GetTypeName ( ) const
pure virtual

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

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

Implemented in Mezzanine::RigidDebrisFactory, and Mezzanine::SoftDebrisFactory.


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