Skip to main content

Polygon

Struct Polygon 

Source
pub struct Polygon { /* private fields */ }
Expand description

Simple polygon obstacle: closed ordered vertex ring, not necessarily convex.

Does not auto-validate. Scene validation requires at least three distinct vertices, non-zero area, vertices inside world bounds, no self-intersections, and pairwise disjointness with other obstacles.

Implementations§

Source§

impl Polygon

Source

pub fn new(vertices: Vec<Point2>) -> Self

Builds an obstacle from a vertex ring. Does not check geometry invariants.

Source

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

Obstacle ring vertices in declaration order (not rewound by constructors).

Source

pub fn signed_area(&self) -> f64

Shoelace signed area (positive for counter-clockwise rings in this coordinate system).

Absolute value near zero is treated as degenerate during validation.

Source

pub fn contains_point_strict(&self, point: Point2) -> bool

Ray-cast interior test: true only for strict interior points.

Points on any edge of the boundary ring return false (boundary is free space unless the edge is sealed against the world boundary).

Source

pub fn validate( &self, world_bounds: WorldBounds, ) -> Result<(), PolygonValidationError>

Validates this obstacle as if it were obstacle index 0 in world_bounds.

§Errors

Returns a PolygonValidationError describing the violated polygon geometry invariant.

Trait Implementations§

Source§

impl Clone for Polygon

Source§

fn clone(&self) -> Polygon

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Polygon

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Polygon

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Polygon

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.