Spinning Topp Logo BlackTopp Studios
inc
mezzanine.h
Go to the documentation of this file.
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 _mezzanine_h
41 #define _mezzanine_h
42 
43 ///////////////////////////////////////////////////////////////////////////////
44 /// @file
45 /// @brief A single file that includes all of the Mezzanine engine
46 /// @details This file exists primarily to make it easier for engine users to include
47 /// parts of the Mezzanine engine in their project with out needing to know or
48 /// care about the internals of our project.
49 /// \n
50 // We put headers in our headers so we can include while we include
51 ///////////////////////////////////////////////////////////////////////////////
52 
53 // Tell SWIG to implement scripting language specific stuff, set compiler macros used else where, must be included first
54 #include "swig.h"
55 
56 // This is required for the swig parser to skip the items that don't support scripting yet.
57 #ifndef SWIG
58  #include "Audio/audio.h"
60  #include "Graphics/graphics.h"
61  #include "Graphics/Procedural/procedural.h"
62  #include "Input/input.h"
63  #include "Physics/physics.h"
64  #include "MathTools/mathtools.h"
65  #include "Network/network.h"
66  #include "Noise/noise.h"
67  #include "Resource/resource.h"
68  #include "Scripting/scripting.h"
69  #include "XML/xml.h"
70  #include "UI/ui.h"
71 #endif
72 
73 #include "actor.h"
74 #include "actormanager.h"
75 #include "areaeffect.h"
76 #include "areaeffectmanager.h"
77 #include "attachable.h"
78 #include "axisalignedbox.h"
79 #include "binarybuffer.h"
80 #include "cameracontroller.h"
81 #include "circle.h"
82 #include "colourvalue.h"
83 #include "countedptr.h"
84 #include "crossplatform.h"
85 #include "crossplatformexport.h"
86 #include "datatypes.h"
87 #include "debris.h"
88 #include "debrismanager.h"
89 #include "enumerations.h"
90 #include "event.h"
91 #include "eventarguments.h"
92 #include "eventbase.h"
93 #include "eventgamewindow.h"
94 #include "eventmanager.h"
95 #include "eventpublisher.h"
96 #include "eventquit.h"
97 #include "eventsubscriber.h"
98 #include "eventsubscriberslot.h"
99 #include "exception.h"
100 #include "managerbase.h"
101 #include "managerfactory.h"
102 #include "plane.h"
103 #include "quaternion.h"
104 #include "ray.h"
105 #include "rayquerytool.h"
106 #include "rect.h"
107 #include "sphere.h"
108 #include "stringtool.h"
109 #include "timer.h"
110 #include "transform.h"
111 #include "vector2.h"
112 #include "vector3.h"
113 #include "world.h"
114 #include "worldmanager.h"
115 #include "worldmanagerfactory.h"
116 #include "worldobject.h"
117 #include "worldproxy.h"
118 
119 #ifndef SWIG
120 #include "entresol.h"
121 #include "entresolmanager.h"
122 #include "entresolmanagerfactory.h"
123 #include "eventuserinput.h"
124 #include "fieldofforce.h"
125 #include "gravityfield.h"
126 #include "gravitywell.h"
127 #include "hashedstring.h"
128 #include "interpolator.h"
129 #include "interval.h"
130 #include "linegroup.h"
131 #include "linesegment.h"
132 #include "macros.h"
133 #include "managedptr.h"
134 #include "meshterrain.h"
135 #include "objectsettings.h"
136 #include "rigiddebris.h"
137 #include "serialization.h"
138 #include "singleton.h"
139 #include "softdebris.h"
140 #include "streamlogging.h"
141 #include "track.h"
142 #include "trackiterator.h"
143 #include "triangle.h"
144 #include "terrainbase.h"
145 #include "terrainmanager.h"
146 #include "uidgenerator.h"
147 #include "worldtrigger.h"
148 #include "version.h"
149 #endif // no SWIG
150 
151 #endif // _mezzanine_h
This file is used on some platforms to determine what data should be read and written to and from a s...
This file contains the declaration for the manager that manages debris objects in a world...
Contains the Mezzanine::Attachable Class and Mezzanine::Attachable::AttachableElement enumeration dec...
All the definitions for datatypes as well as some basic conversion functions are defined here...
Any global enumerations shared between multiple classes is to be declared here.
This implements the exception hiearchy for Mezzanine.
All convience/utility macros for the Mezzanine are to be placed here.
This implemenation of.
This file contains the AxisAlignedBox class for representing AABB's of objects in the world...
The interface for serialization.
This file contains the declaration for the debris class that does not deform.
This file contains a generic Sphere class for math and spacial query.
This file contains the declaration for the debris class used to represent a small loose object in the...
This file describes and implements a reference counted pointer that is NOT threadsafe.
The defintion of the transform is stored in this file.
The interface for a class useful for applying RAII when it should have been used but wasn't...
The base class for all Actors is defined here.
The file to include to get access to all the physics stuff.
Used to give commands specifically to the SWIG preprocessor.
This is the file that code using this library should include. It includes all the required components...
Helper classes to assist in generating data points between two other data points. ...
This file contains the declaration for the debris class that will compress and deform.