//! An example demonstrating how to make a custom collider and use it for collision detection. use avian2d::{math::*, prelude::*}; use bevy::{prelude::*, sprite::MaterialMesh2dBundle}; use examples_common_2d::ExampleCommonPlugin; fn main() { App::new() .add_plugins(( DefaultPlugins, ExampleCommonPlugin, // Add physics plugins and specify a units-per-meter scaling factor, 1 meter = 10 pixels. // The unit allows the engine to tune its parameters for the scale of the world, improving stability. PhysicsPlugins::default().with_length_unit(10.0), // Add collider backend for our custom collider. // This handles things like initializing and updating required components // and managing collider hierarchies. ColliderBackendPlugin::::default(), // Enable collision detection for our custom collider. NarrowPhasePlugin::::default(), )) .insert_resource(ClearColor(Color::srgb(0.01, 0.01, 0.025))) .insert_resource(Gravity::ZERO) .add_systems(Startup, setup) .add_systems( PhysicsSchedule, (center_gravity, rotate).in_set(PhysicsStepSet::First), ) .run(); } /// A basic collider with a circle shape. Only supports uniform scaling. #[derive(Component)] struct CircleCollider { /// The radius of the circle collider. This may be scaled by the `Transform` scale. radius: Scalar, /// The radius of the circle collider without `Transform` scale applied. unscaled_radius: Scalar, /// The scaling factor, determined by `Transform` scale. scale: Scalar, } impl CircleCollider { fn new(radius: Scalar) -> Self { Self { radius, unscaled_radius: radius, scale: 1.0, } } } impl AnyCollider for CircleCollider { fn aabb(&self, position: Vector, _rotation: impl Into) -> ColliderAabb { ColliderAabb::new(position, Vector::splat(self.radius)) } fn mass_properties(&self, density: Scalar) -> ColliderMassProperties { // In 2D, the Z length is assumed to be 1.0, so volume = area let volume = PI * self.radius.powi(2); let mass = density * volume; let inertia = mass * self.radius.powi(2) / 2.0; ColliderMassProperties { mass: Mass(mass), inverse_mass: InverseMass(mass.recip()), inertia: Inertia(inertia), inverse_inertia: InverseInertia(inertia.recip()), center_of_mass: CenterOfMass::default(), } } // This is the actual collision detection part. // It compute all contacts between two colliders at the given positions. fn contact_manifolds( &self, other: &Self, position1: Vector, rotation1: impl Into, position2: Vector, rotation2: impl Into, prediction_distance: Scalar, ) -> Vec { let rotation1: Rotation = rotation1.into(); let rotation2: Rotation = rotation2.into(); let inv_rotation1 = rotation1.inverse(); let delta_pos = inv_rotation1 * (position2 - position1); let delta_rot = inv_rotation1 * rotation2; let distance_squared = delta_pos.length_squared(); let sum_radius = self.radius + other.radius; if distance_squared < (sum_radius + prediction_distance).powi(2) { let normal1 = if distance_squared != 0.0 { delta_pos.normalize_or_zero() } else { Vector::X }; let normal2 = delta_rot.inverse() * (-normal1); let point1 = normal1 * self.radius; let point2 = normal2 * other.radius; vec![ContactManifold { index: 0, normal1, normal2, contacts: vec![ContactData { feature_id1: PackedFeatureId::face(0), feature_id2: PackedFeatureId::face(0), point1, point2, normal1, normal2, penetration: sum_radius - distance_squared.sqrt(), // Impulses are computed by the constraint solver normal_impulse: 0.0, tangent_impulse: 0.0, }], }] } else { vec![] } } } // Note: This circle collider only supports uniform scaling. impl ScalableCollider for CircleCollider { fn scale(&self) -> Vector { Vector::splat(self.scale) } fn set_scale(&mut self, scale: Vector, _detail: u32) { // For non-unifprm scaling, this would need to be converted to an ellipse collider or a convex hull. self.scale = scale.max_element(); self.radius = self.unscaled_radius * scale.max_element(); } } /// A marker component for the rotating body at the center. #[derive(Component)] struct CenterBody; fn setup( mut commands: Commands, mut materials: ResMut>, mut meshes: ResMut>, ) { commands.spawn(Camera2dBundle::default()); let center_radius = 200.0; let particle_radius = 5.0; let red = materials.add(Color::srgb(0.9, 0.3, 0.3)); let blue = materials.add(Color::srgb(0.1, 0.6, 1.0)); let particle_mesh = meshes.add(Circle::new(particle_radius)); // Spawn rotating body at the center. commands .spawn(( MaterialMesh2dBundle { mesh: meshes.add(Circle::new(center_radius)).into(), material: materials.add(Color::srgb(0.7, 0.7, 0.8)).clone(), ..default() }, RigidBody::Kinematic, CircleCollider::new(center_radius.adjust_precision()), CenterBody, )) .with_children(|c| { // Spawn obstacles along the perimeter of the rotating body, like the teeth of a cog. let count = 8; let angle_step = std::f32::consts::TAU / count as f32; for i in 0..count { let pos = Quat::from_rotation_z(i as f32 * angle_step) * Vec3::Y * center_radius; c.spawn(( MaterialMesh2dBundle { mesh: particle_mesh.clone().into(), material: red.clone(), transform: Transform::from_translation(pos).with_scale(Vec3::ONE * 5.0), ..default() }, CircleCollider::new(particle_radius.adjust_precision()), )); } }); let x_count = 10; let y_count = 30; // Spawm grid of particles. These will be pulled towards the rotating body. for x in -x_count / 2..x_count / 2 { for y in -y_count / 2..y_count / 2 { commands.spawn(( MaterialMesh2dBundle { mesh: particle_mesh.clone().into(), material: blue.clone(), transform: Transform::from_xyz( x as f32 * 3.0 * particle_radius - 350.0, y as f32 * 3.0 * particle_radius, 0.0, ), ..default() }, RigidBody::Dynamic, CircleCollider::new(particle_radius.adjust_precision()), LinearDamping(0.4), )); } } } /// Pulls all particles towards the center. fn center_gravity( mut particles: Query<(&Transform, &mut LinearVelocity), Without>, time: Res