KDTree2

bevy_spatial::kdtree

Struct KDTree2 

Source 
pub struct KDTree2<Comp> {
    pub tree: BaseKdTree<Point2>,
    /* private fields */
}
Expand description

Resource for storing a KdTree

Fields§

§tree: BaseKdTree<Point2>

The KdTree

Trait Implementations§

Source§

impl<Comp> Default for KDTree2<Comp>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<Comp> SpatialAccess for KDTree2<Comp>
where Comp: TComp,

Source§

fn nearest_neighbour( &self, loc: <Point2 as SpatialPoint>::Vec, ) -> Option<Self::ResultT>

Get the nearest neighbour to a position.

Source§

fn k_nearest_neighbour( &self, loc: <Point2 as SpatialPoint>::Vec, k: usize, ) -> Vec<Self::ResultT>

Get the k neighbours to loc

If loc is the location of a tracked entity, you might want to skip the first.

Source§

fn within_distance( &self, loc: <Point2 as SpatialPoint>::Vec, distance: <Point2 as SpatialPoint>::Scalar, ) -> Vec<Self::ResultT>

Get all entities within a certain distance (radius) of loc

Source§

type Point = Point2

The point type, can be anything implementing SpatialPoint.
Source§

type Comp = Comp

The marker component type marking the entities whos points are stored, used for accessing the component in trait bounds.
Source§

type ResultT = (<Point2 as SpatialPoint>::Vec, Option<Entity>)

The type of a single query result.
Source§

impl<Comp> Resource for KDTree2<Comp>
where Self: Send + Sync + 'static,

Auto Trait Implementations§

§

impl<Comp> Freeze for KDTree2<Comp>

§

impl<Comp> RefUnwindSafe for KDTree2<Comp>
where Comp: RefUnwindSafe,

§

impl<Comp> Send for KDTree2<Comp>
where Comp: Send,

§

impl<Comp> Sync for KDTree2<Comp>
where Comp: Sync,

§

impl<Comp> Unpin for KDTree2<Comp>
where Comp: Unpin,

§

impl<Comp> UnwindSafe for KDTree2<Comp>
where Comp: UnwindSafe,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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

Source§

type Output = T

Should always be Self
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<T> ConditionalSend for T
where T: Send,