Expand description
Non-persistent geometric queries.
§General cases
The most general methods provided by this module are:
closest_points()
to compute the closest points between two shapes.distance()
to compute the distance between two shapes.contact()
to compute one pair of contact points between two shapes, including penetrating contact.intersection_test()
to determine if two shapes are intersecting or not.cast_shapes()
to determine when two shapes undergoing translational motions hit for the first time.cast_shapes_nonlinear()
to determine when two shapes undergoing continuous rigid motions hit for the first time.
Ray-casting and point-projection can be achieved by importing traits:
RayCast
for ray-casting.PointQuery
for point projection.
§Specific cases
The functions exported by the details
submodule are more specific versions of the ones described above.
For example distance_ball_ball
computes the distance between two shapes known at compile-time to be balls.
They are less convenient to use than the most generic version but will be slightly faster due to the lack of dynamic dispatch.
The specific functions have the form [operation]_[shape1]_[shape2]()
where:
[operation]
can beclosest_points
,distance
,contact
,intersection_test
ortime_of_impact
.[shape1]
is the type of the first shape passed to the function, e.g.,ball
, orhalfspace
. Can also identify a trait implemented by supported shapes, e.g.,support_map
.[shape2]
is the type of the second shape passed to the function, e.g.,ball
, orhalfspace
. Can also identify a trait implemented by supported shapes, e.g.,support_map
.
Re-exports§
pub use self::closest_points::closest_points;
pub use self::closest_points::ClosestPoints;
pub use self::contact::contact;
pub use self::contact::Contact;
pub use self::point::PointProjection;
pub use self::point::PointQuery;
pub use self::point::PointQueryWithLocation;
Modules§
- Implementation details of the
closest_points
function. - Implementation details of the
contact
andcontacts
functions. - Queries dedicated to specific pairs of shapes.
- The EPA algorithm for penetration depth computation.
- The GJK algorithm for distance computation.
- Point inclusion and projection.
- Application of the Separating-Axis-Theorem (SAT).
- Visitors for performing geometric queries exploiting spatial partitioning data structures.
Structs§
- A contact manifold between two shapes.
- A serializable workspace used by some contact-manifolds computation algorithms.
- A dispatcher that exposes built-in queries
- A nonlinear motion from a starting isometry traveling at constant translational and rotational velocity.
- The composition of two dispatchers
- A Ray.
- Structure containing the result of a successful ray cast.
- The result of a shape casting..
- Configuration for controlling the behavior of time-of-impact (i.e. shape-casting) calculations.
- A structure representing 4 rays in an SIMD SoA fashion.
- A single contact between two shape.
- Error indicating that a query is not supported between certain shapes
Enums§
- The result of a plane-intersection operation.
- The status of the time-of-impact computation algorithm.
- The result of a plane-splitting operation.
- Enum representing workspace data of a specific type.
Traits§
- A query dispatcher for queries relying on spatial coherence, including contact-manifold computation.
- Dispatcher for pairwise queries.
- Traits of objects which can be transformed and tested for intersection with a ray.
- Data from a
ContactManifoldsWorkspace
.
Functions§
- Computes the smallest time when two shapes under translational movement are separated by a distance smaller or equal to
distance
. - Computes the smallest time of impact of two shapes under translational an rotational movements.
- Computes the minimum distance separating two shapes.
- Tests whether two shapes are intersecting.