Grid3D Class Reference
Manages grids in an Ignition Rendering scene. This plugin can be used for: More...
#include <Grid3D.hh>
Public Member Functions | |
| Grid3D () | |
| Constructor. More... | |
| virtual | ~Grid3D () |
| 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... | |
 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 QObject *receiver, const char *method) |
| bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
| void | dumpObjectInfo () |
| void | dumpObjectTree () |
| QList< QByteArray > | dynamicPropertyNames () const |
| virtual bool | event (QEvent *e) |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| T | findChild (const QString &name) const |
| QList< T > | findChildren (const QRegExp ®Exp) 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 |
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... | |
| Properties inherited from QObject | |
| objectName | |
Detailed Description
Manages grids in an Ignition Rendering scene. This plugin can be used for:
- Adding grids
- Introspecting grids
- Editing grids
- Deleting grids
Configuration
- <engine> : Optional render engine name, defaults to 'ogre'.
- <scene> : Optional scene name, defaults to 'scene'. If a scene with the given name doesn't exist, the plugin is not initialized.
- <auto_close> : Set to true so the plugin closes after grids given by <insert> tags are added to the scene.
- <insert> : One grid will be inserted at startup for each <insert> tag.
- <cell_count> : Number of cells in the horizontal direction, defaults to 20.
- <vertical_cell_count> : Number of cells in the vertical direction, defaults to 0;
- <cell_length> : Length of each cell, defaults to 1.
- <pose> : Grid pose, defaults to the origin.
- <color> : Grid color, defaults to (0.7, 0.7, 0.7, 1.0)
Constructor & Destructor Documentation
◆ Grid3D()
| Grid3D | ( | ) |
Constructor.
◆ ~Grid3D()
|
virtual |
Destructor.
Member Function Documentation
◆ LoadConfig()
|
overridevirtual |
The documentation for this class was generated from the following file: