🏗️ Rendering engine architecture (EPI-70)

src/common/IObject.hpp

@@ -50,6 +50,16 @@ class IObject {
   */
  IObject &operator=(const IObject &other) = default;
 
+ /**
+  * @brief The comparison operator of the object
+  * @param other The object to compare
+  * @return True if the objects are the same, false otherwise
+  * @version v0.1.0
+  * @since v0.1.0
+  * @author Aubane NOURRY
+  */
+ bool operator==(const IObject &other) const = default;
+
  /**
   * @brief The move constructor of the object
   * @details Is deleted because the object should not be moved

src/graphics/CMakeLists.txt

@@ -5,6 +5,9 @@ add_dependencies(StellarForgeGraphics StellarForgeCommon)
 target_sources(StellarForgeGraphics
         PUBLIC
         ${CMAKE_CURRENT_SOURCE_DIR}/Graphics.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/GraphicsException.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/components/IGraphicsComponent.hpp
         PRIVATE
         ${CMAKE_CURRENT_SOURCE_DIR}/Graphics.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/GraphicsException.cpp
 )

src/graphics/Graphics.hpp

@@ -9,13 +9,123 @@
 #ifndef GRAPHICS_HPP
 #define GRAPHICS_HPP
 
+#include <SDL2/SDL.h>
+#include <vector>
+#include <memory>
+#include "../common/IScene.hpp"
+#include "../common/IObject.hpp"
 
-
+/**
+ * @class Graphics
+ * @brief This class handles all graphics-related operations.
+ * @details The Graphics class is responsible for initializing and managing the rendering
+ *          of objects in the scenes, managing an SDL window and renderer, and ensuring 
+ *          objects are sorted by their z-index for proper rendering order.
+ * @version v0.1.0
+ * @since v0.1.0
+ * @author Aubane NOURRY
+ */
 class Graphics {
 public:
-    Graphics();
-};
+    /**
+     * @brief Constructor for the Graphics class.
+     * @param width The width of the window.
+     * @param height The height of the window.
+     * @param title The title of the window. Default is "Game".
+     * @param precharge Whether to preload all objects in all scenes. Default is false.
+     * @details This initializes the window with the specified dimensions and title,
+     *          and optionally precharges all objects if the precharge flag is set to true.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    Graphics(int width, int height, const char *title = "Game", bool precharge = false);
+
+    /**
+     * @brief Destructor for the Graphics class.
+     * @details Cleans up and releases all resources used by the Graphics class, including
+     *          the SDL window and renderer.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    ~Graphics();
+
+    /**
+     * @brief Initializes the SDL window and renderer.
+     * @details This method initializes the SDL window and renderer based on the provided 
+     *          width, height, and title. It should be called before any rendering operations.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void initialize();
+
+    /**
+     * @brief Renders the objects in the current scene.
+     * @details This method renders all objects in the current scene in the correct order
+     *         based on their z-index. It should be called once per frame to render the
+     *        scene.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void render();
 
+    /**
+     * @brief Clears the current rendering target.
+     * @details Clears the renderer's drawing surface, typically called at the beginning of a frame
+     *          before rendering the objects.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void clear();
 
+    /**
+     * @brief Presents the rendered frame to the window.
+     * @details This method is called at the end of the rendering process to present the
+     *          rendered frame on the screen.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void present();
+
+    /**
+     * @brief Cleans up the SDL resources used by the Graphics class.
+     * @details Destroys the SDL window and renderer, and cleans up any resources used
+     *          by the graphics system.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void clean();
+
+    /**
+     * @brief Adds an object to the sorted object list and maintains the correct order.
+     * @param object A shared pointer to the object to add.
+     * @details This method adds an object to the internal sortedObjects list and ensures
+     *          that the objects are kept in the correct rendering order based on their 
+     *          z-index. If the object is already in the list, it won't be added again.
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void addAndSortObject(std::shared_ptr<IObject> object);
+
+    /**
+     * @brief Changes the current scene to the specified scene.
+     * @param scene A pointer to the scene to set as the current scene.
+     * @details This method changes the current scene to the specified scene and sets the
+     *         scene's objects to be rendered in the correct order. 
+     * @since v0.1.0
+     * @author Aubane NOURRY
+     */
+    void setScene(IScene *scene);
+
+private:
+    SDL_Window *window;                          /**< The SDL window used for rendering. */
+    SDL_Renderer *renderer;                      /**< The SDL renderer used to draw objects. */
+    int width;                                   /**< The width of the window. */
+    int height;                                  /**< The height of the window. */
+    const char *title;                           /**< The title of the window. */
+    bool initialized;                            /**< Flag indicating if the graphics system is initialized. */
+    std::vector<std::shared_ptr<IObject>> sortedObjects; /**< List of objects sorted by z-index for rendering. */
+    bool precharge;                              /**< Flag to indicate if all objects should be preloaded in all scenes. */
+    IScene *currentScene;                        /**< The current scene being rendered. */
+};
 
-#endif //GRAPHICS_HPP
+#endif // GRAPHICS_HPP

src/graphics/GraphicsException.cpp

@@ -0,0 +1,18 @@
+/*
+** EPITECH PROJECT, 2024
+** Stellar-Forge
+** File description:
+** GraphicsException
+*/
+
+#include "GraphicsException.hpp"
+#include <utility>
+
+GraphicsException::GraphicsException(std::string message): _message{std::move(message)}
+{
+}
+
+const char* GraphicsException::what() const noexcept
+{
+    return _message.c_str();
+}

src/graphics/GraphicsException.hpp

@@ -0,0 +1,61 @@
+/*
+** EPITECH PROJECT, 2024
+** Stellar-Forge
+** File description:
+** GraphicsException
+*/
+
+#ifndef GRAPHICSEXCEPTION_HPP
+#define GRAPHICSEXCEPTION_HPP
+
+#include "../common/IError.hpp"
+#include <string>
+
+/**
+ * @class GraphicsException
+ * @brief Exception class for Graphics errors
+ * @details This class is used to throw Graphics errors
+ * @version 0.1.0
+ * @since 0.1.0
+ * @author Aubane NOURRY
+ */
+class GraphicsException final : public IError
+{
+public:
+    /**
+     * @brief Default constructor
+     * @details This constructor initializes the GraphicsException with a message
+     * @param message std::string, the message
+     * @version 0.1.0
+     * @since 0.1.0
+     * @author Aubane NOURRY
+     */
+    explicit GraphicsException(std::string message);
+
+    /**
+     * @brief Default destructor
+     * @details This destructor clears the GraphicsException
+     * @version 0.1.0
+     * @since 0.1.0
+     * @author Aubane NOURRY
+     */
+    ~GraphicsException() override = default;
+
+    /**
+     * @brief Get the error message
+     * @details This function returns the error message
+     * @return const char*, the error message
+     * @version 0.1.0
+     * @since 0.1.0
+     * @author Aubane NOURRY
+     */
+    [[nodiscard]] const char* what() const noexcept override;
+
+private:
+    /**
+     * @brief The error message
+     */
+    std::string _message;
+};
+
+#endif // GRAPHICSEXCEPTION_HPP

src/graphics/components/IGraphicsComponent.hpp

@@ -0,0 +1,55 @@
+/*
+** EPITECH PROJECT, 2024
+** StellarForge
+** File description:
+** No file there , just an epitech header example .
+** You can even have multiple lines if you want !
+*/
+
+#ifndef IGRAPHICSCOMPONENT_HPP
+#define IGRAPHICSCOMPONENT_HPP
+
+#include "../common/IComponent.hpp"
+#include <SDL2/SDL.h>
+
+/**
+ * @class IGraphicsComponent
+ * @brief Interface for graphics components in the game engine.
+ * @details This interface defines the basic structure and functionality for graphics-related components.
+ *          Any component that handles graphics or rendering should inherit from this interface and implement
+ *          its methods.
+ * @version v0.1.0
+ * @since v0.1.0
+ * @author Aubane NOURRY
+ */
+class IGraphicsComponent : public IComponent {
+public:
+    /**
+     * @brief Virtual destructor for the IGraphicsComponent class.
+     * @details This ensures that derived classes can be properly destroyed, releasing all resources 
+     *          when an object is deleted.
+     * @since v0.1.0
+     */
+    virtual ~IGraphicsComponent() = default;
+
+    /**
+     * @brief Runs the logic associated with the graphics component.
+     * @details This pure virtual function should contain any logic that the component needs to execute 
+     *          during each frame, such as updating its state or preparing for rendering. It must be implemented
+     *          by any derived class.
+     * @since v0.1.0
+     */
+    virtual void runComponent() = 0;
+
+    /**
+     * @brief Renders the component using the provided SDL_Renderer.
+     * @param renderer A pointer to the SDL_Renderer object used for rendering.
+     * @details This pure virtual function must be implemented by derived classes to define how the component
+     *          should be drawn on the screen. It is called each frame to render the visual aspects of the 
+     *          component.
+     * @since v0.1.0
+     */
+    virtual void render(SDL_Renderer *renderer) = 0;
+};
+
+#endif //IGRAPHICALCOMPONENT_HPP