Struct heron_rapier::PhysicsWorld

pub struct PhysicsWorld<'a> { /* fields omitted */ }

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

impl<'a> PhysicsWorld<'a>

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. If
• solid: If true a point cast from the inside of a solid object will stop immediately and the collision point will be the same as the from point. If false 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, 

Cast a ray with extra filters

Behaves the same as ray_cast() but takes extra arguments for filtering results:

• layers: The CollisionLayers to considered for collisions, allowing for coarse filtering of collisions.
• filter: A closure taking an [Entity] and returning true 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>

Cast a shape and get the collision shape entity, point, and normal at which it collided, if any

• shape: The CollisionShape to use for the shape cast
• start_position: The position to start the shape cast at
• rotation: The rotation of the collision shape
• end_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, 

Cast a shape with an optional filter

Behaves the same as shape_cast() but takes extra arguments for filtering results:

• layers: The CollisionLayers to considered for collisions, allowing for coarse filtering of collisions.
• filter: A closure taking an [Entity] and returning true 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

impl<'a> SystemParam for PhysicsWorld<'a>

type Fetch = PhysicsWorldState<(<ResMut<'a, QueryPipeline> as SystemParam>::Fetch, <ResMut<'a, ColliderSet> as SystemParam>::Fetch)>