Enum PolygonValidationError 

#[non_exhaustive]
pub enum PolygonValidationError {
    InvalidWorldBounds,
    TooFewVertices {
        obstacle_index: usize,
        actual: usize,
    },
    DuplicateVertices {
        obstacle_index: usize,
        first_vertex_index: usize,
        second_vertex_index: usize,
    },
    ZeroArea {
        obstacle_index: usize,
    },
    VertexOutsideBounds {
        obstacle_index: usize,
        vertex_index: usize,
        vertex: Point2,
    },
    SelfIntersection {
        obstacle_index: usize,
        first_edge_start_index: usize,
        second_edge_start_index: usize,
    },
    ObstaclesOverlap {
        left_index: usize,
        right_index: usize,
    },
    EndpointNotTraversable {
        endpoint: PolygonEndpoint,
        point: Point2,
    },
}

Static geometry or endpoint validation failure for polygonal scenes.

Variants describe invariants required before online search or prepared-map preprocess.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidWorldBounds

min is not strictly less than max on both axes (zero or negative area).

TooFewVertices

Obstacle ring has fewer than three vertices.

Fields

obstacle_index: usize

Index into PolygonScene::obstacles.

actual: usize

Observed vertex count.

DuplicateVertices

Two vertices of the same obstacle coincide within geometry epsilon.

Fields

obstacle_index: usize

Index into PolygonScene::obstacles.

first_vertex_index: usize

First repeated vertex index.

second_vertex_index: usize

Second repeated vertex index.

ZeroArea

Obstacle has near-zero signed area (degenerate ring).

Fields

obstacle_index: usize

Index into PolygonScene::obstacles.

VertexOutsideBounds

Obstacle vertex lies outside the inclusive world rectangle.

Fields

obstacle_index: usize

Index into PolygonScene::obstacles.

vertex_index: usize

Offending vertex index within the obstacle ring.

vertex: Point2

Offending vertex coordinates.

SelfIntersection

Non-adjacent edges of the same obstacle properly intersect.

Fields

obstacle_index: usize

Index into PolygonScene::obstacles.

first_edge_start_index: usize

Start vertex index of the first intersecting edge.

second_edge_start_index: usize

Start vertex index of the second intersecting edge.

ObstaclesOverlap

Two obstacles share interior points, edge crossings, or nested vertices.

Fields

left_index: usize

First overlapping obstacle index.

right_index: usize

Second overlapping obstacle index.

EndpointNotTraversable

Start, goal, or source is outside free space (including sealed boundary).

Fields

endpoint: PolygonEndpoint

Which endpoint role failed traversability.

point: Point2

Rejected continuous point.

Trait Implementations

impl Clone for PolygonValidationError

fn clone(&self) -> PolygonValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolygonValidationError

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

Formats the value using the given formatter.

impl Display for PolygonValidationError

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

Formats the value using the given formatter.

impl Error for PolygonValidationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<PolygonValidationError> for PolygonShortestPathMapBuildError

fn from(source: PolygonValidationError) -> Self

Converts to this type from the input type.

impl PartialEq for PolygonValidationError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PolygonValidationError