Provides a button and a transport service for taking a screenshot of current 3D scene. More...

#include <Screenshot.hh>

Public Slots
void	OnScreenshot ()
	Callback when screenshot is requested from the GUI. More...

Signals
void	DirectoryChanged ()
	Notify that the directory path has changed. More...

void	savedScreenshot ()
	Notify that the screenshot has been saved (opens popup) More...

void	SavedScreenshotPathChanged ()
	Notify that the screenshot filename has changed. More...

Public Member Functions
	Screenshot ()
	Constructor. More...

	~Screenshot () override
	Destructor. More...

Q_INVOKABLE QString	Directory () const
	Get the directory path as a string, for example '/home/Pictures'. More...

void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
	Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations. More...

Q_INVOKABLE QString	SavedScreenshotPath () const
	Get the filepath of the saved screenshot as a string, for example '/home/Pictures/[timestamp].png'. More...

Q_INVOKABLE void	SetDirectory (const QString &_dirUrl)
	Set the directory path from a string, for example '/home/Pictures'. More...

Q_INVOKABLE void	SetSavedScreenshotPath (const QString &_filename)
	Set the filepath of the saved screenshot from a string, for example '/home/Pictures/[timestamp].png'. More...

Public Member Functions inherited from Plugin
	Plugin ()
	Constructor. More...

virtual	~Plugin ()
	Destructor. More...

QQuickItem *	CardItem () const
	Get the card item which contains this plugin. The item is generated the first time this function is run. More...

virtual std::string	ConfigStr ()
	Get the configuration XML as a string. More...

QQmlContext *	Context () const
	Get the QML context where the plugin was created. More...

bool	DeleteLaterRequested () const
	Get the value of the the `delete_later` element from the configuration file, which defaults to false. More...

void	Load (const tinyxml2::XMLElement *_pluginElem)
	Load the plugin with a configuration file. This loads the default parameters and then calls LoadConfig(), which should be overridden to load custom parameters. More...

QQuickItem *	PluginItem () const
	Get the plugin item. More...

void	PostParentChanges ()
	Apply changes which should come after the plugin already has a parent. More...

virtual std::string	Title () const
	Get title. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Properties
QString	directory
	Directory to save screenshots. More...

QString	savedScreenshotPath
	Saved screenshot filepath. More...

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from Plugin
void	DeleteLater ()
	Wait until the plugin has a parent, then close and delete the parent. More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from Plugin
std::string	configStr
	XML configuration. More...

std::string	title = ""
	Title to be displayed on top of plugin. More...

Detailed Description

Provides a button and a transport service for taking a screenshot of current 3D scene.

/gui/screenshot service: Data: Path to save to, leave empty to save to latest path. Response: True if screenshot has been queued succesfully.

Constructor & Destructor Documentation

◆ Screenshot()

Screenshot ( )

Constructor.

◆ ~Screenshot()

~Screenshot ( )

override

Destructor.

Member Function Documentation

◆ Directory()

Q_INVOKABLE QString Directory ( ) const

Get the directory path as a string, for example '/home/Pictures'.

Returns: Directory

◆ DirectoryChanged

void DirectoryChanged ( )

signal

Notify that the directory path has changed.

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement * _pluginElem )

overridevirtual

Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations.

Called when a plugin is first created. This function should not be blocking.

See also: Load

Parameters

[in] _pluginElem Element containing configuration

Reimplemented from Plugin.

◆ OnScreenshot

void OnScreenshot ( )

slot

Callback when screenshot is requested from the GUI.

◆ savedScreenshot

void savedScreenshot ( )

signal

Notify that the screenshot has been saved (opens popup)

◆ SavedScreenshotPath()

Q_INVOKABLE QString SavedScreenshotPath ( ) const

Get the filepath of the saved screenshot as a string, for example '/home/Pictures/[timestamp].png'.

Returns: Saved screenshot filename

◆ SavedScreenshotPathChanged

void SavedScreenshotPathChanged ( )

signal

Notify that the screenshot filename has changed.

◆ SetDirectory()

Q_INVOKABLE void SetDirectory ( const QString & _dirUrl )

Set the directory path from a string, for example '/home/Pictures'.

Parameters

[in] _dirUrl The new directory path

◆ SetSavedScreenshotPath()

Q_INVOKABLE void SetSavedScreenshotPath ( const QString & _filename )

Set the filepath of the saved screenshot from a string, for example '/home/Pictures/[timestamp].png'.

Parameters

[in] _filename The filename (including path) of the screenshot

Property Documentation

◆ directory

QString directory

readwrite

Directory to save screenshots.

◆ savedScreenshotPath

QString savedScreenshotPath

readwrite

Saved screenshot filepath.

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

Screenshot.hh

Gazebo Gui

API Reference

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Screenshot()

◆ ~Screenshot()

Member Function Documentation

◆ Directory()

◆ DirectoryChanged

◆ LoadConfig()

◆ OnScreenshot

◆ savedScreenshot

◆ SavedScreenshotPath()

◆ SavedScreenshotPathChanged

◆ SetDirectory()

◆ SetSavedScreenshotPath()

Property Documentation

◆ directory

◆ savedScreenshotPath