Struct Shape 

pub struct Shape {
    pub kind: ShapeKind,
    pub x: Vec<f64>,
    pub y: Vec<f64>,
    pub color: Color32,
    pub fill: bool,
    pub line_style: LineStyle,
    pub line_width: f32,
    pub gap_color: Option<Color32>,
    pub is_overlay: bool,
}

A shape drawn over the data area (silx BackendBase.addShape).

fill is honored for ShapeKind::Polygon / ShapeKind::Rectangle. Concave polygons fill correctly: the widget chrome fills the polygon’s ear-clipping triangulation (triangulate_simple_polygon) as a mesh rather than using egui’s convex-only Shape::convex_polygon, matching silx’s matplotlib / pygfx backends. The outline (and all line kinds) honor line_style / line_width, with gap_color filling dash gaps (silx gapcolor).

Fields

kind: ShapeKind

What geometry this shape draws.

x: Vec<f64>

Data X coordinates of the shape’s points (see ShapeKind for which array each kind reads).

y: Vec<f64>

Data Y coordinates of the shape’s points.

color: Color32

Outline and fill color (silx color).

fill: bool

Fill the interior (silx fill); honored for Polygon / Rectangle.

line_style: LineStyle

Outline stroke style (silx linestyle).

line_width: f32

Outline width in logical points (silx linewidth).

gap_color: Option<Color32>

Second color filling dash gaps in the outline (silx gapcolor); None leaves the gaps empty.

is_overlay: bool

Whether the shape draws in the overlay layer (silx _OverlayItem.isOverlay / setOverlay, shape.py:54-73).

Honored by the renderer’s two-pass split: true draws in the overlay layer on top of the chrome (like an ROI), false in the base data layer under the overlay items (ROIs, markers, crosshair). Defaults to true (the port’s historical behavior); silx’s _OverlayItem defaults to False, but siplot’s shape constructors are used as on-top annotations, so the default is kept and callers opt into the data layer via Shape::with_overlay.

Implementations

impl Shape

pub fn polygon(x: Vec<f64>, y: Vec<f64>) -> Self

A closed polygon through (x[i], y[i]). Panics if x and y differ in length.

pub fn rectangle(x0: f64, y0: f64, x1: f64, y1: f64) -> Self

An axis-aligned rectangle between corners (x0, y0) and (x1, y1).

pub fn polyline(x: Vec<f64>, y: Vec<f64>) -> Self

An open polyline through (x[i], y[i]). Panics if x and y differ in length.

pub fn hlines(y: Vec<f64>) -> Self

One full-width horizontal line at each y value (silx 'hline').

pub fn vlines(x: Vec<f64>) -> Self

One full-height vertical line at each x value (silx 'vline').

pub fn with_color(self, color: Color32) -> Self

Set the outline / fill color.

pub fn with_fill(self, fill: bool) -> Self

Fill the interior (Polygon / Rectangle only).

pub fn with_line_style(self, style: LineStyle) -> Self

Set the outline stroke style.

pub fn with_line_width(self, width: f32) -> Self

Set the outline width.

pub fn with_gap_color(self, color: Color32) -> Self

Set the dash-gap fill color (silx gapcolor).

pub fn with_overlay(self, overlay: bool) -> Self

Set whether the shape draws in the overlay layer (true) or the base data layer (false) — silx _OverlayItem.setOverlay.

pub fn screen_points(&self, t: &Transform) -> Vec<Pos2>

Screen-space vertices for the area-shaped kinds: the four corners of a ShapeKind::Rectangle, or each (x[i], y[i]) of a ShapeKind::Polygon / ShapeKind::Polyline. Empty for the line kinds, whose lines span the data area and are placed at draw time.

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Shape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shape

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

Formats the value using the given formatter.

impl PartialEq for Shape

fn eq(&self, other: &Shape) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Shape