Struct myelin_geometry::PolygonBuilder

pub struct PolygonBuilder { /* fields omitted */ }

Polygon factory, which can be used in order to configure the properties of a new polygon. Methods can be chained on it in order to configure it.

Examples

use myelin_geometry::PolygonBuilder;
let builder = PolygonBuilder::default();

Implementations

impl PolygonBuilder

pub fn vertex(mut self: Self, x: f64, y: f64) -> Self

Adds a vertex to the polygon

Examples

use myelin_geometry::PolygonBuilder;
let unfinished_builder = PolygonBuilder::default()
    .vertex(-50.0, -50.0)
    .vertex(50.0, -50.0)
    .vertex(50.0, 50.0)
    .vertex(-50.0, 50.0);

pub fn build(self) -> Result<Polygon, ()>

Finishes building the Polygon with all vertices that have been configured up to this point

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.

Examples

use myelin_geometry::PolygonBuilder;

let square = PolygonBuilder::default()
    .vertex(-50.0, -50.0)
    .vertex(50.0, -50.0)
    .vertex(50.0, 50.0)
    .vertex(-50.0, 50.0)
    .build()
    .unwrap();

Trait Implementations

impl Debug for PolygonBuilder

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

Formats the value using the given formatter.

impl Default for PolygonBuilder

pub fn default() -> PolygonBuilder

Returns the "default value" for a type.