Struct bevy_canvas::Path

pub struct Path { /* fields omitted */ }

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<Builder>

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) -> &[f32]

Returns a slice over an endpoint’s custom attributes.

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

Iterates over the entire Path.

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

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

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

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

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

pub fn reversed(&self) -> Path

Returns a reversed version of this path with edge loops specified in the opposite order.

Trait Implementations

impl AttributeStore for Path

pub fn get(&self, id: EndpointId) -> &[f32]

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

pub fn num_attributes(&self) -> usize

Returns the number of float attributes per endpoint.

impl Clone for Path

pub fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

pub fn default() -> Path

Returns the “default value” for a type.

impl Index<ControlPointId> for Path

type Output = Point2D<f32, UnknownUnit>

The returned type after indexing.

pub fn index(&self, id: ControlPointId) -> &Point2D<f32, UnknownUnit>

Performs the indexing (container[index]) operation.

impl Index<EndpointId> for Path

type Output = Point2D<f32, UnknownUnit>

The returned type after indexing.

pub fn index(&self, id: EndpointId) -> &Point2D<f32, UnknownUnit>

Performs the indexing (container[index]) operation.

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

pub fn into(self) -> PathSlice<'l>

Performs the conversion.

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?

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

Creates an iterator from a value.

impl PositionStore for Path

pub fn get_endpoint(&self, id: EndpointId) -> Point2D<f32, UnknownUnit>

pub fn get_control_point(&self, id: ControlPointId) -> Point2D<f32, UnknownUnit>