Skip to content
Snippets Groups Projects
Commit e07b3382 authored by Nicolas Mansard's avatar Nicolas Mansard Committed by Nicolas Mansard
Browse files

[Doc] added doc for GeomData::activatedPair.

parent 1f9889ec
No related branches found
No related tags found
No related merge requests found
......@@ -276,7 +276,22 @@ namespace se3
~GeometryData() {};
#ifdef WITH_HPP_FCL
/// Activate a collision pair, for which collisions and distances would now be computed.
///
/// A collision (resp distance) between to geometries of GeomModel::geometryObjects
/// is computed *iff* the corresponding pair has been added in GeomModel::collisionPairs *AND*
/// it is active, i.e. the corresponding boolean in GeomData::activePairs is true. The second
/// condition can be used to temporarily remove a pair without touching the model, in a versatile
/// manner.
/// \param[in] pairId the index of the pair in GeomModel::collisionPairs vector.
/// \param[in] new value of the activation boolean (true by default).
void activateCollisionPair(const Index pairId,const bool flag=true);
/// Deactivate a collision pair.
///
/// Calls indeed GeomData::activateCollisionPair(pairId,false)
/// \sa activateCollisionPair
void deactivateCollisionPair(const Index pairId);
///
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment