Struct Cycle 

pub struct Cycle { /* private fields */ }

A cycle of connected half-edges

Implementations

impl Cycle

pub fn new(half_edges: impl IntoIterator<Item = Handle<HalfEdge>>) -> Self

Create an instance of Cycle

pub fn half_edges(&self) -> HalfEdgesOfCycle<'_>

Access the half-edges that make up the cycle

pub fn nth_half_edge(&self, index: usize) -> Option<&Handle<HalfEdge>>

Access the half-edge with the provided index

pub fn half_edge_after( &self, half_edge: &Handle<HalfEdge>, ) -> Option<&Handle<HalfEdge>>

Access the half-edge after the provided one

Panics

Panics, if the provided half-edge is not part of this cycle.

pub fn index_of(&self, half_edge: &Handle<HalfEdge>) -> Option<usize>

Return the index of the provided half-edge, if it is in this cycle

pub fn len(&self) -> usize

Return the number of half-edges in the cycle

pub fn is_empty(&self) -> bool

Indicate whether the cycle is empty

pub fn winding(&self) -> Winding

Indicate the cycle’s winding, assuming a right-handed coordinate system

Please note that this is not the winding of the cycle, only one of the two possible windings, depending on the direction you look at the surface that the cycle is defined on from.

Trait Implementations

impl BuildCycle for Cycle

fn empty() -> Cycle

Build an empty cycle

fn polygon<P, Ps>(points: Ps, services: &mut Services) -> Cycle

where P: Into<Point<2>>, Ps: IntoIterator<Item = P>, Ps::IntoIter: Clone + ExactSizeIterator,

Build a polygon

impl Clone for Cycle

fn clone(&self) -> Cycle

Returns a duplicate 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 From<Cycle> for Object<Bare>

fn from(object: Cycle) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Insert for Cycle

type Inserted = Handle<Cycle>

The type of Self, once it has been inserted

fn insert(self, services: &mut Services) -> Self::Inserted

Insert the object into its respective store

impl JoinCycle for Cycle

fn add_joined_edges<Es>(&self, edges: Es, services: &mut Services) -> Self

where Es: IntoIterator<Item = (Handle<HalfEdge>, Curve, [Point<1>; 2])>, Es::IntoIter: Clone + ExactSizeIterator,

Create a cycle that is joined to the provided edges

fn join_to( &self, other: &Cycle, range: RangeInclusive<usize>, range_other: RangeInclusive<usize>, services: &mut Services, ) -> Self

Join the cycle to another

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Cycle

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TransformObject for Cycle

fn transform_with_cache( self, transform: &Transform, services: &mut Services, cache: &mut TransformCache, ) -> Self

Transform the object using the provided cache

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

Transform the object

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

Translate the object

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

Rotate the object

impl UpdateCycle for Cycle

fn add_half_edges( &self, half_edges: impl IntoIterator<Item = Handle<HalfEdge>>, ) -> Cycle

Add half-edges to the cycle

fn replace_half_edge( &self, original: &Handle<HalfEdge>, replacement: Handle<HalfEdge>, ) -> Cycle

Replace the provided half-edge

fn update_nth_half_edge( &self, index: usize, f: impl FnMut(&Handle<HalfEdge>) -> Handle<HalfEdge>, ) -> Cycle

Update the half-edge at the given index

impl Validate for Cycle

fn validate_with_config( &self, config: &ValidationConfig, errors: &mut Vec<ValidationError>, )

Validate the object

fn validate_and_return_first_error(&self) -> Result<(), ValidationError>

Validate the object using default config and return on first error

fn validate(&self, errors: &mut Vec<ValidationError>)

Validate the object using default configuration

impl Eq for Cycle

impl StructuralPartialEq for Cycle