indicatrix 0.9.0

//! A stone together with the finish of each of its facets.
//!
//! [`StoneGeometry`] is the geometry every tracer shares (planes and tools); the render tracer
//! takes the facet finishes beside it, as a separate list. The tilt sweeps take the same pair,
//! bundled as a [`FinishedStone`], so that a frosted facet changes the light the sweep sees the
//! way it changes the render. The metrics that ignore finishes (the live HUD numbers, the
//! optimiser's scoring, the Compare deltas) keep taking a plain [`StoneGeometry`].

use crate::{geometry::tool::StoneGeometry, optics::raytracer::FacetFinish};

/// A stone's planes and tools plus its per-facet finishes.
///
/// `finishes[i]` is the finish of plane `i`, and of tool `k` at index `planes.len() + k`, like
/// the finish slice of `trace_spectral_ray_with_finish_soa_geom`; a missing entry is polished.
/// An empty list, and a list with no frosted facet, both mean the polished stone and give
/// bit-identical results to the plain-geometry entry points.
#[derive(Debug, Clone, Copy)]
pub struct FinishedStone<'a> {
    /// The planes and tools.
    pub geom: StoneGeometry<'a>,
    /// The finish of each facet; empty for a polished stone.
    pub finishes: &'a [FacetFinish],
}

impl<'a> FinishedStone<'a> {
    /// `geom` with the given facet `finishes` (for example from
    /// `geometry::facet_finishes_with_frosted`).
    #[must_use]
    pub const fn new(geom: StoneGeometry<'a>, finishes: &'a [FacetFinish]) -> Self {
        Self { geom, finishes }
    }

    /// `geom` with every facet polished: what every plain-geometry entry point sweeps.
    #[must_use]
    pub const fn polished(geom: StoneGeometry<'a>) -> Self {
        Self {
            geom,
            finishes: &[],
        }
    }
}