pub struct PathCommands { /* private fields */ }
canvas
only.Expand description
The commands of a path encoded in a single array using IDs to refer to endpoints and control points externally.
PathCommands
is a good fit when the a custom endpoint and control point
types are needed or when their the user needs full control over their storage.
Representation
Path commands contains a single array of 32 bits integer values encoding path commands, endpoint IDs or control point IDs.
__________________________________________________________________________
| | | | | | | |
| Begin |EndpointID| Line |EndpointID|Quadratic|ControlPointId|EndpointID| ...
|_______|__________|______|__________|_________|______________|__________|_
Example
use lyon_path::{EndpointId, PathCommands};
let mut cmds = PathCommands::builder();
cmds.begin(EndpointId(0));
cmds.line_to(EndpointId(1));
cmds.line_to(EndpointId(2));
cmds.end(true);
let cmds = cmds.build();
Implementations§
§impl PathCommands
impl PathCommands
pub fn builder() -> PathCommandsBuilder
pub fn builder() -> PathCommandsBuilder
Creates a PathCommandsBuilder to create path commands.
pub fn as_slice(&self) -> PathCommandsSlice<'_>
pub fn as_slice(&self) -> PathCommandsSlice<'_>
Returns a view on the path commands.
pub fn path_slice<Endpoint, ControlPoint, 'l>(
&'l self,
endpoints: &'l [Endpoint],
control_points: &'l [ControlPoint]
) -> CommandsPathSlice<'l, Endpoint, ControlPoint>
pub fn path_slice<Endpoint, ControlPoint, 'l>( &'l self, endpoints: &'l [Endpoint], control_points: &'l [ControlPoint] ) -> CommandsPathSlice<'l, Endpoint, ControlPoint>
Returns a view on a path made of these commands with endpoint and control point slices.
pub fn events<Endpoint, ControlPoint, 'l>(
&'l self,
endpoints: &'l [Endpoint],
control_points: &'l [ControlPoint]
) -> Events<'l, Endpoint, ControlPoint> ⓘ
pub fn events<Endpoint, ControlPoint, 'l>( &'l self, endpoints: &'l [Endpoint], control_points: &'l [ControlPoint] ) -> Events<'l, Endpoint, ControlPoint> ⓘ
Returns an iterator over the path, with endpoints and control points.
pub fn event(&self, id: EventId) -> Event<EndpointId, ControlPointId>
pub fn event(&self, id: EventId) -> Event<EndpointId, ControlPointId>
Returns the event for a given event ID.
pub fn next_event_id_in_path(&self, id: EventId) -> Option<EventId>
pub fn next_event_id_in_path(&self, id: EventId) -> Option<EventId>
Returns the next event id within the path.
pub fn next_event_id_in_sub_path(&self, id: EventId) -> EventId
pub fn next_event_id_in_sub_path(&self, id: EventId) -> EventId
Returns the next event id within the sub-path.
Loops back to the first event after the end of the sub-path.
Trait Implementations§
§impl Clone for PathCommands
impl Clone for PathCommands
§fn clone(&self) -> PathCommands
fn clone(&self) -> PathCommands
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for PathCommands
impl Debug for PathCommands
§impl<'l> From<&'l PathCommands> for PathCommandsSlice<'l>
impl<'l> From<&'l PathCommands> for PathCommandsSlice<'l>
§fn from(commands: &'l PathCommands) -> PathCommandsSlice<'l>
fn from(commands: &'l PathCommands) -> PathCommandsSlice<'l>
§impl<'l> IntoIterator for &'l PathCommands
impl<'l> IntoIterator for &'l PathCommands
Auto Trait Implementations§
impl RefUnwindSafe for PathCommands
impl Send for PathCommands
impl Sync for PathCommands
impl Unpin for PathCommands
impl UnwindSafe for PathCommands
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more