PPL API Reference
Overview Core Algorithm Abstractions Utilities Parallel Methods
Modules Class Hierarchy Classes Functions
Todo List Bug List Dead Code
List of all members
CDInfo Struct Reference

Public Member Functions

Construction
 CDInfo (const bool _retAllInfo=false)
 
void ResetVars (const bool _retAllInfo=false)
 
Ordering
bool operator< (const CDInfo &_cdInfo) const noexcept
 

Public Types

Local Types
typedef std::pair< int, int > CollisionPair
 

Public Attributes

Internal State
bool m_retAllInfo
 Consider all collisions or only the first?
 
int m_collidingObstIndex
 Index for first discovered obstacle collision.
 
int m_nearestObstIndex
 Index for closest obstacle.
 
double m_minDist
 Distance between Robot and closest obstacle.
 
mathtool::Vector3d m_robotPoint
 Closest point on Robot to closest obstacle.
 
mathtool::Vector3d m_objectPoint
 Closest point on closest obstacle to Robot.
 
std::vector< CollisionPairm_trianglePairs
 All colliding triangle pairs.
 
CDClearanceMap m_clearanceMap
 Map of detected clearances.
 

Detailed Description

Information returned by validity checkers, e.g., distance from obstacles.

Todo:
Generalize this object to store collisions with obstacles, boundaries, and other robots in a uniform way. It should contain a vector of 'Collision' structures which describe the object type, indexes, and distance for each detected collision.

Member Typedef Documentation

◆ CollisionPair

typedef std::pair<int, int> CDInfo::CollisionPair

A pair of triangle indexes on the robot (first) and obstacle (second) in a discovered collision.

Constructor & Destructor Documentation

◆ CDInfo()

CDInfo::CDInfo ( const bool  _retAllInfo = false)
Parameters
_retAllInfoCompute distance information if possible

Member Function Documentation

◆ ResetVars()

void CDInfo::ResetVars ( const bool  _retAllInfo = false)

Reset object to default state.

Parameters
_retAllInfoCompute distance information if possible

◆ operator<()

bool CDInfo::operator< ( const CDInfo _cdInfo) const
noexcept

Order these objects according to the minimum distance from closest colliding obstacle.

Parameters
_cdInfoOther CDInfo
Returns
True if minimum distance is less than other's minimum distance.

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