Struct lyon_path::Path

pub struct Path { /* private fields */ }

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:

• BuilderWithAttributes.
• Path::builder_with_attributes.
• Path::attributes.

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

impl Path

pub fn builder() -> Builder

Creates a Builder to build a path.

pub fn builder_with_attributes(num_attributes: usize) -> BuilderWithAttributes

Creates a BuilderWithAttributes to build a path with custom attributes.

pub fn svg_builder() -> WithSvg<BuilderImpl>

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

pub fn new() -> Path

Creates an Empty Path.

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

Returns a view on this Path.

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

Returns a slice over an endpoint’s custom attributes.

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

Iterates over the entire Path, ignoring custom attributes.

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

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

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

Iterates over the entire Path with custom attributes.

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.

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

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

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

Returns the first endpoint and its custom attributes if any.

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

Returns the last endpoint and its custom attributes if any.

Trait Implementations

impl AttributeStore for Path

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

Returns the endpoint’s custom attributes as a slice of 32 bits floats.

fn num_attributes(&self) -> usize

Returns the number of float attributes per endpoint.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

fn default() -> Path

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

Creates a value from an iterator.

impl Index<ControlPointId> for Path

type Output = Point2D<f32, UnknownUnit>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<EndpointId> for Path

type Output = Point2D<f32, UnknownUnit>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'l> IntoIterator for &'l Path

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

The type of the elements being iterated over.

type IntoIter = Iter<'l>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl PositionStore for Path

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

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