Struct lyon_path::Path

source ·
pub struct Path { /* private fields */ }
Expand description

A simple path data structure.

§Custom attributes

Paths can store a fixed number of extra f32 values per endpoint, called “custom attributes” or “interpolated attributes” through the documentation. These can be handy to represent arbitrary attributes such as variable colors, line width, etc.

See also:

§Representation

Paths contain two buffers:

  • a buffer of commands (Begin, Line, Quadratic, Cubic, Close or End),
  • and a buffer of pairs of floats that can be endpoints control points or custom attributes.

The order of storage for points is determined by the sequence of commands. Custom attributes (if any) always directly follow endpoints. If there is an odd number of attributes, the last float of the each attribute sequence is set to zero and is not used.

 __________________________
|       |      |         |
| Begin | Line |Quadratic| ...
|_______|______|_________|_
 __________________________________________________________________________
|         |          |         |          |         |         |          |
|start x,y|attributes| to x, y |attributes|ctrl x,y | to x, y |attributes| ...
|_________|__________|_________|__________|_________|_________|__________|_

Implementations§

source§

impl Path

source

pub fn builder() -> Builder

Creates a Builder to build a path.

source

pub fn builder_with_attributes(num_attributes: usize) -> BuilderWithAttributes

Creates a BuilderWithAttributes to build a path with custom attributes.

source

pub fn svg_builder() -> WithSvg<BuilderImpl>

Creates an WithSvg to build a path with a rich set of commands.

source

pub fn new() -> Path

Creates an Empty Path.

source

pub fn with_attributes(num_attributes: usize) -> Path

source

pub fn as_slice(&self) -> PathSlice<'_>

Returns a view on this Path.

source

pub fn attributes(&self, endpoint: EndpointId) -> Attributes<'_>

Returns a slice over an endpoint’s custom attributes.

source

pub fn iter(&self) -> Iter<'_>

Iterates over the entire Path, ignoring custom attributes.

source

pub fn id_iter(&self) -> IdIter<'_>

Iterates over the endpoint and control point ids of the Path.

source

pub fn iter_with_attributes(&self) -> IterWithAttributes<'_>

Iterates over the entire Path with custom attributes.

source

pub fn transformed<T: Transformation<f32>>(self, transform: &T) -> Self

Applies a transform to all endpoints and control points of this path and Returns the result.

source

pub fn reversed(&self) -> IterNoAttributes<Reversed<'_>>

Returns a reversed version of this path in the form of an iterator

source

pub fn first_endpoint(&self) -> Option<(Point, Attributes<'_>)>

Returns the first endpoint and its custom attributes if any.

source

pub fn last_endpoint(&self) -> Option<(Point, Attributes<'_>)>

Returns the last endpoint and its custom attributes if any.

Trait Implementations§

source§

impl AttributeStore for Path

source§

fn get(&self, id: EndpointId) -> Attributes<'_>

Returns the endpoint’s custom attributes as a slice of 32 bits floats. Read more
source§

fn num_attributes(&self) -> usize

Returns the number of float attributes per endpoint. Read more
source§

impl Clone for Path

source§

fn clone(&self) -> Path

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Path

source§

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

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

impl Default for Path

source§

fn default() -> Path

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

impl<'l> From<&'l Path> for PathSlice<'l>

source§

fn from(path: &'l Path) -> Self

Converts to this type from the input type.
source§

impl FromIterator<Event<Point2D<f32, UnknownUnit>, Point2D<f32, UnknownUnit>>> for Path

source§

fn from_iter<T: IntoIterator<Item = PathEvent>>(iter: T) -> Path

Creates a value from an iterator. Read more
source§

impl Index<ControlPointId> for Path

source§

type Output = Point2D<f32, UnknownUnit>

The returned type after indexing.
source§

fn index(&self, id: ControlPointId) -> &Point

Performs the indexing (container[index]) operation. Read more
source§

impl Index<EndpointId> for Path

source§

type Output = Point2D<f32, UnknownUnit>

The returned type after indexing.
source§

fn index(&self, id: EndpointId) -> &Point

Performs the indexing (container[index]) operation. Read more
source§

impl<'l> IntoIterator for &'l Path

source§

type Item = Event<Point2D<f32, UnknownUnit>, Point2D<f32, UnknownUnit>>

The type of the elements being iterated over.
source§

type IntoIter = Iter<'l>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Iter<'l>

Creates an iterator from a value. Read more
source§

impl PositionStore for Path

Auto Trait Implementations§

§

impl Freeze for Path

§

impl RefUnwindSafe for Path

§

impl Send for Path

§

impl Sync for Path

§

impl Unpin for Path

§

impl UnwindSafe for Path

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, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.