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

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

#include <softdebris.h>

+ Inheritance diagram for Mezzanine::SoftDebrisFactory:
+ Collaboration diagram for Mezzanine::SoftDebrisFactory:

Public Member Functions

 SoftDebrisFactory ()
 Class constructor.
 
virtual ~SoftDebrisFactory ()
 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 SoftDebrisCreateSoftDebris (const String &Name, const Real Mass, World *TheWorld)
 Creates a SoftDebris object. More...
 
virtual SoftDebrisCreateSoftDebris (const XML::Node &XMLNode, World *TheWorld)
 Creates a SoftDebris 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 deformable Debris objects.

Definition at line 201 of file softdebris.h.

Member Function Documentation

Debris * Mezzanine::SoftDebrisFactory::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 403 of file softdebris.cpp.

Debris * Mezzanine::SoftDebrisFactory::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 413 of file softdebris.cpp.

SoftDebris * Mezzanine::SoftDebrisFactory::CreateSoftDebris ( const String Name,
const Real  Mass,
World TheWorld 
)
virtual

Creates a SoftDebris 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 397 of file softdebris.cpp.

SoftDebris * Mezzanine::SoftDebrisFactory::CreateSoftDebris ( const XML::Node XMLNode,
World TheWorld 
)
virtual

Creates a SoftDebris object.

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

Definition at line 400 of file softdebris.cpp.

void Mezzanine::SoftDebrisFactory::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 416 of file softdebris.cpp.

String Mezzanine::SoftDebrisFactory::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 394 of file softdebris.cpp.


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