Added documentation. Fixed index error concerning array selection in vtk-objects

git-svn-id: https://svn.ufz.de/svn/ogs/trunk/sources@7914 3895a583-e809-0410-9bb6-aa9463026377

Base/CheckboxDelegate.h

@@ -13,10 +13,10 @@ class QRect;
 
 /**
  * \brief CheckboxDelegate modifies a model view to display boolean values as checkboxes.
- * Important: the column on which this delegate is set (
- * QAbstractItemView::setItemDelegateForColumn()) must not have the flags
- * Qt::ItemIsEditable or Qt::ItemIsUserCheckable set in the model.
-**/
+ *
+ * Important: the column on which this delegate is set (QAbstractItemView::setItemDelegateForColumn()) 
+ * must not have the flags Qt::ItemIsEditable or Qt::ItemIsUserCheckable set in the model.
+ **/
 class CheckboxDelegate : public QItemDelegate
 {
 	Q_OBJECT

DataView/ConditionModel.h

@@ -13,7 +13,7 @@
 class FEMCondition;
 
 /**
- * The ConditionModel handels conditions such as ICs, BCs and STs on geometric objects 
+ * \brief The ConditionModel handels FEM conditions such as ICs, BCs and STs on geometric objects. 
  */
 
 class ConditionModel : public TreeModel

DataView/ConditionTabWidget.h

@@ -12,7 +12,7 @@
 #include "ui_ConditionTabWidgetBase.h"
 
 /**
- * StationTabWidget
+ * \brief Widget containing the ConditionView.
  */
 class ConditionTabWidget : public QWidget, public Ui_ConditionTabWidgetBase
 {

DataView/ConditionView.h

@@ -10,8 +10,9 @@
 #include <QContextMenuEvent>
 
 /**
- * \brief A view for the StationTreeModel with a number of properties adequate for this kind of data
- * \sa StationTreeModel, ModelTreeItem
+ * \brief A view for FEM-Conditions (Initial- & Boundary Conditions / Source Terms) with a number of additional
+ * information such as Process Type, Distribution, etc.
+ * \sa ConditionModel, CondItem
  */
 class ConditionView : public QTreeView
 {

DataView/DataViewWidget.h

@@ -14,7 +14,7 @@
 class Model;
 
 /**
- * DataViewWidget
+ * \brief Widget containing views for geometrical objects.
  */
 class DataViewWidget : public QWidget, public Ui_DataViewWidgetBase
 {

DataView/GEOModels.h

@@ -21,7 +21,7 @@ class SurfaceModel;
 class TreeModel;
 
 /**
- * GEOModels glues together the data management class GEOObjects and the GUI.
+ * \brief GEOModels connects the data management class GEOObjects and the GUI.
  * It inherits from GEOLIB::GEOObjects and additionally emits signals when
  * data objects are modified. The GUI connects to these signals. Model instances
  * are created for every data object.

DataView/LineEditDialog.h

@@ -14,7 +14,9 @@
 class QStringListModel;
 
 /**
- * \brief A dialog window for editing meshes in various ways
+ * \brief A dialog window for manipulation of polylines.
+ * Currently included functionality is the concatenation of polylines 
+ * as well as creating polygons or surfaces from polylines.
  */
 class LineEditDialog : public QDialog, private Ui_LineEdit
 {
@@ -34,8 +36,10 @@ private:
 
 
 private slots:
+	/// Instructions when polylines are selected.
 	void on_selectPlyButton_pressed();
 
+	/// Instructions when polylines are deselected.
 	void on_deselectPlyButton_pressed();
 
 	/// Instructions if the OK-Button has been pressed.

DataView/LineTabWidget.h

@@ -16,7 +16,7 @@ namespace GEOLIB {
 }
 
 /**
- * LineTabWidget
+ * \brief Widget containing the view for the LinesModel.
  */
 class LineTabWidget : public QWidget, public Ui_LineTabWidgetBase
 {

DataView/MshTabWidget.h

@@ -15,7 +15,7 @@
 class MshModel;
 
 /**
- * Tab Widget for data views on meshes
+ * \brief Widget for data views of meshes.
  */
 class MshTabWidget : public QWidget, public Ui_MshTabWidgetBase
 {

DataView/PntTabWidget.h

@@ -12,7 +12,7 @@
 #include "ui_PntTabWidgetBase.h"
 
 /**
- * PntTabWidget
+ * \brief Widget containing the view for the PointsModel.
  */
 class PntTabWidget : public QWidget, public Ui_PntTabWidgetBase
 {

DataView/StationTabWidget.h

@@ -12,7 +12,7 @@
 #include "ui_StationTabWidgetBase.h"
 
 /**
- * StationTabWidget
+ * \brief Widget containing StationTreeView-objects.
  */
 class StationTabWidget : public QWidget, public Ui_StationTabWidgetBase
 {

DataView/SurfaceTabWidget.h

@@ -12,7 +12,7 @@
 #include "ui_SurfaceTabWidgetBase.h"
 
 /**
- * SurfaceTabWidget
+ * \brief Widget containing the view for the SurfaceModel.
  */
 class SurfaceTabWidget : public QWidget, public Ui_SurfaceTabWidgetBase
 {

DataView/VisualizationWidget.h

@@ -20,7 +20,7 @@ class vtkEventQtSlotConnect;
 #endif // OGS_USE_VRPN
 
 /**
- * VisualizationWidget is a widget which provides the 3d vtk scene view.
+ * \brief Widget containing the 3d VTK scene view.
  */
 class VisualizationWidget : public QWidget, public Ui_VisualizationWidgetBase
 {

Gui/mainwindow.h

@@ -22,6 +22,10 @@ class DatabaseConnection;
 	class TrackingSettingsWidget;
 #endif // OGS_USE_VRPN
 
+
+/**
+ * Main program window for the graphical user interface of OpenGeoSys.
+ */
 class MainWindow : public QMainWindow, public Ui_MainWindowClass
 {
     Q_OBJECT
@@ -44,10 +48,15 @@ protected slots:
 	void showMshDockWidget( bool show );
 	void showVisDockWidget( bool show );
 
+	/// Function calls for opening files.
     void open();
+	/// Function calls for saving files.
 	void save();
+	/// Function calls for generating GMSH files from the GUI
 	void callGMSH(std::vector<std::string> const & selectedGeometries, size_t param1, double param2, double param3, double param4, bool delete_geo_file);
+	/// Function calls for GMS export.
 	void exportBoreholesToGMS(std::string listName, std::string fileName);
+	/// Testing functionality for connection to FEM lib
 	void FEMTestStart();
     void importGMS();
 	void importGoCad();

VtkVis/VtkVisPipelineItem.cpp

@@ -266,7 +266,7 @@ void VtkVisPipelineItem::setVtkProperties(VtkAlgorithmProperties* vtkProps)
 	QObject::connect(vtkProps, SIGNAL(ScalarVisibilityChanged(bool)),
 		_mapper, SLOT(SetScalarVisibility(bool)));
 
-	vtkProps->SetLookUpTable("c:/Project/BoreholeColourReferenceMesh.txt"); //HACK ... needs to be put in GUI
+	//vtkProps->SetLookUpTable("c:/Project/BoreholeColourReferenceMesh.txt"); //HACK ... needs to be put in GUI
 
 	QVtkDataSetMapper* mapper = dynamic_cast<QVtkDataSetMapper*>(_mapper);
 	if (mapper)
@@ -374,6 +374,11 @@ void VtkVisPipelineItem::SetScalarVisibility( bool on )
 
 void VtkVisPipelineItem::SetActiveAttribute( int arrayIndex, int attributeType )
 {
+	if (arrayIndex<0)
+	{
+		return;
+	}
+
 	vtkDataSet* dataSet = vtkDataSet::SafeDownCast(this->_algorithm->GetOutputDataObject(0));
 	bool onPointData(true);
 	double* range(NULL);
@@ -410,6 +415,8 @@ void VtkVisPipelineItem::SetActiveAttribute( int arrayIndex, int attributeType )
 				_mapper->SetScalarRange(dataSet->GetScalarRange());
 			}
 
+			double a = range[0];
+			double b = range[1];
 			_mapper->SetScalarRange(range);
 			_mapper->ScalarVisibilityOn();
 			_mapper->Update();

VtkVis/VtkVisTabWidget.cpp

@@ -195,7 +195,10 @@ void VtkVisTabWidget::setActiveItem( VtkVisPipelineItem* item )
 		emit requestViewUpdate();
 	}
 	else
+	{
 		actorPropertiesGroupBox->setEnabled(false);
+		this->activeScalarComboBox->clear();
+	}
 
 }
 

VtkVis/VtkVisTabWidget.h

@@ -12,7 +12,7 @@
 #include "ui_VtkVisTabWidgetBase.h"
 
 /**
- * VtkVisTabWidget contains a QTreeView of the VtkVisPipeline, a properties
+ * \brief Contains a QTreeView of the VtkVisPipeline and a properties
  * panel for adjusting vtkAlgorithms rendering and filter settings. 
  */
 class VtkVisTabWidget : public QWidget, public Ui_VtkVisTabWidgetBase