Struct fj_kernel::objects::VerticesOfEdge

pub struct VerticesOfEdge<T>(_);

The vertices that bound an edge

This struct is generic over the actual vertex type used, but typically, T will either be Vertex or GlobalVertex.

Implementations

impl<T> VerticesOfEdge<T>

pub fn from_vertices(vertices: [T; 2]) -> Self

Construct an instance of VerticesOfEdge from two vertices

pub fn none() -> Self

Construct an instance of VerticesOfEdge without vertices

pub fn get(&self) -> Option<[&T; 2]>

Access the vertices

pub fn get_or_panic(&self) -> [&T; 2]

Access the two vertices

Panics

Panics, if the edge has no vertices.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterate over the vertices

pub fn map<F>(self, f: F) -> Self where
    F: FnMut(T) -> T, 

Map each vertex using the provided function

pub fn convert<F, U>(self, f: F) -> Option<[U; 2]> where
    F: FnMut(T) -> U, 

Convert each vertex using the provided function

impl VerticesOfEdge<Vertex>

pub fn reverse(self) -> Self

Reverse the order of vertices

Makes sure that the local coordinates are still correct.

pub fn to_global(&self) -> VerticesOfEdge<GlobalVertex>

Convert this instance into its global variant

Trait Implementations

impl<T: Clone> Clone for VerticesOfEdge<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for VerticesOfEdge<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for VerticesOfEdge<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, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for VerticesOfEdge<T>

fn cmp(&self, other: &VerticesOfEdge<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<VerticesOfEdge<T>> for VerticesOfEdge<T>

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

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

impl<T: Eq> Eq for VerticesOfEdge<T>

impl<T> StructuralEq for VerticesOfEdge<T>

impl<T> StructuralPartialEq for VerticesOfEdge<T>