avian2d::spatial_query

Struct SpatialQueryPipeline

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

A resource for the spatial query pipeline.

The pipeline maintains a quaternary bounding volume hierarchy Bvh of the world’s colliders as an acceleration structure for spatial queries.

Implementations§

Source§

impl SpatialQueryPipeline

Source

pub fn new() -> SpatialQueryPipeline

Creates a new SpatialQueryPipeline.

Source

pub fn as_composite_shape<'a>( &'a self, query_filter: &'a SpatialQueryFilter, ) -> impl TypedCompositeShape

Creates a parry TypedCompositeShape for this pipeline. Can be used to implement custom spatial queries

Source

pub fn as_composite_shape_with_predicate<'a>( &'a self, query_filter: &'a SpatialQueryFilter, predicate: &'a dyn Fn(Entity) -> bool, ) -> impl TypedCompositeShape

Creates a parry TypedCompositeShape for this pipeline, with a predicate. Can be used to implement custom spatial queries

Source

pub fn update<'a>( &mut self, colliders: impl Iterator<Item = (Entity, &'a Position, &'a Rotation, &'a Collider, &'a CollisionLayers)>, )

Updates the associated acceleration structures with a new set of entities.

Source

pub fn entity(&self, index: usize) -> Entity

Get the entity corresponding to a given index in the pipeline

Source

pub fn dispatcher_ref(&self) -> &dyn QueryDispatcher

Get a dyn reference to the query dispatcher used in this pipeline

Source

pub fn cast_ray( &self, origin: Vector, direction: Dir2, max_distance: Scalar, solid: bool, filter: &SpatialQueryFilter, ) -> Option<RayHitData>

Casts a ray and computes the closest hit with a collider. If there are no hits, None is returned.

§Arguments
  • origin: Where the ray is cast from.
  • direction: What direction the ray is cast in.
  • max_distance: The maximum distance the ray can travel.
  • solid: If true and the ray origin is inside of a collider, the hit point will be the ray origin itself. Otherwise, the collider will be treated as hollow, and the hit point will be at its boundary.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn cast_ray_predicate( &self, origin: Vector, direction: Dir2, max_distance: Scalar, solid: bool, filter: &SpatialQueryFilter, predicate: &dyn Fn(Entity) -> bool, ) -> Option<RayHitData>

Casts a ray and computes the closest hit with a collider. If there are no hits, None is returned.

§Arguments
  • origin: Where the ray is cast from.
  • direction: What direction the ray is cast in.
  • max_distance: The maximum distance the ray can travel.
  • solid: If true and the ray origin is inside of a collider, the hit point will be the ray origin itself. Otherwise, the collider will be treated as hollow, and the hit point will be at its boundary.
  • predicate: A function called on each entity hit by the ray. The ray keeps travelling until the predicate returns true.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn ray_hits( &self, origin: Vector, direction: Dir2, max_distance: Scalar, max_hits: u32, solid: bool, filter: &SpatialQueryFilter, ) -> Vec<RayHitData>

Casts a ray and computes all hits until max_hits is reached.

Note that the order of the results is not guaranteed, and if there are more hits than max_hits, some hits will be missed.

§Arguments
  • origin: Where the ray is cast from.
  • direction: What direction the ray is cast in.
  • max_distance: The maximum distance the ray can travel.
  • max_hits: The maximum number of hits. Additional hits will be missed.
  • solid: If true and the ray origin is inside of a collider, the hit point will be the ray origin itself. Otherwise, the collider will be treated as hollow, and the hit point will be at its boundary.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn ray_hits_callback( &self, origin: Vector, direction: Dir2, max_distance: Scalar, solid: bool, filter: &SpatialQueryFilter, callback: impl FnMut(RayHitData) -> bool, )

Casts a ray and computes all hits, calling the given callback for each hit. The raycast stops when callback returns false or all hits have been found.

Note that the order of the results is not guaranteed.

§Arguments
  • origin: Where the ray is cast from.
  • direction: What direction the ray is cast in.
  • max_distance: The maximum distance the ray can travel.
  • solid: If true and the ray origin is inside of a collider, the hit point will be the ray origin itself. Otherwise, the collider will be treated as hollow, and the hit point will be at its boundary.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
  • callback: A callback function called for each hit.
Source

pub fn cast_shape( &self, shape: &Collider, origin: Vector, shape_rotation: Scalar, direction: Dir2, config: &ShapeCastConfig, filter: &SpatialQueryFilter, ) -> Option<ShapeHitData>

Casts a shape with a given rotation and computes the closest hit with a collider. If there are no hits, None is returned.

For a more ECS-based approach, consider using the ShapeCaster component instead.

§Arguments
  • shape: The shape being cast represented as a Collider.
  • origin: Where the shape is cast from.
  • shape_rotation: The rotation of the shape being cast.
  • direction: What direction the shape is cast in.
  • config: A ShapeCastConfig that determines the behavior of the cast.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn cast_shape_predicate( &self, shape: &Collider, origin: Vector, shape_rotation: Scalar, direction: Dir2, config: &ShapeCastConfig, filter: &SpatialQueryFilter, predicate: &dyn Fn(Entity) -> bool, ) -> Option<ShapeHitData>

Casts a shape with a given rotation and computes the closest hit with a collider. If there are no hits, None is returned.

For a more ECS-based approach, consider using the ShapeCaster component instead.

§Arguments
  • shape: The shape being cast represented as a Collider.
  • origin: Where the shape is cast from.
  • shape_rotation: The rotation of the shape being cast.
  • direction: What direction the shape is cast in.
  • config: A ShapeCastConfig that determines the behavior of the cast.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
  • predicate: A function called on each entity hit by the shape. The shape keeps travelling until the predicate returns true.
Source

pub fn shape_hits( &self, shape: &Collider, origin: Vector, shape_rotation: Scalar, direction: Dir2, max_hits: u32, config: &ShapeCastConfig, filter: &SpatialQueryFilter, ) -> Vec<ShapeHitData>

Casts a shape with a given rotation and computes computes all hits in the order of distance until max_hits is reached.

§Arguments
  • shape: The shape being cast represented as a Collider.
  • origin: Where the shape is cast from.
  • shape_rotation: The rotation of the shape being cast.
  • direction: What direction the shape is cast in.
  • max_hits: The maximum number of hits. Additional hits will be missed.
  • config: A ShapeCastConfig that determines the behavior of the cast.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn shape_hits_callback( &self, shape: &Collider, origin: Vector, shape_rotation: Scalar, direction: Dir2, config: &ShapeCastConfig, filter: &SpatialQueryFilter, callback: impl FnMut(ShapeHitData) -> bool, )

Casts a shape with a given rotation and computes computes all hits in the order of distance, calling the given callback for each hit. The shapecast stops when callback returns false or all hits have been found.

§Arguments
  • shape: The shape being cast represented as a Collider.
  • origin: Where the shape is cast from.
  • shape_rotation: The rotation of the shape being cast.
  • direction: What direction the shape is cast in.
  • config: A ShapeCastConfig that determines the behavior of the cast.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
  • callback: A callback function called for each hit.
Source

pub fn project_point( &self, point: Vector, solid: bool, filter: &SpatialQueryFilter, ) -> Option<PointProjection>

Finds the projection of a given point on the closest collider. If one isn’t found, None is returned.

§Arguments
  • point: The point that should be projected.
  • solid: If true and the point is inside of a collider, the projection will be at the point. Otherwise, the collider will be treated as hollow, and the projection will be at the collider’s boundary.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn project_point_predicate( &self, point: Vector, solid: bool, filter: &SpatialQueryFilter, predicate: &dyn Fn(Entity) -> bool, ) -> Option<PointProjection>

Finds the projection of a given point on the closest collider. If one isn’t found, None is returned.

§Arguments
  • point: The point that should be projected.
  • solid: If true and the point is inside of a collider, the projection will be at the point. Otherwise, the collider will be treated as hollow, and the projection will be at the collider’s boundary.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
  • predicate: A function for filtering which entities are considered in the query. The projection will be on the closest collider for which the predicate returns true
Source

pub fn point_intersections( &self, point: Vector, filter: &SpatialQueryFilter, ) -> Vec<Entity>

An intersection test that finds all entities with a collider that contains the given point.

§Arguments
  • point: The point that intersections are tested against.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn point_intersections_callback( &self, point: Vector, filter: &SpatialQueryFilter, callback: impl FnMut(Entity) -> bool, )

An intersection test that finds all entities with a collider that contains the given point, calling the given callback for each intersection. The search stops when callback returns false or all intersections have been found.

§Arguments
  • point: The point that intersections are tested against.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
  • callback: A callback function called for each intersection.
Source

pub fn aabb_intersections_with_aabb(&self, aabb: ColliderAabb) -> Vec<Entity>

An intersection test that finds all entities with a ColliderAabb that is intersecting the given aabb.

Source

pub fn aabb_intersections_with_aabb_callback( &self, aabb: ColliderAabb, callback: impl FnMut(Entity) -> bool, )

An intersection test that finds all entities with a ColliderAabb that is intersecting the given aabb, calling callback for each intersection. The search stops when callback returns false or all intersections have been found.

Source

pub fn shape_intersections( &self, shape: &Collider, shape_position: Vector, shape_rotation: Scalar, filter: &SpatialQueryFilter, ) -> Vec<Entity>

An intersection test that finds all entities with a Collider that is intersecting the given shape with a given position and rotation.

§Arguments
  • shape: The shape that intersections are tested against represented as a Collider.
  • shape_position: The position of the shape.
  • shape_rotation: The rotation of the shape.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
Source

pub fn shape_intersections_callback( &self, shape: &Collider, shape_position: Vector, shape_rotation: Scalar, filter: &SpatialQueryFilter, callback: impl FnMut(Entity) -> bool, )

An intersection test that finds all entities with a Collider that is intersecting the given shape with a given position and rotation, calling callback for each intersection. The search stops when callback returns false or all intersections have been found.

§Arguments
  • shape: The shape that intersections are tested against represented as a Collider.
  • shape_position: The position of the shape.
  • shape_rotation: The rotation of the shape.
  • filter: A SpatialQueryFilter that determines which colliders are taken into account in the query.
  • callback: A callback function called for each intersection.

Trait Implementations§

Source§

impl Clone for SpatialQueryPipeline

Source§

fn clone(&self) -> SpatialQueryPipeline

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for SpatialQueryPipeline

Source§

fn default() -> Self

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

impl Resource for SpatialQueryPipeline
where Self: Send + Sync + 'static,

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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> 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> DowncastSync for T
where T: Any + Send + Sync,

Source§

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

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

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<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, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

Source§

impl<T> WasmNotSync for T
where T: Sync,