Struct fj_kernel::objects::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 a new cycle

Panics

Panics, if half_edges does not yield at least one half-edge.

Panic, if the end of each half-edge does not connect to the beginning of the next one.

pub fn surface(&self) -> &Handle<Surface>

Access the surface that this cycle is in

pub fn half_edges(&self) -> impl Iterator<Item = &Handle<HalfEdge>> + '_

Access the half-edges that make up the cycle

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 Approx for &Cycle

type Approximation = CycleApprox

The approximation of the object

type Cache = CurveCache

The cache used to cache approximation results

fn approx_with_cache(
    self,
    tolerance: impl Into<Tolerance>,
    cache: &mut Self::Cache
) -> Self::Approximation

Approximate the object, using the provided cache

fn approx(self, tolerance: impl Into<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 From<&Cycle> for PartialCycle

fn from(cycle: &Cycle) -> Self

Converts to this type from the input type.

impl HasPartial for Cycle

type Partial = PartialCycle

The type representing the partial variant of this object

fn partial() -> Self::Partial

Create an empty partial variant of this object

fn to_partial(&self) -> Self::Partial

Convert this object into its partial variant

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 Ord for Cycle

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + 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 Validate2 for Cycle

type Error = Infallible

The error that validation of the implementing type can result in

fn validate_with_config(&self, _: &ValidationConfig) -> Result<(), Self::Error>

Validate the object

fn validate(&self) -> Result<(), Self::Error>

Validate the object using default configuration

impl Eq for Cycle

impl StructuralEq for Cycle

impl StructuralPartialEq for Cycle