Developer Documentation
InfoVolumeMeshObjectPlugin Class Reference

Plugin to visualize information about open volume meshs in the scene. More...

#include <Plugin-InfoVolumeMeshObject/VolumeMeshObjectInfoPlugin.hh>

Inheritance diagram for InfoVolumeMeshObjectPlugin:
BaseInterface LoggingInterface StatusbarInterface

Signals

void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 
void log (Logtype _type, QString _message)
 
void log (QString _message)
 
void addWidgetToStatusbar (QWidget *_widget)
 
- 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 LoggingInterface
virtual void log (Logtype _type, QString _message)=0
 
virtual void log (QString _message)=0
 
- Signals inherited from StatusbarInterface
virtual void showStatusMessage (QString _message, int _timeout=0)
 Show a message in the status bar. More...
 

Public Member Functions

QString name ()
 Name of the Plugin. More...
 
QString description ()
 Description of the Plugin. More...
 

Private Slots

void initializePlugin ()
 
void pluginsInitialized ()
 initialize the plugin More...
 
void slotObjectUpdated (int _identifier, const UpdateType &_type)
 
void slotObjectSelectionChanged (int _identifier)
 
void slotAllCleared ()
 
void noguiSupported ()
 
- Private Slots inherited from BaseInterface
virtual void exit ()
 
virtual QString version ()
 Return a version string for your plugin. More...
 

Private Member Functions

template<class MeshT >
void printMeshInfo (MeshT *_mesh, int _id, unsigned int _face, ACG::Vec3d &_hitPoint)
 
void updateInfoBar ()
 
- 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 LoggingInterface
virtual ~LoggingInterface ()
 Destructor. More...
 
- Private Member Functions inherited from StatusbarInterface
virtual ~StatusbarInterface ()
 Destructor. More...
 
virtual void setStatus (ApplicationStatus::applicationStatus _status)
 Sets the status icon of the StatusBar. More...
 
virtual void clearStatusMessage ()
 Removes the current message from the statusBar. More...
 
virtual void addWidgetToStatusbar (QWidget *_widget)
 Add a widget on the right side of the statusBar. More...
 

Private Attributes

VolumeMeshInfoBarinfoBar_ = nullptr
 

Scripting Functions

void setDescriptions ()
 set scripting slot descriptions More...
 
int vertexCount (int _id)
 get total number of vertices for a given object More...
 
int edgeCount (int _id)
 get total number of edges for a given object More...
 
int faceCount (int _id)
 get total number of faces for a given object More...
 
int cellCount (int _id)
 get total number of cells for a given object More...
 
QString version ()
 set scripting slot descriptions More...
 

Detailed Description

Plugin to visualize information about open volume meshs in the scene.

Plugin to visualize information about open volume meshs in the scene

Definition at line 62 of file VolumeMeshObjectInfoPlugin.hh.

Constructor & Destructor Documentation

◆ InfoVolumeMeshObjectPlugin()

InfoVolumeMeshObjectPlugin::InfoVolumeMeshObjectPlugin ( )

Definition at line 62 of file VolumeMeshObjectInfoPlugin.cc.

◆ ~InfoVolumeMeshObjectPlugin()

InfoVolumeMeshObjectPlugin::~InfoVolumeMeshObjectPlugin ( )

Definition at line 66 of file VolumeMeshObjectInfoPlugin.cc.

Member Function Documentation

◆ cellCount

int InfoVolumeMeshObjectPlugin::cellCount ( int  _id)
slot

get total number of cells for a given object

Parameters
_idobject id
Returns
number of cells or -1 if an error occured

Definition at line 204 of file VolumeMeshObjectInfoScripting.cc.

◆ description()

QString InfoVolumeMeshObjectPlugin::description ( )
inlinevirtual

Description of the Plugin.

Implements BaseInterface.

Definition at line 109 of file VolumeMeshObjectInfoPlugin.hh.

◆ edgeCount

int InfoVolumeMeshObjectPlugin::edgeCount ( int  _id)
slot

get total number of edges for a given object

Parameters
_idobject id
Returns
number of edges or -1 if an error occured

Definition at line 120 of file VolumeMeshObjectInfoScripting.cc.

◆ faceCount

int InfoVolumeMeshObjectPlugin::faceCount ( int  _id)
slot

get total number of faces for a given object

Parameters
_idobject id
Returns
number of faces or -1 if an error occured

Definition at line 162 of file VolumeMeshObjectInfoScripting.cc.

◆ initializePlugin

void InfoVolumeMeshObjectPlugin::initializePlugin ( )
privateslot

Definition at line 106 of file VolumeMeshObjectInfoPlugin.cc.

◆ name()

QString InfoVolumeMeshObjectPlugin::name ( void  )
inlinevirtual

Name of the Plugin.

Implements BaseInterface.

Definition at line 106 of file VolumeMeshObjectInfoPlugin.hh.

◆ noguiSupported

void InfoVolumeMeshObjectPlugin::noguiSupported ( )
inlineprivateslot

Definition at line 95 of file VolumeMeshObjectInfoPlugin.hh.

◆ pluginsInitialized

void InfoVolumeMeshObjectPlugin::pluginsInitialized ( )
privateslot

initialize the plugin

Definition at line 111 of file VolumeMeshObjectInfoPlugin.cc.

◆ setDescriptions()

void InfoVolumeMeshObjectPlugin::setDescriptions ( )
private

set scripting slot descriptions

set the descriptions for scripting slots

Definition at line 55 of file VolumeMeshObjectInfoScripting.cc.

◆ slotAllCleared

void InfoVolumeMeshObjectPlugin::slotAllCleared ( )
privateslot

Definition at line 139 of file VolumeMeshObjectInfoPlugin.cc.

◆ slotObjectSelectionChanged

void InfoVolumeMeshObjectPlugin::slotObjectSelectionChanged ( int  _identifier)
privateslot

Definition at line 132 of file VolumeMeshObjectInfoPlugin.cc.

◆ slotObjectUpdated

void InfoVolumeMeshObjectPlugin::slotObjectUpdated ( int  _identifier,
const UpdateType _type 
)
privateslot

Definition at line 125 of file VolumeMeshObjectInfoPlugin.cc.

◆ updateInfoBar()

void InfoVolumeMeshObjectPlugin::updateInfoBar ( )
private

Definition at line 70 of file VolumeMeshObjectInfoPlugin.cc.

◆ version

QString InfoVolumeMeshObjectPlugin::version ( )
inlineslot

set scripting slot descriptions

set the descriptions for scripting slots

Definition at line 136 of file VolumeMeshObjectInfoPlugin.hh.

◆ vertexCount

int InfoVolumeMeshObjectPlugin::vertexCount ( int  _id)
slot

get total number of vertices for a given object

Parameters
_idobject id
Returns
number of vertices or -1 if an error occured

Definition at line 78 of file VolumeMeshObjectInfoScripting.cc.

Member Data Documentation

◆ infoBar_

VolumeMeshInfoBar* InfoVolumeMeshObjectPlugin::infoBar_ = nullptr
private

Definition at line 117 of file VolumeMeshObjectInfoPlugin.hh.


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