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

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

#include <areaeffect.h>

+ Inheritance diagram for Mezzanine::AreaEffectFactory:

Public Member Functions

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

Detailed Description

A base factory type for the creation of AreaEffect objects.

Definition at line 242 of file areaeffect.h.

Member Function Documentation

virtual AreaEffect* Mezzanine::AreaEffectFactory::CreateAreaEffect ( const String Name,
World TheWorld,
const NameValuePairMap Params 
)
pure virtual

Creates a AreaEffect 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 AreaEffect created.

Implemented in Mezzanine::FieldOfForceFactory, Mezzanine::GravityWellFactory, and Mezzanine::GravityFieldFactory.

virtual AreaEffect* Mezzanine::AreaEffectFactory::CreateAreaEffect ( const XML::Node XMLNode,
World TheWorld 
)
pure virtual

Creates a AreaEffect 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 AreaEffect created.

Implemented in Mezzanine::FieldOfForceFactory, Mezzanine::GravityWellFactory, and Mezzanine::GravityFieldFactory.

virtual void Mezzanine::AreaEffectFactory::DestroyAreaEffect ( AreaEffect ToBeDestroyed)
pure virtual

Destroys a AreaEffect created by this factory.

Parameters
ToBeDestroyedA pointer to the AreaEffect to be destroyed.

Implemented in Mezzanine::FieldOfForceFactory, Mezzanine::GravityWellFactory, and Mezzanine::GravityFieldFactory.

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

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

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

Implemented in Mezzanine::FieldOfForceFactory, Mezzanine::GravityWellFactory, and Mezzanine::GravityFieldFactory.


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