Struct boostvoronoi::Edge

pub struct Edge { /* private fields */ }

Half-edge data structure. Represents a Voronoi edge.

Data members:

1. id of the corresponding cell
2. id of to the vertex that is the starting point of the half-edge (optional)
3. id of to the twin edge
4. id of of the CCW next edge
5. id of to the CCW prev edge
6. mutable color member

Implementations

impl Edge

pub fn id(&self) -> EdgeIndex

Returns the edge index

pub fn cell(&self) -> Result<CellIndex, BvError>

Returns the cell index of this edge, or a BvError

pub fn vertex0(&self) -> Option<VertexIndex>

Returns vertex0, it is perfectly ok for an edge to not contain a vertex0 so no Result<..> is needed here.

pub fn twin(&self) -> Result<EdgeIndex, BvError>

Returns the twin edge or an error

pub fn next(&self) -> Result<EdgeIndex, BvError>

returns the next edge (counter clockwise winding) or an error

pub fn prev(&self) -> Result<EdgeIndex, BvError>

returns the previous edge (counter clockwise winding)

pub fn is_linear(&self) -> bool

Returns true if the edge is linear (segment, ray, line). Returns false if the edge is curved (parabolic arc).

pub fn is_curved(&self) -> bool

Returns true if the edge is curved (parabolic arc). Returns false if the edge is linear (segment, ray, line).

pub fn is_primary(&self) -> bool

Returns false if edge goes through the endpoint of the segment. Returns true else.

pub fn is_secondary(&self) -> bool

Returns true if edge goes through the endpoint of the segment. Returns false else.

pub fn get_color(&self) -> u32

get_color returns the custom edge info. (does not contain the reserved bits)

pub fn set_color(&mut self, color: u32) -> u32

set_color sets the custom edge info. (does not affect the reserved bits)

pub fn or_color(&mut self, color: u32) -> u32

or_color sets the custom edge info together with the previous value. (does not affect the reserved bits)

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl Copy for Edge