Public Member Functions | List of all members
hpp::fcl::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 hpp::fcl::DistanceCallBackBase:
Inheritance graph
[legend]

Public Member Functions

virtual bool distance (CollisionObject *o1, CollisionObject *o2, FCL_REAL &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, FCL_REAL &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 73 of file broadphase_callbacks.h.

Member Function Documentation

◆ distance()

virtual bool hpp::fcl::DistanceCallBackBase::distance ( CollisionObject o1,
CollisionObject o2,
FCL_REAL 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 hpp::fcl::DistanceCallBackDefault, hpp::fcl::DistanceCallBackBaseWrapper, and DistanceCallBackDerived.

◆ init()

virtual void hpp::fcl::DistanceCallBackBase::init ( )
inlinevirtual

Initialization of the callback before running the collision broadphase manager.

Reimplemented in hpp::fcl::DistanceCallBackBaseWrapper.

Definition at line 76 of file broadphase_callbacks.h.

◆ operator()()

virtual bool hpp::fcl::DistanceCallBackBase::operator() ( CollisionObject o1,
CollisionObject o2,
FCL_REAL dist 
)
inlinevirtual

Functor call associated to the distance operation.

Definition at line 89 of file broadphase_callbacks.h.


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


hpp-fcl
Author(s):
autogenerated on Fri Jun 2 2023 02:39:03