Plexus is a Rust library for generating and manipulating 3D meshes.
Meshes can be generated from primitives like cubes and spheres using iterator
expressions. Primitives emit topological structures like Triangle
s or
Quad
s, which contain arbitrary geometric data in their vertices. These can be
transformed and decomposed into other topologies and geometric data via
triangulation, tesselation, and conversion into rendering pipeline data.
```rust use nalgebra::Point3; use plexus::buffer::MeshBuffer; use plexus::generate::sphere; use plexus::prelude::*;
// Example module in the local crate that provides basic rendering. use render::{self, Color, Vertex};
// Construct a buffer of index and vertex data from a sphere primitive.
let buffer = sphere::UVSphere::
Generators are flexible and easy to use, but only represent vertex geometry and
are difficult to query and manipulate. A Mesh
, represented as a half-edge
graph, supports
arbitrary geometry for vertices, edges, and faces. The graph can also be
queried and manipulated in ways that generators and iterator expressions
cannot.
```rust use decorum::R32; use nalgebra::Point3; use plexus::generate::sphere; use plexus::graph::Mesh; use plexus::prelude::*;
// Construct a mesh from a sphere primitive. The vertex geometry is convertible
// to Point3
via the FromGeometry
trait in this example.
let mut mesh = sphere::UVSphere::
Meshes support arbitrary geometry via optional traits. Implementing these
traits allows more operations to be supported, but only two basic traits are
required: Geometry
and Attribute
.
```rust use nalgebra::{Point3, Vector3}; use plexus::geometry::{Attribute, Geometry}; use plexus::geometry::convert::AsPosition;
pub struct VertexGeometry {
pub position: Point3
impl Attribute for VertexGeometry {}
impl Geometry for VertexGeometry { type Vertex = Self; type Edge = (); type Face = (); }
impl AsPosition for VertexGeometry {
type Target = Point3
fn as_position(&self) -> &Self::Target {
&self.position
}
fn as_position_mut(&mut self) -> &mut Self::Target {
&mut self.position
}
} ```
Geometric traits are optionally implemented for types in the nalgebra and cgmath crates so that common types can be used right away for vertex geometry.
When collecting an iterator expression into a graph or buffer, an indexer is
used to transform the geometry into raw buffers. HashIndexer
is fast and
reliable, and is used by collect
(which can be overridden via
collect_with_indexer
). However, geometry often contains floating point
values, which do not implement Hash
. An LruIndexer
can also be used, but
can be slower and requires a sufficient capacity to work correctly.
The decorum crate is used to ease
this problem. Hashable types like NotNan
, Finite
, R32
, etc. can be used
as geometric data. Common geometric types also implement traits that provide
conversions to and from a conjugate type that implements Hash
(via the
into_hash
and from_hash
functions).
The decorum
crate also exposes some hashing functions for floating point
primitives, which can be used to directly implement Hash
. With the
derivative crate, floating point fields
can be hashed using one of these functions while deriving Hash
. The Vertex
type used in the above example could be defined as follows:
```rust use decorum;
pub struct Vertex { #[derivative(Hash(hashwith = "decorum::hashfloat_array"))] pub position: [f32; 3], ... } ```