Developer Documentation
PropertyVisPlugin Class Reference
Inheritance diagram for PropertyVisPlugin:
LoggingInterface PickingInterface MouseInterface ScriptInterface KeyInterface ToolboxInterface LoadSaveInterface BaseInterface

Public Slots

void slotVisualizeProperty (int _id, const QString &_propname)
 
void slotClear (int _id, const QString &_propname)
 
QScriptValue getPropertyVisualizer (int _id, const QString &_propname)
 

Signals

void updateView () override
 
void updatedObject (int, const UpdateType &) override
 
void log (Logtype, QString) override
 
void log (QString) override
 
void addToolbox (QString _name, QWidget *_widget, QIcon *_icon) override
 
void addHiddenPickMode (const std::string &_mode) override
 
void getScriptingEngine (QScriptEngine *&_engine) override
 
- Signals inherited from BaseInterface
virtual void updateView ()
 Update current view in Main Application. More...
 
virtual void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 Set a description for a public slot. More...
 
virtual void setRenderer (unsigned int _viewer, QString _rendererName)
 Set a renderer for the given viewer. More...
 
- Signals inherited from LoadSaveInterface
virtual void save (int _id, QString _filename)
 Save object to a file. More...
 
virtual void load (QString _filename, DataType _type, int &_id)
 Load object from file with a specific DataType. More...
 
- Signals inherited from ToolboxInterface
virtual void addToolbox (QString _name, QWidget *_widget)
 Add a toolbox widget to the gui with the given name. More...
 
- Signals inherited from KeyInterface
virtual void registerKey (int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse=false)
 Register a key-combination for your plugin. More...
 
- Signals inherited from ScriptInterface
virtual void scriptInfo (QString _functionWithParameters)
 Emit this signal if a scriptable function is executed. More...
 
virtual void getScriptingEngine (QScriptEngine *&_engine)
 
virtual void executeFileScript (QString _filename)
 
virtual void getAvailableFunctions (QStringList &_functions)
 
- Signals inherited from PickingInterface
virtual void addPickMode (const std::string &_mode)
 Add a new picking mode to the examiner. More...
 
- Signals inherited from LoggingInterface
virtual void log (Logtype _type, QString _message)=0
 
virtual void log (QString _message)=0
 

Public Member Functions

QString name () override
 Return a name for the plugin. More...
 
QString description () override
 Return a description of what the plugin is doing. More...
 

Private Slots

void slotObjectUpdated (int _identifier, const UpdateType &_type) override
 
void slotObjectPropertiesChanged (int _identifier) override
 
void slotAllCleared () override
 
void objectDeleted (int _id) override
 
void initializePlugin () override
 
void pluginsInitialized () override
 
void slotMeshChanged (int _index=-1)
 
void slotVisualize ()
 
void slotMouseEvent (QMouseEvent *_event) override
 
void slotPickModeChanged (const std::string &_mode) override
 
void updateGUI ()
 
void propertySelectionChanged ()
 Called when user selects a property. More...
 
void slotDuplicateProperty ()
 Duplicates the selected properties. More...
 
void slotRemoveProperty ()
 Removes the selected properties. More...
 
void slotLog (Logtype _type, QString _message)
 Receives log messages from PropertyModels and emits them. More...
 
void slotLog (QString _message)
 
- Private Slots inherited from BaseInterface
virtual void exit ()
 
virtual QString version ()
 Return a version string for your plugin. More...
 
- Private Slots inherited from KeyInterface
virtual void slotKeyEvent (QKeyEvent *_event)
 Key Event from Main App. More...
 

Private Member Functions

void setNewPropertyModel (int id)
 Exchanges the PropertyModel after the user selected a different object. More...
 
- Private Member Functions inherited from BaseInterface
virtual void noguiSupported ()
 
virtual ~BaseInterface ()
 Destructor. More...
 
virtual void blockScenegraphUpdates (bool _block)
 Tell the core to prevent scenegraph updates. More...
 
virtual void updatedObject (int _objectId)
 An object has been changed or added by this plugin. More...
 
virtual void updatedObject (int _identifier, const UpdateType &_type)
 An object has been changed or added by this plugin. More...
 
virtual void nodeVisibilityChanged (int _identifier)
 A scenegraph node has been shown or hidden. More...
 
virtual void getCurrentRenderer (unsigned int _viewer, QString &_rendererName)
 Get the current renderer for the given viewer. More...
 
- Private Member Functions inherited from LoadSaveInterface
virtual ~LoadSaveInterface ()
 Destructor. More...
 
virtual void addEmptyObject (DataType _type, int &_id)
 
virtual void copyObject (int _oldId, int &_newId)
 
virtual void emptyObjectAdded (int _id)
 DEPRECATED HERE (Moved to Type Interface)! Emit this signal if an empty object has been created. More...
 
virtual void deleteObject (int _id)
 Delete an object
This signal can be called from any thread.
. More...
 
virtual void deleteAllObjects ()
 Delete all Objects. More...
 
virtual void getAllFileFilters (QStringList &_filters)
 Get all file filters that are registered. More...
 
- Private Member Functions inherited from ToolboxInterface
virtual ~ToolboxInterface ()
 Destructor. More...
 
virtual void addToolbox (QString _name, QWidget *_widget, QIcon *_icon)
 Add a toolbox widget to the gui with the given name and an icon. More...
 
virtual void addToolbox (QString _name, QWidget *_widget, QIcon *_icon, QWidget *_headerAreaWidget)
 Add a toolbox widget to the gui with the given name, icon and header area widget. More...
 
- Private Member Functions inherited from KeyInterface
virtual void slotKeyReleaseEvent (QKeyEvent *_event)
 Key Release Event from Main App. More...
 
virtual ~KeyInterface ()
 Destructor. More...
 
- Private Member Functions inherited from ScriptInterface
virtual ~ScriptInterface ()
 Destructor. More...
 
virtual void showScriptInEditor (QString _filename)
 
virtual void executeScript (QString _script)
 
virtual void getDescription (QString _function, QString &_description, QStringList &_parameters, QStringList &_descriptions)
 
- Private Member Functions inherited from MouseInterface
virtual ~MouseInterface ()
 Destructor. More...
 
- Private Member Functions inherited from PickingInterface
virtual void addHiddenPickMode (const std::string &_mode)
 Add a new picking mode to the examiner which will be invisible. More...
 
virtual void setPickModeCursor (const std::string &_mode, QCursor _cursor)
 Set the cursor of the given PickMode. More...
 
virtual void setPickModeMouseTracking (const std::string &_mode, bool _mouseTracking)
 Set mouse tracking for the given PickMode. More...
 
virtual void setPickModeToolbar (const std::string &_mode, QToolBar *_toolbar)
 Set the additional toolbar of the given PickMode. More...
 
virtual void removePickModeToolbar (const std::string &_mode)
 Removes the additional toolbar of the given PickMode. More...
 
virtual ~PickingInterface ()
 Destructor. More...
 
- Private Member Functions inherited from LoggingInterface
virtual ~LoggingInterface ()
 Destructor. More...
 

Private Attributes

PropertyVisToolbartool_
 
QIcon * toolIcon_
 
ObjectListItemModel objectListItemModel_
 
PropertyModelpropertyModel_
 

Detailed Description

Definition at line 81 of file PropertyVisPlugin.hh.

Constructor & Destructor Documentation

◆ PropertyVisPlugin()

PropertyVisPlugin::PropertyVisPlugin ( )

Definition at line 73 of file PropertyVisPlugin.cc.

◆ ~PropertyVisPlugin()

PropertyVisPlugin::~PropertyVisPlugin ( )

Definition at line 80 of file PropertyVisPlugin.cc.

Member Function Documentation

◆ description()

QString PropertyVisPlugin::description ( )
inlineoverridevirtual

Return a description of what the plugin is doing.

This function has to return a basic description of the plugin

Implements BaseInterface.

Definition at line 175 of file PropertyVisPlugin.hh.

◆ getPropertyVisualizer

QScriptValue PropertyVisPlugin::getPropertyVisualizer ( int  _id,
const QString &  _propname 
)
slot

Definition at line 173 of file PropertyVisPlugin.cc.

◆ initializePlugin

void PropertyVisPlugin::initializePlugin ( )
overrideprivateslot

Definition at line 85 of file PropertyVisPlugin.cc.

◆ name()

QString PropertyVisPlugin::name ( )
inlineoverridevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 174 of file PropertyVisPlugin.hh.

◆ objectDeleted

void PropertyVisPlugin::objectDeleted ( int  _id)
overrideprivateslot

Definition at line 222 of file PropertyVisPlugin.cc.

◆ pluginsInitialized

void PropertyVisPlugin::pluginsInitialized ( )
overrideprivateslot

Definition at line 105 of file PropertyVisPlugin.cc.

◆ propertySelectionChanged

void PropertyVisPlugin::propertySelectionChanged ( )
privateslot

Called when user selects a property.

Definition at line 274 of file PropertyVisPlugin.cc.

◆ setNewPropertyModel()

void PropertyVisPlugin::setNewPropertyModel ( int  id)
private

Exchanges the PropertyModel after the user selected a different object.

This method exchanges the PropertyModel after the user selects a different object for visualization. The widget of the old model needs to be hidden and the one of the new model is shown. Also some signals need to be disconnected and connected.

Parameters
idThe id of the selected object

Definition at line 294 of file PropertyVisPlugin.cc.

◆ slotAllCleared

void PropertyVisPlugin::slotAllCleared ( )
overrideprivateslot

Definition at line 207 of file PropertyVisPlugin.cc.

◆ slotClear

void PropertyVisPlugin::slotClear ( int  _id,
const QString &  _propname 
)
slot

Remove visualisation of a property on object _id with the given name. Note that for multiple properties with the same name (i.e., different data types or entity types), there is no guarantee which one is used.

Definition at line 150 of file PropertyVisPlugin.cc.

◆ slotDuplicateProperty

void PropertyVisPlugin::slotDuplicateProperty ( )
privateslot

Duplicates the selected properties.

Definition at line 375 of file PropertyVisPlugin.cc.

◆ slotLog [1/2]

void PropertyVisPlugin::slotLog ( Logtype  _type,
QString  _message 
)
inlineprivateslot

Receives log messages from PropertyModels and emits them.

Definition at line 149 of file PropertyVisPlugin.hh.

◆ slotLog [2/2]

void PropertyVisPlugin::slotLog ( QString  _message)
inlineprivateslot

Definition at line 150 of file PropertyVisPlugin.hh.

◆ slotMeshChanged

void PropertyVisPlugin::slotMeshChanged ( int  _index = -1)
privateslot

Definition at line 327 of file PropertyVisPlugin.cc.

◆ slotMouseEvent

void PropertyVisPlugin::slotMouseEvent ( QMouseEvent *  _event)
overrideprivateslot

Definition at line 368 of file PropertyVisPlugin.cc.

◆ slotObjectPropertiesChanged

void PropertyVisPlugin::slotObjectPropertiesChanged ( int  _identifier)
overrideprivateslot

Definition at line 248 of file PropertyVisPlugin.cc.

◆ slotObjectUpdated

void PropertyVisPlugin::slotObjectUpdated ( int  _identifier,
const UpdateType _type 
)
overrideprivateslot

Definition at line 231 of file PropertyVisPlugin.cc.

◆ slotPickModeChanged

void PropertyVisPlugin::slotPickModeChanged ( const std::string &  _mode)
overrideprivateslot

Definition at line 199 of file PropertyVisPlugin.cc.

◆ slotRemoveProperty

void PropertyVisPlugin::slotRemoveProperty ( )
privateslot

Removes the selected properties.

Definition at line 404 of file PropertyVisPlugin.cc.

◆ slotVisualize

void PropertyVisPlugin::slotVisualize ( )
privateslot

Definition at line 335 of file PropertyVisPlugin.cc.

◆ slotVisualizeProperty

void PropertyVisPlugin::slotVisualizeProperty ( int  _id,
const QString &  _propname 
)
slot

Visualise a property on object _id with the given name. Note that for multiple properties with the same name (i.e., different data types or entity types), there is no guarantee which one is used.

Definition at line 127 of file PropertyVisPlugin.cc.

◆ updateGUI

void PropertyVisPlugin::updateGUI ( )
privateslot

Definition at line 257 of file PropertyVisPlugin.cc.

Member Data Documentation

◆ objectListItemModel_

ObjectListItemModel PropertyVisPlugin::objectListItemModel_
private

Definition at line 191 of file PropertyVisPlugin.hh.

◆ propertyModel_

PropertyModel* PropertyVisPlugin::propertyModel_
private

Definition at line 193 of file PropertyVisPlugin.hh.

◆ tool_

PropertyVisToolbar* PropertyVisPlugin::tool_
private

Definition at line 180 of file PropertyVisPlugin.hh.

◆ toolIcon_

QIcon* PropertyVisPlugin::toolIcon_
private

Definition at line 182 of file PropertyVisPlugin.hh.


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