Struct splashsurf_lib::uniform_grid::NeighborEdge
source · pub struct NeighborEdge<'a, 'b: 'a, I: Index> { /* private fields */ }
Expand description
Helper type that provides connectivity information about an edge that connects a primary point and a neighbor point
Implementations§
source§impl<'a, 'b, I: Index> NeighborEdge<'a, 'b, I>
impl<'a, 'b, I: Index> NeighborEdge<'a, 'b, I>
sourcepub fn origin_index(&self) -> &PointIndex<I>
pub fn origin_index(&self) -> &PointIndex<I>
Returns the origin of this neighbor edge
sourcepub fn neighbor_index(&self) -> &PointIndex<I>
pub fn neighbor_index(&self) -> &PointIndex<I>
Returns the neighbor of the origin node connected by this neighbor edge
sourcepub fn connectivity(&self) -> DirectedAxis
pub fn connectivity(&self) -> DirectedAxis
Returns the connectivity between the origin point and its neighbor in terms of a directed axis
sourcepub fn ascending_point_order(&self) -> (&PointIndex<I>, &PointIndex<I>)
pub fn ascending_point_order(&self) -> (&PointIndex<I>, &PointIndex<I>)
Returns references to the point indices of the edge, ordered in such a way that they are in ascending point index order. That means that the first point index is connected to the second point index with an edge along an axis in positive direction.
Auto Trait Implementations§
impl<'a, 'b, I> RefUnwindSafe for NeighborEdge<'a, 'b, I>where I: RefUnwindSafe,
impl<'a, 'b, I> Send for NeighborEdge<'a, 'b, I>
impl<'a, 'b, I> Sync for NeighborEdge<'a, 'b, I>
impl<'a, 'b, I> Unpin for NeighborEdge<'a, 'b, I>
impl<'a, 'b, I> UnwindSafe for NeighborEdge<'a, 'b, I>where I: RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.