Merge pull request #655 from RayTracing/header_guards

Header guards added

Author: hollasch

CHANGELOG.md

@@ -6,6 +6,8 @@ Change Log -- Ray Tracing in One Weekend
 ### Common
   - Removed: now that the code handles ray-surface intersection from either side, we no longer need
     the `flip_face` class, so we've deleted it from the text and from the code (#482, #270)
+  - Change: Added header guards to the text of all three books whenever a new header file was
+    introduced
 
 ### _The Next Week_
   - Removed: Deleted the section covering the old `flip_face` class, renumbered images as this
@@ -48,10 +50,6 @@ Change Log -- Ray Tracing in One Weekend
   - New: Add new isotropic constructor taking color argument (#644)
 
 
-----------------------------------------------------------------------------------------------------
-# v3.1.3 (in progress)
-
-
 ----------------------------------------------------------------------------------------------------
 # v3.1.2 (2020-06-03)
 

books/RayTracingInOneWeekend.html

@@ -1002,11 +1002,6 @@
 calculation for us.
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
-    #ifndef HITTABLE_H
-    #define HITTABLE_H
-
-    #include "ray.h"
-
     struct hit_record {
         point3 p;
         vec3 normal;
@@ -1020,13 +1015,6 @@
         }
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
     };
-
-    class hittable {
-        public:
-            virtual bool hit(const ray& r, double t_min, double t_max, hit_record& rec) const = 0;
-    };
-
-    #endif
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     [Listing [hittable-time-side]: <kbd>[hittable.h]</kbd> The hittable class with time and side]
 
@@ -1962,12 +1950,10 @@
 that the pointer is to a class, which the “class material” in the hittable class below does:
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
-    #ifndef HITTABLE_H
-    #define HITTABLE_H
-
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
     #include "rtweekend.h"
+    #include "ray.h"
 
     class material;
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
@@ -1986,13 +1972,6 @@
             normal = front_face ? outward_normal :-outward_normal;
         }
     };
-
-    class hittable {
-        public:
-            virtual bool hit(const ray& r, double t_min, double t_max, hit_record& rec) const = 0;
-    };
-
-    #endif
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     [Listing [hit-with-material]: <kbd>[hittable.h]</kbd> Hit record with added material pointer]
 </div>

books/RayTracingTheRestOfYourLife.html

@@ -1291,6 +1291,9 @@
 class because it won't really be more complicated than utility functions:
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
+    #ifndef ONB_H
+    #define ONB_H
+
     class onb {
         public:
             onb() {}
@@ -1322,6 +1325,8 @@
         axis[1] = unit_vector(cross(w(), a));
         axis[0] = cross(w(), v());
     }
+
+    #endif
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     [Listing [class-onb]: <kbd>[onb.h]</kbd> Orthonormal basis class]
 
@@ -1545,13 +1550,18 @@
 to be greedy and hope a minimal interface works, and for the PDF this implies:
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
+    #ifndef PDF_H
+    #define PDF_H
+
     class pdf {
         public:
             virtual ~pdf() {}
 
             virtual double value(const vec3& direction) const = 0;
             virtual vec3 generate() const = 0;
     };
+
+    #endif
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     [Listing [class-pdf]: <kbd>[pdf.h]</kbd> The `pdf` class]
 </div>

src/InOneWeekend/hittable.h

@@ -12,6 +12,7 @@
 //==============================================================================================
 
 #include "rtweekend.h"
+#include "ray.h"
 
 
 class material;