Struct PointProjection

pub struct PointProjection {
    pub is_inside: bool,
    pub point: Point<f32>,
}

The result of projecting a point onto a shape.

Point projection finds the closest point on a shape’s surface to a given query point. This is fundamental for many geometric queries including distance calculation, collision detection, and surface sampling.

Fields

• is_inside: Whether the query point is inside the shape
• point: The closest point on the shape’s surface

Inside vs Outside

The is_inside flag indicates the query point’s location relative to the shape:

• true: Query point is inside the shape (projection is on boundary)
• false: Query point is outside the shape (projection is nearest surface point)

Solid Parameter

Most projection functions take a solid parameter:

• solid = true: Shape is treated as solid (filled interior)
• solid = false: Shape is treated as hollow (surface only)

This affects is_inside calculation for points in the interior.

Example

use parry3d::query::PointQuery;
use parry3d::shape::Ball;
use nalgebra::{Point3, Isometry3};

let ball = Ball::new(5.0);
let ball_pos = Isometry3::translation(10.0, 0.0, 0.0);

// Project a point outside the ball
let outside_point = Point3::origin();
let proj = ball.project_point(&ball_pos, &outside_point, true);

// Closest point on ball surface
assert_eq!(proj.point, Point3::new(5.0, 0.0, 0.0));
assert!(!proj.is_inside);

// Project a point inside the ball
let inside_point = Point3::new(10.0, 0.0, 0.0); // At center
let proj2 = ball.project_point(&ball_pos, &inside_point, true);
assert!(proj2.is_inside);

Fields

is_inside: bool

Whether the query point was inside the shape.

• true: Point is in the interior (for solid shapes)
• false: Point is outside the shape

point: Point<f32>

The closest point on the shape’s surface to the query point.

If is_inside = true, this is the nearest point on the boundary. If is_inside = false, this is the nearest surface point.

Implementations

impl PointProjection

pub fn new(is_inside: bool, point: Point<f32>) -> Self

Initializes a new PointProjection.

pub fn transform_by(&self, pos: &Isometry<f32>) -> Self

Transforms self.point by pos.

pub fn is_inside_eps(&self, original_point: &Point<f32>, min_dist: f32) -> bool

Returns true if Self::is_inside is true or if the distance between the projected point and point is smaller than min_dist.

Trait Implementations

impl Clone for PointProjection

fn clone(&self) -> PointProjection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PointProjection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PointProjection

fn default() -> PointProjection

Returns the “default value” for a type.

impl Copy for PointProjection