Creates an ignition rendering scene and user camera. It is possible to orbit the camera around the scene with the mouse. Use other plugins to manage objects in the scene. More...

#include <Scene3D.hh>

Public Slots
void	OnFocusWindow ()
	Callback when the mouse enters the render window to focus the window for mouse/key events. More...

void	OnHovered (int _mouseX, int _mouseY)
	Callback when the mouse hovers to a new position. More...

Signals
void	LoadingErrorChanged ()
	Notify that loading error has changed. More...

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

virtual	~Scene3D ()
	Destructor. More...

virtual 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	LoadingError () const
	Get the loading error string. More...

Q_INVOKABLE void	SetLoadingError (const QString &_loadingError)
	Set the loading error message. 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

Protected Member Functions
bool	eventFilter (QObject _obj, QEvent _event) override

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)

Properties
QString	loadingError
	Loading error message. 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)

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

Creates an ignition rendering scene and user camera. It is possible to orbit the camera around the scene with the mouse. Use other plugins to manage objects in the scene.

Only one plugin displaying an Gazebo Rendering scene can be used at a time.

Configuration

<engine> : Optional render engine name, defaults to 'ogre'. If another engine is already loaded, that will be used, because only one engine is supported at a time currently.
<scene> : Optional scene name, defaults to 'scene'. The plugin will create a scene with this name if there isn't one yet. If there is already one, a new camera is added to it.
<ambient_light> : Optional color for ambient light, defaults to (0.3, 0.3, 0.3, 1.0)
<background_color> : Optional background color, defaults to (0.3, 0.3, 0.3, 1.0)
<camera_pose> : Optional starting pose for the camera, defaults to (0, 0, 5, 0, 0, 0)

Constructor & Destructor Documentation

◆ Scene3D()

Scene3D ( )

Constructor.

◆ ~Scene3D()

virtual ~Scene3D ( )

virtual

Destructor.

Member Function Documentation

◆ eventFilter()

bool eventFilter	(	QObject *	_obj,
		QEvent *	_event
	)

overrideprotectedvirtual

Reimplemented from QObject.

◆ LoadConfig()

virtual 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.

◆ LoadingError()

Q_INVOKABLE QString LoadingError ( ) const

Get the loading error string.

Returns: String explaining the loading error. If empty, there's no error.

◆ LoadingErrorChanged

void LoadingErrorChanged ( )

signal

Notify that loading error has changed.

◆ OnFocusWindow

void OnFocusWindow ( )

slot

Callback when the mouse enters the render window to focus the window for mouse/key events.

◆ OnHovered

void OnHovered	(	int	_mouseX,
		int	_mouseY
	)

slot

Callback when the mouse hovers to a new position.

Parameters

[in]	_mouseX	x coordinate of the hovered mouse position.
[in]	_mouseY	y coordinate of the hovered mouse position.

◆ SetLoadingError()

Q_INVOKABLE void SetLoadingError ( const QString & _loadingError )

Set the loading error message.

Parameters

[in] _loadingError Error message.

Property Documentation

◆ loadingError

QString loadingError

readwrite

Loading error message.

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

Scene3D.hh

Gazebo Gui

API Reference

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Configuration

Constructor & Destructor Documentation

◆ Scene3D()

◆ ~Scene3D()

Member Function Documentation

◆ eventFilter()

◆ LoadConfig()

◆ LoadingError()

◆ LoadingErrorChanged

◆ OnFocusWindow

◆ OnHovered

◆ SetLoadingError()

Property Documentation

◆ loadingError