Struct myelin_engine::prelude::Polygon

pub struct Polygon { /* fields omitted */ }

A convex polygon.

Can either be constructed using a PolygonBuilder or with Polygon::try_new.

Methods

impl Polygon

pub fn try_new(vertices: Vec<Point>) -> Result<Polygon, ()>

Creates a new Polygon from the given Points.

Errors

This method will return an error if the number of configured vertices is less than three (as the resulting Polygon would not be two-dimensional), or if the resulting Polygon is not convex.

pub fn vertices(&self) -> &[Point]

Returns the vertices of the polygon

pub fn translate(&self, translation: Point) -> Polygon

Apply translation specified by translation, represented as a relative point

pub fn rotate_around_point(&self, rotation: Radians, point: Point) -> Polygon

Rotate polygon by a rotation around a point

pub fn contains_point(&self, point: Point) -> bool

Checks if a given point rests inside the polygon

pub fn aabb(&self) -> Aabb

Returns an Aabb which fully contains this polygon.

Panics

Panics if the floating-point values representing the vertices' coordinates are not comparable, e.g. NaN or if the polygon has no vertices. The latter should never occur, because the constructor validates that the polygon is valid.

pub fn edges(&self) -> impl Iterator<Item = Vector>

Returns the polygon's edges, i.e. the lines between vertices, as vectors.

Trait Implementations

impl Intersects<Polygon> for Polygon

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

Returns wether this polygon touches, contains or is contained in another polygon

impl From<Aabb> for Polygon

fn from(aabb: Aabb) -> Polygon

Performs the conversion.

impl PartialEq<Polygon> 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: &Polygon) -> bool

This method tests for !=.

impl Default for Polygon

fn default() -> Polygon

Returns the "default value" for a type.

impl Debug for Polygon

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

Formats the value using the given formatter.

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 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 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.