From 2a1c6d27020d2a98b029c420db6acb3fb9ab6840 Mon Sep 17 00:00:00 2001 From: DBA_3 <yacine.acheroufkebir@gmail.com> Date: Thu, 9 Jan 2020 18:17:07 +0100 Subject: [PATCH] doxygen --- camera.h | 3 +++ quad.h | 46 +++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 44 insertions(+), 5 deletions(-) diff --git a/camera.h b/camera.h index 77422ac..47f9120 100644 --- a/camera.h +++ b/camera.h @@ -56,6 +56,9 @@ class Camera Vector3f direction() const; }; + /*! + * \brief Opérateur d'affichage des paramètres de la camera + */ std::ostream & operator<<(std::ostream & st, const Camera & c); diff --git a/quad.h b/quad.h index 617c487..048319e 100644 --- a/quad.h +++ b/quad.h @@ -3,29 +3,65 @@ #include "shape.h" +/*! + * \file quad.h + * \brief Implementation des Parallélépipèdes rectangles + */ +/*! + * \class Quad + * \brief Representation des Parallélépipèdes rectangles + * + * Classe derivant de Shape : Representation des Parallélépipèdes rectangles par le centre du Parallélépipède son hauteur, sa largeur et sa longueur. + */ class Quad : public Shape { + private: - Vector3f origin_; - float width_; - float height_; - float depth_; + Vector3f origin_; /*!Coordonnées du centre du Parallélépipède */ + float width_; /*!Largeur du Parallélépipède*/ + float height_; /*!Hauteur du Parallélépipède*/ + float depth_; /*!Longueur du Parallélépipède*/ public: + /*! + * \brief Constructeur + * + * Constructeur de la classe Quad + * Attention, si les paramètres de taille ne sont pas positifs le constructeur ne craie pas l'instance + * \param <matter> le materiau dont est fait le Quad + * \param <origin> le centre du Quad + * \param <width> la largeur du Quad + * \param <height> la hauteur du Quad + * \param <depth> la longueur du Quad + */ Quad(Material matter, Vector3f origin, float width, float height, float depth); bool is_hit(const Ray3f ray); Ray3f reflect(const Ray3f ray) const; + /*! + * \brief Getter pour le vecteur au centre du Quad + */ Vector3f origin() const; + /*! + * \brief Getter pour la largeur du Quad + */ float width() const; + /*! + * \brief Getter pour la hauteur du Quad + */ float height() const; + /*! + * \brief Getter pour la longueur du Quad + */ float depth() const; }; - + /*! + * \brief Opérateur d'affichage du centre + */ std::ostream & operator<<(std::ostream & st, const Quad & q); -- GitLab