Struct batbox_lapp::Chain

pub struct Chain<T> {
    pub vertices: Vec<vec2<T>>,
}

A polygonal chain connecting a vector of points in space

Fields

vertices: Vec<vec2<T>>

List of points

Implementations

impl<T: Float> Chain<T>

pub fn new(vertices: Vec<vec2<T>>) -> Self

Construct a new chain

pub fn length(&self) -> T

where T: Sum<T>,

Returns the total length of the chain

pub fn take_range_ratio(self, range: RangeInclusive<T>) -> Self

where T: Sum<T>,

Returns a part of the chain. The full chain’s range is 0.0..=1.0.

Examples

let chain = Chain::new(vec![vec2(0.0, 0.0), vec2(1.0, 0.0), vec2(1.0, 1.0), vec2(0.0, 1.0)]);
assert_eq!(chain.clone().take_range_ratio(0.0..=1.0).vertices, chain.vertices);

pub fn take_range_length(self, range: RangeInclusive<T>) -> Self

Returns a part of the chain. The full chain’s range is 0.0..=chain.length().

Examples

let chain = Chain::new(vec![vec2(0.0, 0.0), vec2(1.0, 0.0), vec2(1.0, 1.0), vec2(0.0, 1.0)]);
assert_eq!(chain.clone().take_range_ratio(0.0..=chain.length()).vertices, chain.vertices);

pub fn segments(&self) -> Vec<Segment<T>>

Converts a chain into a vector of segments.

Trait Implementations

impl<T: Clone> Clone for Chain<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Chain<T>

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

Formats the value using the given formatter.