playrho::d2::DistanceConf Struct Reference
Distance Configuration. More...
#include <Distance.hpp>
Public Types | |
using | iteration_type = std::remove_const< decltype(DefaultMaxDistanceIters)>::type |
Iteration type. More... | |
Public Attributes | |
Simplex::Cache | cache |
Cache. More... | |
iteration_type | maxIterations = DefaultMaxDistanceIters |
Max iterations. More... | |
Related Functions | |
(Note that these are not member functions.) | |
DistanceOutput | Distance (const DistanceProxy &proxyA, const Transformation &transformA, const DistanceProxy &proxyB, const Transformation &transformB, DistanceConf conf=DistanceConf{}) |
Determines the closest points between two shapes. More... | |
Detailed Description
Distance Configuration.
Configuration information for calling the Distance
function.
Definition at line 50 of file Distance.hpp.
Member Typedef Documentation
◆ iteration_type
using playrho::d2::DistanceConf::iteration_type = std::remove_const<decltype(DefaultMaxDistanceIters)>::type |
Iteration type.
Definition at line 53 of file Distance.hpp.
Friends And Related Function Documentation
◆ Distance()
|
related |
Determines the closest points between two shapes.
- Note
- Supports any combination of shapes.
-
On the first call, the Simplex::Cache.count should be set to zero.
- Parameters
-
proxyA Proxy A. transformA Transform of A. proxyB Proxy B. transformB Transform of B. conf Configuration to use including the simplex cache for assisting the determination.
- Returns
- Closest points between the two shapes and the count of iterations it took to determine them. The iteration count will always be greater than zero unless
DefaultMaxDistanceIters
is zero.
Definition at line 108 of file Distance.cpp.
Member Data Documentation
◆ cache
Simplex::Cache playrho::d2::DistanceConf::cache |
Cache.
Definition at line 55 of file Distance.hpp.
◆ maxIterations
iteration_type playrho::d2::DistanceConf::maxIterations = DefaultMaxDistanceIters |
Max iterations.
Definition at line 56 of file Distance.hpp.
The documentation for this struct was generated from the following file:
- Collision/Distance.hpp