Public Member Functions | List of all members
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 <broadphase_callbacks.h>

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

Public Member Functions

virtual bool distance (CollisionObject *o1, CollisionObject *o2, CoalScalar &dist)=0
 Distance evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. More...
 
virtual void init ()
 Initialization of the callback before running the collision broadphase manager. More...
 
virtual bool operator() (CollisionObject *o1, CollisionObject *o2, CoalScalar &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).

Definition at line 72 of file coal/broadphase/broadphase_callbacks.h.

Member Function Documentation

◆ distance()

virtual bool coal::DistanceCallBackBase::distance ( CollisionObject o1,
CollisionObject o2,
CoalScalar 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, coal::DistanceCallBackBaseWrapper, and DistanceCallBackDerived.

◆ init()

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

Initialization of the callback before running the collision broadphase manager.

Reimplemented in coal::DistanceCallBackDefault, and coal::DistanceCallBackBaseWrapper.

Definition at line 75 of file coal/broadphase/broadphase_callbacks.h.

◆ operator()()

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

Functor call associated to the distance operation.

Definition at line 88 of file coal/broadphase/broadphase_callbacks.h.


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


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