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

Inheritance diagram for hpp::fcl::CollisionCallBackBase:
Inheritance graph
[legend]

Public Member Functions

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 void init ()
 Initialization of the callback before running the collision broadphase manager. 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).

Definition at line 50 of file broadphase_callbacks.h.

Member Function Documentation

◆ collide()

virtual bool hpp::fcl::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 hpp::fcl::CollisionCallBackCollect, hpp::fcl::CollisionCallBackDefault, CollisionFunctionForUniquenessChecking, and hpp::fcl::CollisionCallBackBaseWrapper.

◆ init()

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

Initialization of the callback before running the collision broadphase manager.

Reimplemented in hpp::fcl::CollisionCallBackCollect, hpp::fcl::CollisionCallBackDefault, and hpp::fcl::CollisionCallBackBaseWrapper.

Definition at line 53 of file broadphase_callbacks.h.

◆ operator()()

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

Functor call associated to the collide operation.

Definition at line 64 of file broadphase_callbacks.h.


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


hpp-fcl
Author(s):
autogenerated on Fri Jan 26 2024 03:46:16