Struct cavalier_contours::polyline::PlineVertex

pub struct PlineVertex<T = f64> {
    pub x: T,
    pub y: T,
    pub bulge: T,
}

A polyline vertex is represented by an x, y, and bulge value.

x and y describe the 2D position of the vertex. bulge describes the arc sweep angle for the polyline segment that starts with this vertex. bulge is defined as tan(arc_sweep_angle / 4). Note a polyline arc segment can never have a sweep angle greater than PI (half circle).

See angle_from_bulge and bulge_from_angle for functions to convert between bulge arc sweep angle.

Fields

x: T

X coordinate position for the vertex.

y: T

Y coordinate position for the vertex.

bulge: T

Bulge for the polyline segment that starts with this vertex.

Implementations

impl<T> PlineVertex<T>

where T: Real,

pub fn new(x: T, y: T, bulge: T) -> Self

pub fn from_slice(slice: &[T]) -> Option<Self>

Construct a vertex from a [x, y, bulge] slice.

If the slice does not contain exactly 3 elements then None is returned.

pub fn from_vector2(vector2: Vector2<T>, bulge: T) -> Self

Construct a vertex using a 2D vector as the position.

pub fn with_bulge(&self, bulge: T) -> Self

Create a copy of the vertex with new bulge value but same x and y values.

pub fn pos(&self) -> Vector2<T>

Return the position as a 2D vector.

pub fn bulge_is_zero(&self) -> bool

Returns true if self.bulge.fuzzy_eq_zero() (represents the start of a line segment).

pub fn bulge_is_pos(&self) -> bool

Returns true if self.bulge > T::zero() (represents the start of a counter clockwise arc segment).

pub fn bulge_is_neg(&self) -> bool

Returns true if self.bulge < T::zero() (represents the start of a clockwise arc segment).

pub fn fuzzy_eq_eps(&self, other: Self, fuzzy_epsilon: T) -> bool

Fuzzy equal comparison with another vertex using fuzzy_epsilon given.

pub fn fuzzy_eq(&self, other: Self) -> bool

Fuzzy equal comparison with another vertex using T::fuzzy_epsilon().

Trait Implementations

impl<T: Clone> Clone for PlineVertex<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PlineVertex<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PlineVertex<T>

fn default() -> PlineVertex<T>

Returns the “default value” for a type.

impl<T> Display for PlineVertex<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for PlineVertex<T>

fn eq(&self, other: &PlineVertex<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: Copy> Copy for PlineVertex<T>

impl<T: Eq> Eq for PlineVertex<T>

impl<T> StructuralPartialEq for PlineVertex<T>