Struct substrate::geometry::polygon::Polygon

pub struct Polygon { /* private fields */ }

A polygon, with vertex coordinates given

Implementations

impl Polygon

pub fn from_verts(vec: Vec<Point>) -> Polygon

Creates a polygon with given vertices.

pub fn bot(&self) -> i64

Returns the bottom y-coordinate in the polygon.

Example

let points = vec![
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: -4, y: 5 },
];
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.bot(), 0);

pub fn top(&self) -> i64

Returns the top y-coordinate in the polygon.

Example

let points = vec![
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: -4, y: 5 },
];
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.top(), 5);

pub fn left(&self) -> i64

Returns the leftmost x-coordinate in the polygon.

Example

let points = vec![
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: -4, y: 5 },
];
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.left(), -4);

pub fn right(&self) -> i64

Returns the rightmost x-coordinate in the polygon.

Example

let points = vec![
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: -4, y: 5 },
];
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.right(), 1);

pub fn points(&self) -> &Vec<Point>

Returns a the vector of points representing the polygon.

pub fn center(&self) -> Point

Returns the center point of the polygon.

Returns a point with x-coordinate equal to the average of all x-coordinates and y-coordinate equal to the average of all y-coordinates. Note that the current behavior is to round down.

Example

let points = vec![
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: -4, y: 5 },
];
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.center(), Point::new(-1, 2));

Trait Implementations

impl Bbox for Polygon

fn bbox(&self) -> Option<Rect>

Computes the axis-aligned rectangular bounding box.

fn bbox_rect(&self) -> Rect

Computes the axis-aligned rectangular bounding box, panicking if it is empty.

impl Clone for Polygon

fn clone(&self) -> Polygon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Contains<Point> for Polygon

fn contains(&self, p: &Point) -> Containment

Determines if a point is contained within a polygon.

Example

let points = vec![
    Point { x: -4, y: 0 },
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: 2, y: 2 },
    Point { x: -4, y: 5 },
];
let p1 = Point::new(0,0);
let p2 = Point::new(0,4);
let p3 = Point::new(-5,3);
let p4 = Point::new(-2,4);
let p5 = Point::new(-2,2);
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.contains(&p1), Containment::Full);
assert_eq!(polygon.contains(&p2), Containment::None);
assert_eq!(polygon.contains(&p3), Containment::None);
assert_eq!(polygon.contains(&p4), Containment::Full);
assert_eq!(polygon.contains(&p5), Containment::Full);

fn encloses(&self, other: &T) -> bool

Returns true if other is fully enclosed in this shape.

fn partially_intersects(&self, other: &T) -> bool

Returns true if other is fully or partially enclosed in this shape.

impl Debug for Polygon

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

Formats the value using the given formatter.

impl Default for Polygon

fn default() -> Polygon

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Polygon

fn deserialize<__D>( __deserializer: __D ) -> Result<Polygon, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Polygon> for Shape

fn from(value: Polygon) -> Shape

Converts to this type from the input type.

impl Ord for Polygon

fn cmp(&self, other: &Polygon) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Polygon

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Polygon

fn partial_cmp(&self, other: &Polygon) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Polygon

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TransformMut for Polygon

fn transform_mut(&mut self, trans: Transformation)

Applies matrix-vector Transformation trans.

impl TranslateMut for Polygon

fn translate_mut(&mut self, p: Point)

Translates the shape by a Point through mutation.

impl Eq for Polygon

impl StructuralPartialEq for Polygon