Struct libreda_db::prelude::PointString

pub struct PointString<T> {
    pub points: Vec<Point<T>, Global>,
}

A point string is a finite sequence of points. TODO: Implement Deref for accessing the list of points.

Fields

points: Vec<Point<T>, Global>

The points defining this point string.

Implementations

impl<T> PointString<T>

pub fn len(&self) -> usize

Get the number of vertices.

pub fn is_empty(&self) -> bool

Check if string has zero length.

impl<T> PointString<T>where T: Copy,

pub fn new<I>(i: I) -> PointString<T>where I: Into<PointString<T>>,

Create new point string by taking vertices from a type that implements Into<PointString<T>>.

pub fn iter(&self) -> Iter<'_, Point<T>>

Shortcut for self.points.iter().

pub fn edges(&self) -> impl Iterator<Item = Edge<T>>

Get the sequence of edges of the point string starting from the first point to the last.

Examples

use iron_shapes::point_string::PointString;
use iron_shapes::edge::Edge;
let coords = vec![(0, 0), (1, 0), (2, 0)];

let point_string = PointString::new(coords);

let edges: Vec<_> = point_string.edges().collect();

assert_eq!(edges, vec![Edge::new((0, 0), (1, 0)), Edge::new((1, 0), (2, 0))]);

pub fn edges_reversed(&self) -> impl Iterator<Item = Edge<T>>

Same as edges but in reverse order. Get the sequence of edges of the point string starting from the last point to the first.

Examples

use iron_shapes::point_string::PointString;
use iron_shapes::edge::Edge;
let coords = vec![(0, 0), (1, 0), (2, 0)];

let point_string = PointString::new(coords);

let edges: Vec<_> = point_string.edges_reversed().collect();

assert_eq!(edges, vec![Edge::new((2, 0), (1, 0)), Edge::new((1, 0), (0, 0))]);

impl<T> PointString<T>where T: Copy + Sub<T, Output = T> + NumCast,

pub fn path_length<F>(&self) -> Fwhere F: Float,

Compute geometrical length of the path defined by the point string.

Examples

use iron_shapes::point_string::PointString;
let coords = vec![(0, 0), (1, 0), (2, 0)];

let point_string = PointString::new(coords);

assert_eq!(point_string.path_length::<f64>(), 2.0);

Trait Implementations

impl<T> Clone for PointString<T>where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PointString<T>where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for PointString<T>where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<PointString<T>, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I, T, P> From<I> for PointString<T>where T: Copy, I: IntoIterator<Item = P>, Point<T>: From<P>,

Create a point string from something that can be turned into an iterator of values convertible to Points.

fn from(iter: I) -> PointString<T>

Converts to this type from the input type.

impl<T, P> FromIterator<P> for PointString<T>where T: Copy, P: Into<Point<T>>,

Create a point string from a iterator of values convertible to Points.

fn from_iter<I>(iter: I) -> PointString<T>where I: IntoIterator<Item = P>,

Creates a value from an iterator.

impl<T> Hash for PointString<T>where T: Hash,

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> MapPointwise<T> for PointString<T>where T: Copy,

fn transform<F>(&self, tf: F) -> PointString<T>where F: Fn(Point<T>) -> Point<T>,

Point wise transformation.

impl<T> PartialEq<PointString<T>> for PointString<T>where T: PartialEq<T>,

fn eq(&self, other: &PointString<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> Serialize for PointString<T>where T: Serialize,

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryBoundingBox<T> for PointString<T>where T: Copy + PartialOrd<T>,

fn try_bounding_box(&self) -> Option<Rect<T>>

Compute the bounding box of all the points in this string. Returns None if the string is empty.

Examples

use iron_shapes::point_string::PointString;
use iron_shapes::traits::TryBoundingBox;
use iron_shapes::rect::Rect;
let coords = vec![(0, 0), (1, 0), (2, 1), (-1, -3)];

let point_string = PointString::new(coords);

assert_eq!(point_string.try_bounding_box(), Some(Rect::new((2, 1), (-1, -3))));

impl<T, Dst> TryCastCoord<T, Dst> for PointString<T>where T: Copy + NumCast, Dst: CoordinateType + NumCast,

type Output = PointString<Dst>

Output type of the cast. This is likely the same geometrical type just with other coordinate types.

fn try_cast(&self) -> Option<<PointString<T> as TryCastCoord<T, Dst>>::Output>

Try to cast to target data type.

fn cast(&self) -> Self::Output

Cast to target data type.

impl<T> Eq for PointString<T>where T: Eq,

impl<T> StructuralEq for PointString<T>

impl<T> StructuralPartialEq for PointString<T>