Struct fj_kernel::objects::Solid

pub struct Solid { /* private fields */ }

A 3-dimensional shape

Implementation Note

The faces that make up the solid must form a closed shape. This is not currently validated.

In fact, solids could be made up of several closed shells. One outer shell, and multiple inner ones (cavities within the solid). There should probably a separate Shell object that is a collection of faces, and validates that those faces form a closed shape. Solid should be a collection of such Shells, and validate that those Shells don’t intersect.

Implementations

impl Solid

pub fn build() -> SolidBuilder

Build a solid using SolidBuilder

pub fn new() -> Self

Construct an empty instance of Solid

pub fn with_faces(self, faces: impl IntoIterator<Item = impl Into<Face>>) -> Self

Add faces to the solid

Consumes the solid and returns the updated instance.

pub fn faces(&self) -> impl Iterator<Item = &Face>

Access the solid’s faces

pub fn into_faces(self) -> impl Iterator<Item = Face>

Convert the solid into a list of faces

Trait Implementations

impl Clone for Solid

fn clone(&self) -> Solid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Solid

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

Formats the value using the given formatter.

impl Default for Solid

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Solid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'r> ObjectIters<'r> for Solid

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn curve_iter(&'r self) -> Iter<&'r Curve<3>>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn edge_iter(&'r self) -> Iter<&'r Edge>

Iterate over all edges

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Vertex>

Iterator over all vertices

impl Ord for Solid

fn cmp(&self, other: &Solid) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Solid> for Solid

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Solid> for Solid

fn partial_cmp(&self, other: &Solid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TransformObject for Solid

fn transform(self, transform: &Transform) -> Self

Transform the object

fn translate(self, offset: impl Into<Vector<3>>) -> Self

Translate the object

fn rotate(self, axis_angle: impl Into<Vector<3>>) -> Self

Rotate the object

impl Eq for Solid

impl StructuralEq for Solid

impl StructuralPartialEq for Solid