parry3d::query::details

Function distance

Source 
pub fn distance(
    pos1: &Isometry<f32>,
    g1: &dyn Shape,
    pos2: &Isometry<f32>,
    g2: &dyn Shape,
) -> Result<f32, Unsupported>
Expand description

Computes the minimum distance separating two shapes.

This is one of the most fundamental geometric queries in collision detection. It calculates the shortest distance between any two points on the surfaces of the two shapes.

§Behavior

  • Returns the shortest distance between the two shape surfaces
  • Returns 0.0 if the shapes are touching (surfaces just make contact)
  • Returns 0.0 if the shapes are penetrating (overlapping)
  • Always returns a non-negative value

§Arguments

  • pos1 - Position and orientation of the first shape in world space
  • g1 - The first shape (can be any shape implementing the Shape trait)
  • pos2 - Position and orientation of the second shape in world space
  • g2 - The second shape (can be any shape implementing the Shape trait)

§Returns

  • Ok(distance) - The minimum distance between the shapes
  • Err(Unsupported) - If this shape pair combination is not supported

§Performance

Performance varies by shape type:

  • Ball-Ball: Very fast (analytical solution)
  • Cuboid-Cuboid: Fast (SAT-based)
  • Convex-Convex: Moderate (GJK algorithm)
  • Concave shapes: Slower (requires BVH traversal)

§Example

use parry3d::query::distance;
use parry3d::shape::Ball;
use nalgebra::Isometry3;

// Create two balls
let ball1 = Ball::new(1.0);
let ball2 = Ball::new(2.0);

// Position them 10 units apart along the x-axis
let pos1 = Isometry3::translation(0.0, 0.0, 0.0);
let pos2 = Isometry3::translation(10.0, 0.0, 0.0);

// Compute distance
let dist = distance(&pos1, &ball1, &pos2, &ball2).unwrap();

// Distance = 10.0 (separation) - 1.0 (radius1) - 2.0 (radius2) = 7.0
assert_eq!(dist, 7.0);
use parry3d::query::distance;
use parry3d::shape::Cuboid;
use nalgebra::{Isometry3, Vector3};

// Create two boxes
let box1 = Cuboid::new(Vector3::new(1.0, 1.0, 1.0));
let box2 = Cuboid::new(Vector3::new(0.5, 0.5, 0.5));

// Position them so they're touching
let pos1 = Isometry3::translation(0.0, 0.0, 0.0);
let pos2 = Isometry3::translation(1.5, 0.0, 0.0); // Edge to edge

let dist = distance(&pos1, &box1, &pos2, &box2).unwrap();

// They're touching, so distance is 0.0
assert_eq!(dist, 0.0);

§See Also