Struct fj_core::objects::Cycle

pub struct Cycle { /* private fields */ }

A cycle of connected 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) -> &ObjectSet<HalfEdge>

Access the edges that make up the cycle

pub fn winding(&self, geometry: &Geometry) -> 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 BoundingVerticesOfHalfEdge for Cycle

fn bounding_vertices_of_half_edge( &self, half_edge: &Handle<HalfEdge> ) -> Option<CurveBoundary<Vertex>>

Determine the bounding vertices of a half-edge

impl BoundingVolume<2> for Cycle

fn aabb(&self, geometry: &Geometry) -> Option<Aabb<2>>

Compute an axis-aligned bounding box (AABB)

impl BuildCycle for Cycle

fn empty() -> Cycle

Build an empty cycle

fn circle( center: impl Into<Point<2>>, radius: impl Into<Scalar>, core: &mut Core ) -> Cycle

Build a circle

fn polygon<P, Ps>(points: Ps, core: &mut Core) -> 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 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 AnyObject<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, core: &mut Core) -> Self::Inserted

Insert the object into its respective store

impl IsObject for Cycle

type BareObject = Cycle

The type of the bare object

impl JoinCycle for Cycle

fn add_joined_edges<Es>(&self, edges: Es, core: &mut Core) -> Self

where Es: IntoIterator<Item = (Handle<HalfEdge>, SurfacePath, CurveBoundary<Point<1>>)>, Es::IntoIter: Clone + ExactSizeIterator,

Add half-edges to the cycle that are joined to the provided ones

fn join_to( &self, other: &Cycle, range: RangeInclusive<usize>, range_other: RangeInclusive<usize>, core: &mut Core ) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 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 ReplaceCurve for Cycle

fn replace_curve( &self, original: &Handle<Curve>, replacement: Handle<Curve>, core: &mut Core ) -> ReplaceOutput<Self, Self::BareObject>

Replace the curve

impl ReplaceHalfEdge for Cycle

fn replace_half_edge<const N: usize>( &self, original: &Handle<HalfEdge>, replacements: [Handle<HalfEdge>; N], _: &mut Core ) -> ReplaceOutput<Self, Self::BareObject>

Replace the half-edge

impl ReplaceVertex for Cycle

fn replace_vertex( &self, original: &Handle<Vertex>, replacement: Handle<Vertex>, core: &mut Core ) -> ReplaceOutput<Self, Self::BareObject>

Replace the vertex

impl Reverse for Cycle

fn reverse(&self, core: &mut Core) -> Self

Reverse the direction/orientation of the object

impl ReverseCurveCoordinateSystems for Cycle

fn reverse_curve_coordinate_systems(&self, core: &mut Core) -> Self

Reverse the direction of the curve coordinate systems within an object

impl SweepCycle for Cycle

fn sweep_cycle( &self, surface: &SurfaceGeometry, color: Option<Color>, path: impl Into<Vector<3>>, cache: &mut SweepCache, core: &mut Core ) -> SweptCycle

Sweep the Cycle

impl TransformObject for Cycle

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

Transform the object using the provided cache

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

Transform the object

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

Translate the object

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

Rotate the object

impl UpdateCycle for Cycle

fn add_half_edges<T>( &self, half_edges: impl IntoIterator<Item = T>, core: &mut Core ) -> Self

where T: Insert<Inserted = Handle<HalfEdge>>,

Add edges to the cycle

fn update_half_edge<T, R>( &self, handle: &Handle<HalfEdge>, update: impl FnOnce(&Handle<HalfEdge>, &mut Core) -> R, core: &mut Core ) -> Self

where T: Insert<Inserted = Handle<HalfEdge>>, R: IntoIterator<Item = T>,

Update an edge of the cycle

impl Validate for Cycle

fn validate( &self, config: &ValidationConfig, errors: &mut Vec<ValidationError>, geometry: &Geometry )

Validate the object

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

Validate the object using default config and return on first error

impl ValidationCheck<Cycle> for AdjacentHalfEdgesNotConnected

fn check( object: &Cycle, geometry: &Geometry, config: &ValidationConfig ) -> impl Iterator<Item = Self>

Run the validation check on the implementing object

fn check_and_return_first_error( object: &T, geometry: &Geometry ) -> Result<(), Self>

Convenience method to run the check return the first error

fn check_and_expect_one_error(object: &T, geometry: &Geometry) -> Self

where Self: Display,

Convenience method to run the check and expect one error

impl Eq for Cycle

impl StructuralPartialEq for Cycle