MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
actor.h
Go to the documentation of this file.
1 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 
41 #ifndef _actor_h
42 #define _actor_h
43 
44 #include "datatypes.h"
45 #include "worldobject.h"
46 
47 /// @file
48 /// @brief The base class for all Actors is defined here.
49 
50 namespace Mezzanine
51 {
52  ///////////////////////////////////////////////////////////////////////////////
53  /// @brief This is the base class from which all the actors inherit.
54  /// @details The actor classes are responsible for character and character-like objects in the
55  /// 3D world.
56  ///////////////////////////////////////
57  class MEZZ_LIB Actor : public WorldObject
58  {
59  protected:
60  public:
61  /// @brief Class constructor.
62  Actor();
63  /// @brief Class destructor.
64  virtual ~Actor();
65  };//Actor
66 
67  ///////////////////////////////////////////////////////////////////////////////
68  /// @brief A base factory type for the creation of Actor objects.
69  /// @details
70  ///////////////////////////////////////
72  {
73  public:
74  /// @brief Class constructor.
76  /// @brief Class destructor.
77  virtual ~ActorFactory() { }
78 
79  /// @brief Gets the name of the Actor that is created by this factory.
80  /// @return Returns the typename of the Actor created by this factory.
81  virtual String GetTypeName() const = 0;
82 
83  /// @brief Creates a Actor of the type represented by this factory.
84  /// @param Name The name to be given to this object.
85  /// @param TheWorld A pointer to the world this object belongs to.
86  /// @param Params A NameValuePairList containing the params to be applied during construction.
87  /// @return Returns a pointer to the Actor created.
88  virtual Actor* CreateActor(const String& Name, World* TheWorld, const NameValuePairMap& Params) = 0;
89  /// @brief Creates a Actor from XML.
90  /// @param XMLNode The node of the xml document to construct from.
91  /// @param TheWorld A pointer to the world this object belongs to.
92  /// @return Returns a pointer to the Actor created.
93  virtual Actor* CreateActor(const XML::Node& XMLNode, World* TheWorld) = 0;
94  /// @brief Destroys a Actor created by this factory.
95  /// @param ToBeDestroyed A pointer to the Actor to be destroyed.
96  virtual void DestroyActor(Actor* ToBeDestroyed) = 0;
97  };//ActorFactory
98 }//Mezzanine
99 
100 #endif