prosha/src/openmesh.rs

//pub mod openmesh;

use nalgebra::*;
use std::fs::OpenOptions;
use std::io;

/// A type for mesh vertices. Initialize with [vertex][self::vertex].
pub type Vertex = Vector4<f32>;
/// A type for homogeneous transforms
pub type Mat4 = Matrix4<f32>;

/// Initializes a vertex:
pub fn vertex(x: f32, y: f32, z: f32) -> Vertex {
    Vertex::new(x, y, z, 1.0)
}

/// Transforms a vector of vertices:
pub fn transform(verts: &Vec<Vertex>, xf: &Mat4) -> Vec<Vertex> {
    verts.iter().map(|v| xf * v).collect()
}

/// A type for a 'tagged' vertex index referring either to an index of
/// a mesh, or of its parent.
#[derive(Clone, Debug)]
pub enum Tag {
    Body(usize),
    Parent(usize),
}
// TODO: This is clumsy. Can I do this some other way, or at least
// phrase it better?

/// A face-vertex mesh whose faces indices can refer either to its own
/// vertices, or to some 'parent' mesh.
#[derive(Clone, Debug)]
pub struct OpenMesh {
    /// Vertices of mesh
    pub verts: Vec<Vertex>,
    /// Indices of triangles (taken as every 3 values).  `Tag::Body`
    /// indices correspond to `verts`, while `Tag::Parent` indices
    /// correspond to some parent mesh that must eventually be given
    /// to complete this mesh.
    pub faces: Vec<Tag>,
}

impl OpenMesh {

    pub fn append<T: IntoIterator<Item = OpenMesh>>(meshes: T) -> OpenMesh
    {
        let mut v: Vec<Vertex> = vec![];
        let mut f: Vec<Tag> = vec![];
        for mesh in meshes {
            // Position in 'verts' at which we're appending
            // mesh.verts, which we need to know to shift indices:
            let offset = v.len();
            
            // Copy all vertices:
            v.append(&mut mesh.verts.clone());
            // Append its faces, applying offset:
            f.extend(mesh.faces.iter().map(|t| {
                match t {
                    Tag::Body(n) => Tag::Body(n + offset),
                    Tag::Parent(_) => panic!("Cannot append() if mesh has parent references!"),
                    // TODO: Handle the above
                }
            }));
        }
           
        OpenMesh { verts: v, faces: f }
    }
    
    /// Returns a new `OpenMesh` whose vertices have been transformed.
    pub fn transform(&self, xfm: &Mat4) -> OpenMesh {
        OpenMesh {
            verts: self.verts.iter().map(|v| xfm * v).collect(),
            // TODO: Is the above faster if I pack vectors into a
            // bigger matrix, and transform that?
            faces: self.faces.clone(), // TODO: Use Rc?
        }
    }

    /// Write this mesh as an STL file.  This will fail if any element
    /// of `faces` is `Tag::Parent`.
    pub fn write_stl_file(&self, fname: &str) -> io::Result<()> {
        let mut file = OpenOptions::new().write(true).create(true).truncate(true).open(fname)?;
        self.write_stl(&mut file)
    }

    fn write_stl<W: std::io::Write>(&self, writer: &mut W) -> io::Result<()> {

        // Every group of 3 indices in self.faces is one triangle, so
        // pre-allocate in the format stl_io wants:
        let num_faces = self.faces.len() / 3;
        let mut triangles = vec![stl_io::Triangle {
            normal: [0.0; 3],
            vertices: [[0.0; 3]; 3],
        }; num_faces];

        let get_vert = |j| {
            match self.faces[j] {
                Tag::Body(n) => self.verts[n].xyz(),
                Tag::Parent(_) => panic!("Cannot write_stl() if mesh has parent references!"),
            }
        };
        // TODO: Handle this behavior
        
        // Turn every face into an stl_io::Triangle:
        for i in 0..num_faces {
            let v0 = get_vert(3*i + 0);
            let v1 = get_vert(3*i + 1);
            let v2 = get_vert(3*i + 2);
            
            let normal = (v1-v0).cross(&(v2-v0));

            triangles[i].normal.copy_from_slice(&normal.as_slice());
            triangles[i].vertices[0].copy_from_slice(v0.as_slice());
            triangles[i].vertices[1].copy_from_slice(v1.as_slice());
            triangles[i].vertices[2].copy_from_slice(v2.as_slice());
            // TODO: Is there a cleaner way to do the above?
        }

        // I could also solve this with something like
        // https://doc.rust-lang.org/std/primitive.slice.html#method.chunks_exact
        // however I don't know what performance difference may be.

        stl_io::write_stl(writer, triangles.iter())
    }

    /// Treat this mesh as a 'parent' mesh to connect with any number
    /// of 'child' meshes, all of them paired with their respective
    /// parent vertex mappings.  This returns a tuple of (new mesh,
    /// offsets), where 'offsets' gives the offset of where child
    /// meshes were shifted in the new mesh.
    ///
    /// That is, the vertices of 'children[i]' begin at vertex
    /// 'offset[i]' of the new mesh. This is needed in some cases for
    /// adjusting a parent vertex mapping, like 'vmap' of Rule::Child.
    pub fn connect(&self, children: &Vec<(OpenMesh, &Vec<usize>)>) -> (OpenMesh, Vec<usize>) {
        // TODO: Clean up this description a bit
        // TODO: Clean up Vec<usize> stuff

        // Copy body vertices & faces:
        let mut verts: Vec<Vertex> = self.verts.clone();
        let mut faces = self.faces.clone();

        let mut offsets: Vec<usize> = vec![];
        
        for (child,mapping) in children {

            // body_offset corresponds to the position in 'verts' at
            // which we're appending everything in 'child.verts' -
            // thus, the offset we shift all indices in 'children' by.
            let body_offset = verts.len();
            
            // Copy all vertices from 'child':
            verts.append(&mut child.verts.clone());

            // Append its faces:
            faces.extend(child.faces.iter().map(|t| {
                match t {
                    // Apply aforementioned shift to its body vertices:
                    Tag::Body(n) => Tag::Body(n + body_offset),
                    // Since 'self' vertices are in the same order,
                    // parent vertex references retain same index:
                    Tag::Parent(n) => Tag::Body(mapping[*n]),
                }
            }));

            offsets.push(body_offset);
        }

        let m = OpenMesh {
            verts: verts,
            faces: faces,
        };
        (m, offsets)
    }
}