Enum plexus::graph::Selector

pub enum Selector<K> {
    ByKey(K),
    ByIndex(usize),
}

Entity selector.

Identifies an entity by key or index. Keys behave as an absolute selector and uniquely identify a single entity within a MeshGraph. Indices behave as a relative selector and identify an entity relative to some other entity. Selector is used by operations that support both of these selection mechanisms.

An index is typically used to select an adjacent entity or contained (and ordered) entity, such as an adjacent face.

Examples

Splitting a face by index (of its contained vertices):

use decorum::R64;
use nalgebra::Point3;
use plexus::graph::MeshGraph;
use plexus::prelude::*;
use plexus::primitive::cube::Cube;
use plexus::primitive::generate::Position;

type E3 = Point3<R64>;

let mut graph: MeshGraph<E3> = Cube::new().polygons::<Position<E3>>().collect();
let key = graph.faces().nth(0).unwrap().key();
graph
    .face_mut(key)
    .unwrap()
    .split(ByIndex(0), ByIndex(2))
    .unwrap();

Variants

ByKey(K)

ByIndex(usize)

Implementations

impl<K> Selector<K>

pub fn key_or_else<E, F>(self, f: F) -> Result<K, GraphError> where
    E: Into<GraphError>,
    F: Fn(usize) -> Result<K, E>, 

Gets the selector’s key or passes its index to a function to resolve the key.

pub fn index_or_else<E, F>(self, f: F) -> Result<usize, GraphError> where
    E: Into<GraphError>,
    F: Fn(K) -> Result<usize, E>, 

Gets the selector’s index or passes its key to a function to resolve the index.

Trait Implementations

impl<K: Clone> Clone for Selector<K>

fn clone(&self) -> Selector<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for Selector<K>

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

Formats the value using the given formatter.

impl<K> From<K> for Selector<K> where
    K: Key, 

fn from(key: K) -> Self

Converts to this type from the input type.

impl<K> From<usize> for Selector<K>

fn from(index: usize) -> Self

Converts to this type from the input type.

impl<K: PartialEq> PartialEq<Selector<K>> for Selector<K>

fn eq(&self, other: &Selector<K>) -> bool

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

fn ne(&self, other: &Selector<K>) -> bool

This method tests for !=.

impl<K: Copy> Copy for Selector<K>

impl<K: Eq> Eq for Selector<K>

impl<K> StructuralEq for Selector<K>

impl<K> StructuralPartialEq for Selector<K>