Struct blend2d::path::Path

#[repr(transparent)]
pub struct Path { /* fields omitted */ }

A 2D vector path.

Methods

impl Path

pub fn new() -> Self

Creates a new empty path.

pub fn with_capacity(n: usize) -> Self

Creates a new path with space for n elements before having to reallocate.

pub fn clear(&mut self)

Clears the path.

pub fn shrink_to_fit(&mut self)

Shrinks the path's allocated capacity down to its currently used size.

pub fn reserve(&mut self, n: usize)

Reserves capacity for at least n items.

Panics

Panics if blend2d returns an OutOfMemory error

pub fn try_reserve(&mut self, n: usize) -> Result<(), OutOfMemory>

Reserves capacity for at least n items.

pub fn len(&self) -> usize

Returns the current number of vertices in the path.

pub fn capacity(&self) -> usize

Returns the currently allocated capacity of the path.

pub fn is_empty(&self) -> bool

Returns true if the path has no vertices.

pub fn command_data(&self) -> &[u8]

Returns the path's command data.

pub fn vertex_data(&self) -> &[PointD]

Returns the path's vertex data.

pub fn info_flags(&self) -> Option<PathFlags>

Returns this path's flags, or None if its geometry is invalid.

pub fn control_box(&self) -> Option<BoxD>

Retrieves a bounding box of all vertices and control points.

pub fn bounding_box(&self) -> Option<BoxD>

Retrieves a bounding box of all on-path vertices and curve extremas.

pub fn figure_range(&self, index: usize) -> Option<Range<usize>>

Returns the range describing a figure at the given index.

pub fn last_vertex(&self) -> Option<PointD>

pub fn closest_vertex(
    &self,
    p: &PointD,
    max_distance: f64
) -> Option<(usize, f64)>

pub fn hit_test(&self, p: &PointD, fill_rule: FillRule) -> HitTest

Hit tests the given point p by respecting the given FillRule.

pub fn set_vertex_at(&mut self, index: usize, cmd: PathCommand, x: f64, y: f64)

Sets the vertex at the index to the given PathCommand and point.

pub fn set_vertex_at_point(
    &mut self,
    index: usize,
    cmd: PathCommand,
    point: PointD
)

Sets the vertex at the index to the given PathCommand and point.

impl Path

pub fn move_to(&mut self, x: f64, y: f64)

Moves to the point.

pub fn move_to_point(&mut self, point: &PointD)

Moves to the point.

pub fn line_to(&mut self, x: f64, y: f64)

Adds a line from the current to the given point to this path.

pub fn line_to_point(&mut self, point: &PointD)

Adds a line from the current to the given point to this path.

pub fn poly_to(&mut self, poly: &[PointD])

Adds a polyline (LineTo) of the given points.

pub fn quad_to(&mut self, x1: f64, y1: f64, x2: f64, y2: f64)

Adds a quadratic curve to the first and second point.

Matches SVG 'Q' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataQuadraticBezierCommands

pub fn quad_to_points(&mut self, x1: f64, y1: f64, x2: f64, y2: f64)

Adds a quadratic curve to the first and second point.

Matches SVG 'Q' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataQuadraticBezierCommands

pub fn cubic_to(&mut self, x1: f64, y1: f64, x2: f64, y2: f64, x3: f64, y3: f64)

Adds a cubic curve to the first, second and third point.

Matches SVG 'C' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataCubicBezierCommands

pub fn cubic_to_points(&mut self, p1: &PointD, p2: &PointD, p3: &PointD)

Adds a cubic curve to the first, second and third point.

Matches SVG 'C' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataCubicBezierCommands

pub fn smooth_quad_to(&mut self, x2: f64, y2: f64)

Adds a smooth quadratic curve to the given point, calculating the first from previous points.

Matches SVG 'T' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataQuadraticBezierCommands

pub fn smooth_quad_to_point(&mut self, p2: &PointD)

Adds a smooth quadratic curve to the given point, calculating the first from previous points.

Matches SVG 'T' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataQuadraticBezierCommands

pub fn smooth_cubic_to(&mut self, x2: f64, y2: f64, x3: f64, y3: f64)

Adds a smooth cubic curve to the given points, calculating the first from previous points.

Matches SVG 'S' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataCubicBezierCommands

pub fn smooth_cubic_to_points(&mut self, p2: &PointD, p3: &PointD)

Adds a smooth cubic curve to the given points, calculating the first from previous points.

Matches SVG 'S' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataCubicBezierCommands

pub fn arc_to(
    &mut self,
    cx: f64,
    cy: f64,
    rx: f64,
    ry: f64,
    start: f64,
    sweep: f64,
    force_move_to: bool
)

Adds an arc to the path.

The center of the arc is specified by c and radius by r. Both start and sweep angles are in radians. If the last vertex doesn't match the start of the arc then a Path::line_to would be emitted before adding the arc. Pass true in force_move_to to always emit Path::move_to at the beginning of the arc, which starts a new figure.

Path::line_to Path::move_to

pub fn arc_to_points(
    &mut self,
    cp: &PointD,
    rp: &PointD,
    start: f64,
    sweep: f64,
    force_move_to: bool
)

Adds an arc to the path.

The center of the arc is specified by cp and radius by rp. Both start and sweep angles are in radians. If the last vertex doesn't match the start of the arc then a Path::line_to would be emitted before adding the arc. Pass true in force_move_to to always emit Path::move_to at the beginning of the arc, which starts a new figure.

Path::line_to Path::move_to

pub fn arc_quadrant_to(&mut self, x1: f64, y1: f64, x2: f64, y2: f64)

Adds an arc quadrant (90deg) to the path. The first point specifies the quadrant corner and the last point specifies the end point.

pub fn arc_quadrant_to_points(&mut self, p1: &PointD, p2: &PointD)

Adds an arc quadrant (90deg) to the path. The first point specifies the quadrant corner and the last point specifies the end point.

pub fn elliptic_arc_to(
    &mut self,
    rx: f64,
    ry: f64,
    x_axis_rotation: f64,
    large_arc_flag: bool,
    sweep_flag: bool,
    x1: f64,
    y1: f64
)

Adds an elliptic arc to the path that follows the SVG specification.

Matches SVG 'A' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataEllipticalArcCommands

pub fn elliptic_arc_to_points(
    &mut self,
    rp: &PointD,
    x_axis_rotation: f64,
    large_arc_flag: bool,
    sweep_flag: bool,
    p1: &PointD
)

Adds an elliptic arc to the path that follows the SVG specification.

Matches SVG 'A' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataEllipticalArcCommands

pub fn close(&mut self)

Closes the current figure.

Matches SVG 'Z' path command:

• https://www.w3.org/TR/SVG/paths.html#PathDataClosePathCommand

impl Path

pub fn add_geometry<T: Geometry + ?Sized>(
    &mut self,
    g: &T,
    matrix: Option<&Matrix2D>,
    dir: GeometryDirection
)

Adds a Geometry to the path.

pub fn add_polygon<R, P>(
    &mut self,
    p: R,
    matrix: Option<&Matrix2D>,
    dir: GeometryDirection
) where
    R: AsRef<[P]>,
    P: Point + Geometry, 

Adds a polygon.

pub fn add_polyline<R, P>(
    &mut self,
    p: R,
    matrix: Option<&Matrix2D>,
    dir: GeometryDirection
) where
    R: AsRef<[P]>,
    P: Point, 

Adds a polyline.

pub fn add_path(&mut self, other: &Path)

Adds another path.

pub fn add_path_range<R: RangeBounds<usize>>(&mut self, other: &Path, range: R)

Adds a part of another path.

pub fn add_translated_path(&mut self, other: &Path, p: &PointD)

Adds a translated path.

pub fn add_translated_path_range<R: RangeBounds<usize>>(
    &mut self,
    other: &Path,
    range: R,
    p: &PointD
)

Adds a translated part of another path.

pub fn add_transformed_path(&mut self, other: &Path, m: &Matrix2D)

Adds a transformed path.

pub fn add_transformed_path_range<R: RangeBounds<usize>>(
    &mut self,
    other: &Path,
    range: R,
    m: &Matrix2D
)

Adds a transformed part of another path.

pub fn add_reversed_path(&mut self, other: &Path, mode: PathReverseMode)

Adds a reversed path.

pub fn add_reversed_path_range<R: RangeBounds<usize>>(
    &mut self,
    other: &Path,
    range: R,
    mode: PathReverseMode
)

Adds a reversed part of another path.

pub fn add_stroked_path(
    &mut self,
    other: &Path,
    options: &StrokeOptions,
    approx: &ApproximationOptions
)

Adds a stroked path.

pub fn add_stroked_path_range<R: RangeBounds<usize>>(
    &mut self,
    other: &Path,
    range: R,
    options: &StrokeOptions,
    approx: &ApproximationOptions
)

Adds a stroked part of another path.

impl Path

pub fn translate(&mut self, p: &PointD)

Translates the whole path by the given point.

pub fn translate_range<R: RangeBounds<usize>>(&mut self, range: R, p: &PointD)

Translates a part of the path by the given point.

pub fn transform(&mut self, m: &Matrix2D)

Transforms the whole path by the given transformation matrix.

pub fn transform_range<R: RangeBounds<usize>>(&mut self, range: R, m: &Matrix2D)

Transforms a part of the path by the given transformation matrix.

pub fn fit_to(&mut self, rect: &RectD, flags: PathFitFlags)

Fits the whole path into the given rect by taking into account fit flags passed by PathFitFlags.

pub fn fit_to_range<R: RangeBounds<usize>>(
    &mut self,
    range: R,
    rect: &RectD,
    flags: PathFitFlags
)

Fits a part of the path specified by the given range into the given rect by taking into account the given PathFitFlags.

Trait Implementations

impl DeepClone for Path

const ASSIGN_DEEP: unsafe extern "C" fn(_: *mut Self::Core, _: *const Self::Core) -> BLResult

fn clone_deep(&self) -> Self

Returns a deeply cloned copy of the value.

impl Geometry for Path

const GEO_TYPE: u32

impl PartialEq<Path> for Path

fn eq(&self, other: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for Path

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<[PointD]> for Path

fn as_ref(&self) -> &[PointD]

Performs the conversion.

impl Default for Path

fn default() -> Self

Returns the "default value" for a type.

impl Drop for Path

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Path

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

Formats the value using the given formatter.

impl Borrow<[PointD]> for Path

fn borrow(&self) -> &[PointD]

Immutably borrows from an owned value.