[−][src]Struct lyon_path::Path
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
impl Path
[src]
pub fn builder() -> Builder
[src]
Creates a Builder to build a path.
pub fn builder_with_attributes(num_attributes: usize) -> BuilderWithAttributes
[src]
Creates a BuilderWithAttributes to build a path with custom attributes.
pub fn svg_builder() -> WithSvg<Builder>
[src]
Creates an WithSvg to build a path with a rich set of commands.
pub fn new() -> Path
[src]
Creates an Empty Path
.
pub fn as_slice(&self) -> PathSlice<'_>
[src]
Returns a view on this Path
.
pub fn attributes(&self, endpoint: EndpointId) -> &[f32]
[src]
Returns a slice over an endpoint's custom attributes.
pub fn iter(&self) -> Iter<'_>ⓘ
[src]
Iterates over the entire Path
.
pub fn id_iter(&self) -> IdIter<'_>ⓘ
[src]
Iterates over the endpoint and control point ids of the Path
.
pub fn iter_with_attributes(&self) -> IterWithAttributes<'_>ⓘ
[src]
pub fn transformed<T: Transformation<f32>>(self, transform: &T) -> Self
[src]
Applies a transform to all endpoints and control points of this path and Returns the result.
pub fn reversed(&self) -> Self
[src]
Returns a reversed version of this path with edge loops specified in the opposite order.
Trait Implementations
impl AttributeStore for Path
[src]
pub fn get(&self, id: EndpointId) -> &[f32]
[src]
pub fn num_attributes(&self) -> usize
[src]
impl Clone for Path
[src]
impl Debug for Path
[src]
impl Default for Path
[src]
impl Index<ControlPointId> for Path
[src]
type Output = Point
The returned type after indexing.
pub fn index(&self, id: ControlPointId) -> &Point
[src]
impl Index<EndpointId> for Path
[src]
type Output = Point
The returned type after indexing.
pub fn index(&self, id: EndpointId) -> &Point
[src]
impl<'l> Into<PathSlice<'l>> for &'l Path
[src]
impl<'l> IntoIterator for &'l Path
[src]
type Item = PathEvent
The type of the elements being iterated over.
type IntoIter = Iter<'l>
Which kind of iterator are we turning this into?
pub fn into_iter(self) -> Iter<'l>ⓘ
[src]
impl PositionStore for Path
[src]
pub fn get_endpoint(&self, id: EndpointId) -> Point
[src]
pub fn get_control_point(&self, id: ControlPointId) -> Point
[src]
Auto Trait Implementations
impl RefUnwindSafe for Path
[src]
impl Send for Path
[src]
impl Sync for Path
[src]
impl Unpin for Path
[src]
impl UnwindSafe for Path
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,