Struct heron_rapier::PhysicsWorld
source · pub struct PhysicsWorld<'w, 's> { /* private fields */ }
Expand description
A Bevy system parameter that can be used to perform queries such as ray casts on the physics world
See the ray_casting
example for a detailed usage example.
Implementations
sourceimpl<'w, 's> PhysicsWorld<'w, 's>
impl<'w, 's> PhysicsWorld<'w, 's>
sourcepub fn ray_cast(&self, start: Vec3, ray: Vec3, solid: bool) -> Option<RayCastInfo>
pub fn ray_cast(&self, start: Vec3, ray: Vec3, solid: bool) -> Option<RayCastInfo>
Cast a ray and get the collision shape entity, point, and normal at which it collided, if any
from
: The point to cast the ray from.ray
: A vector indicating the direction and the distance to cast the ray. Ifsolid
: Iftrue
a point cast from the inside of a solid object will stop immediately and the collision point will be the same as thefrom
point. Iffalse
a ray cast from inside of an object will act like the object is hollow and will hit the surface of the object after traveling through the object interior.
sourcepub fn ray_cast_with_filter<F>(
&self,
start: Vec3,
ray: Vec3,
solid: bool,
layers: CollisionLayers,
filter: F
) -> Option<RayCastInfo>where
F: Fn(Entity) -> bool,
pub fn ray_cast_with_filter<F>(
&self,
start: Vec3,
ray: Vec3,
solid: bool,
layers: CollisionLayers,
filter: F
) -> Option<RayCastInfo>where
F: Fn(Entity) -> bool,
Cast a ray with extra filters
Behaves the same as ray_cast
but takes extra arguments for
filtering results:
layers
: TheCollisionLayers
to considered for collisions, allowing for coarse filtering of collisions.filter
: A closure taking an [Entity
] and returningtrue
if the entity should be considered for collisions, allowing for fine-grained, per-entity filtering of collisions.
sourcepub fn shape_cast(
&self,
shape: &CollisionShape,
start_position: Vec3,
start_rotation: Quat,
ray: Vec3
) -> Option<ShapeCastInfo>
pub fn shape_cast(
&self,
shape: &CollisionShape,
start_position: Vec3,
start_rotation: Quat,
ray: Vec3
) -> Option<ShapeCastInfo>
Cast a shape and get the collision shape entity, point, and normal at which it collided, if any
shape
: TheCollisionShape
to use for the shape caststart_position
: The position to start the shape cast atstart_rotation
: The rotation of the collision shaperay
: A vector indicating the direction and the distance to cast the shape
Panics
This will panic if the start position and end position are the same.
sourcepub fn shape_cast_with_filter<F>(
&self,
shape: &CollisionShape,
start_position: Vec3,
start_rotation: Quat,
ray: Vec3,
layers: CollisionLayers,
filter: F
) -> Option<ShapeCastInfo>where
F: Fn(Entity) -> bool,
pub fn shape_cast_with_filter<F>(
&self,
shape: &CollisionShape,
start_position: Vec3,
start_rotation: Quat,
ray: Vec3,
layers: CollisionLayers,
filter: F
) -> Option<ShapeCastInfo>where
F: Fn(Entity) -> bool,
Cast a shape with an optional filter
Behaves the same as shape_cast
but takes extra arguments for
filtering results:
layers
: TheCollisionLayers
to considered for collisions, allowing for coarse filtering of collisions.filter
: A closure taking an [Entity
] and returningtrue
if the entity should be considered for collisions, allowing for fine-grained, per-entity filtering of collisions.
Panics
This will panic if the from
point and the to
point are the same.
Trait Implementations
sourceimpl<'w, 's> SystemParam for PhysicsWorld<'w, 's>
impl<'w, 's> SystemParam for PhysicsWorld<'w, 's>
type Fetch = FetchState<(<ResMut<'w, QueryPipeline> as SystemParam>::Fetch, <ResMut<'w, ColliderSet> as SystemParam>::Fetch)>
Auto Trait Implementations
impl<'w, 's> !RefUnwindSafe for PhysicsWorld<'w, 's>
impl<'w, 's> Send for PhysicsWorld<'w, 's>
impl<'w, 's> Sync for PhysicsWorld<'w, 's>
impl<'w, 's> Unpin for PhysicsWorld<'w, 's>
impl<'w, 's> !UnwindSafe for PhysicsWorld<'w, 's>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moresourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.