Struct fj_math::PolyChain

#[repr(C)]
pub struct PolyChain<const D: usize> { /* private fields */ }

A polygonal chain

The dimensionality of the polygonal chain is defined by the const generic D parameter.

Implementations

impl<const D: usize> PolyChain<D>

pub fn new() -> Self

Create an empty PolyChain

pub fn from_points( points: impl IntoIterator<Item = impl Into<Point<D>>> ) -> Self

Construct a polygonal chain from a number of points

pub fn segments(&self) -> Vec<Segment<D>>

Access the segments of the polygonal chain

pub fn close(self) -> Self

Close the polygonal chain

Adds the first point of the chain as the last, closing the chain. This method does not check whether the PolyChain is already closed.

pub fn reverse(self) -> Self

Reverse the order of points in the PolyChain

Trait Implementations

impl<const D: usize> Clone for PolyChain<D>

fn clone(&self) -> PolyChain<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for PolyChain<D>

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

Formats the value using the given formatter.

impl<const D: usize> Default for PolyChain<D>

fn default() -> PolyChain<D>

Returns the “default value” for a type.

impl<P, Ps, const D: usize> From<Ps> for PolyChain<D>

where P: Into<Point<D>>, Ps: IntoIterator<Item = P>,

fn from(points: Ps) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for PolyChain<D>

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<const D: usize> Ord for PolyChain<D>

fn cmp(&self, other: &PolyChain<D>) -> 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<const D: usize> PartialEq for PolyChain<D>

fn eq(&self, other: &PolyChain<D>) -> 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<const D: usize> PartialOrd for PolyChain<D>

fn partial_cmp(&self, other: &PolyChain<D>) -> 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<const D: usize> Eq for PolyChain<D>

impl<const D: usize> StructuralPartialEq for PolyChain<D>