Gazebo Gui

API Reference

7.2.2

Texture node for displaying the render texture from gz-renderer. More...

#include <MinimalScene.hh>

Public Slots

void NewTexture (void *_texturePtr, const QSize &_size)
 This function gets called on the FBO rendering thread and will store the texture id and size and schedule an update on the window. More...
 
void PrepareNode ()
 Before the scene graph starts to render, we update to the pending texture. More...
 

Signals

void PendingNewTexture ()
 Signal emitted when a new texture is ready to trigger window update. More...
 
void TextureInUse (RenderSync *_renderSync)
 

Public Member Functions

 TextureNode (QQuickWindow *_window, RenderSync &_renderSync, const rendering::GraphicsAPI &_graphicsAPI)
 Constructor. More...
 
 ~TextureNode () override
 Destructor. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () const
 

Public Attributes

QMutex mutex
 Mutex to protect the texture variables. More...
 
RenderSync & renderSync
 See RenderSync. More...
 
QSize size = QSize(0, 0)
 Texture size. More...
 
QQuickWindow * window = nullptr
 Qt quick window. More...
 

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 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
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Texture node for displaying the render texture from gz-renderer.

Constructor & Destructor Documentation

◆ TextureNode()

TextureNode ( QQuickWindow *  _window,
RenderSync &  _renderSync,
const rendering::GraphicsAPI _graphicsAPI 
)
explicit

Constructor.

Parameters
[in]_windowWindow to display the texture
[in]_renderSyncRenderSync to safely synchronize Qt (this) and worker thread
[in]_graphicsAPIThe type of graphics API

◆ ~TextureNode()

~TextureNode ( )
override

Destructor.

Member Function Documentation

◆ NewTexture

void NewTexture ( void *  _texturePtr,
const QSize _size 
)
slot

This function gets called on the FBO rendering thread and will store the texture id and size and schedule an update on the window.

Parameters
[in]_texturePtrPointer to a texture Id
[in]_sizeTexture size

◆ PendingNewTexture

void PendingNewTexture ( )
signal

Signal emitted when a new texture is ready to trigger window update.

◆ PrepareNode

void PrepareNode ( )
slot

Before the scene graph starts to render, we update to the pending texture.

◆ TextureInUse

void TextureInUse ( RenderSync *  _renderSync)
signal
Parameters
[in]_renderSyncRenderSync to send to the worker thread

Member Data Documentation

◆ mutex

QMutex mutex

Mutex to protect the texture variables.

◆ renderSync

RenderSync& renderSync

See RenderSync.

◆ size

QSize size = QSize(0, 0)

Texture size.

◆ window

QQuickWindow* window = nullptr

Qt quick window.


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