Struct ril::draw::Polygon

pub struct Polygon<F: IntoFill> {
    pub vertices: Vec<(u32, u32)>,
    pub border: Option<Border<F::Pixel>>,
    pub rounded: bool,
    pub fill: Option<F::Fill>,
    pub overlay: Option<OverlayMode>,
    pub antialiased: bool,
}

A polygon.

Fields

vertices: Vec<(u32, u32)>

A Vec of vertices that make up the polygon. The vertices are connected in the order they are given.

When drawing, a panic will occur if there is less than 3 vertices in this Vec.

If the first and last vertices are the same, these points will remain untouched. Otherwise, and extra vertex equivalent to the first vertex will be added to the end of the Vec to close the polygon.

border: Option<Border<F::Pixel>>

The border of the polygon. Either this or fill must be Some.

rounded: bool

Whether the border should be rounded off by drawing circles at each vertex. This is only applied if border is Some. Additionally, these circles will not antialias.

fill: Option<F::Fill>

The fill color of the polygon. Either this or border must be Some.

overlay: Option<OverlayMode>

The overlay mode of the polygon. If None, the image’s overlay mode will be used.

antialiased: bool

Whether to antialias the polygon’s edges.

Implementations

impl<F: IntoFill> Polygon<F>

pub fn new() -> Self

Creates a new empty polygon.

pub fn update_bounding_box(&mut self)

Updates the polygon’s bounding box. This is automatically called, unless explicitly specified in documentation.

pub fn from_vertices(vertices: impl IntoIterator<Item = (u32, u32)>) -> Self

Creates a new polygon with the given vertices.

pub fn regular_rotated( n: u32, center: (u32, u32), radius: u32, angle: f64, ) -> Self

Creates a regular polygon with n sides centered at center, with each of the points radius away from the center. angle is measured in radians and is the angle offset of the first point, which for angle=0.0, will be horizontally to the right of the center (i.e. a unit circle).

For angles specified in degrees, the f64::to_radians method can be used for conversion.

Note

Apart from n=4, the polygon will not be pixel-perfect since no polygons other than squares have all of their vertices as perfect integers. This means that they will be rounded to the nearest pixel.

Panics

• If n < 3

pub fn regular(n: u32, center: (u32, u32), radius: u32) -> Self

Creates a regular polygon with the first point vertically up from the center (the polygon will seem to be facing “upwards”).

This is a shortcut to calling Polygon::regular_rotated with angle = PI / 2 (90deg).

See Also

• Polygon::regular_rotated for more information.

pub fn with_vertex(self, x: u32, y: u32) -> Self

Adds a vertex to the polygon.

pub fn push_vertex(&mut self, x: u32, y: u32)

Adds a vertex to the polygon in place.

pub fn vertices(&self) -> &[(u32, u32)]

Returns a slice of the vertices in the polygon.

pub fn vertices_mut(&mut self) -> &mut [(u32, u32)]

Returns a mutable slice of the vertices in the polygon.

pub fn iter_vertices(&self) -> impl Iterator<Item = &(u32, u32)>

Iterates over the vertices in the polygon.

pub fn iter_vertices_mut(&mut self) -> impl Iterator<Item = &mut (u32, u32)>

Iterates over the vertices in the polygon in mutable form. Make sure to call update_bounding_box after mutating the vertices.

pub const fn with_border(self, border: Border<F::Pixel>) -> Self

Sets the border of the polygon.

pub const fn with_rounded(self, rounded: bool) -> Self

Sets whether the border should be rounded.

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

Sets the fill color of the polygon.

pub const fn with_overlay_mode(self, overlay: OverlayMode) -> Self

Sets the overlay mode of the polygon.

pub const fn with_antialiased(self, antialiased: bool) -> Self

Sets whether to antialias the polygon’s edges. If set to true, this will also set the overlay mode to OverlayMode::Merge.

Trait Implementations

impl<F: Clone + IntoFill> Clone for Polygon<F>

where F::Pixel: Clone, F::Fill: Clone,

fn clone(&self) -> Polygon<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + IntoFill> Debug for Polygon<F>

where F::Pixel: Debug, F::Fill: Debug,

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

Formats the value using the given formatter.

impl<F: IntoFill> Default for Polygon<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: IntoFill> Draw<<F as IntoFill>::Pixel> for Polygon<F>

fn draw<I: DerefMut<Target = Image<F::Pixel>>>(&self, image: I)

Draws the object to the given image.