softrender 0.1.0

//! Generic mesh structure

use std::fmt::{Debug, Formatter, Result as FmtResult};

use nalgebra::Point3;

/// A single vertex with a required position vector and any other vertex data
#[derive(Debug, Clone)]
pub struct Vertex<V> {
    /// Position of the vertex in object-space
    pub position: Point3<f32>,
    /// Any data that goes alongside the required position, such as normals, UV coordinates, tangents, or whatever.
    ///
    /// This is separate because the position is required, but anything else is optional,
    /// so setting type `V` to `()` for no extra vertex data means no extra overhead.
    pub vertex_data: V,
}

/// Mesh structure with indexed vertices.
#[derive(Clone)]
pub struct Mesh<V> {
    /// Vertex indices
    ///
    /// If you are unfamiliar with vertex indices, it's a way of re-using vertices for multiple primitives.
    ///
    /// For example (in 2D), for a rectangle made of two triangles, you would define the four points for each corner vertex:
    ///
    /// ```text
    /// vertex #: name         = (x,   y)
    /// 0:        bottom_left  = (0.0, 1.0)
    /// 1:        top_left     = (0.0, 1.0)
    /// 2:        bottom_right = (1.0, 0.0)
    /// 3:        top_right    = (1.0, 1.0)
    /// ```
    ///
    /// then you'd have your index list be something like:
    ///
    /// ```text
    /// [0, 1, 2, // bottom half triangle
    ///  1, 3, 2] // top half triangle
    /// ```
    ///
    /// Note that both of those triangles go in a clockwise direction from vertex to vertex.
    pub indices: Vec<u32>,
    /// Vertices with their vertex data
    pub vertices: Vec<Vertex<V>>,
}

impl<V> Debug for Mesh<V> {
    fn fmt(&self, f: &mut Formatter) -> FmtResult {
        write!(f, "Mesh {{ vertices: {} }}", self.vertices.len())
    }
}