Struct rten_imageproc::Line

pub struct Line<T: Coord = i32> {
    pub start: Point<T>,
    pub end: Point<T>,
}

A bounded line segment defined by a start and end point.

Fields

start: Point<T>

end: Point<T>

Implementations

impl<T: Coord> Line<T>

pub fn from_endpoints(start: Point<T>, end: Point<T>) -> Line<T>

pub fn is_empty(&self) -> bool

Return true if this line has zero length.

pub fn width(&self) -> T

Return the difference between the starting and ending X coordinates of the line.

pub fn height(&self) -> T

Return the difference between the starting and ending Y coordinates of the line.

pub fn is_horizontal(&self) -> bool

Return true if the Y coordinate of the line’s start and end points are the same.

pub fn reverse(&self) -> Line<T>

Return a copy of this line with the start and end points swapped.

pub fn downwards(&self) -> Line<T>

Return a copy of this line with the same endpoints but swapped if needed so that end.y >= start.y.

pub fn rightwards(&self) -> Line<T>

Return a copy of this line with the same endpoints but swapped if needed so that end.x >= start.x.

pub fn vertical_overlap(&self, other: Line<T>) -> T

Return the number of pixels by which this line overlaps other in the vertical direction.

pub fn horizontal_overlap(&self, other: Line<T>) -> T

Return the number of pixels by which this line overlaps other in the horizontal direction.

impl Line<f32>

pub fn distance(&self, p: PointF) -> f32

Return the euclidean distance between a point and the closest coordinate that lies on the line.

pub fn intersects(&self, other: Line<f32>) -> bool

Test whether this line segment intersects other at a single point.

Returns false if the line segments do not intersect, or are coincident (ie. overlap for part of their lengths).

impl Line<f32>

pub fn center(&self) -> PointF

Return the midpoint between the start and end points of the line.

pub fn x_for_y(&self, y: f32) -> Option<f32>

Return the X coordinate that corresponds to a given Y coordinate on the line.

Returns None if the Y coordinate is not on the line or the line is horizontal.

pub fn y_for_x(&self, x: f32) -> Option<f32>

Return the Y coordinate that corresponds to a given X coordinate on the line.

Returns None if the X coordinate is not on the line or the line is vertical.

impl Line<i32>

pub fn to_f32(&self) -> LineF

pub fn distance(&self, p: Point) -> f32

Return the euclidean distance between a point and the closest coordinate that lies on the line.

pub fn intersects(&self, other: Line) -> bool

Test whether this line segment intersects other at a single point.

Returns false if the line segments do not intersect, or are coincident (ie. overlap for part of their lengths).

Trait Implementations

impl<T: Coord> BoundingRect for Line<T>

type Coord = T

Coordinate type of bounding rect.

fn bounding_rect(&self) -> Rect<T>

Return the smallest axis-aligned bounding rect which contains this shape.

impl<T: Clone + Coord> Clone for Line<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Coord> Debug for Line<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Coord> PartialEq for Line<T>

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

impl<T: Coord> StructuralPartialEq for Line<T>