Struct rust_3d::HalfEdge

pub struct HalfEdge { /* fields omitted */ }

HalfEdge, the half edge data structure

Methods

impl HalfEdge

pub fn new<T, M>(mesh: &M) -> Self where
    M: IsMesh<T, Face3>, 

Creates a new HalfEdge3D for the given IsMesh3D This only stays valid if IMesh3D is not changed after creation The mesh must be manifold (@todo ensure via types?)

pub fn tail(&self, id: EId) -> Result<VId>

Returns the ID of the vertex the edge originates from (error if id out of bounds)

pub fn face(&self, id: EId) -> Result<FId>

Returns the ID of the face the edge belongs to (error if id out of bounds)

pub fn twin(&self, id: EId) -> Result<Option<EId>>

Returns the ID of the twin edge (None if there isn't any) (error if id out of bounds)

pub fn next(&self, id: EId) -> Result<EId>

Returns the ID of the edge after this edge (error if id out of bounds)

pub fn prev(&self, id: EId) -> Result<EId>

Returns the ID of the edge before this edge (error if id out of bounds)

pub fn edges_originating(&self, id: VId, result: &mut Vec<EId>) -> Result<()>

Appends all edges originating (pointing away) from the given vertex (error if id out of bounds)

pub fn edges_ending(
    &self,
    id: VId,
    cache: &mut Vec<EId>,
    result: &mut Vec<EId>
) -> Result<()>

Appends all edges ending (pointing at) the given vertex (error if id out of bounds) cache is used to avoid allocations, pass any Vec

pub fn edges_all(
    &self,
    id: VId,
    cache: &mut Vec<EId>,
    result: &mut Vec<EId>
) -> Result<()>

Appends all edges connected to the vertex (both originating and ending) (error if id out of bounds) cache is used to avoid allocations, pass any Vec

pub fn faces(
    &self,
    id: VId,
    cache: &mut Vec<EId>,
    result: &mut Vec<FId>
) -> Result<()>

Appends all faces a vertex is part of (error if id out of bounds) cache is used to avoid allocations, pass any Vec

pub fn ensure_edge_id(&self, id: EId) -> Result<()>

Fails if the edge ID is out of bounds

pub fn ensure_vertex_id(&self, id: VId) -> Result<()>

Fails if the vertex ID is out of bounds

Trait Implementations

impl PartialOrd<HalfEdge> for HalfEdge

fn partial_cmp(&self, other: &HalfEdge) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &HalfEdge) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &HalfEdge) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &HalfEdge) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &HalfEdge) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<HalfEdge> for HalfEdge

fn eq(&self, other: &HalfEdge) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HalfEdge) -> bool

This method tests for !=.

impl Ord for HalfEdge

fn cmp(&self, other: &HalfEdge) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for HalfEdge

impl Clone for HalfEdge

fn clone(&self) -> HalfEdge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for HalfEdge

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 Debug for HalfEdge

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

Formats the value using the given formatter.