Struct CompileOutcome

#[non_exhaustive]
pub struct CompileOutcome {
    pub mesh: TriMesh,
    pub attribute_fates: Option<Vec<(String, AttributeFate)>>,
    pub closure: MeshClosure,
}

A compiled mesh and, when the compiler tracks it, each channel’s fate.

Compilation moves and concatenates geometry, and a boolean inside the graph cuts it, so a channel can reach the result unchanged, derived, or not at all. mesh.attributes shows what survived; attribute_fates says why the rest did not – the #84 contract, applied to graph compilation (#115).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mesh: TriMesh

The compiled mesh.

attribute_fates: Option<Vec<(String, AttributeFate)>>

Each channel seen anywhere in the compiled subgraph, in first-seen order, with its worst fate on any path to the root.

None when the compiler does not track channels: that is “unknown”, not “nothing was dropped”.

closure: MeshClosure

Whether the mesh bounds a solid. MeshClosure::Unknown unless the compiler reports it; read the mesh through Self::solid_mesh before taking a volume from it.

Implementations

impl CompileOutcome

pub const fn untracked(mesh: TriMesh) -> Self

A mesh from a compiler that does not report channel fates.

pub const fn tracked( mesh: TriMesh, attribute_fates: Vec<(String, AttributeFate)>, ) -> Self

A mesh with its channel report.

pub const fn with_closure(self, closure: MeshClosure) -> Self

The same outcome with its closure reported.

pub fn solid_mesh(&self) -> GeomResult<&TriMesh>

The mesh, only if it is known to bound a solid.

Use this before measuring volume, centroid or second moments. A surface model’s mesh can be closed and consistently wound, so a volume computed from it would be a plausible number with no meaning; this refuses instead of returning it (#161).

Errors

GeomError::InvalidInput for MeshClosure::Surface and for MeshClosure::Unknown: an unreported closure is not a solid.

pub fn fate(&self, name: &str) -> Option<&AttributeFate>

The fate of the channel named name, if the compiler reported one.

Trait Implementations

impl Clone for CompileOutcome

fn clone(&self) -> CompileOutcome

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompileOutcome

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CompileOutcome

fn eq(&self, other: &CompileOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CompileOutcome