ray 0.2.0

A toy raytracer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use crate::traits::AlmostEqual;
use std::f32;
use std::ops::{Add, Mul};

#[derive(Copy, Clone, Debug)]
pub struct Material {
    pub color: Color,
}

impl Material {
    pub fn dummy() -> Material {
        Material {
            color: Color::new_black(),
        }
    }
}

#[derive(Copy, Clone, Debug)]
pub struct Color {
    pub r: f32,
    pub g: f32,
    pub b: f32,
}

impl Color {
    pub fn new(r: f32, g: f32, b: f32) -> Color {
        Color { r, g, b }
    }

    pub fn new_black() -> Color {
        Self::new(0.0, 0.0, 0.0)
    }

    pub fn new_red() -> Color {
        Self::new(1.0, 0.0, 0.0)
    }

    pub fn new_green() -> Color {
        Self::new(0.0, 1.0, 0.0)
    }

    pub fn new_blue() -> Color {
        Self::new(0.0, 0.0, 1.0)
    }

    pub fn new_white() -> Color {
        Color {
            r: 1.0,
            g: 1.0,
            b: 1.0,
        }
    }
}

impl AlmostEqual for Color {
    fn almost_equal(&self, other: &Color) -> bool {
        self.r.almost_equal(&other.r)
            && self.g.almost_equal(&other.g)
            && self.b.almost_equal(&other.b)
    }
}

impl Add for Color {
    type Output = Color;

    fn add(self, other: Color) -> Color {
        // Adding two Colors together clamps the r, g and b values to [0.0, 1.0] range
        Color {
            r: clamp(0.0, 1.0, self.r + other.r),
            g: clamp(0.0, 1.0, self.g + other.g),
            b: clamp(0.0, 1.0, self.b + other.b),
        }
    }
}

fn clamp(min: f32, max: f32, value: f32) -> f32 {
    if value < min {
        min
    } else if value > max {
        max
    } else {
        value
    }
}

impl Mul<f32> for Color {
    type Output = Color;

    fn mul(self, other: f32) -> Color {
        // The floating point operand needs to be strictly within (0.0, 1.0) range, this is for
        // simple scaling. May revisit later to do multiplication by values larger than 1.0 and
        // clamping afterwards.
        assert!(0.0 <= other && other <= 1.0);
        Color {
            r: self.r * other,
            g: self.g * other,
            b: self.b * other,
        }
    }
}

impl Mul<Color> for f32 {
    type Output = Color;

    fn mul(self, other: Color) -> Color {
        // See impl Mul<f32> for Color comment.
        assert!(0.0 <= self && self <= 1.0);
        other * self
    }
}

#[cfg(test)]
mod tests {
    use crate::assert_almost_eq;
    use crate::material::Color;
    use crate::traits::AlmostEqual;

    #[test]
    fn test_color_scalar_multiplication() {
        assert_almost_eq!(
            Color {
                r: 1.0,
                g: 1.0,
                b: 1.0
            } * 0.5,
            Color {
                r: 0.5,
                g: 0.5,
                b: 0.5
            }
        );
        assert_almost_eq!(
            0.5 * Color {
                r: 1.0,
                g: 1.0,
                b: 1.0
            },
            Color {
                r: 0.5,
                g: 0.5,
                b: 0.5
            }
        );
    }

    #[test]
    fn test_color_addition() {
        assert_almost_eq!(
            Color::new_red() + Color::new_green() + Color::new_blue(),
            Color::new_white()
        );
        assert_almost_eq!(Color::new_red() + Color::new_red(), Color::new_red());
    }
}