brepkit-geometry 3.2.13

Geometry algorithms: sampling, extrema, conversion
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Distance and extrema computation between geometry primitives.
//!
//! # Result types
//!
//! - [`ExtremaSolution`] — general closest-point result between two entities.
//! - [`CurveProjection`] — closest point on a curve from a query point.
//! - [`SurfaceProjection`] — closest point on a surface from a query point.
//!
//! # Algorithms
//!
//! - [`point_curve`] — point-to-curve projection (analytic fast paths + generic
//!   Newton-Raphson fallback).
//! - [`point_surface`] — point-to-surface projection (analytic fast paths + generic
//!   Newton-Raphson fallback).
//! - [`curve_curve`] — curve-to-curve minimum distance (analytic `line_to_line` +
//!   generic sampler/Newton-Raphson).
//! - [`lipschitz`] — Lipschitz global optimizer and NURBS curve-to-curve distance.
//! - [`segment`] — segment-to-segment minimum distance.

pub mod curve_curve;
pub mod lipschitz;
pub mod point_curve;
pub mod point_surface;
pub mod segment;

pub use curve_curve::{curve_to_curve, line_to_line};
pub use lipschitz::{estimate_curve_curve_lipschitz, nurbs_curve_curve_distance};
pub use point_curve::{point_to_circle, point_to_curve, point_to_line};
pub use point_surface::{
    point_to_cone, point_to_cylinder, point_to_nurbs_surface, point_to_plane, point_to_sphere,
    point_to_surface, point_to_torus,
};
pub use segment::segment_segment_distance;

use brepkit_math::vec::Point3;

/// Result of a distance/extrema computation between two geometric entities.
#[derive(Debug, Clone, Copy)]
pub struct ExtremaSolution {
    /// Minimum distance found.
    pub distance: f64,
    /// Closest point on entity A.
    pub point_a: Point3,
    /// Closest point on entity B.
    pub point_b: Point3,
    /// Parameter on entity A at closest point.
    pub param_a: f64,
    /// Parameter on entity B at closest point.
    pub param_b: f64,
}

/// Result of projecting a point onto a curve.
#[derive(Debug, Clone, Copy)]
pub struct CurveProjection {
    /// Distance from point to closest point on curve.
    pub distance: f64,
    /// Closest point on the curve.
    pub point: Point3,
    /// Parameter value at closest point.
    pub parameter: f64,
}

/// Result of projecting a point onto a surface.
#[derive(Debug, Clone, Copy)]
pub struct SurfaceProjection {
    /// Distance from point to closest point on surface.
    pub distance: f64,
    /// Closest point on the surface.
    pub point: Point3,
    /// U parameter at closest point.
    pub u: f64,
    /// V parameter at closest point.
    pub v: f64,
}