Skip to main content

PathBuilder

Struct PathBuilder 

Source
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

Source

pub fn new() -> Self

Creates a new, empty path builder.

§Examples
use martensite_render::PathBuilder;

let builder = PathBuilder::new();
assert!(builder.elements().is_empty());
Source

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);
Source

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);
Source

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);
Source

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);
Source

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);
Source

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);
Source

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

Source§

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)

Performs copy-assignment from source. Read more
Source§

impl Debug for PathBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PathBuilder

Source§

fn default() -> PathBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

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>

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)

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)

Convert &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
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more