Public Member Functions | Public Attributes | Protected Attributes | List of all members
pinocchio::CollisionCallBackBase Struct Referenceabstract

Interface for Pinocchio collision callback functors. More...

#include <broadphase-callbacks.hpp>

Inheritance diagram for pinocchio::CollisionCallBackBase:
Inheritance graph
[legend]

Public Member Functions

 CollisionCallBackBase (const GeometryModel &geometry_model, GeometryData &geometry_data)
 
virtual void done ()
 Callback method called after the termination of a collisition detection algorithm. The default implementation does nothing. More...
 
GeometryDatagetGeometryData ()
 
const GeometryDatagetGeometryData () const
 
const GeometryModelgetGeometryModel () const
 
virtual bool stop () const =0
 If true, the stopping criteria related to the collision callback has been met and one can stop. More...
 
- Public Member Functions inherited from hpp::fcl::CollisionCallBackBase
virtual bool collide (CollisionObject *o1, CollisionObject *o2)=0
 
virtual void init ()
 
virtual bool operator() (CollisionObject *o1, CollisionObject *o2)
 

Public Attributes

bool accumulate
 Whether the callback is used in an accumulate mode where several collide methods are called successively. More...
 
bool collision
 Whether there is a collision or not. More...
 

Protected Attributes

GeometryDatageometry_data_ptr
 Geometry data associated to the callback. More...
 
const GeometryModelgeometry_model_ptr
 Geometry model associated to the callback. More...
 

Detailed Description

Interface for Pinocchio collision callback functors.

Definition at line 19 of file broadphase-callbacks.hpp.

Constructor & Destructor Documentation

◆ CollisionCallBackBase()

pinocchio::CollisionCallBackBase::CollisionCallBackBase ( const GeometryModel geometry_model,
GeometryData geometry_data 
)
inline

Definition at line 21 of file broadphase-callbacks.hpp.

Member Function Documentation

◆ done()

virtual void pinocchio::CollisionCallBackBase::done ( )
inlinevirtual

Callback method called after the termination of a collisition detection algorithm. The default implementation does nothing.

Reimplemented in pinocchio::CollisionCallBackDefault, and pinocchio::python::CollisionCallBackBaseWrapper.

Definition at line 48 of file broadphase-callbacks.hpp.

◆ getGeometryData() [1/2]

GeometryData& pinocchio::CollisionCallBackBase::getGeometryData ( )
inline

Definition at line 37 of file broadphase-callbacks.hpp.

◆ getGeometryData() [2/2]

const GeometryData& pinocchio::CollisionCallBackBase::getGeometryData ( ) const
inline

Definition at line 33 of file broadphase-callbacks.hpp.

◆ getGeometryModel()

const GeometryModel& pinocchio::CollisionCallBackBase::getGeometryModel ( ) const
inline

Definition at line 29 of file broadphase-callbacks.hpp.

◆ stop()

virtual bool pinocchio::CollisionCallBackBase::stop ( ) const
pure virtual

If true, the stopping criteria related to the collision callback has been met and one can stop.

Implemented in pinocchio::CollisionCallBackDefault, and pinocchio::python::CollisionCallBackBaseWrapper.

Member Data Documentation

◆ accumulate

bool pinocchio::CollisionCallBackBase::accumulate

Whether the callback is used in an accumulate mode where several collide methods are called successively.

Definition at line 63 of file broadphase-callbacks.hpp.

◆ collision

bool pinocchio::CollisionCallBackBase::collision

Whether there is a collision or not.

Definition at line 59 of file broadphase-callbacks.hpp.

◆ geometry_data_ptr

GeometryData* pinocchio::CollisionCallBackBase::geometry_data_ptr
protected

Geometry data associated to the callback.

Definition at line 55 of file broadphase-callbacks.hpp.

◆ geometry_model_ptr

const GeometryModel* pinocchio::CollisionCallBackBase::geometry_model_ptr
protected

Geometry model associated to the callback.

Definition at line 48 of file broadphase-callbacks.hpp.


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


pinocchio
Author(s):
autogenerated on Sat Jun 22 2024 02:41:52