Refactor emitted() to use hit_rec values directly

hollasch · hollasch · commit a7b2e9da530b · 2024-08-23T11:19:39.000-07:00
This simplifies the `material::emitted()` function. Resolves #1605
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,8 @@ Change Log / Ray Tracing in One Weekend
   - Fix    --
   - New    --
 
+  - Change -- Changed `material::emitted()` function to use passed `hit_rec` values directly (#1605)
+
 ### In One Weekend
 
 ### The Next Week
diff --git a/books/RayTracingTheNextWeek.html b/books/RayTracingTheNextWeek.html
@@ -3202,8 +3202,8 @@
         diffuse_light(shared_ptr<texture> tex) : tex(tex) {}
         diffuse_light(const color& emit) : tex(make_shared<solid_color>(emit)) {}
 
-        color emitted(double u, double v, const point3& p) const override {
-            return tex->value(u, v, p);
+        color emitted(const hit_record& rec) const override {
+            return tex->value(rec.u, rec.v, rec.p);
         }
 
       private:
@@ -3223,7 +3223,7 @@
 
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
-        virtual color emitted(double u, double v, const point3& p) const {
+        virtual color emitted(const hit_record& rec) const {
             return color(0,0,0);
         }
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
@@ -3276,7 +3276,7 @@
 
             ray scattered;
             color attenuation;
-            color color_from_emission = rec.mat->emitted(rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(rec);
 
             if (!rec.mat->scatter(r, rec, attenuation, scattered))
                 return color_from_emission;
diff --git a/books/RayTracingTheRestOfYourLife.html b/books/RayTracingTheRestOfYourLife.html
@@ -1742,7 +1742,7 @@
 
             ray scattered;
             color attenuation;
-            color color_from_emission = rec.mat->emitted(rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(rec);
 
             if (!rec.mat->scatter(r, rec, attenuation, scattered))
                 return color_from_emission;
@@ -1797,7 +1797,7 @@
 
             ray scattered;
             color attenuation;
-            color color_from_emission = rec.mat->emitted(rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(rec);
 
             if (!rec.mat->scatter(r, rec, attenuation, scattered))
                 return color_from_emission;
@@ -2399,7 +2399,7 @@
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
             double pdf_value;
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
-            color color_from_emission = rec.mat->emitted(rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(rec);
 
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
@@ -2540,7 +2540,7 @@
             ray scattered;
             color attenuation;
             double pdf_value;
-            color color_from_emission = rec.mat->emitted(rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(rec);
 
             if (!rec.mat->scatter(r, rec, attenuation, scattered, pdf_value))
                 return color_from_emission;
@@ -2614,9 +2614,7 @@
 
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
-        virtual color emitted(
-            const ray& r_in, const hit_record& rec, double u, double v, const point3& p
-        ) const {
+        virtual color emitted(const ray& r_in, const hit_record& rec) const {
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
             return color(0,0,0);
         }
@@ -2629,11 +2627,10 @@
 
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
-        color emitted(const ray& r_in, const hit_record& rec, double u, double v, const point3& p)
-        const override {
+        color emitted(const ray& r_in, const hit_record& rec) const override {
             if (!rec.front_face)
                 return color(0,0,0);
-            return tex->value(u, v, p);
+            return tex->value(rec.u, rec.v, rec.p);
         }
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
 
@@ -2652,7 +2649,7 @@
 
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
-            color color_from_emission = rec.mat->emitted(r, rec, rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(r, rec);
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
 
             ...
@@ -2802,7 +2799,7 @@
             ray scattered;
             color attenuation;
             double pdf_value;
-            color color_from_emission = rec.mat->emitted(r, rec, rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(r, rec);
 
             if (!rec.mat->scatter(r, rec, attenuation, scattered, pdf_value))
                 return color_from_emission;
@@ -3040,7 +3037,7 @@
             ray scattered;
             color attenuation;
             double pdf_value;
-            color color_from_emission = rec.mat->emitted(r, rec, rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(r, rec);
 
             if (!rec.mat->scatter(r, rec, attenuation, scattered, pdf_value))
                 return color_from_emission;
@@ -3466,7 +3463,7 @@
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
             scatter_record srec;
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++
-            color color_from_emission = rec.mat->emitted(r, rec, rec.u, rec.v, rec.p);
+            color color_from_emission = rec.mat->emitted(r, rec);
 
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ C++ highlight
diff --git a/src/TheNextWeek/camera.h b/src/TheNextWeek/camera.h
@@ -146,7 +146,7 @@ class camera {
 
         ray scattered;
         color attenuation;
-        color color_from_emission = rec.mat->emitted(rec.u, rec.v, rec.p);
+        color color_from_emission = rec.mat->emitted(rec);
 
         if (!rec.mat->scatter(r, rec, attenuation, scattered))
             return color_from_emission;
diff --git a/src/TheNextWeek/material.h b/src/TheNextWeek/material.h
@@ -21,7 +21,7 @@ class material {
   public:
     virtual ~material() = default;
 
-    virtual color emitted(double u, double v, const point3& p) const {
+    virtual color emitted(const hit_record& rec) const {
         return color(0,0,0);
     }
 
@@ -119,8 +119,8 @@ class diffuse_light : public material {
     diffuse_light(shared_ptr<texture> tex) : tex(tex) {}
     diffuse_light(const color& emit) : tex(make_shared<solid_color>(emit)) {}
 
-    color emitted(double u, double v, const point3& p) const override {
-        return tex->value(u, v, p);
+    color emitted(const hit_record& rec) const override {
+        return tex->value(rec.u, rec.v, rec.p);
     }
 
   private:
diff --git a/src/TheRestOfYourLife/camera.h b/src/TheRestOfYourLife/camera.h
@@ -163,7 +163,7 @@ class camera {
             return background;
 
         scatter_record srec;
-        color color_from_emission = rec.mat->emitted(r, rec, rec.u, rec.v, rec.p);
+        color color_from_emission = rec.mat->emitted(r, rec);
 
         if (!rec.mat->scatter(r, rec, srec))
             return color_from_emission;
diff --git a/src/TheRestOfYourLife/material.h b/src/TheRestOfYourLife/material.h
@@ -31,9 +31,7 @@ class material {
   public:
     virtual ~material() = default;
 
-    virtual color emitted(
-        const ray& r_in, const hit_record& rec, double u, double v, const point3& p
-    ) const {
+    virtual color emitted(const ray& r_in, const hit_record& rec) const {
         return color(0,0,0);
     }
 
@@ -138,11 +136,10 @@ class diffuse_light : public material {
     diffuse_light(shared_ptr<texture> tex) : tex(tex) {}
     diffuse_light(const color& emit) : tex(make_shared<solid_color>(emit)) {}
 
-    color emitted(const ray& r_in, const hit_record& rec, double u, double v, const point3& p)
-    const override {
+    color emitted(const ray& r_in, const hit_record& rec) const override {
         if (!rec.front_face)
             return color(0,0,0);
-        return tex->value(u, v, p);
+        return tex->value(rec.u, rec.v, rec.p);
     }
 
   private:
