pub struct PathBuilder { /* private fields */ }Expand description
A helper for incrementally constructing a kurbo::BezPath.
This is a thin convenience wrapper around BezPath that records the
current subpath state and provides ergonomic builder methods. It is purely
advisory — the underlying BezPath can always be extracted with
PathBuilder::build.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.line_to(Point::new(10.0, 0.0));
builder.quad_to(Point::new(15.0, 5.0), Point::new(10.0, 10.0));
builder.line_to(Point::new(0.0, 10.0));
builder.close_path();
let path = builder.build();
// move + 2 lines + quad + close = 5 elements.
assert_eq!(path.elements().len(), 5);Implementations§
Source§impl PathBuilder
impl PathBuilder
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new, empty path builder.
§Examples
use martensite_render::PathBuilder;
let builder = PathBuilder::new();
assert!(builder.elements().is_empty());Sourcepub fn move_to(&mut self, p: Point)
pub fn move_to(&mut self, p: Point)
Begins a new subpath at p.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(5.0, 5.0));
assert_eq!(builder.elements().len(), 1);Sourcepub fn line_to(&mut self, p: Point)
pub fn line_to(&mut self, p: Point)
Adds a line segment to p.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.line_to(Point::new(10.0, 0.0));
assert_eq!(builder.elements().len(), 2);Sourcepub fn quad_to(&mut self, p1: Point, p2: Point)
pub fn quad_to(&mut self, p1: Point, p2: Point)
Adds a quadratic Bézier segment with control point p1 and end p2.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.quad_to(Point::new(5.0, 5.0), Point::new(10.0, 0.0));
assert_eq!(builder.elements().len(), 2);Sourcepub fn curve_to(&mut self, p1: Point, p2: Point, p3: Point)
pub fn curve_to(&mut self, p1: Point, p2: Point, p3: Point)
Adds a cubic Bézier segment with control points p1, p2 and end p3.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.curve_to(
Point::new(5.0, 0.0),
Point::new(10.0, 5.0),
Point::new(15.0, 0.0),
);
assert_eq!(builder.elements().len(), 2);Sourcepub fn close_path(&mut self)
pub fn close_path(&mut self)
Closes the current subpath.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.line_to(Point::new(10.0, 0.0));
builder.close_path();
// move + line + close = 3 elements
assert_eq!(builder.elements().len(), 3);Sourcepub fn elements(&self) -> &[PathEl]
pub fn elements(&self) -> &[PathEl]
Returns a reference to the underlying path elements.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.line_to(Point::new(10.0, 0.0));
let elements = builder.elements();
assert_eq!(elements.len(), 2);Sourcepub fn build(self) -> BezPath
pub fn build(self) -> BezPath
Finalizes the builder and returns the constructed BezPath.
§Examples
use martensite_render::PathBuilder;
use kurbo::Point;
let mut builder = PathBuilder::new();
builder.move_to(Point::new(0.0, 0.0));
builder.line_to(Point::new(10.0, 0.0));
builder.close_path();
let path = builder.build();
// move + line + close = 3 elements
assert_eq!(path.elements().len(), 3);Trait Implementations§
Source§impl Clone for PathBuilder
impl Clone for PathBuilder
Source§fn clone(&self) -> PathBuilder
fn clone(&self) -> PathBuilder
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for PathBuilder
impl Debug for PathBuilder
Source§impl Default for PathBuilder
impl Default for PathBuilder
Source§fn default() -> PathBuilder
fn default() -> PathBuilder
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for PathBuilder
impl RefUnwindSafe for PathBuilder
impl Send for PathBuilder
impl Sync for PathBuilder
impl Unpin for PathBuilder
impl UnsafeUnpin for PathBuilder
impl UnwindSafe for PathBuilder
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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>
Convert
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>
Convert
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)
Convert
&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)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.