[][src]Struct collision::algorithm::broad_phase::SweepAndPrune

pub struct SweepAndPrune<V> { /* fields omitted */ }

Sweep and prune broad phase collision detection algorithm.

Will sort the bounding boxes of the collision world along some axis, and will then sweep the sorted list, and compare the bounds along the sweep axis, adding them to an active list when they are encountered, and removing them from the active list when the end extent is passed.

Any shape pairs found by the base algorithm, will then do a bounding box intersection test, before adding to the resulting pairs list.

Type parameters:

  • V: Variance type used for computing what axis to use on the next iteration. SweepAndPrune2 and SweepAndPrune3 provide a variance type for you, so they should be used if you do not have a custom type implementing Variance.

Methods

impl<V> SweepAndPrune<V> where
    V: Variance
[src]

pub fn new() -> Self[src]

Create a new sweep and prune algorithm, will use the X axis as the first sweep axis

pub fn with_sweep_axis(sweep_axis: usize) -> Self[src]

Create a new sweep and prune algorithm, starting with the given axis as the first sweep axis

pub fn get_sweep_axis(&self) -> usize[src]

Get sweep axis

pub fn find_collider_pairs<A>(
    &mut self,
    shapes: &mut [A]
) -> Vec<(usize, usize)> where
    A: HasBound,
    A::Bound: Bound + Discrete<A::Bound>,
    V: Variance<Bound = A::Bound>, 
[src]

Find all potentially colliding pairs of shapes

Parameters

  • shapes: Shapes to do find potential collisions for

Returns

Returns tuples with indices into the shapes list, of all potentially colliding pairs. The first value in the tuple will always be first in the list.

Side effects:

The shapes list might have been resorted. The indices in the return values will be for the sorted list.

Auto Trait Implementations

impl<V> Send for SweepAndPrune<V> where
    V: Send

impl<V> Sync for SweepAndPrune<V> where
    V: Sync

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]