geodesic 0.1.0

A Rust library for constructing and sampling 3D geometric scenes.
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

//! Scene structure for `Ray` tracing.

use nalgebra::RealField;
use num_traits::ToPrimitive;
use std::borrow::Cow;

use crate::{
    bvh::{Bvh, BvhConfig},
    error::{Result, SceneError},
    geometry::Aabb,
    rt::{Hit, Ray},
    scene::{SceneBuilder, SceneObject},
    traits::{Bounded, Traceable},
};

/// Scene containing multiple `Traceable` objects.
#[derive(Debug)]
pub struct Scene<'a, T: RealField + Copy + ToPrimitive> {
    /// Collection of `Traceable` objects in the scene.
    objects: Vec<SceneObject<'a, T>>,
    /// `Bvh` acceleration structure for the scene.
    bvh: Bvh<T>,
}

impl<'a, T: RealField + Copy + ToPrimitive> Scene<'a, T> {
    /// Construct a new `Scene` instance.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - The objects vector is empty
    /// - BVH construction fails for the scene objects
    pub fn new(config: &BvhConfig<T>, objects: Vec<SceneObject<'a, T>>) -> Result<Self> {
        if objects.is_empty() {
            return Err(SceneError::EmptyScene.into());
        }

        let bvh = Bvh::new(config, &objects)?;
        Ok(Self { objects, bvh })
    }

    /// Return a builder for constructing a `Scene`.
    #[must_use]
    pub fn builder() -> SceneBuilder<'a, T> {
        SceneBuilder::default()
    }
}

impl<T: RealField + Copy + ToPrimitive> Bounded<T> for Scene<'_, T> {
    fn aabb(&self) -> Result<Cow<Aabb<T>>> {
        self.bvh.aabb()
    }
}

impl<T: RealField + Copy + ToPrimitive> Traceable<T> for Scene<'_, T> {
    fn intersect(&self, ray: &Ray<T>) -> Result<Option<Hit<T>>> {
        // Use the BVH to find the closest intersection
        // The BVH returns the object index within the scene
        self.bvh.intersect(ray, &self.objects).map(|opt| opt.map(|(_, hit)| hit))
    }

    fn intersect_any(&self, ray: &Ray<T>, max_distance: T) -> Result<bool> {
        self.bvh.intersect_any(ray, &self.objects, max_distance)
    }
}