Public Types | Public Member Functions | Protected Attributes | List of all members
coal::CollisionCallBackCollect Struct Reference

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

#include <default_broadphase_callbacks.h>

Inheritance diagram for coal::CollisionCallBackCollect:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

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...
 
 CollisionCallBackCollect (const size_t max_size)
 Default constructor. More...
 
bool exist (CollisionObject *o1, CollisionObject *o2) const
 Check whether a collision pair exists. More...
 
bool exist (const CollisionPair &pair) const
 Check whether a collision pair exists. 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...
 
size_t numCollisionPairs () const
 Returns the number of registered collision pairs. 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.

Definition at line 223 of file coal/broadphase/default_broadphase_callbacks.h.

Member Typedef Documentation

◆ CollisionPair

Constructor & Destructor Documentation

◆ CollisionCallBackCollect()

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

Default constructor.

Definition at line 92 of file default_broadphase_callbacks.cpp.

◆ ~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.

Definition at line 97 of file default_broadphase_callbacks.cpp.

◆ exist() [1/2]

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

Check whether a collision pair exists.

Definition at line 114 of file default_broadphase_callbacks.cpp.

◆ exist() [2/2]

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

Check whether a collision pair exists.

Definition at line 119 of file default_broadphase_callbacks.cpp.

◆ getCollisionPairs()

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

Returns a const reference to the active collision_pairs to check.

Definition at line 108 of file default_broadphase_callbacks.cpp.

◆ init()

void coal::CollisionCallBackCollect::init ( )
virtual

Reset the callback.

Reimplemented from coal::CollisionCallBackBase.

Definition at line 112 of file default_broadphase_callbacks.cpp.

◆ numCollisionPairs()

size_t coal::CollisionCallBackCollect::numCollisionPairs ( ) const

Returns the number of registered collision pairs.

Definition at line 103 of file default_broadphase_callbacks.cpp.

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 files:


hpp-fcl
Author(s):
autogenerated on Sat Nov 23 2024 03:45:00