CollisionConfig Class Reference

A tab for configuring collision properties of a link. More...

#include <CollisionConfig.hh>

Inherits QWidget.

Public Slots

void RestoreOriginalData ()
 Restore the widget's data to how it was when first opened. More...
 

Signals

void Applied ()
 Qt signal emitted to indicate that changes should be applied. More...
 
void CollisionAdded (const std::string &_name)
 Qt signal emitted when a collision is added. More...
 
void CollisionChanged (const std::string &_name, const std::string &_type)
 Signal to indicate a collision change. More...
 
void CollisionRemoved (const std::string &_name)
 Qt signal emitted when a collision is removed. More...
 
void ShowCollision (const bool _show, const std::string &_name)
 Qt signal emitted requesting to show/hide a collision. More...
 

Public Member Functions

 CollisionConfig ()
 Constructor. More...
 
 ~CollisionConfig ()
 Destructor. More...
 
void AddCollision (const std::string &_name, const msgs::Collision *_collisionMsg=NULL)
 Add a collision widget to the tab. More...
 
const std::map< int, CollisionConfigData * > & ConfigData () const
 Get collision config data. More...
 
void Geometry (const std::string &_name, ignition::math::Vector3d &_size, std::string &_uri) const
 Get the geometry data of a collision. More...
 
unsigned int GetCollisionCount () const
 Get the number of collisions. More...
 
msgs::Collision * GetData (const std::string &_name) const
 Get the msg containing all collision data. More...
 
void Init ()
 Initialize widget. More...
 
void Reset ()
 Reset the collision tab. More...
 
void SetGeometry (const std::string &_name, const ignition::math::Vector3d &_size, const std::string &_uri="")
 Set the geometry data of a collision. More...
 
void SetShowCollision (const bool _show, const std::string &_name)
 Set the state of a show collision button. More...
 
void UpdateCollision (const std::string &_name, ConstCollisionPtr _collisionMsg)
 Update a collision widget from a collision msg. More...
 

Detailed Description

A tab for configuring collision properties of a link.

Constructor & Destructor Documentation

Constructor.

Destructor.

Member Function Documentation

void AddCollision ( const std::string &  _name,
const msgs::Collision *  _collisionMsg = NULL 
)

Add a collision widget to the tab.

Parameters
[in]_nameName of collision added.
[in]_collisionMsgMsg containing information of the collision to be added.
void Applied ( )
signal

Qt signal emitted to indicate that changes should be applied.

void CollisionAdded ( const std::string &  _name)
signal

Qt signal emitted when a collision is added.

Parameters
[in]_nameName of collision added.
void CollisionChanged ( const std::string &  _name,
const std::string &  _type 
)
signal

Signal to indicate a collision change.

Parameters
[in]_nameName of collision changed.
[in]_typeType of change.
void CollisionRemoved ( const std::string &  _name)
signal

Qt signal emitted when a collision is removed.

Parameters
[in]_nameName of collision removed.
const std::map<int, CollisionConfigData *>& ConfigData ( ) const

Get collision config data.

Returns
Config data for the collisions.
void Geometry ( const std::string &  _name,
ignition::math::Vector3d &  _size,
std::string &  _uri 
) const

Get the geometry data of a collision.

Parameters
[in]_nameName of collision.
[in]_sizeSize of the geometry.
[in]_uriURI of the geometry.
unsigned int GetCollisionCount ( ) const

Get the number of collisions.

Returns
Number of collisions.
msgs::Collision* GetData ( const std::string &  _name) const

Get the msg containing all collision data.

Parameters
[in]_nameName of collision.
Returns
Collision msg.
void Init ( )

Initialize widget.

void Reset ( )

Reset the collision tab.

void RestoreOriginalData ( )
slot

Restore the widget's data to how it was when first opened.

void SetGeometry ( const std::string &  _name,
const ignition::math::Vector3d &  _size,
const std::string &  _uri = "" 
)

Set the geometry data of a collision.

Parameters
[in]_nameName of collision.
[in]_sizeSize to set the geometry to.
[in]_uriURI of the geometry.
void SetShowCollision ( const bool  _show,
const std::string &  _name 
)

Set the state of a show collision button.

Parameters
[in]_showIf true, button is checked.
[in]_nameName of collision.
void ShowCollision ( const bool  _show,
const std::string &  _name 
)
signal

Qt signal emitted requesting to show/hide a collision.

Parameters
[in]_showTrue to show, false to hide.
[in]_nameName of collision removed.
void UpdateCollision ( const std::string &  _name,
ConstCollisionPtr  _collisionMsg 
)

Update a collision widget from a collision msg.

Parameters
[in]_nameName of collision to be updated.
[in]_collisionMsgMsg used to update the collision widget values.

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