Struct fj_core::geometry::CurveBoundary

pub struct CurveBoundary<T: CurveBoundaryElement> {
    pub inner: [T::Repr; 2],
}

A boundary on a curve

This struct is generic, because different situations require different representations of a boundary. In some cases, curve coordinates are enough, in other cases, vertices are required, and sometimes you need both.

Fields

inner: [T::Repr; 2]

The raw representation of the boundary

Implementations

impl<T: CurveBoundaryElement> CurveBoundary<T>

pub fn is_normalized(&self) -> bool

Indicate whether the boundary is normalized

If the boundary is normalized, its bounding elements are in a defined order, and calling normalize will return an identical instance.

pub fn reverse(self) -> Self

Reverse the direction of the boundary

Returns a new instance of this struct, which has its direction reversed.

pub fn normalize(self) -> Self

Normalize the boundary

Returns a new instance of this struct, which has the bounding elements in a defined order. This can be used to compare boundaries while disregarding their direction.

impl CurveBoundary<Point<1>>

pub fn is_empty(&self) -> bool

Indicate whether the boundary is empty

pub fn contains(&self, point: Point<1>) -> bool

Indicate whether the boundary contains the given element

pub fn overlaps(&self, other: &Self) -> bool

Indicate whether the boundary overlaps another

Boundaries that touch (i.e. their closest boundary elements are equal) count as overlapping.

pub fn difference(self, other: Self) -> Option<OneOrTwoBoundaries>

Create the difference of this boundary and another

The result will be normalized.

pub fn intersection(self, other: Self) -> Self

Create the intersection of this boundary and another

The result will be normalized.

pub fn union(self, other: Self) -> Self

Create the union of this boundary and another

The result will be normalized.

Panics

Panics, if the two boundaries don’t overlap (touching counts as overlapping).

Trait Implementations

impl<T: Clone + CurveBoundaryElement> Clone for CurveBoundary<T>

where T::Repr: Clone,

fn clone(&self) -> CurveBoundary<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + CurveBoundaryElement> Debug for CurveBoundary<T>

where T::Repr: Debug,

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

Formats the value using the given formatter.

impl<S, T: CurveBoundaryElement> From<[S; 2]> for CurveBoundary<T>

where S: Into<T::Repr>,

fn from(boundary: [S; 2]) -> Self

Converts to this type from the input type.

impl<T: CurveBoundaryElement> Hash for CurveBoundary<T>

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<T: CurveBoundaryElement> Ord for CurveBoundary<T>

fn cmp(&self, other: &Self) -> 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<T: CurveBoundaryElement> PartialEq for CurveBoundary<T>

fn eq(&self, other: &Self) -> 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<T: CurveBoundaryElement> PartialOrd for CurveBoundary<T>

fn partial_cmp(&self, other: &Self) -> 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<T: Copy + CurveBoundaryElement> Copy for CurveBoundary<T>

where T::Repr: Copy,

impl<T: CurveBoundaryElement> Eq for CurveBoundary<T>