coal  3.0.1
Coal, The Collision Detection Library. Previously known as HPP-FCL, fork of FCL -- The Flexible Collision Library
coal::CollisionCallBackCollect Struct Reference

Collision callback to collect collision pairs potentially in contacts. More...

#include <coal/broadphase/default_broadphase_callbacks.h>

Inheritance diagram for coal::CollisionCallBackCollect:
Collaboration diagram for coal::CollisionCallBackCollect:

Public Types

typedef std::pair< CollisionObject *, CollisionObject * > CollisionPair
 

Public Member Functions

 CollisionCallBackCollect (const size_t max_size)
 Default constructor. More...
 
bool collide (CollisionObject *o1, CollisionObject *o2)
 Collision evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. More...
 
size_t numCollisionPairs () const
 Returns the number of registered collision pairs. More...
 
const std::vector< CollisionPair > & getCollisionPairs () const
 Returns a const reference to the active collision_pairs to check. More...
 
void init ()
 Reset the callback. More...
 
bool exist (const CollisionPair &pair) const
 Check whether a collision pair exists. More...
 
bool exist (CollisionObject *o1, CollisionObject *o2) const
 Check whether a collision pair exists. More...
 
virtual ~CollisionCallBackCollect ()
 
- Public Member Functions inherited from coal::CollisionCallBackBase
virtual bool operator() (CollisionObject *o1, CollisionObject *o2)
 Functor call associated to the collide operation. More...
 

Protected Attributes

std::vector< CollisionPaircollision_pairs
 
size_t max_size
 

Detailed Description

Collision callback to collect collision pairs potentially in contacts.

Member Typedef Documentation

◆ CollisionPair

Constructor & Destructor Documentation

◆ CollisionCallBackCollect()

coal::CollisionCallBackCollect::CollisionCallBackCollect ( const size_t  max_size)

Default constructor.

◆ ~CollisionCallBackCollect()

virtual coal::CollisionCallBackCollect::~CollisionCallBackCollect ( )
inlinevirtual

Member Function Documentation

◆ collide()

bool coal::CollisionCallBackCollect::collide ( CollisionObject o1,
CollisionObject o2 
)
virtual

Collision evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true.

Parameters
[in]o1Collision object #1.
[in]o2Collision object #2.

Implements coal::CollisionCallBackBase.

◆ exist() [1/2]

bool coal::CollisionCallBackCollect::exist ( CollisionObject o1,
CollisionObject o2 
) const

Check whether a collision pair exists.

◆ exist() [2/2]

bool coal::CollisionCallBackCollect::exist ( const CollisionPair pair) const

Check whether a collision pair exists.

◆ getCollisionPairs()

const std::vector<CollisionPair>& coal::CollisionCallBackCollect::getCollisionPairs ( ) const

Returns a const reference to the active collision_pairs to check.

◆ init()

void coal::CollisionCallBackCollect::init ( )
virtual

Reset the callback.

Reimplemented from coal::CollisionCallBackBase.

◆ numCollisionPairs()

size_t coal::CollisionCallBackCollect::numCollisionPairs ( ) const

Returns the number of registered collision pairs.

Member Data Documentation

◆ collision_pairs

std::vector<CollisionPair> coal::CollisionCallBackCollect::collision_pairs
protected

◆ max_size

size_t coal::CollisionCallBackCollect::max_size
protected

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