dotrix_core 0.5.2

Dotrix 3D game engine core
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

//! Mouse ray implementation
use crate::{
    ecs::{ Const, Mut },
    services::{ Camera, Input, Window },
};
use dotrix_math::{ InnerSpace, SquareMatrix, Vec2, Vec3, Vec4 };

/// Represents ray and provides method for various calculations
#[derive(Default)]
pub struct Ray {
    /// Ray direction
    pub direction: Option<Vec3>,
    /// Inverted ray direction
    pub inverted: Option<Vec3>,
    /// Ray origin point
    pub origin: Option<Vec3>,
    /// Index array according to ray axis signs
    pub sign: [u8; 3],
}

impl Ray {
    /// Calculates normalized device coords. Pointer argument can be mouse coordinates or, for
    /// example middle moint of the screen (crosshair)
    pub fn normalized_device_coords(
        pointer: &Vec2,
        viewport_width: f32,
        viewport_height: f32,
    ) -> Vec4 {

        let x = (2.0 * pointer.x) / viewport_width - 1.0;
        let y = 1.0 - (2.0 * pointer.y) / viewport_height;
        Vec4::new(x, y, -1.0, 1.0)
    }

    /// Calculate intersection with an axis aligned box
    /// Returns optional ray length in near and far intersection points
    pub fn intersect_aligned_box(
        &self,
        bounds: [Vec3; 2],
    ) -> Option<(f32, f32)> {

        if let Some(origin) = self.origin.as_ref() {
            if let Some(inverted) = self.inverted.as_ref() {

                let x_min = (bounds[self.sign[0] as usize].x - origin.x) * inverted.x;
                let x_max = (bounds[1 - self.sign[0] as usize].x - origin.x) * inverted.x;

                let y_min = (bounds[self.sign[1] as usize].y - origin.y) * inverted.y;
                let y_max = (bounds[1 - self.sign[1] as usize].y - origin.y) * inverted.y;

                if x_min > y_max || y_min > x_max {
                    return None;
                }

                let t_min = if y_min > x_min { y_min } else { x_min };
                let t_max = if y_max < x_max { y_max } else { x_max };

                let z_min = (bounds[self.sign[2] as usize].z - origin.z) * inverted.z; 
                let z_max = (bounds[1 - self.sign[2] as usize].z - origin.z) * inverted.z; 

                if t_min > z_max || z_min > t_max {
                    return None; 
                }

                let t_min = if z_min > t_min { z_min } else { t_min };
                let t_max = if z_max < t_max { z_max } else { t_max };
 
                return Some((t_min, t_max));
            }
        }
        None
    }
}

/// Mouse ray calculation system
pub fn calculate(
    mut ray: Mut<Ray>,
    camera: Const<Camera>,
    input: Const<Input>,
    window: Const<Window>,
) {
    ray.direction = input.mouse_position().map(|mouse| {
        let viewport = window.inner_size();
        let ray = Ray::normalized_device_coords(
            mouse, viewport.x as f32, viewport.y as f32);

        // eye coordinates
        let mut ray = camera.proj().invert().unwrap() * ray;

        ray.z = -1.0;
        ray.w = 0.0;
        // world coordinates
        let ray = camera.view().invert().unwrap() * ray;
        Vec3::new(ray.x, ray.y, ray.z).normalize()
    });

    let inverted = ray.direction.as_ref().map(|d| 1.0_f32 / d);

    ray.origin = Some(camera.position());

    if let Some(inverted) = inverted.as_ref() {
        ray.sign[0] = if inverted.x < 0.0 { 1 } else { 0 };
        ray.sign[1] = if inverted.y < 0.0 { 1 } else { 0 };
        ray.sign[2] = if inverted.z < 0.0 { 1 } else { 0 };
    }

    ray.inverted = inverted;
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn ray_intersection() {
        let direction = Vec3::new(0.0, 0.0, -1.0);
        let inverted = 1.0_f32 / direction;
        let sign = [
            if inverted.x < 0.0 { 1 } else { 0 },
            if inverted.y < 0.0 { 1 } else { 0 },
            if inverted.z < 0.0 { 1 } else { 0 },
        ];
        let ray = Ray {
            direction: Some(direction),
            origin: Some(Vec3::new(0.0, 0.0, 10.0)),
            inverted: Some(inverted),
            sign,
        };

        let res = ray.intersect_aligned_box([
            Vec3::new(-1.0, -1.0, -1.0),
            Vec3::new(1.0, 1.0, 1.0)
        ]);

        assert_eq!(res.is_some(), true);
        let (t_min, t_max) = res.unwrap();

        assert_eq!(t_min.round() as i32, 9);
        assert_eq!(t_max.round() as i32, 11);
    }

}