pub struct LineSegment<S> {
pub from: Point2D<S, UnknownUnit>,
pub to: Point2D<S, UnknownUnit>,
}
Expand description
A linear segment.
Fields§
§from: Point2D<S, UnknownUnit>
§to: Point2D<S, UnknownUnit>
Implementations§
source§impl<S> LineSegment<S>where
S: Scalar,
impl<S> LineSegment<S>where
S: Scalar,
sourcepub fn sample(&self, t: S) -> Point2D<S, UnknownUnit>
pub fn sample(&self, t: S) -> Point2D<S, UnknownUnit>
Sample the segment at t (expecting t between 0 and 1).
sourcepub fn x(&self, t: S) -> S
pub fn x(&self, t: S) -> S
Sample the x coordinate of the segment at t (expecting t between 0 and 1).
sourcepub fn y(&self, t: S) -> S
pub fn y(&self, t: S) -> S
Sample the y coordinate of the segment at t (expecting t between 0 and 1).
pub fn from(&self) -> Point2D<S, UnknownUnit>
pub fn to(&self) -> Point2D<S, UnknownUnit>
pub fn solve_t_for_x(&self, x: S) -> S
pub fn solve_t_for_y(&self, y: S) -> S
pub fn solve_y_for_x(&self, x: S) -> S
pub fn solve_x_for_y(&self, y: S) -> S
sourcepub fn flip(&self) -> LineSegment<S>
pub fn flip(&self) -> LineSegment<S>
Returns an inverted version of this segment where the beginning and the end points are swapped.
sourcepub fn split_range(&self, t_range: Range<S>) -> LineSegment<S>
pub fn split_range(&self, t_range: Range<S>) -> LineSegment<S>
Return the sub-segment inside a given range of t.
This is equivalent splitting at the range’s end points.
sourcepub fn split(&self, t: S) -> (LineSegment<S>, LineSegment<S>)
pub fn split(&self, t: S) -> (LineSegment<S>, LineSegment<S>)
Split this curve into two sub-segments.
sourcepub fn before_split(&self, t: S) -> LineSegment<S>
pub fn before_split(&self, t: S) -> LineSegment<S>
Return the segment before the split point.
sourcepub fn after_split(&self, t: S) -> LineSegment<S>
pub fn after_split(&self, t: S) -> LineSegment<S>
Return the segment after the split point.
pub fn split_at_x(&self, x: S) -> (LineSegment<S>, LineSegment<S>)
sourcepub fn bounding_box(&self) -> Box2D<S, UnknownUnit>
pub fn bounding_box(&self) -> Box2D<S, UnknownUnit>
Return the smallest rectangle containing this segment.
sourcepub fn to_vector(&self) -> Vector2D<S, UnknownUnit>
pub fn to_vector(&self) -> Vector2D<S, UnknownUnit>
Returns the vector between this segment’s from
and to
points.
sourcepub fn square_length(&self) -> S
pub fn square_length(&self) -> S
Computes the squared length of this segment.
sourcepub fn set_length(&mut self, new_length: S)
pub fn set_length(&mut self, new_length: S)
Changes the segment’s length, moving destination point.
sourcepub fn mid_point(&mut self) -> Point2D<S, UnknownUnit>
pub fn mid_point(&mut self) -> Point2D<S, UnknownUnit>
Computes third mid-point of this segment.
pub fn translate(&mut self, by: Vector2D<S, UnknownUnit>) -> LineSegment<S>
sourcepub fn transformed<T>(&self, transform: &T) -> LineSegment<S>where
T: Transformation<S>,
pub fn transformed<T>(&self, transform: &T) -> LineSegment<S>where
T: Transformation<S>,
Applies the transform to this segment and returns the results.
sourcepub fn intersection_t(&self, other: &LineSegment<S>) -> Option<(S, S)>
pub fn intersection_t(&self, other: &LineSegment<S>) -> Option<(S, S)>
Computes the intersection (if any) between this segment and another one.
The result is provided in the form of the t
parameter of each
segment. To get the intersection point, sample one of the segments
at the corresponding value.
pub fn intersection( &self, other: &LineSegment<S>, ) -> Option<Point2D<S, UnknownUnit>>
pub fn line_intersection_t(&self, line: &Line<S>) -> Option<S>
pub fn line_intersection( &self, line: &Line<S>, ) -> Option<Point2D<S, UnknownUnit>>
pub fn horizontal_line_intersection_t(&self, y: S) -> Option<S>
pub fn vertical_line_intersection_t(&self, x: S) -> Option<S>
pub fn horizontal_line_intersection( &self, y: S, ) -> Option<Point2D<S, UnknownUnit>>
pub fn vertical_line_intersection( &self, x: S, ) -> Option<Point2D<S, UnknownUnit>>
pub fn intersects(&self, other: &LineSegment<S>) -> bool
pub fn intersects_line(&self, line: &Line<S>) -> bool
pub fn overlaps_line(&self, line: &Line<S>) -> bool
pub fn overlaps_segment(&self, other: &LineSegment<S>) -> bool
pub fn contains_segment(&self, other: &LineSegment<S>) -> bool
sourcepub fn clipped_x(&self, clip: Range<S>) -> Option<LineSegment<S>>
pub fn clipped_x(&self, clip: Range<S>) -> Option<LineSegment<S>>
Horizontally clip this segment against a range of the x axis.
sourcepub fn clipped_y(&self, clip: Range<S>) -> Option<LineSegment<S>>
pub fn clipped_y(&self, clip: Range<S>) -> Option<LineSegment<S>>
Vertically clip this segment against a range of the y axis.
sourcepub fn clipped(&self, clip: &Box2D<S, UnknownUnit>) -> Option<LineSegment<S>>
pub fn clipped(&self, clip: &Box2D<S, UnknownUnit>) -> Option<LineSegment<S>>
Clip this segment against a rectangle.
sourcepub fn distance_to_point(&self, p: Point2D<S, UnknownUnit>) -> S
pub fn distance_to_point(&self, p: Point2D<S, UnknownUnit>) -> S
Computes the distance between this segment and a point.
sourcepub fn square_distance_to_point(&self, p: Point2D<S, UnknownUnit>) -> S
pub fn square_distance_to_point(&self, p: Point2D<S, UnknownUnit>) -> S
Computes the squared distance between this segment and a point.
Can be useful to save a square root and a division when comparing against a distance that can be squared.
sourcepub fn closest_point(
&self,
p: Point2D<S, UnknownUnit>,
) -> Point2D<S, UnknownUnit>
pub fn closest_point( &self, p: Point2D<S, UnknownUnit>, ) -> Point2D<S, UnknownUnit>
Computes the closest point on this segment to p
.
pub fn to_f32(&self) -> LineSegment<f32>
pub fn to_f64(&self) -> LineSegment<f64>
Trait Implementations§
source§impl<S> Clone for LineSegment<S>where
S: Clone,
impl<S> Clone for LineSegment<S>where
S: Clone,
source§fn clone(&self) -> LineSegment<S>
fn clone(&self) -> LineSegment<S>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<S> Debug for LineSegment<S>where
S: Debug,
impl<S> Debug for LineSegment<S>where
S: Debug,
source§impl<S> PartialEq for LineSegment<S>where
S: PartialEq,
impl<S> PartialEq for LineSegment<S>where
S: PartialEq,
source§impl<S> Segment for LineSegment<S>where
S: Scalar,
impl<S> Segment for LineSegment<S>where
S: Scalar,
type Scalar = S
source§fn from(&self) -> Point2D<S, UnknownUnit>
fn from(&self) -> Point2D<S, UnknownUnit>
source§fn to(&self) -> Point2D<S, UnknownUnit>
fn to(&self) -> Point2D<S, UnknownUnit>
source§fn sample(&self, t: S) -> Point2D<S, UnknownUnit>
fn sample(&self, t: S) -> Point2D<S, UnknownUnit>
source§fn derivative(&self, _t: S) -> Vector2D<S, UnknownUnit>
fn derivative(&self, _t: S) -> Vector2D<S, UnknownUnit>
source§fn split(&self, t: S) -> (LineSegment<S>, LineSegment<S>)
fn split(&self, t: S) -> (LineSegment<S>, LineSegment<S>)
source§fn before_split(&self, t: S) -> LineSegment<S>
fn before_split(&self, t: S) -> LineSegment<S>
source§fn after_split(&self, t: S) -> LineSegment<S>
fn after_split(&self, t: S) -> LineSegment<S>
source§fn split_range(&self, t_range: Range<S>) -> LineSegment<S>
fn split_range(&self, t_range: Range<S>) -> LineSegment<S>
source§fn flip(&self) -> LineSegment<S>
fn flip(&self) -> LineSegment<S>
source§fn approximate_length(&self, _tolerance: S) -> S
fn approximate_length(&self, _tolerance: S) -> S
source§fn for_each_flattened_with_t(
&self,
_tolerance: <LineSegment<S> as Segment>::Scalar,
callback: &mut dyn FnMut(&LineSegment<S>, Range<S>),
)
fn for_each_flattened_with_t( &self, _tolerance: <LineSegment<S> as Segment>::Scalar, callback: &mut dyn FnMut(&LineSegment<S>, Range<S>), )
impl<S> Copy for LineSegment<S>where
S: Copy,
impl<S> StructuralPartialEq for LineSegment<S>
Auto Trait Implementations§
impl<S> Freeze for LineSegment<S>where
S: Freeze,
impl<S> RefUnwindSafe for LineSegment<S>where
S: RefUnwindSafe,
impl<S> Send for LineSegment<S>where
S: Send,
impl<S> Sync for LineSegment<S>where
S: Sync,
impl<S> Unpin for LineSegment<S>where
S: Unpin,
impl<S> UnwindSafe for LineSegment<S>where
S: UnwindSafe,
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more