Skip to main content

PolygonScene

Struct PolygonScene 

Source
pub struct PolygonScene {
    pub world_bounds: WorldBounds,
    pub obstacles: Vec<Polygon>,
}
Expand description

Bounded free space with polygon obstacles and walkability predicates.

Public fields are the static scene snapshot: world rectangle plus obstacle rings. Pathfinders and prepared maps treat geometry as immutable for a query. Prefer Self::validate_static / Self::validate before trusting a hand- built scene; constructors do not enforce invariants.

Fields§

§world_bounds: WorldBounds

Axis-aligned world rectangle that bounds free space.

§obstacles: Vec<Polygon>

Simple polygon obstacle rings; free space is the world rectangle minus their strict interiors.

Implementations§

Source§

impl PolygonScene

Source

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

Point free-space test: in bounds and not strictly inside any obstacle.

Does not reject sealed world-boundary edges by itself; endpoint validation (validate, validate_source, validate_goal) and Self::segment_is_walkable apply the sealed-edge rule.

Source

pub fn segment_is_walkable(&self, start: Point2, end: Point2) -> bool

Whether the segment from start to end stays in free space.

Rejects either endpoint when non-traversable (including sealed boundary), then samples every obstacle-edge intersection parameter and each open sub-interval midpoint. Visibility graphs and TFS use this as the edge legality predicate; cost is always Euclidean length of accepted segments.

Source

pub fn validate_static(&self) -> Result<(), PolygonValidationError>

Validates world bounds, obstacle geometry, and pairwise obstacle disjointness.

§Errors

Returns a PolygonValidationError for invalid bounds, obstacle geometry, or intersecting obstacles.

Source

pub fn validate_source( &self, source: Point2, ) -> Result<(), PolygonValidationError>

Validates static scene invariants and that source is traversable.

§Errors

Returns a PolygonValidationError when static geometry or the source endpoint is invalid.

Source

pub fn validate_goal(&self, goal: Point2) -> Result<(), PolygonValidationError>

Validates static scene invariants and that goal is traversable.

§Errors

Returns a PolygonValidationError when static geometry or the goal endpoint is invalid.

Source

pub fn validate( &self, request: PolygonSearchRequest, ) -> Result<(), PolygonValidationError>

Validates static scene invariants and that both endpoints are traversable.

§Errors

Returns a PolygonValidationError when static geometry or either endpoint is invalid.

Trait Implementations§

Source§

impl Clone for PolygonScene

Source§

fn clone(&self) -> PolygonScene

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 PolygonScene

Source§

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

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

impl PartialEq for PolygonScene

Source§

fn eq(&self, other: &PolygonScene) -> 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 PolygonScene

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool