Gazebo Sim

API Reference

10.1.1
VisualizeFrustum Class Reference

Visualize the frustum from supported camera sensor messages. More...

#include <VisualizeFrustum.hh>

Classes

struct  FrustumData
 Frustum parameters extracted from a supported sensor message. More...
 

Signals

void TopicListChanged ()
 Notify that topic list has changed.
 

Public Member Functions

 VisualizeFrustum ()
 Constructor.
 
 ~VisualizeFrustum () override
 Destructor.
 
Q_INVOKABLE void DisplayVisual (bool _value)
 Set whether to display the frustum visual.
 
bool eventFilter (QObject *_obj, QEvent *_event) override
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
void LoadFrustum ()
 Load the scene and attach FrustumVisual to the scene.
 
void OnCameraInfo (const msgs::CameraInfo &_msg)
 Callback function to get data from a CameraInfo message.
 
Q_INVOKABLE void OnRefresh ()
 Callback when refresh button is pressed.
 
void OnScan (const msgs::LogicalCameraSensor &_msg)
 Callback function to get data from a LogicalCameraSensor message.
 
Q_INVOKABLE void OnTopic (const QString &_topicName)
 Set topic to subscribe for frustum data.
 
Q_INVOKABLE void SetTopicList (const QStringList &_topicList)
 Set the list of topics.
 
Q_INVOKABLE QStringList TopicList () const
 Get the list of topics as a string list.
 
void Update (const UpdateInfo &, EntityComponentManager &_ecm) override
 Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots.
 

Properties

QStringList topicList
 Topic list.
 

Detailed Description

Visualize the frustum from supported camera sensor messages.

Constructor & Destructor Documentation

◆ VisualizeFrustum()

Constructor.

◆ ~VisualizeFrustum()

~VisualizeFrustum ( )
override

Destructor.

Member Function Documentation

◆ DisplayVisual()

Q_INVOKABLE void DisplayVisual ( bool  _value)

Set whether to display the frustum visual.

Parameters
[in]_valueBoolean value for displaying the visual

◆ eventFilter()

bool eventFilter ( QObject *  _obj,
QEvent *  _event 
)
override

◆ LoadConfig()

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

◆ LoadFrustum()

void LoadFrustum ( )

Load the scene and attach FrustumVisual to the scene.

◆ OnCameraInfo()

void OnCameraInfo ( const msgs::CameraInfo &  _msg)

Callback function to get data from a CameraInfo message.

Parameters
[in]_msgCameraInfo message used to compute frustum information

◆ OnRefresh()

Q_INVOKABLE void OnRefresh ( )

Callback when refresh button is pressed.

◆ OnScan()

void OnScan ( const msgs::LogicalCameraSensor &  _msg)

Callback function to get data from a LogicalCameraSensor message.

Parameters
[in]_msgLogicalCameraSensor message with frustum information

◆ OnTopic()

Q_INVOKABLE void OnTopic ( const QString &  _topicName)

Set topic to subscribe for frustum data.

Parameters
[in]_topicNameName of selected topic

◆ SetTopicList()

Q_INVOKABLE void SetTopicList ( const QStringList &  _topicList)

Set the list of topics.

Parameters
[in]_topicListTopic list

◆ TopicList()

Q_INVOKABLE QStringList TopicList ( ) const

Get the list of topics as a string list.

Returns
Supported topic list

◆ TopicListChanged

void TopicListChanged ( )
signal

Notify that topic list has changed.

◆ Update()

void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
overridevirtual

Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots.

Parameters
[in]_infoCurrent simulation information, such as time.
[in]_ecmMutable reference to the ECM, so the system can read and write entities and their components.

Reimplemented from GuiSystem.

Property Documentation

◆ topicList

QStringList topicList
readwrite

Topic list.


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