Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::common::CollisionMarginPairData Class Reference

Public Member Functions

 CollisionMarginPairData (const PairsCollisionMarginData &pair_margins)
void setCollisionMargin (const LinkId &id1, const LinkId &id2, double margin)
 Set the margin for a given contact pair.
std::optional< double > getCollisionMargin (const LinkIdPair &pair) const
 Get the pairs collision margin data, or nullopt if the pair has no entry.
std::optional< double > getMaxCollisionMargin () const
 Get the largest pair collision margin.
std::optional< double > getMaxCollisionMargin (const LinkId &obj_id) const
 Get the largest collision margin for the given object.
const PairsCollisionMarginData & getCollisionMargins () const
 Get Collision Margin Data for stored pairs.
void incrementMargins (double increment)
 Increment all margins by input amount. Useful for inflating or reducing margins.
void scaleMargins (double scale)
 Scale all margins by input value.
bool empty () const
 Check if empty.
void clear ()
 Clear/Reset the data structure.
void apply (const CollisionMarginPairData &pair_margin_data, CollisionMarginPairOverrideType override_type)
 Apply the contents of the provide CollisionMarginPairData based on the override type.
bool operator== (const CollisionMarginPairData &rhs) const
bool operator!= (const CollisionMarginPairData &rhs) const

Friends

template<class Archive>
friend void::tesseract::common::serialize (Archive &ar, CollisionMarginPairData &obj)

Member Function Documentation

◆ setCollisionMargin()

void tesseract::common::CollisionMarginPairData::setCollisionMargin ( const LinkId & id1,
const LinkId & id2,
double margin )

Set the margin for a given contact pair.

Parameters
id1The first object LinkId. Order doesn't matter
id2The second object LinkId. Order doesn't matter
margincontacts with distance < collision_margin are considered in collision

◆ getCollisionMargin()

std::optional< double > tesseract::common::CollisionMarginPairData::getCollisionMargin ( const LinkIdPair & pair) const

Get the pairs collision margin data, or nullopt if the pair has no entry.

Parameters
parThe link id pair
Returns
A link pair contact margin if exists

◆ getMaxCollisionMargin() [1/2]

std::optional< double > tesseract::common::CollisionMarginPairData::getMaxCollisionMargin ( ) const

Get the largest pair collision margin.

Returns
Max pair contact distance threshold if objects exist

◆ getMaxCollisionMargin() [2/2]

std::optional< double > tesseract::common::CollisionMarginPairData::getMaxCollisionMargin ( const LinkId & obj_id) const

Get the largest collision margin for the given object.

Returns
Max contact distance threshold if object exists

◆ getCollisionMargins()

const PairsCollisionMarginData & tesseract::common::CollisionMarginPairData::getCollisionMargins ( ) const

Get Collision Margin Data for stored pairs.

Returns
A map of link pairs collision margin data

◆ incrementMargins()

void tesseract::common::CollisionMarginPairData::incrementMargins ( double increment)

Increment all margins by input amount. Useful for inflating or reducing margins.

Parameters
incrementAmount to increment margins

◆ scaleMargins()

void tesseract::common::CollisionMarginPairData::scaleMargins ( double scale)

Scale all margins by input value.

Parameters
scaleValue by which all margins are multiplied

◆ empty()

bool tesseract::common::CollisionMarginPairData::empty ( ) const

Check if empty.

Returns
True if empty otherwise false

◆ apply()

void tesseract::common::CollisionMarginPairData::apply ( const CollisionMarginPairData & pair_margin_data,
CollisionMarginPairOverrideType override_type )

Apply the contents of the provide CollisionMarginPairData based on the override type.

Parameters
pair_margin_dataThe collision margin pair data to apply
override_typeThe type indicating how the provided data should be applied.