Stores information about how the margins allowed between collision objects.
More...
#include <collision_margin_data.h>
|
|
using | Ptr = std::shared_ptr<CollisionMarginData> |
|
using | ConstPtr = std::shared_ptr<const CollisionMarginData> |
|
|
template<class Archive> |
| friend | void::tesseract::common::serialize (Archive &ar, CollisionMarginData &obj) |
Stores information about how the margins allowed between collision objects.
◆ setDefaultCollisionMargin()
| void tesseract::common::CollisionMarginData::setDefaultCollisionMargin |
( |
double | default_collision_margin | ) |
|
Set the default collision margin.
- Parameters
-
| default_collision_margin | New default collision margin |
◆ getDefaultCollisionMargin()
| double tesseract::common::CollisionMarginData::getDefaultCollisionMargin |
( |
| ) |
const |
Get the default collision margin.
- Returns
- default collision margin
◆ setCollisionMargin()
| void tesseract::common::CollisionMarginData::setCollisionMargin |
( |
const LinkId & | id1, |
|
|
const LinkId & | id2, |
|
|
double | collision_margin ) |
Set the margin for a given contact pair.
The order of the object names does not matter, that is handled internal to the class.
- Parameters
-
| id1 | The first object LinkId. Order doesn't matter |
| id2 | The second object LinkId. Order doesn't matter |
| collision_margin | contacts with distance < collision_margin are considered in collision |
◆ getCollisionMargin() [1/2]
| double tesseract::common::CollisionMarginData::getCollisionMargin |
( |
const LinkIdPair & | pair | ) |
const |
Get the pairs collision margin data.
If a collision margin for the request pair does not exist it returns the default collision margin data.
- Parameters
-
- Returns
- A link pair contact margin
◆ getCollisionMargin() [2/2]
| double tesseract::common::CollisionMarginData::getCollisionMargin |
( |
const LinkId & | id1, |
|
|
const LinkId & | id2 ) const |
Get the pairs collision margin data.
If a collision margin for the request pair does not exist it returns the default collision margin data.
- Parameters
-
| id1 | The first object id |
| id2 | The second object id |
- Returns
- A link pair contact margin
◆ getCollisionMarginPairData()
Get Collision Margin Data for stored pairs.
- Returns
- A map of link pairs collision margin data
◆ getMaxCollisionMargin() [1/2]
| double tesseract::common::CollisionMarginData::getMaxCollisionMargin |
( |
| ) |
const |
Get the largest collision margin.
This used when setting the contact distance in the contact manager.
- Returns
- Max contact distance threshold
◆ getMaxCollisionMargin() [2/2]
| double tesseract::common::CollisionMarginData::getMaxCollisionMargin |
( |
const LinkId & | obj_id | ) |
const |
Get the largest collision margin for the given object.
This used when setting the contact distance in the contact manager.
- Returns
- Max contact distance threshold
◆ incrementMargins()
| void tesseract::common::CollisionMarginData::incrementMargins |
( |
double | increment | ) |
|
Increment all margins by input amount. Useful for inflating or reducing margins.
- Parameters
-
| increment | Amount to increment margins |
◆ scaleMargins()
| void tesseract::common::CollisionMarginData::scaleMargins |
( |
double | scale | ) |
|
Scale all margins by input value.
- Parameters
-
| scale | Value by which all margins are multiplied |
◆ apply()
Apply the contents of the provide CollisionMarginPairData based on the override type.
- Parameters
-
| pair_margin_data | The collision margin pair data to apply |
| override_type | The type indicating how the provided data should be applied. |