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

Default distance callback to check collision between collision objects. More...

#include <coal/broadphase/default_broadphase_callbacks.h>

Inheritance diagram for coal::DistanceCallBackDefault:
Collaboration diagram for coal::DistanceCallBackDefault:

Public Member Functions

void init ()
 Initialize the callback. Clears the distance result and sets the done boolean to false. More...
 
bool distance (CollisionObject *o1, CollisionObject *o2, Scalar &dist)
 Distance evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. More...
 
virtual ~DistanceCallBackDefault ()
 
- Public Member Functions inherited from coal::DistanceCallBackBase
virtual bool operator() (CollisionObject *o1, CollisionObject *o2, Scalar &dist)
 Functor call associated to the distance operation. More...
 

Public Attributes

DistanceData data
 

Detailed Description

Default distance callback to check collision between collision objects.

Constructor & Destructor Documentation

◆ ~DistanceCallBackDefault()

virtual coal::DistanceCallBackDefault::~DistanceCallBackDefault ( )
inlinevirtual

Member Function Documentation

◆ distance()

bool coal::DistanceCallBackDefault::distance ( CollisionObject o1,
CollisionObject o2,
Scalar dist 
)
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.

Implements coal::DistanceCallBackBase.

◆ init()

void coal::DistanceCallBackDefault::init ( )
inlinevirtual

Initialize the callback. Clears the distance result and sets the done boolean to false.

Reimplemented from coal::DistanceCallBackBase.

Member Data Documentation

◆ data

DistanceData coal::DistanceCallBackDefault::data

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