Struct heron_rapier::PhysicsWorld [−][src]
pub struct PhysicsWorld<'a> { /* fields omitted */ }
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
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.
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,
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.
pub 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 atrotation
: The rotation of the collision shapeend_posiion
: The end position of the shape cast
Panics
This will panic if the start position and end position are the same.
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,
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
type Fetch = PhysicsWorldState<(<ResMut<'a, QueryPipeline> as SystemParam>::Fetch, <ResMut<'a, ColliderSet> as SystemParam>::Fetch)>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for PhysicsWorld<'a>
impl<'a> Send for PhysicsWorld<'a>
impl<'a> Sync for PhysicsWorld<'a>
impl<'a> Unpin for PhysicsWorld<'a>
impl<'a> !UnwindSafe for PhysicsWorld<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
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 more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub 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 more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub 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 more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
pub fn vzip(self) -> V