Spinning Topp Logo BlackTopp Studios
inc
entresolmanagerfactory.h
1 // © Copyright 2010 - 2016 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 #ifndef _entresolmanagerfactory_h
41 #define _entresolmanagerfactory_h
42 
43 #include "managerfactory.h"
44 
45 namespace Mezzanine
46 {
47  class EntresolManager;
48  ///////////////////////////////////////////////////////////////////////////////
49  /// @class EntresolManagerFactory
50  /// @brief This is a base class for factories that construct managers used by the Entresol class.
51  /// @details
52  ///////////////////////////////////////
54  {
55  public:
56  /// @brief Class constructor.
58  /// @brief Class destructor.
60 
61  /// @brief Creates a manager of the type represented by this factory.
62  /// @param Params A NameValuePairList containing the params to be applied during construction.
63  /// @return Returns a pointer to the created manager.
64  virtual EntresolManager* CreateManager(const NameValuePairList& Params) = 0;
65  /// @brief Creates a manager from XML.
66  /// @param XMLNode The node of the xml document to construct from.
67  /// @return Returns a pointer to the created manager.
68  virtual EntresolManager* CreateManager(const XML::Node& XMLNode) = 0;
69  /// @brief Destroys a Manager created by this factory.
70  /// @param ToBeDestroyed A pointer to the manager to be destroyed.
71  virtual void DestroyManager(EntresolManager* ToBeDestroyed) = 0;
72  };//EntresolManagerFactory
73 }//Mezzanine
74 
75 #endif
virtual ~EntresolManagerFactory()
Class destructor.
This is a base class for factories that construct managers used by the Entresol class.
This is the base class for all managers that do no describe properties of a single world...
A light-weight handle for manipulating nodes in DOM tree.
Definition: node.h:89
std::list< NameValuePair > NameValuePairList
This is a datatype mostly used for describing settings or parameters that can't be declared in advanc...
Definition: datatypes.h:206
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
This is a base class for factories that construct the managers the engine uses.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56