Skip to main content

PathCollection

Struct PathCollection 

Source
pub struct PathCollection<'a> {
    pub master_transform: Affine2D,
    pub paths: &'a [Path],
    pub path_transforms: &'a [Affine2D],
    pub offsets: &'a [Point],
    pub facecolors: &'a [Rgba],
    pub edgecolors: &'a [Rgba],
    pub hatchcolors: &'a [Rgba],
    pub linewidths: &'a [f64],
    pub dashes: &'a [Dashes],
    pub antialiased: &'a [bool],
    pub urls: &'a [Option<String>],
}
Expand description

The arguments of matplotlib’s draw_path_collection.

Every per-item sequence is cycled to the item count (see ItemCycle); an empty sequence means “use the base graphics context” (or, for colours, “do not fill/stroke”).

Fields§

§master_transform: Affine2D

Applied after each item’s own transform.

§paths: &'a [Path]

Item shapes.

§path_transforms: &'a [Affine2D]

Per-item transforms applied before master_transform.

§offsets: &'a [Point]

Per-item translations in display coordinates.

§facecolors: &'a [Rgba]

Face colours; empty = no fills.

§edgecolors: &'a [Rgba]

Edge colours; empty = no strokes.

§hatchcolors: &'a [Rgba]

Hatch colours.

§linewidths: &'a [f64]

Edge line widths in points.

§dashes: &'a [Dashes]

Edge dash patterns.

§antialiased: &'a [bool]

Per-item anti-aliasing.

§urls: &'a [Option<String>]

Per-item hyperlinks.

Implementations§

Source§

impl<'a> PathCollection<'a>

Source

pub fn len(&self) -> usize

Number of items that will be drawn (before skipping non-finite offsets).

Source

pub fn raw_paths(&self) -> impl Iterator<Item = (&'a Path, Affine2D)> + '_

Every shape with its transform before the offset (matplotlib’s _iter_collection_raw_paths); items refer to them by CollectionItem::path_index.

Source

pub fn uses_per_path(&self) -> usize

How often each raw path is used, rounded up (matplotlib’s _iter_collection_uses_per_path); zero when nothing is filled or stroked.

Source

pub fn is_empty(&self) -> bool

Returns true when nothing would be drawn.

Source

pub fn items( &self, base: &GraphicsContext, ) -> impl Iterator<Item = CollectionItem<'a>> + '_

Resolves every drawable item, exactly as matplotlib’s RendererBase._iter_collection does: items with non-finite offsets are skipped, fully transparent faces become unfilled, and fully transparent edges disable stroking.

The context is copied only when an override changes it while an earlier item still holds it, so items dropped before the next is taken share one context.

Source

pub fn items_cycled( &self, base: &GraphicsContext, cycle: ItemCycle, ) -> impl Iterator<Item = CollectionItem<'a>> + '_

PathCollection::items, cycling through the shapes and their transforms as cycle says.

Trait Implementations§

Source§

impl<'a> Clone for PathCollection<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for PathCollection<'a>

Source§

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

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

impl<'a> Default for PathCollection<'a>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<'a> Forget for PathCollection<'a>

§

impl<'a> Freeze for PathCollection<'a>

§

impl<'a> Move for PathCollection<'a>

§

impl<'a> RefUnwindSafe for PathCollection<'a>

§

impl<'a> Send for PathCollection<'a>

§

impl<'a> Sync for PathCollection<'a>

§

impl<'a> Unpin for PathCollection<'a>

§

impl<'a> UnsafeUnpin for PathCollection<'a>

§

impl<'a> UnwindSafe for PathCollection<'a>

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.