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

Base callback class for collision queries. This class can be supersed by child classes to provide desired behaviors according to the application (e.g, only listing the potential CollisionObjects in collision). More...

#include <coal/broadphase/broadphase_callbacks.h>

Inheritance diagram for coal::CollisionCallBackBase:

Public Member Functions

virtual void init ()
 Initialization of the callback before running the collision broadphase manager. More...
 
virtual bool collide (CollisionObject *o1, CollisionObject *o2)=0
 Collision evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. More...
 
virtual bool operator() (CollisionObject *o1, CollisionObject *o2)
 Functor call associated to the collide operation. More...
 

Detailed Description

Base callback class for collision queries. This class can be supersed by child classes to provide desired behaviors according to the application (e.g, only listing the potential CollisionObjects in collision).

Member Function Documentation

◆ collide()

virtual bool coal::CollisionCallBackBase::collide ( CollisionObject o1,
CollisionObject o2 
)
pure 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.

Implemented in coal::CollisionCallBackCollect, and coal::CollisionCallBackDefault.

◆ init()

virtual void coal::CollisionCallBackBase::init ( )
inlinevirtual

Initialization of the callback before running the collision broadphase manager.

Reimplemented in coal::CollisionCallBackCollect, and coal::CollisionCallBackDefault.

◆ operator()()

virtual bool coal::CollisionCallBackBase::operator() ( CollisionObject o1,
CollisionObject o2 
)
inlinevirtual

Functor call associated to the collide operation.


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