mirror of
https://github.com/bevyengine/bevy
synced 2024-11-23 21:23:05 +00:00
601cf6b9e5
# Objective Previously, this area of bevy_math used raw translation and rotations to encode isometries, which did not exist earlier. The goal of this PR is to make the codebase of bevy_math more harmonious by using actual isometries (`Isometry2d`/`Isometry3d`) in these places instead — this will hopefully make the interfaces more digestible for end-users, in addition to facilitating conversions. For instance, together with the addition of #14478, this means that a bounding box for a collider with an isometric `Transform` can be computed as ```rust collider.aabb_3d(collider_transform.to_isometry()) ``` instead of using manual destructuring. ## Solution - The traits `Bounded2d` and `Bounded3d` now use `Isometry2d` and `Isometry3d` (respectively) instead of `translation` and `rotation` parameters; e.g.: ```rust /// A trait with methods that return 3D bounding volumes for a shape. pub trait Bounded3d { /// Get an axis-aligned bounding box for the shape translated and rotated by the given isometry. fn aabb_3d(&self, isometry: Isometry3d) -> Aabb3d; /// Get a bounding sphere for the shape translated and rotated by the given isometry. fn bounding_sphere(&self, isometry: Isometry3d) -> BoundingSphere; } ``` - Similarly, the `from_point_cloud` constructors for axis-aligned bounding boxes and bounding circles/spheres now take isometries instead of separate `translation` and `rotation`; e.g.: ```rust /// Computes the smallest [`Aabb3d`] containing the given set of points, /// transformed by the rotation and translation of the given isometry. /// /// # Panics /// /// Panics if the given set of points is empty. #[inline(always)] pub fn from_point_cloud( isometry: Isometry3d, points: impl Iterator<Item = impl Into<Vec3A>>, ) -> Aabb3d { //... } ``` This has a couple additional results: 1. The end-user no longer interacts directly with `Into<Vec3A>` or `Into<Rot2>` parameters; these conversions all happen earlier now, inside the isometry types. 2. Similarly, almost all intermediate `Vec3 -> Vec3A` conversions have been eliminated from the `Bounded3d` implementations for primitives. This probably has some performance benefit, but I have not measured it as of now. ## Testing Existing unit tests help ensure that nothing has been broken in the refactor. --- ## Migration Guide The `Bounded2d` and `Bounded3d` traits now take `Isometry2d` and `Isometry3d` parameters (respectively) instead of separate translation and rotation arguments. Existing calls to `aabb_2d`, `bounding_circle`, `aabb_3d`, and `bounding_sphere` will have to be changed to use isometries instead. A straightforward conversion is to refactor just by calling `Isometry2d/3d::new`, as follows: ```rust // Old: let aabb = my_shape.aabb_2d(my_translation, my_rotation); // New: let aabb = my_shape.aabb_2d(Isometry2d::new(my_translation, my_rotation)); ``` However, if the old translation and rotation are 3d translation/rotations originating from a `Transform` or `GlobalTransform`, then `to_isometry` may be used instead. For example: ```rust // Old: let bounding_sphere = my_shape.bounding_sphere(shape_transform.translation, shape_transform.rotation); // New: let bounding_sphere = my_shape.bounding_sphere(shape_transform.to_isometry()); ``` This discussion also applies to the `from_point_cloud` construction method of `Aabb2d`/`BoundingCircle`/`Aabb3d`/`BoundingSphere`, which has similarly been altered to use isometries.
435 lines
12 KiB
Rust
435 lines
12 KiB
Rust
//! This example demonstrates bounding volume intersections.
|
|
|
|
use bevy::{
|
|
color::palettes::css::*,
|
|
math::{bounding::*, Isometry2d},
|
|
prelude::*,
|
|
};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.init_state::<Test>()
|
|
.add_systems(Startup, setup)
|
|
.add_systems(
|
|
Update,
|
|
(update_text, spin, update_volumes, update_test_state),
|
|
)
|
|
.add_systems(
|
|
PostUpdate,
|
|
(
|
|
render_shapes,
|
|
(
|
|
aabb_intersection_system.run_if(in_state(Test::AabbSweep)),
|
|
circle_intersection_system.run_if(in_state(Test::CircleSweep)),
|
|
ray_cast_system.run_if(in_state(Test::RayCast)),
|
|
aabb_cast_system.run_if(in_state(Test::AabbCast)),
|
|
bounding_circle_cast_system.run_if(in_state(Test::CircleCast)),
|
|
),
|
|
render_volumes,
|
|
)
|
|
.chain(),
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct Spin;
|
|
|
|
fn spin(time: Res<Time>, mut query: Query<&mut Transform, With<Spin>>) {
|
|
for mut transform in query.iter_mut() {
|
|
transform.rotation *= Quat::from_rotation_z(time.delta_seconds() / 5.);
|
|
}
|
|
}
|
|
|
|
#[derive(States, Default, Debug, Hash, PartialEq, Eq, Clone, Copy)]
|
|
enum Test {
|
|
AabbSweep,
|
|
CircleSweep,
|
|
#[default]
|
|
RayCast,
|
|
AabbCast,
|
|
CircleCast,
|
|
}
|
|
|
|
fn update_test_state(
|
|
keycode: Res<ButtonInput<KeyCode>>,
|
|
cur_state: Res<State<Test>>,
|
|
mut state: ResMut<NextState<Test>>,
|
|
) {
|
|
if !keycode.just_pressed(KeyCode::Space) {
|
|
return;
|
|
}
|
|
|
|
use Test::*;
|
|
let next = match **cur_state {
|
|
AabbSweep => CircleSweep,
|
|
CircleSweep => RayCast,
|
|
RayCast => AabbCast,
|
|
AabbCast => CircleCast,
|
|
CircleCast => AabbSweep,
|
|
};
|
|
state.set(next);
|
|
}
|
|
|
|
fn update_text(mut text: Query<&mut Text>, cur_state: Res<State<Test>>) {
|
|
if !cur_state.is_changed() {
|
|
return;
|
|
}
|
|
|
|
let mut text = text.single_mut();
|
|
let text = &mut text.sections[0].value;
|
|
text.clear();
|
|
|
|
text.push_str("Intersection test:\n");
|
|
use Test::*;
|
|
for &test in &[AabbSweep, CircleSweep, RayCast, AabbCast, CircleCast] {
|
|
let s = if **cur_state == test { "*" } else { " " };
|
|
text.push_str(&format!(" {s} {test:?} {s}\n"));
|
|
}
|
|
text.push_str("\nPress space to cycle");
|
|
}
|
|
|
|
#[derive(Component)]
|
|
enum Shape {
|
|
Rectangle(Rectangle),
|
|
Circle(Circle),
|
|
Triangle(Triangle2d),
|
|
Line(Segment2d),
|
|
Capsule(Capsule2d),
|
|
Polygon(RegularPolygon),
|
|
}
|
|
|
|
fn render_shapes(mut gizmos: Gizmos, query: Query<(&Shape, &Transform)>) {
|
|
let color = GRAY;
|
|
for (shape, transform) in query.iter() {
|
|
let translation = transform.translation.xy();
|
|
let rotation = transform.rotation.to_euler(EulerRot::YXZ).2;
|
|
match shape {
|
|
Shape::Rectangle(r) => {
|
|
gizmos.primitive_2d(r, translation, rotation, color);
|
|
}
|
|
Shape::Circle(c) => {
|
|
gizmos.primitive_2d(c, translation, rotation, color);
|
|
}
|
|
Shape::Triangle(t) => {
|
|
gizmos.primitive_2d(t, translation, rotation, color);
|
|
}
|
|
Shape::Line(l) => {
|
|
gizmos.primitive_2d(l, translation, rotation, color);
|
|
}
|
|
Shape::Capsule(c) => {
|
|
gizmos.primitive_2d(c, translation, rotation, color);
|
|
}
|
|
Shape::Polygon(p) => {
|
|
gizmos.primitive_2d(p, translation, rotation, color);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Component)]
|
|
enum DesiredVolume {
|
|
Aabb,
|
|
Circle,
|
|
}
|
|
|
|
#[derive(Component, Debug)]
|
|
enum CurrentVolume {
|
|
Aabb(Aabb2d),
|
|
Circle(BoundingCircle),
|
|
}
|
|
|
|
fn update_volumes(
|
|
mut commands: Commands,
|
|
query: Query<
|
|
(Entity, &DesiredVolume, &Shape, &Transform),
|
|
Or<(Changed<DesiredVolume>, Changed<Shape>, Changed<Transform>)>,
|
|
>,
|
|
) {
|
|
for (entity, desired_volume, shape, transform) in query.iter() {
|
|
let translation = transform.translation.xy();
|
|
let rotation = transform.rotation.to_euler(EulerRot::YXZ).2;
|
|
let isometry = Isometry2d::new(translation, Rot2::radians(rotation));
|
|
match desired_volume {
|
|
DesiredVolume::Aabb => {
|
|
let aabb = match shape {
|
|
Shape::Rectangle(r) => r.aabb_2d(isometry),
|
|
Shape::Circle(c) => c.aabb_2d(isometry),
|
|
Shape::Triangle(t) => t.aabb_2d(isometry),
|
|
Shape::Line(l) => l.aabb_2d(isometry),
|
|
Shape::Capsule(c) => c.aabb_2d(isometry),
|
|
Shape::Polygon(p) => p.aabb_2d(isometry),
|
|
};
|
|
commands.entity(entity).insert(CurrentVolume::Aabb(aabb));
|
|
}
|
|
DesiredVolume::Circle => {
|
|
let circle = match shape {
|
|
Shape::Rectangle(r) => r.bounding_circle(isometry),
|
|
Shape::Circle(c) => c.bounding_circle(isometry),
|
|
Shape::Triangle(t) => t.bounding_circle(isometry),
|
|
Shape::Line(l) => l.bounding_circle(isometry),
|
|
Shape::Capsule(c) => c.bounding_circle(isometry),
|
|
Shape::Polygon(p) => p.bounding_circle(isometry),
|
|
};
|
|
commands
|
|
.entity(entity)
|
|
.insert(CurrentVolume::Circle(circle));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn render_volumes(mut gizmos: Gizmos, query: Query<(&CurrentVolume, &Intersects)>) {
|
|
for (volume, intersects) in query.iter() {
|
|
let color = if **intersects { AQUA } else { ORANGE_RED };
|
|
match volume {
|
|
CurrentVolume::Aabb(a) => {
|
|
gizmos.rect_2d(a.center(), 0., a.half_size() * 2., color);
|
|
}
|
|
CurrentVolume::Circle(c) => {
|
|
gizmos.circle_2d(c.center(), c.radius(), color);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Component, Deref, DerefMut, Default)]
|
|
struct Intersects(bool);
|
|
|
|
const OFFSET_X: f32 = 125.;
|
|
const OFFSET_Y: f32 = 75.;
|
|
|
|
fn setup(mut commands: Commands) {
|
|
commands.spawn(Camera2dBundle::default());
|
|
commands.spawn((
|
|
SpatialBundle {
|
|
transform: Transform::from_xyz(-OFFSET_X, OFFSET_Y, 0.),
|
|
..default()
|
|
},
|
|
Shape::Circle(Circle::new(45.)),
|
|
DesiredVolume::Aabb,
|
|
Intersects::default(),
|
|
));
|
|
|
|
commands.spawn((
|
|
SpatialBundle {
|
|
transform: Transform::from_xyz(0., OFFSET_Y, 0.),
|
|
..default()
|
|
},
|
|
Shape::Rectangle(Rectangle::new(80., 80.)),
|
|
Spin,
|
|
DesiredVolume::Circle,
|
|
Intersects::default(),
|
|
));
|
|
|
|
commands.spawn((
|
|
SpatialBundle {
|
|
transform: Transform::from_xyz(OFFSET_X, OFFSET_Y, 0.),
|
|
..default()
|
|
},
|
|
Shape::Triangle(Triangle2d::new(
|
|
Vec2::new(-40., -40.),
|
|
Vec2::new(-20., 40.),
|
|
Vec2::new(40., 50.),
|
|
)),
|
|
Spin,
|
|
DesiredVolume::Aabb,
|
|
Intersects::default(),
|
|
));
|
|
|
|
commands.spawn((
|
|
SpatialBundle {
|
|
transform: Transform::from_xyz(-OFFSET_X, -OFFSET_Y, 0.),
|
|
..default()
|
|
},
|
|
Shape::Line(Segment2d::new(Dir2::from_xy(1., 0.3).unwrap(), 90.)),
|
|
Spin,
|
|
DesiredVolume::Circle,
|
|
Intersects::default(),
|
|
));
|
|
|
|
commands.spawn((
|
|
SpatialBundle {
|
|
transform: Transform::from_xyz(0., -OFFSET_Y, 0.),
|
|
..default()
|
|
},
|
|
Shape::Capsule(Capsule2d::new(25., 50.)),
|
|
Spin,
|
|
DesiredVolume::Aabb,
|
|
Intersects::default(),
|
|
));
|
|
|
|
commands.spawn((
|
|
SpatialBundle {
|
|
transform: Transform::from_xyz(OFFSET_X, -OFFSET_Y, 0.),
|
|
..default()
|
|
},
|
|
Shape::Polygon(RegularPolygon::new(50., 6)),
|
|
Spin,
|
|
DesiredVolume::Circle,
|
|
Intersects::default(),
|
|
));
|
|
|
|
commands.spawn(
|
|
TextBundle::from_section("", TextStyle::default()).with_style(Style {
|
|
position_type: PositionType::Absolute,
|
|
bottom: Val::Px(12.0),
|
|
left: Val::Px(12.0),
|
|
..default()
|
|
}),
|
|
);
|
|
}
|
|
|
|
fn draw_filled_circle(gizmos: &mut Gizmos, position: Vec2, color: Srgba) {
|
|
for r in [1., 2., 3.] {
|
|
gizmos.circle_2d(position, r, color);
|
|
}
|
|
}
|
|
|
|
fn draw_ray(gizmos: &mut Gizmos, ray: &RayCast2d) {
|
|
gizmos.line_2d(
|
|
ray.ray.origin,
|
|
ray.ray.origin + *ray.ray.direction * ray.max,
|
|
WHITE,
|
|
);
|
|
draw_filled_circle(gizmos, ray.ray.origin, FUCHSIA);
|
|
}
|
|
|
|
fn get_and_draw_ray(gizmos: &mut Gizmos, time: &Time) -> RayCast2d {
|
|
let ray = Vec2::new(time.elapsed_seconds().cos(), time.elapsed_seconds().sin());
|
|
let dist = 150. + (0.5 * time.elapsed_seconds()).sin().abs() * 500.;
|
|
|
|
let aabb_ray = Ray2d {
|
|
origin: ray * 250.,
|
|
direction: Dir2::new_unchecked(-ray),
|
|
};
|
|
let ray_cast = RayCast2d::from_ray(aabb_ray, dist - 20.);
|
|
|
|
draw_ray(gizmos, &ray_cast);
|
|
ray_cast
|
|
}
|
|
|
|
fn ray_cast_system(
|
|
mut gizmos: Gizmos,
|
|
time: Res<Time>,
|
|
mut volumes: Query<(&CurrentVolume, &mut Intersects)>,
|
|
) {
|
|
let ray_cast = get_and_draw_ray(&mut gizmos, &time);
|
|
|
|
for (volume, mut intersects) in volumes.iter_mut() {
|
|
let toi = match volume {
|
|
CurrentVolume::Aabb(a) => ray_cast.aabb_intersection_at(a),
|
|
CurrentVolume::Circle(c) => ray_cast.circle_intersection_at(c),
|
|
};
|
|
**intersects = toi.is_some();
|
|
if let Some(toi) = toi {
|
|
draw_filled_circle(
|
|
&mut gizmos,
|
|
ray_cast.ray.origin + *ray_cast.ray.direction * toi,
|
|
LIME,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn aabb_cast_system(
|
|
mut gizmos: Gizmos,
|
|
time: Res<Time>,
|
|
mut volumes: Query<(&CurrentVolume, &mut Intersects)>,
|
|
) {
|
|
let ray_cast = get_and_draw_ray(&mut gizmos, &time);
|
|
let aabb_cast = AabbCast2d {
|
|
aabb: Aabb2d::new(Vec2::ZERO, Vec2::splat(15.)),
|
|
ray: ray_cast,
|
|
};
|
|
|
|
for (volume, mut intersects) in volumes.iter_mut() {
|
|
let toi = match *volume {
|
|
CurrentVolume::Aabb(a) => aabb_cast.aabb_collision_at(a),
|
|
CurrentVolume::Circle(_) => None,
|
|
};
|
|
|
|
**intersects = toi.is_some();
|
|
if let Some(toi) = toi {
|
|
gizmos.rect_2d(
|
|
aabb_cast.ray.ray.origin + *aabb_cast.ray.ray.direction * toi,
|
|
0.,
|
|
aabb_cast.aabb.half_size() * 2.,
|
|
LIME,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn bounding_circle_cast_system(
|
|
mut gizmos: Gizmos,
|
|
time: Res<Time>,
|
|
mut volumes: Query<(&CurrentVolume, &mut Intersects)>,
|
|
) {
|
|
let ray_cast = get_and_draw_ray(&mut gizmos, &time);
|
|
let circle_cast = BoundingCircleCast {
|
|
circle: BoundingCircle::new(Vec2::ZERO, 15.),
|
|
ray: ray_cast,
|
|
};
|
|
|
|
for (volume, mut intersects) in volumes.iter_mut() {
|
|
let toi = match *volume {
|
|
CurrentVolume::Aabb(_) => None,
|
|
CurrentVolume::Circle(c) => circle_cast.circle_collision_at(c),
|
|
};
|
|
|
|
**intersects = toi.is_some();
|
|
if let Some(toi) = toi {
|
|
gizmos.circle_2d(
|
|
circle_cast.ray.ray.origin + *circle_cast.ray.ray.direction * toi,
|
|
circle_cast.circle.radius(),
|
|
LIME,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn get_intersection_position(time: &Time) -> Vec2 {
|
|
let x = (0.8 * time.elapsed_seconds()).cos() * 250.;
|
|
let y = (0.4 * time.elapsed_seconds()).sin() * 100.;
|
|
Vec2::new(x, y)
|
|
}
|
|
|
|
fn aabb_intersection_system(
|
|
mut gizmos: Gizmos,
|
|
time: Res<Time>,
|
|
mut volumes: Query<(&CurrentVolume, &mut Intersects)>,
|
|
) {
|
|
let center = get_intersection_position(&time);
|
|
let aabb = Aabb2d::new(center, Vec2::splat(50.));
|
|
gizmos.rect_2d(center, 0., aabb.half_size() * 2., YELLOW);
|
|
|
|
for (volume, mut intersects) in volumes.iter_mut() {
|
|
let hit = match volume {
|
|
CurrentVolume::Aabb(a) => aabb.intersects(a),
|
|
CurrentVolume::Circle(c) => aabb.intersects(c),
|
|
};
|
|
|
|
**intersects = hit;
|
|
}
|
|
}
|
|
|
|
fn circle_intersection_system(
|
|
mut gizmos: Gizmos,
|
|
time: Res<Time>,
|
|
mut volumes: Query<(&CurrentVolume, &mut Intersects)>,
|
|
) {
|
|
let center = get_intersection_position(&time);
|
|
let circle = BoundingCircle::new(center, 50.);
|
|
gizmos.circle_2d(center, circle.radius(), YELLOW);
|
|
|
|
for (volume, mut intersects) in volumes.iter_mut() {
|
|
let hit = match volume {
|
|
CurrentVolume::Aabb(a) => circle.intersects(a),
|
|
CurrentVolume::Circle(c) => circle.intersects(c),
|
|
};
|
|
|
|
**intersects = hit;
|
|
}
|
|
}
|