MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
debris.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 #ifndef _debris_h
41 #define _debris_h
42 
43 /// @file
44 /// @brief This file contains the declaration for the debris class used to represent a small loose object in the world.
45 
46 #include "worldobject.h"
47 
48 namespace Mezzanine
49 {
50  ///////////////////////////////////////////////////////////////////////////////
51  /// @brief A simple world object without a large structure ideal for representing loose small objects.
52  /// @details
53  ///////////////////////////////////////
54  class MEZZ_LIB Debris : public WorldObject
55  {
56  protected:
57  public:
58  /// @brief Blank constructor.
59  /// @param TheWorld A pointer to the world this object belongs to.
60  Debris(World* TheWorld);
61  /// @brief Class constructor.
62  /// @param Name The name to be given to this object.
63  /// @param TheWorld A pointer to the world this object belongs to.
64  Debris(const String& Name, World* TheWorld);
65  /// @brief Class destructor.
66  virtual ~Debris();
67 
68  ///////////////////////////////////////////////////////////////////////////////
69  // Utility and Configuration
70 
71  ///////////////////////////////////////////////////////////////////////////////
72  // Working with the World
73 
74  ///////////////////////////////////////////////////////////////////////////////
75  // Serialization
76 
77  /// @copydoc Mezzanine::WorldObject::ProtoSerializeProperties(XML::Node&) const
78  virtual void ProtoSerializeProperties(XML::Node& SelfRoot) const;
79  /// @copydoc Mezzanine::WorldObject::ProtoDeSerializeProperties(const XML::Node&)
80  virtual void ProtoDeSerializeProperties(const XML::Node& SelfRoot);
81 
82  /// @copydoc Mezzanine::WorldObject::GetDerivedSerializableName() const
83  virtual String GetDerivedSerializableName() const;
84  /// @copydoc Mezzanine::WorldObject::GetSerializableName()
85  static String GetSerializableName();
86 
87  ///////////////////////////////////////////////////////////////////////////////
88  // Internal Methods
89  };//Debris
90 
91  ///////////////////////////////////////////////////////////////////////////////
92  /// @brief A base factory type for the creation of Debris objects.
93  /// @details
94  ///////////////////////////////////////
96  {
97  public:
98  /// @brief Class constructor.
100  /// @brief Class destructor.
101  virtual ~DebrisFactory() { };
102 
103  /// @brief Gets the name of the Debris that is created by this factory.
104  /// @return Returns the typename of the Debris created by this factory.
105  virtual String GetTypeName() const = 0;
106 
107  /// @brief Creates a Debris of the type represented by this factory.
108  /// @param Name The name to be given to this object.
109  /// @param TheWorld A pointer to the world this object belongs to.
110  /// @param Params A NameValuePairList containing the params to be applied during construction.
111  /// @return Returns a pointer to the Debris created.
112  virtual Debris* CreateDebris(const String& Name, World* TheWorld, const NameValuePairMap& Params) = 0;
113  /// @brief Creates a Debris from XML.
114  /// @param XMLNode The node of the xml document to construct from.
115  /// @param TheWorld A pointer to the world this object belongs to.
116  /// @return Returns a pointer to the Debris created.
117  virtual Debris* CreateDebris(const XML::Node& XMLNode, World* TheWorld) = 0;
118  /// @brief Destroys a Debris created by this factory.
119  /// @param ToBeDestroyed A pointer to the Debris to be destroyed.
120  virtual void DestroyDebris(Debris* ToBeDestroyed) = 0;
121  };//DebrisFactory
122 }//Mezzanine
123 
124 #endif