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

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

#include <actor.h>

Public Member Functions

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

Detailed Description

A base factory type for the creation of Actor objects.

Definition at line 71 of file actor.h.

Member Function Documentation

virtual Actor* Mezzanine::ActorFactory::CreateActor ( const String Name,
World TheWorld,
const NameValuePairMap Params 
)
pure virtual

Creates a Actor 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 Actor created.
virtual Actor* Mezzanine::ActorFactory::CreateActor ( const XML::Node XMLNode,
World TheWorld 
)
pure virtual

Creates a Actor 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 Actor created.
virtual void Mezzanine::ActorFactory::DestroyActor ( Actor ToBeDestroyed)
pure virtual

Destroys a Actor created by this factory.

Parameters
ToBeDestroyedA pointer to the Actor to be destroyed.
virtual String Mezzanine::ActorFactory::GetTypeName ( ) const
pure virtual

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

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

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