Struct fj_kernel::objects::Cycle

pub struct Cycle { /* private fields */ }

A cycle of connected edges

The end of each edge in the cycle must connect to the beginning of the next edge. The end of the last edge must connect to the beginning of the first one.

Implementations

impl Cycle

pub fn build(surface: Surface) -> CycleBuilder

Build a cycle using CycleBuilder

pub fn new(surface: Surface) -> Self

Create a new cycle

pub fn with_edges(self, edges: impl IntoIterator<Item = Edge>) -> Self

Add edges to the cycle

Consumes the cycle and returns the updated instance.

pub fn surface(&self) -> &Surface

Access the surface that this cycle is in

pub fn edges(&self) -> impl Iterator<Item = &Edge> + '_

Access edges that make up the cycle

pub fn into_edges(self) -> impl Iterator<Item = Edge>

Consume the cycle and return its edges

Trait Implementations

impl Approx for Cycle

type Approximation = CycleApprox

The approximation of the object

fn approx(&self, tolerance: Tolerance) -> Self::Approximation

Approximate the object

impl Clone for Cycle

fn clone(&self) -> Cycle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cycle

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

Formats the value using the given formatter.

impl Hash for Cycle

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 Cycle

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

Return all objects that this one references

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

Iterate over all cycles

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

Iterate over all curves

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_curve_iter(&'r self) -> Iter<&'r GlobalCurve>

Iterate over all global curves

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

Iterate over all global vertices

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

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

Iterate over all sketches

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

Iterate over all solids

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 Cycle

fn cmp(&self, other: &Cycle) -> 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<Cycle> for Cycle

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

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

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

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

impl PartialOrd<Cycle> for Cycle

fn partial_cmp(&self, other: &Cycle) -> 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 Cycle

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 Cycle

impl StructuralEq for Cycle

impl StructuralPartialEq for Cycle