Struct frui::prelude::Line

pub struct Line {
    pub p0: Point,
    pub p1: Point,
}

A single line.

Fields

p0: Point

The line’s start point.

p1: Point

The line’s end point.

Implementations

impl Line

pub fn new(p0: impl Into<Point>, p1: impl Into<Point>) -> Line

Create a new line.

pub fn length(self) -> f64

The length of the line.

Trait Implementations

impl Add<Vec2> for Line

type Output = Line

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> Line

Performs the + operation.

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Line

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

Formats the value using the given formatter.

impl From<Line> for PathSeg

fn from(line: Line) -> PathSeg

Converts to this type from the input type.

impl Mul<Line> for Affine

type Output = Line

The resulting type after applying the * operator.

fn mul(self, other: Line) -> Line

Performs the * operation.

impl Mul<Line> for TranslateScale

type Output = Line

The resulting type after applying the * operator.

fn mul(self, other: Line) -> Line

Performs the * operation.

impl ParamCurve for Line

fn eval(&self, t: f64) -> Point

Evaluate the curve at parameter t.

fn start(&self) -> Point

The start point.

fn end(&self) -> Point

The end point.

fn subsegment(&self, range: Range<f64>) -> Line

Get a subsegment of the curve for the given parameter range.

fn subdivide(&self) -> (Self, Self)

Subdivide into (roughly) halves.

impl ParamCurveArclen for Line

fn arclen(&self, _accuracy: f64) -> f64

The arc length of the curve.

fn inv_arclen(&self, arclen: f64, accuracy: f64) -> f64

Solve for the parameter that has the given arclength from the start.

impl ParamCurveArea for Line

fn signed_area(&self) -> f64

Compute the signed area under the curve.

impl ParamCurveCurvature for Line

fn curvature(&self, _t: f64) -> f64

Compute the signed curvature at parameter t.

impl ParamCurveDeriv for Line

type DerivResult = ConstPoint

The parametric curve obtained by taking the derivative of this one.

fn deriv(&self) -> ConstPoint

The derivative of the curve.

fn gauss_arclen(&self, coeffs: &[(f64, f64)]) -> f64

Estimate arclength using Gaussian quadrature.

impl ParamCurveExtrema for Line

fn extrema(&self) -> ArrayVec<[f64; 4]>

Compute the extrema of the curve.

fn extrema_ranges(&self) -> ArrayVec<[Range<f64>; 5]>

Return parameter ranges, each of which is monotonic within the range.

fn bounding_box(&self) -> Rect

The smallest rectangle that encloses the curve in the range (0..1).

impl ParamCurveNearest for Line

fn nearest(&self, p: Point, _accuracy: f64) -> (f64, f64)

Find the point on the curve nearest the given point.

impl PartialEq<Line> for Line

fn eq(&self, other: &Line) -> 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 Scalable for Line

fn to_px(&self, scale: Scale) -> Line

Converts a Line from display points into pixels, using the x axis scale factor for x and the y axis scale factor for y.

fn to_dp(&self, scale: Scale) -> Line

Converts a Line from pixels into display points, using the x axis scale factor for x and the y axis scale factor for y.

impl Shape for Line

fn area(&self) -> f64

Returning zero here is consistent with the contract (area is only meaningful for closed shapes), but an argument can be made that the contract should be tightened to include the Green’s theorem contribution.

fn winding(&self, _pt: Point) -> i32

Same consideration as area.

type PathElementsIter = LinePathIter

The iterator returned by the path_elements method.

fn path_elements(&self, _tolerance: f64) -> LinePathIter

Returns an iterator over this shape expressed as PathEls; that is, as Bézier path elements.

fn perimeter(&self, _accuracy: f64) -> f64

Total length of perimeter.

fn bounding_box(&self) -> Rect

The smallest rectangle that encloses the shape.

fn as_line(&self) -> Option<Line>

If the shape is a line, make it available.

fn to_path(&self, tolerance: f64) -> BezPath

Convert to a Bézier path.

fn into_path(self, tolerance: f64) -> BezPath

Convert into a Bézier path.

fn path_segments(&self, tolerance: f64) -> Segments<Self::PathElementsIter>

Returns an iterator over this shape expressed as Bézier path segments (PathSegs).

fn contains(&self, pt: Point) -> bool

Returns true if the Point is inside this shape.

fn as_rect(&self) -> Option<Rect>

If the shape is a rectangle, make it available.

fn as_rounded_rect(&self) -> Option<RoundedRect>

If the shape is a rounded rectangle, make it available.

fn as_circle(&self) -> Option<Circle>

If the shape is a circle, make it available.

fn as_path_slice(&self) -> Option<&[PathEl]>

If the shape is stored as a slice of path elements, make that available.

impl Sub<Vec2> for Line

type Output = Line

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> Line

Performs the - operation.

impl Copy for Line

impl StructuralPartialEq for Line