guimainwindow.h

   1 //
   2 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   3 // +                                                                      +
   4 // + This file is part of enGrid.                                         +
   5 // +                                                                      +
   6 // + Copyright 2008,2009 Oliver Gloth                                     +
   7 // +                                                                      +
   8 // + enGrid is free software: you can redistribute it and/or modify       +
   9 // + it under the terms of the GNU General Public License as published by +
  10 // + the Free Software Foundation, either version 3 of the License, or    +
  11 // + (at your option) any later version.                                  +
  12 // +                                                                      +
  13 // + enGrid is distributed in the hope that it will be useful,            +
  14 // + but WITHOUT ANY WARRANTY; without even the implied warranty of       +
  15 // + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        +
  16 // + GNU General Public License for more details.                         +
  17 // +                                                                      +
  18 // + You should have received a copy of the GNU General Public License    +
  19 // + along with enGrid. If not, see <http://www.gnu.org/licenses/>.       +
  20 // +                                                                      +
  21 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  22 //
  23 #ifndef mainwindow_H
  24 #define mainwindow_H
  25
  26 class GuiMainWindow;
  27
  28 #include <QMainWindow>
  29 #include <QSettings>
  30 #include <QLabel>
  31 #include <QSet>
  32 #include <QFileSystemWatcher>
  33 #include <QMutex>
  34 #include <QTimer>
  35 #include <QDockWidget>
  36
  37 #include <vtkUnstructuredGrid.h>
  38 #include <vtkActor.h>
  39 #include <vtkPolyDataMapper.h>
  40 #include <vtkGeometryFilter.h>
  41 #include <vtkCubeAxesActor2D.h>
  42 #include <vtkCellPicker.h>
  43 #include <vtkPointPicker.h>
  44 #include <vtkSphereSource.h>
  45 #include <vtkTextActor.h>
  46 #include <vtkVectorText.h>
  47 #include <vtkFollower.h>
  48 #include <vtkScalarBarActor.h>
  49 #include <vtkLookupTable.h>
  50
  51 #include "ui_guimainwindow.h"
  52 #include "ui_guioutputwindow.h"
  53 #include "vtkEgBoundaryCodesFilter.h"
  54 #include "vtkEgExtractVolumeCells.h"
  55 #include "egvtkobject.h"
  56 #include "boundarycondition.h"
  57
  58 #include "std_includes.h"
  59 #include "guitransform.h"
  60
  61 class GuiOutputWindow : public QWidget
  62 {
  63
  64   friend class GuiMainWindow;
  65
  66   Q_OBJECT;
  67
  68 private: // attributes
  69
  70   Ui::GuiOutputWindow ui;
  71
  72 public: // methods
  73
  74   GuiOutputWindow();
  75
  76 };
  77
  78
  79
  80
  81 /**
  82  * This is the main GUI class of enGrid.
  83  */
  84 class GuiMainWindow : public QMainWindow, public EgVtkObject
  85 {
  86
  87   Q_OBJECT;
  88
  89 private: // attributes
  90
  91   /** The user interface definition -- created by QtDesigner. */
  92   Ui::GuiMainWindow ui;
  93
  94   /** The current state of the grid that is being generated. */
  95   vtkUnstructuredGrid *grid;
  96
  97   vtkPolyData *boundary_pd;
  98   vtkPolyData *tetras_pd;
  99   vtkPolyData *wedges_pd;
 100   vtkPolyData *pyras_pd;
 101   vtkPolyData *hexas_pd;
 102   vtkPolyData *volume_pd;
 103
 104   /** The VTK renderer object, used for visualising the grid */
 105   vtkRenderer *renderer;
 106
 107   vtkActor *surface_actor;
 108   vtkActor *surface_wire_actor;
 109   vtkActor *tetra_actor;
 110   vtkActor *wedge_actor;
 111   vtkActor *pyramid_actor;
 112   vtkActor *hexa_actor;
 113   vtkActor *volume_wire_actor;
 114   vtkProperty *backface_property;
 115
 116   vtkLookupTable *lut;
 117   vtkScalarBarActor *iamlegend_actor;
 118
 119   vtkPolyDataMapper *field_mapper;
 120   vtkPolyDataMapper *surface_mapper;
 121   vtkPolyDataMapper *surface_wire_mapper;
 122   vtkPolyDataMapper *tetra_mapper;
 123   vtkPolyDataMapper *pyramid_mapper;
 124   vtkPolyDataMapper *wedge_mapper;
 125   vtkPolyDataMapper *hexa_mapper;
 126   vtkPolyDataMapper *volume_wire_mapper;
 127
 128   vtkEgExtractVolumeCells *extr_vol;
 129   vtkEgExtractVolumeCells *extr_tetras;
 130   vtkEgExtractVolumeCells *extr_pyramids;
 131   vtkEgExtractVolumeCells *extr_wedges;
 132   vtkEgExtractVolumeCells *extr_hexas;
 133
 134   vtkGeometryFilter *volume_geometry;
 135   vtkGeometryFilter *tetra_geometry;
 136   vtkGeometryFilter *pyramid_geometry;
 137   vtkGeometryFilter *wedge_geometry;
 138   vtkGeometryFilter *hexa_geometry;
 139
 140   /** VTK filter to extract the surface of the current grid. */
 141   vtkGeometryFilter *surface_filter;
 142
 143   /** sphere to mark picked cell/points */
 144   vtkSphereSource *pick_sphere;
 145
 146   /** Size to use for picker objects and annotations */
 147   double ReferenceSize;
 148
 149   /** 2D Text actor to display node IDs */
 150   vector <vtkTextActor*> NodeText;
 151
 152   /** 2D Text actor to display cell IDs */
 153   vector <vtkTextActor*> CellText;
 154
 155   /** 3D Text actor to display node IDs */
 156   vector <vtkVectorText*> NodeText_VectorText;
 157   vector <vtkPolyDataMapper*> NodeText_PolyDataMapper;
 158   vector <vtkFollower*> NodeText_Follower;
 159
 160   /** 3D Text actor to display cell IDs */
 161   vector <vtkVectorText*> CellText_VectorText;
 162   vector <vtkPolyDataMapper*> CellText_PolyDataMapper;
 163   vector <vtkFollower*> CellText_Follower;
 164
 165   /** Picked point */
 166   static vtkIdType PickedPoint;
 167
 168   /** Picked cell */
 169   static vtkIdType PickedCell;
 170
 171   /** Boolean value specifying wether the VTK Interactor should be used or not to determine picked points/cells */
 172   static bool m_UseVTKInteractor;
 173
 174 /*  vtkTextActor* textActor[3];
 175
 176   vtkVectorText* atext[3];
 177   vtkPolyDataMapper* textMapper[3];
 178   vtkFollower* textActor2[3];*/
 179
 180   /** VTK mapper to map pick marker */
 181   vtkPolyDataMapper *pick_mapper;
 182
 183   /** VTK actor to display pick marker */
 184   vtkActor *pick_actor;
 185
 186   /** VTK actor to display the coordinate system */
 187   vtkCubeAxesActor2D *axes;
 188
 189   /** The current file name of the grid. */
 190   QString current_filename;
 191
 192   /** Status bar of the main window and application */
 193   QStatusBar *status_bar;
 194
 195   /** Label for the information in the status bar */
 196   QLabel *status_label;
 197
 198   /** A QList with all active boundary codes. */
 199   QSet<int> display_boundary_codes;
 200
 201     /** A QList with all boundary codes. */
 202   QSet<int> all_boundary_codes;
 203
 204   /** VTK filter to extract boundary elements with certain codes */
 205   vtkEgBoundaryCodesFilter *bcodes_filter;
 206
 207   /** VTK CellPicker to pick cells for various user interactions */
 208   vtkCellPicker *CellPicker;
 209
 210   /** VTK PointPicker to pick points for various user interactions */
 211   vtkPointPicker *PointPicker;
 212
 213   /** flag to indicate that enGrid is busy with an operation */
 214   bool busy;
 215
 216   /** log file to collect program output for display in the output window */
 217   QString log_file_name;
 218
 219   /** number of lines that have been read from the log file */
 220   long int N_chars;
 221
 222   FILE *system_stdout;
 223   static QMutex mutex;
 224   QTimer garbage_timer;
 225   QTimer log_timer;
 226   GuiOutputWindow *output_window;
 227   QDockWidget *dock_widget;
 228
 229   /** mapping between numerical and symbolic boundary codes */
 230   QMap<int,BoundaryCondition> bcmap;
 231
 232 private: // static attributes
 233
 234   /**
 235    * Platform independant access to application settings.
 236    * For a UNIX system the user preferences will be stored in the file
 237    * folder ".config/enGits/enGrid.conf" in the user's home directory;
 238    * on Windows preferences will be stored in the registry.
 239    */
 240   static QSettings qset;
 241
 242   /**
 243    * The current working directory of enGrid
 244    */
 245   static QString cwd;
 246
 247   /** a static this pointer (somewhat ugly, but there is only one MainWindow) */
 248   static GuiMainWindow *THIS;
 249
 250 private: // methods
 251
 252   /** Add VTK type information to the grid (useful for visualisation with ParaView). */
 253   void addVtkTypeInfo();
 254
 255   /** callback for cell picking */
 256   static void pickCellCallBack(vtkObject *caller, unsigned long int eid, void *clientdata, void *calldata);
 257
 258   /** callback for point picking */
 259   static void pickPointCallBack(vtkObject *caller, unsigned long int eid, void *clientdata, void *calldata);
 260
 261 public: // methods
 262
 263   /**
 264    * The constructor connects the menu and toolbar actions and
 265    * the VTK basics(i.e. renderer, actor, ...) will be set up.
 266    * Furthermore preferences will be read from qset.
 267    */
 268   GuiMainWindow();
 269
 270   /**
 271    * Preferences will be written back.
 272    */
 273   virtual ~GuiMainWindow();
 274
 275   /**
 276    * Get the VTK render window
 277    * @return the VTK render window
 278    */
 279   vtkRenderWindow* getRenderWindow();
 280
 281   /**
 282    * Get the VTK renderer
 283    * @return the VTK renderer
 284    */
 285   vtkRenderer* getRenderer();
 286
 287   /**
 288    * Get the Qt-VTK interactor
 289    * @return the Qt-VTK interactor
 290    */
 291   QVTKInteractor* getInteractor();
 292
 293   /**
 294    * Get a pointer to the current grid object
 295    * @return a pointer to the current vtkUnstructuredGrid object
 296    */
 297   vtkUnstructuredGrid* getGrid() { return grid; };
 298
 299   void setBusy() { busy = true; updateStatusBar(); };
 300   void setIdle() { busy = false; updateStatusBar(); };
 301
 302 public: // static methods
 303
 304   /**
 305    * Get the current working directory.
 306    * @return the current working directory
 307    */
 308   static QString getCwd();
 309
 310   /**
 311    * Set the current working directory
 312    * @param cwd the current working directory
 313    */
 314   static void setCwd(QString dir);
 315
 316   /**
 317    * Get the currently picked cell.
 318    * @return the picked cell ID or -1 if no cell has been picked
 319    */
 320   static vtkIdType getPickedCell();
 321
 322   /**
 323    * Get the currently picked point.
 324    * @return the picked point ID or -1 if no point has been picked
 325    */
 326   static vtkIdType getPickedPoint();
 327
 328   /**
 329    * Access to the QSettings object/
 330    */
 331   static QSettings* settings() { return &qset; };
 332
 333   BoundaryCondition getBC(int bc) { return bcmap[bc]; };
 334
 335   static GuiMainWindow* pointer() { return THIS; };
 336   static void lock() { mutex.lock(); };
 337   static void unlock() { mutex.unlock(); };
 338   static bool tryLock() { return mutex.tryLock(); };
 339   void getAllBoundaryCodes(QSet<int> &bcs);
 340   vtkPointPicker* getPointPicker(){return(PointPicker);};
 341   vtkSphereSource* getPickSphere(){return(pick_sphere);};
 342   bool pickPoint(vtkIdType Point);
 343   bool pickCell(vtkIdType cellId);
 344
 345   QString GetFilename() {return(current_filename);};
 346
 347 public slots:
 348   void setUseVTKInteractor(int a_UseVTKInteractor);
 349   void setPickMode(bool a_UseVTKInteractor,bool a_CellPickerMode);
 350
 351   /** Exit the application */
 352   void exit();
 353
 354   /** Import an STL file (ASCII or binary) */
 355   void importSTL();
 356
 357   /** Import a Gmsh grid from an ASCII file -- using version 1.0 of the Gmsh file format */
 358   void importGmsh1Ascii();
 359
 360   /** Export a grid from to an ASCII Gmsh file -- using version 1.0 of the Gmsh file format */
 361   void exportGmsh1Ascii();
 362
 363   /** Import a Gmsh grid from an ASCII file -- using version 2.0 of the Gmsh file format */
 364   void importGmsh2Ascii();
 365
 366   /** Export a grid from to an ASCII Gmsh file -- using version 2.0 of the Gmsh file format */
 367   void exportGmsh2Ascii();
 368
 369   /** Export a grid to neutral format for NETGEN */
 370   void exportNeutral();
 371
 372   /** Update the VTK output */
 373   void updateActors();
 374
 375   /** Scale to data */
 376   void ScaleToData();
 377
 378   /** Move the camera in order to show everything on the screen */
 379   void zoomAll();
 380
 381   /** Open an existing grid */
 382   void open();
 383
 384   void openBC();
 385   void saveBC();
 386
 387   void undo();
 388   void redo();
 389
 390   /** Save the current grid */
 391   void save();
 392
 393   /** Save the current grid -- using a different file name */
 394   void saveAs();
 395
 396   /** Save the current grid as a_filename */
 397   void QuickSave(QString a_filename);
 398
 399   /** Update the status bar */
 400   void updateStatusBar();
 401
 402   /** Select the boundary codes to be diplayed/hidden */
 403   void selectBoundaryCodes();
 404
 405   /** Update the boundary code book keeping (e.g. after reading a mesh). */
 406   void updateBoundaryCodes(bool all_on);
 407
 408   /** Normal extrusion of boundary elements (no validity check). */
 409   void normalExtrusion();
 410
 411   /** Toggle the visibility of the axes annotation. */
 412   void setAxesVisibility();
 413
 414   /** Toggle orthogonal viewing mode. */
 415   void setViewingMode();
 416
 417   /** Toggle node ID viewing mode. */
 418   void ViewNodeIDs();
 419
 420   /** Toggle cell ID viewing mode. */
 421   void ViewCellIDs();
 422
 423   /** Change the orientation of all surface elements */
 424   void changeSurfaceOrientation();
 425
 426   /** Check and, if required, change the orientation of all surface elements */
 427   void checkSurfaceOrientation();
 428
 429   /** Eliminate edges in order to improve the aspect ratio of the cells */
 430   void improveAspectRatio();
 431
 432   /** Write surface elements to an ASCII STL file. */
 433   void exportAsciiStl();
 434
 435   /** Write surface elements to a binary STL file. */
 436   void exportBinaryStl();
 437
 438   /** Edit boundary conditions (names and types) */
 439   void editBoundaryConditions();
 440
 441   /** Edit settings */
 442   void configure();
 443
 444   /** Display an about message */
 445   void about();
 446
 447   void viewXP();
 448   void viewXM();
 449   void viewYP();
 450   void viewYM();
 451   void viewZP();
 452   void viewZM();
 453
 454   void appendOutput(QString txt) { output_window->ui.textEditOutput->append(txt); };
 455   void clearOutput() { output_window->ui.textEditOutput->clear(); };
 456   void updateOutput();
 457   void periodicUpdate();
 458
 459   // SLOTS for all standard operations should be defined below;
 460   // entries should look like this:
 461   // void callOperationName() { EG_STDSLOT(OperationName); };
 462   // The actual class name in this case, however, would be GuiOperationName.
 463   //
 464   // the following line can be used as a template:
 465   // void call() { EG_STDSLOT(); };
 466
 467   void callSmoothSurface() { EG_STDINTERSLOT(GuiSmoothSurface); };
 468   void callCreateBoundaryLayer() { EG_STDSLOT(GuiCreateBoundaryLayer); };
 469   void callDivideBoundaryLayer() { EG_STDSLOT(GuiDivideBoundaryLayer); };
 470   void callDeleteVolumeGrid() { EG_STDSLOT(DeleteVolumeGrid); };
 471   void callDeleteTetras() { EG_STDSLOT(DeleteTetras); };
 472   void callCreateVolumeMesh() { EG_STDSLOT(CreateVolumeMesh); };
 473   void callSmoothVolumeGrid() { EG_STDSLOT(SmoothVolumeGrid); };
 474   void callSetBoundaryCode()  { EG_STDINTERSLOT(GuiSetBoundaryCode); };
 475   void callDeleteBadAspectTris() { EG_STDINTERSLOT(GuiDeleteBadAspectTris); };
 476   void callDeletePickedCell() { EG_STDSLOT(DeletePickedCell); };
 477   void callDeletePickedPoint() { EG_STDINTERSLOT(DeletePickedPoint); };
 478   void callPick_cell_point() { EG_STDINTERSLOT(GuiPick); };
 479   void callTransform() { EG_STDINTERSLOT(GuiTransform); };
 480
 481   void callFixSTL();
 482
 483   void callFoamReader()       { EG_STDREADERSLOT(FoamReader); };
 484   void callFoamWriter()       { EG_STDINTERSLOT(FoamWriter); };
 485   void callSimpleFoamWriter() { EG_STDINTERSLOT(SimpleFoamWriter); };
 486   void callVtkReader()        { EG_STDREADERSLOT(VtkReader); };
 487   void callPolyDataReader()   { EG_STDREADERSLOT(PolyDataReader); };
 488
 489 };
 490
 491 #endif