PlayRho  1.1.0
An Interactive Real-Time-Oriented C++ Physics Engine & Library
playrho::d2::DistanceConf Struct Reference

Distance Configuration. More...

#include <Distance.hpp>

Collaboration diagram for playrho::d2::DistanceConf:
[legend]

Public Types

using iteration_type = std::remove_const< decltype(DefaultMaxDistanceIters)>::type
 Iteration type.
 

Public Attributes

Simplex::Cache cache
 Cache.
 
iteration_type maxIterations = DefaultMaxDistanceIters
 Max iterations.
 

Related Functions

(Note that these are not member functions.)

DistanceConf GetDistanceConf (const ToiConf &conf) noexcept
 Gets the distance configuration for the given time of impact configuration.
 
DistanceConf GetDistanceConf (const StepConf &conf) noexcept
 Gets the distance configuration for the given step configuration.
 
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.

Friends And Related Function Documentation

◆ Distance()

DistanceOutput Distance ( const DistanceProxy proxyA,
const Transformation transformA,
const DistanceProxy proxyB,
const Transformation transformB,
DistanceConf  conf = DistanceConf{} 
)
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
proxyAProxy A.
transformATransform of A.
proxyBProxy B.
transformBTransform of B.
confConfiguration 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.

The documentation for this struct was generated from the following file: