gazebo::gui::VisualConfig Class Reference

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

#include <VisualConfig.hh>

Inheritance diagram for gazebo::gui::VisualConfig:

Signals
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...
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	Reset ()
	Reset the visual tab. More...
void	SetGeometry (const std::string &_name, const math::Vector3 &_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	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

gazebo::gui::VisualConfig::VisualConfig

(

)

Constructor.

gazebo::gui::VisualConfig::~VisualConfig

(

)

Destructor.

Member Function Documentation

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

Add a visual widget to the tab.

Parameters

[in]	_name	Name of visual added.
[in]	_visualMsg	Msg containing information of the visual to be added.

msgs::Visual* gazebo::gui::VisualConfig::GetData

(

const std::string &

_name

)

const

Get the msg containing all visual data.

Parameters

[in]

_name

Name of visual.

Returns

Visual msg.

unsigned int gazebo::gui::VisualConfig::GetVisualCount

(

)

const

Get the number of visuals.

Returns

Number of visuals.

void gazebo::gui::VisualConfig::Reset

(

)

Reset the visual tab.

void gazebo::gui::VisualConfig::SetGeometry	(	const std::string &	_name,
		const math::Vector3 &	_size,
		const std::string &	_uri = ""
	)

Set the geometry data of a visual.

Parameters

[in]	_name	Name of visual.
[in]	_size	Size of the geometry.
[in]	_uri	URI of the geometry.

void gazebo::gui::VisualConfig::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]	_name	Name of visual.
[in]	_materialName	Name of material.
[in]	_ambient	Ambient color of visual.
[in]	_diffuse	Diffuse color of visual.
[in]	_specular	Specular color of visual.
[in]	_emissive	Emissive color of visual.

void gazebo::gui::VisualConfig::UpdateVisual	(	const std::string &	_name,
		ConstVisualPtr	_visualMsg
	)

Update a visual widget from a visual msg.

Parameters

[in]	_name	Name of visual to be updated.
[in]	_visualMsg	Msg used to update the visual widget values.

void gazebo::gui::VisualConfig::VisualAdded ( const std::string &  _name )

signal

Qt signal emitted when a visual is added.

Parameters

[in]

_name

Name of visual added.

void gazebo::gui::VisualConfig::VisualRemoved ( const std::string &  _name )

signal

Qt signal emitted when a visual is removed.

Parameters

[in]

_name

Name of visual removed.

---

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

• VisualConfig.hh