pub struct CubicBezierSegment<S> {
pub from: Point<S>,
pub ctrl1: Point<S>,
pub ctrl2: Point<S>,
pub to: Point<S>,
}
Expand description
A 2d curve segment defined by four points: the beginning of the segment, two control points and the end of the segment.
The curve is defined by equation:²
∀ t ∈ [0..1], P(t) = (1 - t)³ * from + 3 * (1 - t)² * t * ctrl1 + 3 * t² * (1 - t) * ctrl2 + t³ * to
Fields§
§from: Point<S>
§ctrl1: Point<S>
§ctrl2: Point<S>
§to: Point<S>
Implementations§
source§impl<S: Scalar> CubicBezierSegment<S>
impl<S: Scalar> CubicBezierSegment<S>
sourcepub fn x(&self, t: S) -> S
pub fn x(&self, t: S) -> S
Sample the x coordinate of the curve 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 curve at t (expecting t between 0 and 1).
sourcepub fn solve_t_for_x(&self, x: S) -> ArrayVec<S, 3>
pub fn solve_t_for_x(&self, x: S) -> ArrayVec<S, 3>
Return the parameter values corresponding to a given x coordinate.
sourcepub fn solve_t_for_y(&self, y: S) -> ArrayVec<S, 3>
pub fn solve_t_for_y(&self, y: S) -> ArrayVec<S, 3>
Return the parameter values corresponding to a given y coordinate.
sourcepub fn derivative(&self, t: S) -> Vector<S>
pub fn derivative(&self, t: S) -> Vector<S>
Sample the curve’s derivative at t (expecting t between 0 and 1).
sourcepub fn dx(&self, t: S) -> S
pub fn dx(&self, t: S) -> S
Sample the x coordinate of the curve’s derivative at t (expecting t between 0 and 1).
sourcepub fn dy(&self, t: S) -> S
pub fn dy(&self, t: S) -> S
Sample the y coordinate of the curve’s derivative at t (expecting t between 0 and 1).
sourcepub fn split_range(&self, t_range: Range<S>) -> Self
pub fn split_range(&self, t_range: Range<S>) -> Self
Return the sub-curve inside a given range of t.
This is equivalent to splitting at the range’s end points.
sourcepub fn split(&self, t: S) -> (CubicBezierSegment<S>, CubicBezierSegment<S>)
pub fn split(&self, t: S) -> (CubicBezierSegment<S>, CubicBezierSegment<S>)
Split this curve into two sub-curves.
sourcepub fn before_split(&self, t: S) -> CubicBezierSegment<S>
pub fn before_split(&self, t: S) -> CubicBezierSegment<S>
Return the curve before the split point.
sourcepub fn after_split(&self, t: S) -> CubicBezierSegment<S>
pub fn after_split(&self, t: S) -> CubicBezierSegment<S>
Return the curve after the split point.
pub fn baseline(&self) -> LineSegment<S>
sourcepub fn is_linear(&self, tolerance: S) -> bool
pub fn is_linear(&self, tolerance: S) -> bool
Returns true if the curve can be approximated with a single line segment, given a tolerance threshold.
sourcepub fn fat_line(&self) -> (LineEquation<S>, LineEquation<S>)
pub fn fat_line(&self) -> (LineEquation<S>, LineEquation<S>)
Computes a “fat line” of this segment.
A fat line is two conservative lines between which the segment is fully contained.
sourcepub fn transformed<T: Transformation<S>>(&self, transform: &T) -> Self
pub fn transformed<T: Transformation<S>>(&self, transform: &T) -> Self
Applies the transform to this curve and returns the results.
sourcepub fn to_quadratic(&self) -> QuadraticBezierSegment<S>
pub fn to_quadratic(&self) -> QuadraticBezierSegment<S>
Approximate the curve with a single quadratic bézier segment.
This is terrible as a general approximation but works if the cubic curve does not have inflection points and is “flat” enough. Typically usable after subdividing the curve a few times.
sourcepub fn to_quadratic_error(&self) -> S
pub fn to_quadratic_error(&self) -> S
Evaluates an upper bound on the maximum distance between the curve
and its quadratic approximation obtained using to_quadratic
.
sourcepub fn is_quadratic(&self, tolerance: S) -> bool
pub fn is_quadratic(&self, tolerance: S) -> bool
Returns true if the curve can be safely approximated with a single quadratic bézier segment given the provided tolerance threshold.
Equivalent to comparing to_quadratic_error
with the tolerance threshold, avoiding
the cost of two square roots.
sourcepub fn num_quadratics(&self, tolerance: S) -> u32
pub fn num_quadratics(&self, tolerance: S) -> u32
Computes the number of quadratic bézier segments required to approximate this cubic curve given a tolerance threshold.
Derived by Raph Levien from section 10.6 of Sedeberg’s CAGD notes https://scholarsarchive.byu.edu/cgi/viewcontent.cgi?article=1000&context=facpub#section.10.6 and the error metric from the caffein owl blog post http://caffeineowl.com/graphics/2d/vectorial/cubic2quad01.html
sourcepub fn flattened(&self, tolerance: S) -> Flattened<S> ⓘ
pub fn flattened(&self, tolerance: S) -> Flattened<S> ⓘ
Returns the flattened representation of the curve as an iterator, starting after the current point.
sourcepub fn for_each_monotonic_range<F>(&self, cb: &mut F)
pub fn for_each_monotonic_range<F>(&self, cb: &mut F)
Invokes a callback for each monotonic part of the segment.
sourcepub fn for_each_monotonic<F>(&self, cb: &mut F)where
F: FnMut(&CubicBezierSegment<S>),
pub fn for_each_monotonic<F>(&self, cb: &mut F)where
F: FnMut(&CubicBezierSegment<S>),
Invokes a callback for each monotonic part of the segment.
sourcepub fn for_each_y_monotonic_range<F>(&self, cb: &mut F)
pub fn for_each_y_monotonic_range<F>(&self, cb: &mut F)
Invokes a callback for each y-monotonic part of the segment.
sourcepub fn for_each_y_monotonic<F>(&self, cb: &mut F)where
F: FnMut(&CubicBezierSegment<S>),
pub fn for_each_y_monotonic<F>(&self, cb: &mut F)where
F: FnMut(&CubicBezierSegment<S>),
Invokes a callback for each y-monotonic part of the segment.
sourcepub fn for_each_x_monotonic_range<F>(&self, cb: &mut F)
pub fn for_each_x_monotonic_range<F>(&self, cb: &mut F)
Invokes a callback for each x-monotonic part of the segment.
sourcepub fn for_each_x_monotonic<F>(&self, cb: &mut F)where
F: FnMut(&CubicBezierSegment<S>),
pub fn for_each_x_monotonic<F>(&self, cb: &mut F)where
F: FnMut(&CubicBezierSegment<S>),
Invokes a callback for each x-monotonic part of the segment.
sourcepub fn for_each_quadratic_bezier<F>(&self, tolerance: S, cb: &mut F)where
F: FnMut(&QuadraticBezierSegment<S>),
pub fn for_each_quadratic_bezier<F>(&self, tolerance: S, cb: &mut F)where
F: FnMut(&QuadraticBezierSegment<S>),
Approximates the cubic bézier curve with sequence of quadratic ones, invoking a callback at each step.
sourcepub fn for_each_quadratic_bezier_with_t<F>(&self, tolerance: S, cb: &mut F)
pub fn for_each_quadratic_bezier_with_t<F>(&self, tolerance: S, cb: &mut F)
Approximates the cubic bézier curve with sequence of quadratic ones, invoking a callback at each step.
sourcepub fn for_each_flattened<F: FnMut(&LineSegment<S>)>(
&self,
tolerance: S,
callback: &mut F,
)
pub fn for_each_flattened<F: FnMut(&LineSegment<S>)>( &self, tolerance: S, callback: &mut F, )
Approximates the curve with sequence of line segments.
The tolerance
parameter defines the maximum distance between the curve and
its approximation.
sourcepub fn for_each_flattened_with_t<F: FnMut(&LineSegment<S>, Range<S>)>(
&self,
tolerance: S,
callback: &mut F,
)
pub fn for_each_flattened_with_t<F: FnMut(&LineSegment<S>, Range<S>)>( &self, tolerance: S, callback: &mut F, )
Approximates the curve with sequence of line segments.
The tolerance
parameter defines the maximum distance between the curve and
its approximation.
The end of the t parameter range at the final segment is guaranteed to be equal to 1.0
.
sourcepub fn approximate_length(&self, tolerance: S) -> S
pub fn approximate_length(&self, tolerance: S) -> S
Compute the length of the segment using a flattened approximation.
sourcepub fn for_each_inflection_t<F>(&self, cb: &mut F)where
F: FnMut(S),
pub fn for_each_inflection_t<F>(&self, cb: &mut F)where
F: FnMut(S),
Invokes a callback at each inflection point if any.
sourcepub fn for_each_local_x_extremum_t<F>(&self, cb: &mut F)where
F: FnMut(S),
pub fn for_each_local_x_extremum_t<F>(&self, cb: &mut F)where
F: FnMut(S),
Return local x extrema or None if this curve is monotonic.
This returns the advancements along the curve, not the actual x position.
sourcepub fn for_each_local_y_extremum_t<F>(&self, cb: &mut F)where
F: FnMut(S),
pub fn for_each_local_y_extremum_t<F>(&self, cb: &mut F)where
F: FnMut(S),
Return local y extrema or None if this curve is monotonic.
This returns the advancements along the curve, not the actual y position.
sourcepub fn y_maximum_t(&self) -> S
pub fn y_maximum_t(&self) -> S
Find the advancement of the y-most position in the curve.
This returns the advancement along the curve, not the actual y position.
sourcepub fn y_minimum_t(&self) -> S
pub fn y_minimum_t(&self) -> S
Find the advancement of the y-least position in the curve.
This returns the advancement along the curve, not the actual y position.
sourcepub fn x_maximum_t(&self) -> S
pub fn x_maximum_t(&self) -> S
Find the advancement of the x-most position in the curve.
This returns the advancement along the curve, not the actual x position.
sourcepub fn x_minimum_t(&self) -> S
pub fn x_minimum_t(&self) -> S
Find the x-least position in the curve.
sourcepub fn fast_bounding_box(&self) -> Box2D<S>
pub fn fast_bounding_box(&self) -> Box2D<S>
Returns a conservative rectangle the curve is contained in.
This method is faster than bounding_box
but more conservative.
sourcepub fn fast_bounding_range_x(&self) -> (S, S)
pub fn fast_bounding_range_x(&self) -> (S, S)
Returns a conservative range of x that contains this curve.
sourcepub fn fast_bounding_range_y(&self) -> (S, S)
pub fn fast_bounding_range_y(&self) -> (S, S)
Returns a conservative range of y that contains this curve.
sourcepub fn bounding_box(&self) -> Box2D<S>
pub fn bounding_box(&self) -> Box2D<S>
Returns a conservative rectangle that contains the curve.
sourcepub fn bounding_range_x(&self) -> (S, S)
pub fn bounding_range_x(&self) -> (S, S)
Returns the smallest range of x that contains this curve.
sourcepub fn bounding_range_y(&self) -> (S, S)
pub fn bounding_range_y(&self) -> (S, S)
Returns the smallest range of y that contains this curve.
sourcepub fn is_x_monotonic(&self) -> bool
pub fn is_x_monotonic(&self) -> bool
Returns whether this segment is monotonic on the x axis.
sourcepub fn is_y_monotonic(&self) -> bool
pub fn is_y_monotonic(&self) -> bool
Returns whether this segment is monotonic on the y axis.
sourcepub fn is_monotonic(&self) -> bool
pub fn is_monotonic(&self) -> bool
Returns whether this segment is fully monotonic.
sourcepub fn cubic_intersections_t(
&self,
curve: &CubicBezierSegment<S>,
) -> ArrayVec<(S, S), 9>
pub fn cubic_intersections_t( &self, curve: &CubicBezierSegment<S>, ) -> ArrayVec<(S, S), 9>
Computes the intersections (if any) between this segment and another one.
The result is provided in the form of the t
parameters of each point along the curves. To
get the intersection points, sample the curves at the corresponding values.
Returns endpoint intersections where an endpoint intersects the interior of the other curve, but not endpoint/endpoint intersections.
Returns no intersections if either curve is a point.
sourcepub fn cubic_intersections(
&self,
curve: &CubicBezierSegment<S>,
) -> ArrayVec<Point<S>, 9>
pub fn cubic_intersections( &self, curve: &CubicBezierSegment<S>, ) -> ArrayVec<Point<S>, 9>
Computes the intersection points (if any) between this segment and another one.
sourcepub fn quadratic_intersections_t(
&self,
curve: &QuadraticBezierSegment<S>,
) -> ArrayVec<(S, S), 9>
pub fn quadratic_intersections_t( &self, curve: &QuadraticBezierSegment<S>, ) -> ArrayVec<(S, S), 9>
Computes the intersections (if any) between this segment a quadratic bézier segment.
The result is provided in the form of the t
parameters of each point along the curves. To
get the intersection points, sample the curves at the corresponding values.
Returns endpoint intersections where an endpoint intersects the interior of the other curve, but not endpoint/endpoint intersections.
Returns no intersections if either curve is a point.
sourcepub fn quadratic_intersections(
&self,
curve: &QuadraticBezierSegment<S>,
) -> ArrayVec<Point<S>, 9>
pub fn quadratic_intersections( &self, curve: &QuadraticBezierSegment<S>, ) -> ArrayVec<Point<S>, 9>
Computes the intersection points (if any) between this segment and a quadratic bézier segment.
sourcepub fn line_intersections_t(&self, line: &Line<S>) -> ArrayVec<S, 3>
pub fn line_intersections_t(&self, line: &Line<S>) -> ArrayVec<S, 3>
Computes the intersections (if any) between this segment and a line.
The result is provided in the form of the t
parameters of each
point along curve. To get the intersection points, sample the curve
at the corresponding values.
sourcepub fn line_intersections(&self, line: &Line<S>) -> ArrayVec<Point<S>, 3>
pub fn line_intersections(&self, line: &Line<S>) -> ArrayVec<Point<S>, 3>
Computes the intersection points (if any) between this segment and a line.
sourcepub fn line_segment_intersections_t(
&self,
segment: &LineSegment<S>,
) -> ArrayVec<(S, S), 3>
pub fn line_segment_intersections_t( &self, segment: &LineSegment<S>, ) -> ArrayVec<(S, S), 3>
Computes the intersections (if any) between this segment and a line segment.
The result is provided in the form of the t
parameters of each
point along curve and segment. To get the intersection points, sample
the segments at the corresponding values.
pub fn from(&self) -> Point<S>
pub fn to(&self) -> Point<S>
pub fn line_segment_intersections( &self, segment: &LineSegment<S>, ) -> ArrayVec<Point<S>, 3>
pub fn drag(&self, t: S, new_position: Point<S>) -> Self
pub fn drag_with_weight(&self, t: S, new_position: Point<S>, weight: S) -> Self
pub fn to_f32(&self) -> CubicBezierSegment<f32>
pub fn to_f64(&self) -> CubicBezierSegment<f64>
Trait Implementations§
source§impl<S: Clone> Clone for CubicBezierSegment<S>
impl<S: Clone> Clone for CubicBezierSegment<S>
source§fn clone(&self) -> CubicBezierSegment<S>
fn clone(&self) -> CubicBezierSegment<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> Debug for CubicBezierSegment<S>
impl<S: Debug> Debug for CubicBezierSegment<S>
source§impl<S: PartialEq> PartialEq for CubicBezierSegment<S>
impl<S: PartialEq> PartialEq for CubicBezierSegment<S>
source§impl<S: Scalar> Segment for CubicBezierSegment<S>
impl<S: Scalar> Segment for CubicBezierSegment<S>
type Scalar = S
source§fn derivative(&self, t: S) -> Vector<S>
fn derivative(&self, t: S) -> Vector<S>
source§fn before_split(&self, t: S) -> Self
fn before_split(&self, t: S) -> Self
source§fn after_split(&self, t: S) -> Self
fn after_split(&self, t: S) -> Self
source§fn split_range(&self, t_range: Range<S>) -> Self
fn split_range(&self, t_range: Range<S>) -> Self
source§fn approximate_length(&self, tolerance: S) -> S
fn approximate_length(&self, tolerance: S) -> S
source§fn for_each_flattened_with_t(
&self,
tolerance: Self::Scalar,
callback: &mut dyn FnMut(&LineSegment<S>, Range<S>),
)
fn for_each_flattened_with_t( &self, tolerance: Self::Scalar, callback: &mut dyn FnMut(&LineSegment<S>, Range<S>), )
impl<S: Copy> Copy for CubicBezierSegment<S>
impl<S> StructuralPartialEq for CubicBezierSegment<S>
Auto Trait Implementations§
impl<S> Freeze for CubicBezierSegment<S>where
S: Freeze,
impl<S> RefUnwindSafe for CubicBezierSegment<S>where
S: RefUnwindSafe,
impl<S> Send for CubicBezierSegment<S>where
S: Send,
impl<S> Sync for CubicBezierSegment<S>where
S: Sync,
impl<S> Unpin for CubicBezierSegment<S>where
S: Unpin,
impl<S> UnwindSafe for CubicBezierSegment<S>where
S: UnwindSafe,
Blanket Implementations§
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<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
)