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

Base callback class for distance 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::DistanceCallBackBase:

Public Member Functions

virtual void init ()
 Initialization of the callback before running the collision broadphase manager. More...
 
virtual bool distance (CollisionObject *o1, CollisionObject *o2, Scalar &dist)=0
 Distance 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, Scalar &dist)
 Functor call associated to the distance operation. More...
 

Detailed Description

Base callback class for distance 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

◆ distance()

virtual bool coal::DistanceCallBackBase::distance ( CollisionObject o1,
CollisionObject o2,
Scalar dist 
)
pure virtual

Distance 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.
[out]distDistance between the two collision geometries.

Implemented in coal::DistanceCallBackDefault.

◆ init()

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

Initialization of the callback before running the collision broadphase manager.

Reimplemented in coal::DistanceCallBackDefault.

◆ operator()()

virtual bool coal::DistanceCallBackBase::operator() ( CollisionObject o1,
CollisionObject o2,
Scalar dist 
)
inlinevirtual

Functor call associated to the distance operation.


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