[Multimedia] Split module into Graphics and Shapes

Bromeon · Jul 20, 2012 · 176bef9 · 176bef9
1 parent d66a5de
commit 176bef9
Show file tree

Hide file tree

Showing 25 changed files with 77 additions and 42 deletions.
diff --git a/doc/Documentation.hpp b/doc/Documentation.hpp
@@ -50,18 +50,21 @@
 /// @defgroup Events Events
 /// @brief Facilities for object-oriented event handling using callbacks.
 
+/// @defgroup Graphics Graphics
+/// @brief Miscellaneous graphics-related functionality, such as specialized sprites or color helpers.
+
 /// @defgroup Math Math
 /// @brief Mathematical functionality, such as random number generator or trigonometric wrappers.
 
-/// @defgroup Multimedia Multimedia
-/// @brief Miscellaneous SFML related functionality, such as shapes and colors.
-
 /// @defgroup Particles Particles
 /// @brief Contains a particle system based on sf::Texture. The module also provides several affector and emitter classes.
 
 /// @defgroup Resources Resources
 /// @brief Provides a resource manager for various resource types as well as the possibility to access them safely.
 
+/// @defgroup Shapes Shapes
+/// @brief Extensions for sf::Shape like concave shapes or predefined figures.
+
 /// @defgroup Time Time
 /// @brief Supplies classes to measure time. These are convenient wrappers around sf::Clock.
 

diff --git a/examples/Action.cpp b/examples/Action.cpp
@@ -1,6 +1,6 @@
 
 #include <Thor/Events.hpp>
-#include <Thor/Multimedia/ToString.hpp>
+#include <Thor/Graphics/ToString.hpp>
 #include <SFML/Window.hpp>
 #include <iostream>
 

diff --git a/examples/Shapes.cpp b/examples/Shapes.cpp
@@ -1,11 +1,11 @@
 
-#include <Thor/Multimedia.hpp>
+#include <Thor/Shapes.hpp>
 #include <SFML/Graphics.hpp>
 
 int main()
 {
 	// Create render window
-	sf::RenderWindow window(sf::VideoMode(600, 500), "Thor Multimedia", sf::Style::Close);
+	sf::RenderWindow window(sf::VideoMode(600, 500), "Thor Shapes", sf::Style::Close);
 	window.setVerticalSyncEnabled(true);
 
 	// Create a concave shape by directly inserting the polygon points

diff --git a/include/Thor/Multimedia.hpp → include/Thor/Graphics.hpp b/include/Thor/Multimedia.hpp → include/Thor/Graphics.hpp
@@ -24,17 +24,14 @@
 /////////////////////////////////////////////////////////////////////////////////
 
 /// @file
-/// @brief Complete header for the Multimedia module
+/// @brief Complete header for the Graphics module
 
-#ifndef THOR_MODULE_MULTIMEDIA_HPP
-#define THOR_MODULE_MULTIMEDIA_HPP
+#ifndef THOR_MODULE_GRAPHICS_HPP
+#define THOR_MODULE_GRAPHICS_HPP
 
-#include <Thor/Multimedia/Arrow.hpp>
-#include <Thor/Multimedia/BigTexture.hpp>
-#include <Thor/Multimedia/BigSprite.hpp>
-#include <Thor/Multimedia/Colors.hpp>
-#include <Thor/Multimedia/ConcaveShape.hpp>
-#include <Thor/Multimedia/Shapes.hpp>
-#include <Thor/Multimedia/ToString.hpp>
+#include <Thor/Graphics/BigTexture.hpp>
+#include <Thor/Graphics/BigSprite.hpp>
+#include <Thor/Graphics/Colors.hpp>
+#include <Thor/Graphics/ToString.hpp>
 
-#endif // THOR_MODULE_MULTIMEDIA_HPP
+#endif // THOR_MODULE_GRAPHICS_HPP
diff --git a/include/Thor/Multimedia/BigSprite.hpp → include/Thor/Graphics/BigSprite.hpp b/include/Thor/Multimedia/BigSprite.hpp → include/Thor/Graphics/BigSprite.hpp
@@ -53,7 +53,7 @@ namespace thor
 class BigTexture;
 
 
-/// @addtogroup Multimedia
+/// @addtogroup Graphics
 /// @{
 
 /// @brief Sprite using big textures.

diff --git a/include/Thor/Multimedia/BigTexture.hpp → include/Thor/Graphics/BigTexture.hpp b/include/Thor/Multimedia/BigTexture.hpp → include/Thor/Graphics/BigTexture.hpp
@@ -50,7 +50,7 @@ namespace sf
 namespace thor
 {
 
-/// @addtogroup Multimedia
+/// @addtogroup Graphics
 /// @{
 
 /// @brief Class for textures which are too big for sf::Texture.

diff --git a/include/Thor/Multimedia/Colors.hpp → include/Thor/Graphics/Colors.hpp b/include/Thor/Multimedia/Colors.hpp → include/Thor/Graphics/Colors.hpp
@@ -29,7 +29,7 @@
 #ifndef THOR_COLORS_HPP
 #define THOR_COLORS_HPP
 
-#include <Thor/Multimedia/Detail/ColorImpl.hpp>
+#include <Thor/Graphics/Detail/ColorImpl.hpp>
 #include <Thor/Config.hpp>
 
 #include <SFML/Graphics/Color.hpp>
@@ -45,7 +45,7 @@ namespace detail
 } // namespace detail
 
 
-/// @addtogroup Multimedia
+/// @addtogroup Graphics
 /// @{
 
 /// @brief Blends the colors @a firstColor and @a secondColor, according to the given interpolation.

diff --git a/include/Thor/Multimedia/Detail/ColorImpl.hpp → include/Thor/Graphics/Detail/ColorImpl.hpp b/include/Thor/Multimedia/Detail/ColorImpl.hpp → include/Thor/Graphics/Detail/ColorImpl.hpp
diff --git a/include/Thor/Multimedia/Detail/ToString.inl → include/Thor/Graphics/Detail/ToString.inl b/include/Thor/Multimedia/Detail/ToString.inl → include/Thor/Graphics/Detail/ToString.inl
diff --git a/include/Thor/Multimedia/ToString.hpp → include/Thor/Graphics/ToString.hpp b/include/Thor/Multimedia/ToString.hpp → include/Thor/Graphics/ToString.hpp
@@ -62,7 +62,7 @@ namespace thor
 template <typename T>
 struct PolarVector2;
 
-/// @addtogroup Multimedia
+/// @addtogroup Graphics
 /// @{
 
 /// @brief Returns a std::string representation of sf::Color.
@@ -109,5 +109,5 @@ class StringConversionException : public aurora::Exception
 
 } // namespace thor
 
-#include <Thor/Multimedia/Detail/ToString.inl>
+#include <Thor/Graphics/Detail/ToString.inl>
 #endif // THOR_TOSTRING_HPP
diff --git a/include/Thor/Particles/Affector.hpp b/include/Thor/Particles/Affector.hpp
@@ -30,7 +30,7 @@
 #define THOR_AFFECTOR_HPP
 
 #include <Thor/Particles/ParticleInterfaces.hpp>
-#include <Thor/Multimedia/Colors.hpp>
+#include <Thor/Graphics/Colors.hpp>
 #include <Thor/Config.hpp>
 
 #include <SFML/System/Time.hpp>

diff --git a/include/Thor/Resources/Detail/ResourceKeyHelpers.hpp b/include/Thor/Resources/Detail/ResourceKeyHelpers.hpp
@@ -27,7 +27,7 @@
 #define THOR_RESOURCEKEYHELPERS_HPP
 
 #include <Thor/Resources/ResourceKey.hpp>
-#include <Thor/Multimedia/ToString.hpp>
+#include <Thor/Graphics/ToString.hpp>
 #include <Thor/Config.hpp>
 
 #include <SFML/Graphics/Color.hpp>

diff --git a/include/Thor/Shapes.hpp b/include/Thor/Shapes.hpp
@@ -0,0 +1,36 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+// Thor C++ Library
+// Copyright (c) 2011-2012 Jan Haller
+// 
+// This software is provided 'as-is', without any express or implied
+// warranty. In no event will the authors be held liable for any damages
+// arising from the use of this software.
+// 
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it
+// freely, subject to the following restrictions:
+// 
+// 1. The origin of this software must not be misrepresented; you must not
+//    claim that you wrote the original software. If you use this software
+//    in a product, an acknowledgment in the product documentation would be
+//    appreciated but is not required.
+// 
+// 2. Altered source versions must be plainly marked as such, and must not be
+//    misrepresented as being the original software.
+// 
+// 3. This notice may not be removed or altered from any source distribution.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+/// @file
+/// @brief Complete header for the Shapes module
+
+#ifndef THOR_MODULE_SHAPES_HPP
+#define THOR_MODULE_SHAPES_HPP
+
+#include <Thor/Shapes/Arrow.hpp>
+#include <Thor/Shapes/ConcaveShape.hpp>
+#include <Thor/Shapes/Shapes.hpp>
+
+#endif // THOR_MODULE_SHAPES_HPP
diff --git a/include/Thor/Multimedia/Arrow.hpp → include/Thor/Shapes/Arrow.hpp b/include/Thor/Multimedia/Arrow.hpp → include/Thor/Shapes/Arrow.hpp
@@ -39,7 +39,7 @@
 namespace thor
 {
 
-/// @addtogroup Multimedia
+/// @addtogroup Shapes
 /// @{
 
 /// @brief Drawable arrow class

diff --git a/include/Thor/Multimedia/ConcaveShape.hpp → include/Thor/Shapes/ConcaveShape.hpp b/include/Thor/Multimedia/ConcaveShape.hpp → include/Thor/Shapes/ConcaveShape.hpp
@@ -53,7 +53,7 @@ namespace sf
 namespace thor
 {
 
-/// @addtogroup Multimedia
+/// @addtogroup Shapes
 /// @{
 
 /// @brief Concave shape class

diff --git a/include/Thor/Multimedia/Shapes.hpp → include/Thor/Shapes/Shapes.hpp b/include/Thor/Multimedia/Shapes.hpp → include/Thor/Shapes/Shapes.hpp
@@ -48,7 +48,7 @@ namespace thor
 
 class ConcaveShape;
 
-/// @addtogroup Multimedia
+/// @addtogroup Shapes
 /// @{
 
 /// @brief Namespace for predefined shapes

diff --git a/src/Arrow.cpp b/src/Arrow.cpp
@@ -23,8 +23,8 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/Arrow.hpp>
-#include <Thor/Multimedia/Shapes.hpp>
+#include <Thor/Shapes/Arrow.hpp>
+#include <Thor/Shapes/Shapes.hpp>
 #include <Thor/Vectors/VectorAlgebra2D.hpp>
 
 #include <SFML/Graphics/RenderTarget.hpp>

diff --git a/src/BigSprite.cpp b/src/BigSprite.cpp
@@ -23,8 +23,8 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/BigSprite.hpp>
-#include <Thor/Multimedia/BigTexture.hpp>
+#include <Thor/Graphics/BigSprite.hpp>
+#include <Thor/Graphics/BigTexture.hpp>
 #include <Aurora/Tools/ForEach.hpp>
 
 #include <SFML/Graphics/RenderTarget.hpp>

diff --git a/src/BigTexture.cpp b/src/BigTexture.cpp
@@ -23,7 +23,7 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/BigTexture.hpp>
+#include <Thor/Graphics/BigTexture.hpp>
 
 #include <SFML/Graphics/Sprite.hpp>
 #include <SFML/Graphics/Image.hpp>

diff --git a/src/ColorImpl.cpp b/src/ColorImpl.cpp
@@ -23,7 +23,7 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/Detail/ColorImpl.hpp>
+#include <Thor/Graphics/Detail/ColorImpl.hpp>
 
 #include <cassert>
 

diff --git a/src/Colors.cpp b/src/Colors.cpp
@@ -23,7 +23,7 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/Colors.hpp>
+#include <Thor/Graphics/Colors.hpp>
 #include <Aurora/Tools/ForEach.hpp>
 
 #include <SFML/Graphics/Color.hpp>

diff --git a/src/ConcaveShape.cpp b/src/ConcaveShape.cpp
@@ -23,8 +23,8 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/ConcaveShape.hpp>
-#include <Thor/Multimedia/Shapes.hpp>
+#include <Thor/Shapes/ConcaveShape.hpp>
+#include <Thor/Shapes/Shapes.hpp>
 #include <Thor/Math/Triangulation.hpp>
 #include <Thor/Vectors/PolarVector.hpp>
 

diff --git a/src/InputNames.cpp b/src/InputNames.cpp
@@ -24,7 +24,7 @@
 /////////////////////////////////////////////////////////////////////////////////
 
 #include <Thor/Events/InputNames.hpp>
-#include <Thor/Multimedia/ToString.hpp> // thor::StringConversionException
+#include <Thor/Graphics/ToString.hpp> // thor::StringConversionException
 
 #include <Aurora/Tools/Metaprogramming.hpp>
 

diff --git a/src/Shapes.cpp b/src/Shapes.cpp
@@ -23,9 +23,8 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-
-#include <Thor/Multimedia/Shapes.hpp>
-#include <Thor/Multimedia/ConcaveShape.hpp>
+#include <Thor/Shapes/Shapes.hpp>
+#include <Thor/Shapes/ConcaveShape.hpp>
 #include <Thor/Vectors/PolarVector.hpp>
 
 #include <SFML/Graphics/ConvexShape.hpp>

diff --git a/src/ToString.cpp b/src/ToString.cpp
@@ -23,7 +23,7 @@
 //
 /////////////////////////////////////////////////////////////////////////////////
 
-#include <Thor/Multimedia/ToString.hpp>
+#include <Thor/Graphics/ToString.hpp>
 
 #include <SFML/Graphics/Color.hpp>