Struct iron_shapes::path::Path

pub struct Path<T> {
    pub points: PointString<T>,
    pub width: T,
    pub path_type: PathEndType<T>,
}

Path is essentially a chain of line segments but with a possibly a non-zero width. It can be thought of the shape resulting by a stroke of a thick pen along the line segments.

Fields

points: PointString<T>

The vertices of the path which define the sequence of line segments.

width: T

Width of the path.

path_type: PathEndType<T>

Type of the path endings.

Implementations

impl<T> Path<T>

pub fn len(&self) -> usize

Get number of vertices defining the path.

impl<T: Copy> Path<T>

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

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

pub fn new_extended<I>(i: I, width: T, ext_begin: T, ext_end: T) -> Self where
    I: Into<PointString<T>>, 

Create a path with extended beginning and end.

pub fn new_rounded<I>(i: I, width: T) -> Self where
    I: Into<PointString<T>>, 

Create a path with rounded beginning and end.

impl<T: Copy + Add<Output = T>> Path<T>

pub fn translate(&self, v: Vector<T>) -> Self

Translate the path by an offset vector.

impl<T: Copy + Mul<Output = T>> Path<T>

pub fn scale(&self, factor: T) -> Self

Scale the path. Scaling center is the origin (0, 0).

impl<T: CoordinateType> Path<T>

pub fn rotate_ortho(&self, angle: Angle) -> Self

Rotate the path by a multiple of 90 degrees around the origin (0, 0).

pub fn transform(&self, tf: &SimpleTransform<T>) -> Self

Get the transformed version of this path by applying tf.

impl<T: CoordinateType + NumCast> Path<T>

pub fn area_approx<F: Float>(&self) -> F

Compute approximate area occupied by the path. Simply computes length*width.

Examples

use iron_shapes::prelude::*;
let path = Path::new(&[(0, 0), (0, 2)], 1);
assert_eq!(path.area_approx::<f64>(), 2f64);

pub fn to_polygon_approx(&self) -> SimplePolygon<f64>

Convert the path into a polygon. The polygon can be self-intersecting.

Examples

use iron_shapes::prelude::*;
let path = Path::new(&[(0, 0), (10, 0), (10, 20)], 4);
let polygon = path.to_polygon_approx();
assert_eq!(polygon, SimplePolygon::from(&[(0., 2.), (0., -2.), (12., -2.), (12., 20.), (8., 20.), (8., 2.)]));

Trait Implementations

impl<T: Clone> Clone for Path<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Path<T>

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

Formats the value using the given formatter.

impl<T> From<Path<T>> for Geometry<T>

fn from(x: Path<T>) -> Geometry<T>

Converts to this type from the input type.

impl<T: Hash> Hash for Path<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<Path<T>> for Path<T>

fn eq(&self, other: &Path<T>) -> bool

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

fn ne(&self, other: &Path<T>) -> bool

This method tests for !=.

impl<T: Copy + PartialOrd + Num> TryBoundingBox<T> for Path<T>

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

Compute the bounding box of this path. The returned bounding box is not necessarily the smallest bounding box.

TODO: Find a better approximation.

impl<T: CoordinateType + NumCast, Dst: CoordinateType + NumCast> TryCastCoord<T, Dst> for Path<T>

type Output = Path<Dst>

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

fn try_cast(&self) -> Option<Self::Output>

Try to cast to target data type.

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

Cast to target data type.

impl<T: Eq> Eq for Path<T>

impl<T> StructuralEq for Path<T>

impl<T> StructuralPartialEq for Path<T>