VisualConfig Class Reference

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

#include <VisualConfig.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 ShowVisual (const bool _show, const std::string &_name)
 Qt signal emitted requesting to show/hide a collision. More...
 
void VisualAdded (const std::string &_name)
 Qt signal emitted when a visual is added. More...
 
void VisualRemoved (const std::string &_name)
 Qt signal emitted when a visual is removed. More...
 

Public Member Functions

 VisualConfig ()
 Constructor. More...
 
 ~VisualConfig ()
 Destructor. More...
 
void AddVisual (const std::string &_name, const msgs::Visual *_visualMsg=NULL)
 Add a visual widget to the tab. More...
 
const std::map< int, VisualConfigData * > & ConfigData () const
 Get visual config data. More...
 
void Geometry (const std::string &_name, ignition::math::Vector3d &_size, std::string &_uri)
 Get the geometry data of a visual. More...
 
msgs::Visual * GetData (const std::string &_name) const
 Get the msg containing all visual data. More...
 
unsigned int GetVisualCount () const
 Get the number of visuals. More...
 
void Init ()
 Initialize widget. More...
 
void Reset ()
 Reset the visual tab. More...
 
void SetGeometry (const std::string &_name, const ignition::math::Vector3d &_size, const std::string &_uri="")
 Set the geometry data of a visual. More...
 
void SetMaterial (const std::string &_name, const std::string &_materialName, const common::Color &_ambient, const common::Color &_diffuse, const common::Color &_specular, const common::Color &_emissive)
 Set the material of a visual. More...
 
void SetShowVisual (const bool _show, const std::string &_name)
 Set the state of a show collision button. More...
 
void UpdateVisual (const std::string &_name, ConstVisualPtr _visualMsg)
 Update a visual widget from a visual msg. More...
 

Detailed Description

A tab for configuring visual properties of a link.

Constructor & Destructor Documentation

Constructor.

Destructor.

Member Function Documentation

void AddVisual ( const std::string &  _name,
const msgs::Visual *  _visualMsg = NULL 
)

Add a visual widget to the tab.

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

Qt signal emitted to indicate that changes should be applied.

const std::map<int, VisualConfigData *>& ConfigData ( ) const

Get visual config data.

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

Get the geometry data of a visual.

Parameters
[in]_nameName of visual.
[in]_sizeSize of the geometry.
[in]_uriURI of the geometry.
msgs::Visual* GetData ( const std::string &  _name) const

Get the msg containing all visual data.

Parameters
[in]_nameName of visual.
Returns
Visual msg.
unsigned int GetVisualCount ( ) const

Get the number of visuals.

Returns
Number of visuals.
void Init ( )

Initialize widget.

void Reset ( )

Reset the visual 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 visual.

Parameters
[in]_nameName of visual.
[in]_sizeSize of the geometry.
[in]_uriURI of the geometry.
void SetMaterial ( const std::string &  _name,
const std::string &  _materialName,
const common::Color _ambient,
const common::Color _diffuse,
const common::Color _specular,
const common::Color _emissive 
)

Set the material of a visual.

Parameters
[in]_nameName of visual.
[in]_materialNameName of material.
[in]_ambientAmbient color of visual.
[in]_diffuseDiffuse color of visual.
[in]_specularSpecular color of visual.
[in]_emissiveEmissive color of visual.
void SetShowVisual ( 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 ShowVisual ( 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 UpdateVisual ( const std::string &  _name,
ConstVisualPtr  _visualMsg 
)

Update a visual widget from a visual msg.

Parameters
[in]_nameName of visual to be updated.
[in]_visualMsgMsg used to update the visual widget values.
void VisualAdded ( const std::string &  _name)
signal

Qt signal emitted when a visual is added.

Parameters
[in]_nameName of visual added.
void VisualRemoved ( const std::string &  _name)
signal

Qt signal emitted when a visual is removed.

Parameters
[in]_nameName of visual removed.

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