Commit 28e53f20 authored by Emeric Verschuur's avatar Emeric Verschuur

Correction de la documentation

parent 78a169a5
......@@ -17,8 +17,8 @@
#include <list>
#include "LrBinder.h"
#include "LrEntity.h"
#include "LrVector.h"
#include "LrEntity.h"
#include "LrVector.h"
#include <vector>
......@@ -39,8 +39,8 @@ class LrBinderRegularGrid : public LrBinder
* @brief Donne d'intersection entre un rayon et la structure accélératrice
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @param minbound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxbound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
*
* Cette méthode calcul l'intersection entre le rayon @a ray et la structure accélératrice
......@@ -55,33 +55,33 @@ class LrBinderRegularGrid : public LrBinder
virtual void initBinder();
private :
class LrInfoVoxel {
public:
LrEntity* m_entite;
int m_numFragment;
};
/// @brief nombre de voxel en X dans la structure accélératrice.
int m_nbVoxelX;
/// @brief nombre de voxel en Y dans la structure accélératrice.
int m_nbVoxelY;
/// @brief nombre de voxel en Z dans la structure accélératrice.
int m_nbVoxelZ;
/// @brief vecteur diagonale en point min et max de la structure accélératrice.
LrVector m_lenBinder;
/// @brief vecteur diagonale en point min et max d'un voxel.
LrVector m_lenVoxel;
/// @brief Tableau de tableau de structure infoVoxel.
std::vector<std::vector< LrInfoVoxel> > m_tabVoxel;
private :
class LrInfoVoxel {
public:
LrEntity* m_entite;
int m_numFragment;
};
/// @brief nombre de voxel en X dans la structure accélératrice.
int m_nbVoxelX;
/// @brief nombre de voxel en Y dans la structure accélératrice.
int m_nbVoxelY;
/// @brief nombre de voxel en Z dans la structure accélératrice.
int m_nbVoxelZ;
/// @brief vecteur diagonale en point min et max de la structure accélératrice.
LrVector m_lenBinder;
/// @brief vecteur diagonale en point min et max d'un voxel.
LrVector m_lenVoxel;
/// @brief Tableau de tableau de structure infoVoxel.
std::vector<std::vector< LrInfoVoxel> > m_tabVoxel;
};
#endif
......
......@@ -198,16 +198,16 @@ public :
/**
* @brief Opérateur d'égalité
* @param lhs Opérande gauche de type LrColor
* @param rhs Opérande droite de type LrColor
* @param c_lhs Opérande gauche de type LrColor
* @param c_rhs Opérande droite de type LrColor
* @return Retourne vrai si lhs et rhs sont égaux
*/
friend bool operator == (const LrColor & c_lhs, const LrColor & c_rhs);
/**
* @brief Opérateur d'égalité
* @param lhs Opérande gauche de type LrColor
* @param rhs Opérande droite de type LrColor
* @param c_lhs Opérande gauche de type LrColor
* @param c_rhs Opérande droite de type LrColor
* @return Retourne vrai si lhs et rhs sont diférents
*/
friend bool operator != (const LrColor & c_lhs, const LrColor & c_rhs);
......@@ -247,7 +247,7 @@ public :
/**
* @brief Opérateur de multiplication
* @param coef Opérande gauche de type Real
* @param lhs Opérande droite de type LrColor
* @param rhs Opérande droite de type LrColor
* @return Retourne une nouvelle LrColor
*/
friend LrColor operator * (const Real coef, const LrColor &rhs);
......
......@@ -96,6 +96,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de géométrie.
* @param entityLocal Entitée dans lequel se trouve le fragment.
* @param fragmentLocal fragment d'entitée.
*
......
......@@ -29,6 +29,7 @@ public:
/**
* @brief Constructeur.
* @param mat Référence d'un objet LrMatrix.
* @param geometry Référence vers une géométrie.
* @param optic Référence d'un objet LrGeometry.
*/
LrEntityElementary(const LrMatrix &mat, LrGeometry *geometry, LrOptic *optic);
......@@ -118,6 +119,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de géométrie.
* @param entityLocal Entitée dans lequel se trouve le fragment.
* @param fragmentLocal fragment d'entitée.
*
......
......@@ -43,7 +43,7 @@ public:
/**
* @brief Constructeur par copie.
* @param src Référence d'un objet LrEntityLight.
* @param source Référence d'un objet LrEntityLight.
*/
LrEntityLight(const LrEntityLight &source);
......@@ -83,7 +83,7 @@ public:
/**
* @brief Opérateur d'affectation.
* @param src Entitée source.
* @param source Entitée source.
* @return Une référence sur l'objet affecté.
*/
LrEntityLight& operator = (const LrEntityLight& source);
......
......@@ -34,7 +34,7 @@ public:
/**
* @brief Constructeur par copie.
* @param src Référence d'un objet LrEntityLightPlane.
* @param source Référence d'un objet LrEntityLightPlane.
*/
LrEntityLightPlane(const LrEntityLightPlane &source);
......@@ -58,7 +58,7 @@ public:
/**
* @brief Opérateur d'affectation.
* @param src Entitée source.
* @param source Entitée source.
* @return Une référence sur l'objet affecté.
*/
LrEntityLightPlane& operator = (const LrEntityLightPlane& source);
......
......@@ -34,7 +34,7 @@ public:
/**
* @brief Constructeur par copie.
* @param src Référence d'un objet LrEntityLightPoint.
* @param source Référence d'un objet LrEntityLightPoint.
*/
LrEntityLightPoint(const LrEntityLightPoint &source);
......
......@@ -70,6 +70,7 @@ public:
* @brief Donne d'intersection entre un rayon et la géométrie.
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param fragment Fragment de la géométrie.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
......@@ -88,6 +89,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de la géométrie.
*
* Calcule le point "en bas, devant, à gauche" et le point "en haut,
* derrière, à droite" de la géométrie.
......
......@@ -26,8 +26,6 @@ class LrGeometryPlan : public LrGeometry
public:
/**
* @brief Constructeur.
* @param center Centre de la sphère.
* @param r Rayon de la sphère.
*/
LrGeometryPlan();
......@@ -76,6 +74,7 @@ public:
* @brief Donne d'intersection entre un rayon et la géométrie.
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param fragment Fragment de la géométrie.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
......@@ -93,6 +92,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de la géométrie.
*
* Calcule le point "en bas, devant, à gauche" et le point "en haut,
* derrière, à droite" de la géométrie.
......
......@@ -69,6 +69,7 @@ public:
* @brief Donne d'intersection entre un rayon et la géométrie.
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param fragment Fragment de la géométrie.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
......@@ -86,6 +87,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de la géométrie.
*
* Calcule le point "en bas, devant, à gauche" et le point "en haut,
* derrière, à droite" de la géométrie.
......
......@@ -69,6 +69,7 @@ public:
* @brief Donne d'intersection entre un rayon et la géométrie.
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param fragment Fragment de la géométrie.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
......@@ -86,6 +87,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de la géométrie.
*
* Calcule le point "en bas, devant, à gauche" et le point "en haut,
* derrière, à droite" de la géométrie.
......
......@@ -26,8 +26,6 @@ class LrGeometrySphere : public LrGeometry
public:
/**
* @brief Constructeur.
* @param center Centre de la sphère.
* @param r Rayon de la sphère.
*/
LrGeometrySphere();
......@@ -71,6 +69,7 @@ public:
* @brief Donne d'intersection entre un rayon et la géométrie.
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param fragment Fragment de la géométrie.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
......@@ -88,6 +87,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de la géométrie.
*
* Calcule le point "en bas, devant, à gauche" et le point "en haut,
* derrière, à droite" de la géométrie.
......
......@@ -73,6 +73,7 @@ public:
* @brief Donne d'intersection entre un rayon et la géométrie.
* @param ray Référence d'un objet LrRay.
* @param hit Adresse de l'objet LrHit dans lequel sera stocké le résultat.
* @param fragment Fragment de la géométrie.
* @param minBound Distance minimum par rapport à l'origine (défaut : 0).
* @param maxBound Distance maximum par rapport à l'origine (défaut : INFINITY).
* @return vrai si il y a une intersection, sinon faux.
......@@ -91,6 +92,7 @@ public:
* @brief Calcul des points min et max de la boîte englobante.
* @param min LrPoint minimum de la boîte.
* @param max LrPoint maximum de la boîte.
* @param fragment Fragment de la géométrie.
*
* Calcule le point "en bas, devant, à gauche" et le point "en haut,
* derrière, à droite" de la géométrie.
......
......@@ -118,15 +118,15 @@ class LrScene
/**
* @brief Methode pour la génération des images. Initialise les threads.
* @ param nbThreads le nombre de threads a lancer pour le calcul
* @param nbThreads le nombre de threads a lancer pour le calcul
*/
void generateImage(int nbThreads=1);
/**
* @brief Methode abstraite pour la génération des images.
* @brief Genere une partie de l'image
* @lOffset entier correspondant a ligne de depart
* @lNb entier correspondant au nombre de lignes a calculer
* @param lOffset entier correspondant a ligne de depart
* @param lNb entier correspondant au nombre de lignes a calculer
*/
virtual void generateImagePart(int lOffset, int lNb)=0;
......
......@@ -81,8 +81,8 @@ public :
/**
* @brief Methode abstraite pour la génération des images.
* @brief Genere une partie de l'image
* @lOffset entier correspondant a ligne de depart
* @lNb entier correspondant au nombre de lignes a calculer
* @param lOffset entier correspondant a ligne de depart
* @param lNb entier correspondant au nombre de lignes a calculer
*/
virtual void generateImagePart(int lOffset, int lNb);
......
......@@ -234,7 +234,7 @@ public :
/**
* @brief Opérateur de multiplication (multiplication par un scalaire)
* @param scalaire Opérande gauche de type Real
* @param lhs Opérande droite de type LrVector
* @param v Opérande droite de type LrVector
* @return Retourne un nouveau LrVector
*/
friend LrVector operator * (Real scalaire, const LrVector & v);
......
......@@ -116,20 +116,20 @@ int main(int argc, char** argv)
//Entite X
LrMatrix X_Mat = LrMatrix::translate(LrVector(-50, 0, 50));
LrEntityLightPoint X(X_Mat, LrColor(0.4f,0.4f,0.4f));
//LrEntityLightPlane X(X_Mat, LrColor(0.6f,0.6f,0.6f),10);
// LrEntityLightPoint X(X_Mat, LrColor(0.4f,0.4f,0.4f));
LrEntityLightPlane X(X_Mat, LrColor(0.6f,0.6f,0.6f),10);
/**************************************************************************/
//Entite Y
LrMatrix Y_Mat = LrMatrix::translate(LrVector(0, 0, 20));
LrEntityLightPoint Y(Y_Mat, LrColor(0.6f,0.6f,0.6f));
//LrEntityLightPlane Y(Y_Mat, LrColor(0.6f,0.6f,0.6f),10);
// LrEntityLightPoint Y(Y_Mat, LrColor(0.6f,0.6f,0.6f));
LrEntityLightPlane Y(Y_Mat, LrColor(0.6f,0.6f,0.6f),10);
/**************************************************************************/
//Entite Z
LrMatrix Z_Mat = LrMatrix::translate(LrVector(50, 0, 50));
LrEntityLightPoint Z(Z_Mat, LrColor(0.4f,0.4f,0.4f));
//LrEntityLightPlane Z(Z_Mat, LrColor(0.6f,0.6f,0.6f),10);
// LrEntityLightPoint Z(Z_Mat, LrColor(0.4f,0.4f,0.4f));
LrEntityLightPlane Z(Z_Mat, LrColor(0.6f,0.6f,0.6f),10);
/**************************************************************************/
/*############################################################################*/
......@@ -179,14 +179,14 @@ int main(int argc, char** argv)
LrAntiAliasingCentre aa(1);
//LrAntiAliasingRandom aa(2);
//LrAntiAliasingCentre aa(4);
//LrAntiAliasingRandom aa(4);
// LrAntiAliasingRandom aa(4);
//La SCENE
LrSceneRayTracing scene(list_entities, list_lights,&binder, &image, &camera, &aa, 2);
cout<<"RayTracing Start..."<< endl;
//Lancement de l'algorithme de lancer de rayons (parametre : nb de threads)
scene.generateImage(1);
scene.generateImage(2);
//scene.generateImagePart(0,600);
//Sauvegarde de l'image
//file = fopen("./testTurbulenceLin.ppm","wb");
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment