PathTracerDocumentation/_scene_8h_source.html

 #ifndef DEF_SCENE

 #define DEF_SCENE


 #include <omp.h>


 #include "DoubleMatrix33.h"

 #include "KDTreeNode.h"

 #include "Object3DGroup.h"

 #include "PerspectiveCamera.h"

 #include "Picture.h"


 #include <fbxsdk.h>

 #include <fbxsdk/fileio/fbxiosettings.h>

 #include <fbxsdk/utils/fbxgeometryconverter.h>


 class Scene {

 private:

     std::vector<Object3DGroup> objectGroups;

     std::vector<Object3D*> objects;

     std::vector<Object3D*> lamps;

     KDTreeNode* kdTreeRoot = nullptr;


     PerspectiveCamera camera;

     unsigned int samplesPerPixel;

     unsigned int minBounces;


     bool russianRoulette = true;

     double rrStopProbability = 0.1;  // Linked to russianRoulette   /  stopProb=1 <=> russianRoulette=false

     bool nextEventEstimation = true;

     unsigned int numberThreads = omp_get_max_threads();

     bool kdTree = true;

     unsigned int kdMaxObjectNumber = 10;

     unsigned int kdMaxDepth = 10;


     std::string backupFileName = "backup";

     bool backupParameters = true;

     bool backupObjectGroups = true;

     bool backupPicture = true;

     double leastRenderTime4PictureBackup = 180.0;  // Three minutes


     KDTreeNode::Intersection bruteForceIntersection(const Ray& ray) const;

     DoubleVec3D traceRay(const Ray& ray, double usedNextEventEstimation = false, const KDTreeNode* lastNode = nullptr, unsigned int bounces = 0) const;

     std::string getCurrentIndex(int currentIndex, bool displayIndex) const;


 public:

     Scene(PerspectiveCamera camera = PerspectiveCamera(), unsigned int samplesPerPixel = 8, unsigned int minBounces = 5);

     Scene(const Scene& scene);


     std::vector<Object3DGroup> getObjectGroups() const;

     std::vector<Object3DGroup>& getObjectGroupsReference();  // Reference -> can modify it -> != const

     std::vector<Object3D*> getObjects();

     std::vector<Object3D*> getLamps();

     PerspectiveCamera getCamera() const;

     PerspectiveCamera& getCameraReference();

     unsigned int getSamplesPerPixel() const;

     unsigned int getMinBounces() const;

     bool getRussianRoulette() const;

     double getRrStopProbability() const;

     bool getNextEventEstimation() const;

     unsigned int getNumberThreads() const;

     bool getKDTree() const;

     unsigned int getKDMaxObjectNumber() const;

     unsigned int getKDMaxDepth() const;

     std::string getBackupFileName() const;

     bool getBackupParameters() const;

     bool getBackupObjectGroups() const;

     bool getBackupPicture() const;

     double getLeastRenderTime4PictureBackup() const;


     void setObjectGroups(std::vector<Object3DGroup> groups);

     void setCamera(PerspectiveCamera camera);

     void setSamplesPerPixel(unsigned int samplesPerPixel);

     void setMinBounces(unsigned int minBounces);

     void setRussianRoulette(bool russianRoulette);

     void setRussianRoulette(bool russianRoulette, double rrStopProbability);

     void setRrStopProbability(double rrStopProbability);

     void setNextEventEstimation(bool nextEventEstimation);

     void setNumberThreads(unsigned int numberThreads);

     void setKDTree(bool kdTree);

     void setKDMaxObjectNumber(unsigned int kdMaxObjectNumber);

     void setKDMaxDepth(unsigned int kdMaxDepth);

     void setBackupFileName(std::string backupFileName);

     void setBackupParameters(bool backupParameters);

     void setBackupObjectGroups(bool backupObjectGroups);

     void setBackupPicture(bool backupPicture);

     void setLeastRenderTime4PictureBackup(double leastRenderTime4PictureBackup);


     void addObjectGroup(const Object3DGroup& group);

     void resetAndDeleteObjectGroups();

     void computeObjectsAndLamps();

     void defaultScene();


     void saveParameters2File(std::string fileName) const;

     void saveObjectGroups2File(std::string fileName) const;


     bool importFBXFile(const char* filePath, Material* material, std::string name);


     Picture* render();


     void displayParametersPage(bool displayIndexes = true) const;

     void displayObjectsPage() const;

 };


 bool importTrianglesFromFbxNode(FbxNode* node, Material* material, std::vector<Object3D*>& objects);


 void displayRenderingProgression(unsigned int numberPixelXAlreadyComputed, unsigned int pictureWidth, double loopBeginningTime);


 #endif

DoubleMatrix33.h
Defines the DoubleMatrix33 class and some functions around it.

scene
static Scene scene
The scene that will be used by the interface.
Definition: Interface.h:59

KDTreeNode.h
Defines the KDTreeNode class and some functions around it.

Object3DGroup.h
Defines the Object3DGroup class and some functions around it.

PerspectiveCamera.h
Defines the PerspectiveCamera class.

Picture.h
Defines the Picture class and some functions around it.

displayRenderingProgression
void displayRenderingProgression(unsigned int numberPixelXAlreadyComputed, unsigned int pictureWidth, double loopBeginningTime)
Prints the progression information.
Definition: Scene.cpp:341

importTrianglesFromFbxNode
bool importTrianglesFromFbxNode(FbxNode *node, Material *material, std::vector< Object3D * > &objects)
Imports recursively all triangles present in a FBXNode.
Definition: Scene.cpp:169

DoubleVec3D
A three-dimensional vector using double values.
Definition: DoubleVec3D.h:190

KDTreeNode
A node of a k-d tree.
Definition: KDTreeNode.h:140

Material
Abstrat class that models a material.
Definition: Material.h:77

Object3DGroup
Group of objects.
Definition: Object3DGroup.h:122

PerspectiveCamera
Models a perspective camera.
Definition: PerspectiveCamera.h:76

Picture
Stores radiance for every pixel.
Definition: Picture.h:120

Ray
Combination of an origin and a direction.
Definition: Ray.h:44

Scene
Stores object groups and a camera for the render.
Definition: Scene.h:291

Scene::defaultScene
void defaultScene()
Sets this scene's objects to default ones.
Definition: Scene.cpp:90

Scene::setRrStopProbability
void setRrStopProbability(double rrStopProbability)
Setter for the russian roulette stop probability.
Definition: Scene.cpp:56

Scene::setLeastRenderTime4PictureBackup
void setLeastRenderTime4PictureBackup(double leastRenderTime4PictureBackup)
Setter for the least render time after which the picture is backed up.
Definition: Scene.cpp:66

Scene::setKDMaxObjectNumber
void setKDMaxObjectNumber(unsigned int kdMaxObjectNumber)
Setter for the maximum number of objects in a k-d tree leaf.
Definition: Scene.cpp:60

Scene::setBackupFileName
void setBackupFileName(std::string backupFileName)
Setter for the new name of the file in which backups will be made.
Definition: Scene.cpp:62

Scene::getRrStopProbability
double getRrStopProbability() const
Getter for the russian roulette stop probability.
Definition: Scene.cpp:33

Scene::getCameraReference
PerspectiveCamera & getCameraReference()
Getter for a reference to the camera.
Definition: Scene.cpp:29

Scene::Scene
Scene(PerspectiveCamera camera=PerspectiveCamera(), unsigned int samplesPerPixel=8, unsigned int minBounces=5)
Main constructor.
Definition: Scene.cpp:4

Scene::getLamps
std::vector< Object3D * > getLamps()
Getter for the lamps.
Definition: Scene.cpp:22

Scene::setNextEventEstimation
void setNextEventEstimation(bool nextEventEstimation)
Setter for the next event estimation.
Definition: Scene.cpp:57

Scene::computeObjectsAndLamps
void computeObjectsAndLamps()
Computes all the objects.
Definition: Scene.cpp:80

Scene::getKDTree
bool getKDTree() const
Getter for the k-d tree option.
Definition: Scene.cpp:36

Scene::getSamplesPerPixel
unsigned int getSamplesPerPixel() const
Getter for the number of samples per pixel.
Definition: Scene.cpp:30

Scene::setBackupObjectGroups
void setBackupObjectGroups(bool backupObjectGroups)
Setter for the option to backup the object groups.
Definition: Scene.cpp:64

Scene::getMinBounces
unsigned int getMinBounces() const
Getter for the minimum number of bounces.
Definition: Scene.cpp:31

Scene::resetAndDeleteObjectGroups
void resetAndDeleteObjectGroups()
Deletes all object groups and their objects.
Definition: Scene.cpp:74

Scene::setKDMaxDepth
void setKDMaxDepth(unsigned int kdMaxDepth)
Setter for the maximum depth recursion of the k-d tree.
Definition: Scene.cpp:61

Scene::setKDTree
void setKDTree(bool kdTree)
Setter for the k-d tree.
Definition: Scene.cpp:59

Scene::getBackupObjectGroups
bool getBackupObjectGroups() const
Getter for the option to backup the object groups.
Definition: Scene.cpp:41

Scene::displayParametersPage
void displayParametersPage(bool displayIndexes=true) const
Prints the parameters page.
Definition: Scene.cpp:462

Scene::importFBXFile
bool importFBXFile(const char *filePath, Material *material, std::string name)
Imports a fbx file as triangles.
Definition: Scene.cpp:128

Scene::setBackupParameters
void setBackupParameters(bool backupParameters)
Setter for the option to backup the parameters.
Definition: Scene.cpp:63

Scene::getBackupFileName
std::string getBackupFileName() const
Getter for the name of the file in which backups will be made.
Definition: Scene.cpp:39

Scene::setCamera
void setCamera(PerspectiveCamera camera)
Setter for the camera.
Definition: Scene.cpp:48

Scene::getLeastRenderTime4PictureBackup
double getLeastRenderTime4PictureBackup() const
Getter for the least render time after which the picture is backed up.
Definition: Scene.cpp:43

Scene::getObjectGroups
std::vector< Object3DGroup > getObjectGroups() const
Getter for the object groups.
Definition: Scene.cpp:12

Scene::getKDMaxDepth
unsigned int getKDMaxDepth() const
Getter for the maximum depth recursion of the k-d tree.
Definition: Scene.cpp:38

Scene::getBackupParameters
bool getBackupParameters() const
Getter for the option to backup the parameters.
Definition: Scene.cpp:40

Scene::getObjectGroupsReference
std::vector< Object3DGroup > & getObjectGroupsReference()
Getter for a reference to the object groups.
Definition: Scene.cpp:13

Scene::saveObjectGroups2File
void saveObjectGroups2File(std::string fileName) const
Saves object groups to a file.
Definition: Scene.cpp:248

Scene::setBackupPicture
void setBackupPicture(bool backupPicture)
Setter for the option to backup the picture.
Definition: Scene.cpp:65

Scene::getCamera
PerspectiveCamera getCamera() const
Getter for the camera.
Definition: Scene.cpp:28

Scene::getObjects
std::vector< Object3D * > getObjects()
Getter for the objects.
Definition: Scene.cpp:16

Scene::saveParameters2File
void saveParameters2File(std::string fileName) const
Saves parameters to a file.
Definition: Scene.cpp:208

Scene::setNumberThreads
void setNumberThreads(unsigned int numberThreads)
Setter for the number of CPU threads.
Definition: Scene.cpp:58

Scene::setSamplesPerPixel
void setSamplesPerPixel(unsigned int samplesPerPixel)
Setter for the number of samples per pixel.
Definition: Scene.cpp:49

Scene::displayObjectsPage
void displayObjectsPage() const
Prints the objects page.
Definition: Scene.cpp:500

Scene::getNumberThreads
unsigned int getNumberThreads() const
Getter for the number of CPU threads.
Definition: Scene.cpp:35

Scene::getBackupPicture
bool getBackupPicture() const
Getter for the option to backup the picture.
Definition: Scene.cpp:42

Scene::getNextEventEstimation
bool getNextEventEstimation() const
Getter for the next event estimation.
Definition: Scene.cpp:34

Scene::setObjectGroups
void setObjectGroups(std::vector< Object3DGroup > groups)
Setter for the object groups.
Definition: Scene.cpp:47

Scene::setRussianRoulette
void setRussianRoulette(bool russianRoulette)
Setter for the russian roulette.
Definition: Scene.cpp:51

Scene::getRussianRoulette
bool getRussianRoulette() const
Getter for the russian roulette.
Definition: Scene.cpp:32

Scene::setMinBounces
void setMinBounces(unsigned int minBounces)
Setter for the minimum number of bounces.
Definition: Scene.cpp:50

Scene::addObjectGroup
void addObjectGroup(const Object3DGroup &group)
Adds an object group to the current ones.
Definition: Scene.cpp:70

Scene::render
Picture * render()
Start the render of the picture.
Definition: Scene.cpp:356

Scene::getKDMaxObjectNumber
unsigned int getKDMaxObjectNumber() const
Getter for the maximum number of objects in a k-d tree leaf.
Definition: Scene.cpp:37

KDTreeNode::Intersection
A struct binding a pointer to an Object3D, a distance, and a pointer to a KDTreeNode.
Definition: KDTreeNode.h:152