ImageDisplay Class Reference

Display images coming through a Gazebo Transport topic. More...

#include <ImageDisplay.hh>

Public Slots
void	OnRefresh ()
	Callback when refresh button is pressed.
void	OnTopic (const QString _topic)
	Callback when a new topic is chosen on the combo box.

Signals
void	newImage ()
	Notify that a new image has been received.
void	TopicListChanged ()
	Notify that topic list has changed.

Public Member Functions
	ImageDisplay ()
	Constructor.
virtual	~ImageDisplay ()
	Destructor.
Q_INVOKABLE QString	ImageProviderName ()
	Get the provider name unique to this plugin instance.
virtual void	LoadConfig (const tinyxml2::XMLElement *_pluginElem)
Q_INVOKABLE void	RegisterImageProvider (const QString &_uniqueName)
	Register the image provider with the given name.
void	SetEnableDepthFlip (bool _enable)
	Enable or disable the depth image flip checkbox.
Q_INVOKABLE void	SetFlipDepthVisualization (bool _value)
	Set whether darker pixels in depth image have higher values or lower values.
Q_INVOKABLE void	SetTopicList (const QStringList &_topicList)
	Set the topic list from a string, for example 'gz.msgs.StringMsg'.
Q_INVOKABLE QStringList	TopicList () const
	Get the topic list as a string, for example 'gz.msgs.StringMsg'.

Properties
QStringList	topicList
	Topic list.

Detailed Description

Display images coming through a Gazebo Transport topic.

Configuration

<topic> : Set the topic to receive image messages. <topic_picker> : Whether to show the topic picker, true by default. If this is false, a <topic> must be specified. <show_depth_flip> : Whether to show the Flip Depth Image Visualization Checkbox, true by default.

Constructor & Destructor Documentation

ImageDisplay()

ImageDisplay

(

)

Constructor.

~ImageDisplay()

virtual ~ImageDisplay ( )

virtual

Destructor.

Member Function Documentation

ImageProviderName()

Q_INVOKABLE QString ImageProviderName

(

)

Get the provider name unique to this plugin instance.

LoadConfig()

virtual void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem )

virtual

newImage

void newImage ( )

signal

Notify that a new image has been received.

OnRefresh

void OnRefresh ( )

slot

Callback when refresh button is pressed.

OnTopic

void OnTopic ( const QString  _topic )

slot

Callback when a new topic is chosen on the combo box.

RegisterImageProvider()

Q_INVOKABLE void RegisterImageProvider

(

const QString &

_uniqueName

)

Register the image provider with the given name.

Parameters

[in]

_uniqueName

Unique name for the provider to be registered

SetEnableDepthFlip()

void SetEnableDepthFlip ( bool  _enable )

inline

Enable or disable the depth image flip checkbox.

Parameters

[in]

_enable

Boolean value for enabling/disabling the depth image flip checkbox

Note

This is used to disable the checkbox when the image format is not depth

SetFlipDepthVisualization()

Q_INVOKABLE void SetFlipDepthVisualization

(

bool

_value

)

Set whether darker pixels in depth image have higher values or lower values.

Parameters

[in]

_value

Boolean value for flipping the depth image display style

SetTopicList()

Q_INVOKABLE void SetTopicList

(

const QStringList &

_topicList

)

Set the topic list from a string, for example 'gz.msgs.StringMsg'.

Parameters

[in]

_topicList

Message type

TopicList()

Q_INVOKABLE QStringList TopicList

(

)

const

Get the topic list as a string, for example 'gz.msgs.StringMsg'.

Returns

Message type

TopicListChanged

void TopicListChanged ( )

signal

Notify that topic list has changed.

Property Documentation

topicList

QStringList topicList

readwrite

Topic list.

---

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

• ImageDisplay.hh