Update comments

[modules/gui.git] / src / VTKViewer / VTKViewer_CellRectPicker.h

diff --git a/src/VTKViewer/VTKViewer_CellRectPicker.h b/src/VTKViewer/VTKViewer_CellRectPicker.h
index 76b0b8c40106d5ac87c9b02c079ce3fc9c51f6dd..94785d29518553a6331a7a450fd162f934ab0445 100755 (executable)
--- a/src/VTKViewer/VTKViewer_CellRectPicker.h
+++ b/src/VTKViewer/VTKViewer_CellRectPicker.h
@@ -19,11 +19,10 @@
 // 
 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
 //
-//
-//
-//  File   : VTKViewer_CellRectPicker.h
-//  Author : Natalia KOPNOVA
-//  Module : SALOME
+//  File    : VTKViewer_CellRectPicker.h
+//  Author  : Natalia KOPNOVA
+//  Module  : SALOME
+
 
 #ifndef __VTKViewer_CellRectPicker_h
 #define __VTKViewer_CellRectPicker_h
@@ -32,6 +31,7 @@
 #include <map>
 #include <vector>
 
+/*! \brief Cell data structure*/
 typedef struct {
   vtkIdType cellId;
   int subId;
@@ -46,40 +46,67 @@ typedef std::map<vtkActor*, VTKViewer_CellDataSet> VTKViewer_ActorDataMap;
 class vtkCell;
 class vtkGenericCell;
 class vtkQuad;
-
+/*! \class VTKViewer_CellRectPicker
+ * \brief Rectangular cell picker class.
+ */
 class VTK_EXPORT VTKViewer_CellRectPicker : public VTKViewer_RectPicker
 {
 public:
   static VTKViewer_CellRectPicker *New();
+  /*! \fn vtkTypeMacro(VTKViewer_CellRectPicker,VTKViewer_RectPicker);
+   * \brief VTK type macros.
+   */
   vtkTypeMacro(VTKViewer_CellRectPicker,VTKViewer_RectPicker);
 
-  // Description:
-  // Get the id of the picked cells. 
-  // (Notes: use GetActors() to get picked actors list)
+  /*! \fn VTKViewer_CellDataSet GetCellData(vtkActor* actor)
+   * \brief Get the id of the picked cells. 
+   * \brief (Notes: use GetActors() to get picked actors list)
+   * \param actor - vtkActor pointer
+   */
   VTKViewer_CellDataSet GetCellData(vtkActor* actor) 
     { return this->ActorData[actor]; }
 
-  // Description:
-  // The method returns a non-zero value if the cells intersect each other 
-  // in the direction dir[3]. Returned value is 1 if the first cell is top of 
-  // the second one according to direction and 2 if the second cell is top.
+  /*! \fn static int IntersectCells(vtkCell* c1, float d1, vtkCell* c2, float d2, float dir[3]);
+   * \brief The method returns a non-zero value, if the cells intersect each other 
+   * in the direction dir[3].
+   * \param c1 - first vtkCell pointer
+   * \param d1 - 
+   * \param c2 - second vtkCell pointer
+   * \param d2 - 
+   * \param dir[3] - direction
+   * \retval integer - Returned value is 1 if the first cell is top of 
+   * the second one according to direction and 2 if the second cell is top.
+   */
   static int IntersectCells(vtkCell* c1, float d1, vtkCell* c2, float d2, float dir[3]);
 
-  // Description:
-  // The method returns a non-zero value if the point is inlide point data set
+  /*! \fn static char PointInside(float point[3], vtkPoints* list);
+   * \brief Check point position.
+   * \param point[3] - point
+   * \param list - point data set
+   * \retval 0 or 1 - The method returns a non-zero value, if the point is inlide point data set
+   */
   static char PointInside(float point[3], vtkPoints* list);
 
 protected:
+  
   VTKViewer_CellRectPicker();
   ~VTKViewer_CellRectPicker();
 
   VTKViewer_ActorDataMap ActorData;
 
+  /*! \fn virtual float IntersectWithHex(float p1[4][4], float p2[4][4], float tol, 
+   *                              vtkAssemblyPath *path, vtkProp3D *p, 
+   *                              vtkAbstractMapper3D *m);
+   */
   virtual float IntersectWithHex(float p1[4][4], float p2[4][4], float tol, 
                           vtkAssemblyPath *path, vtkProp3D *p, 
                           vtkAbstractMapper3D *m);
+  /*! \fn void Initialize();
+   * \brief Clear \a ActorData and call VTKViewer_RectPicker::Initialize() method
+   */
   void Initialize();
 
+  
   void IncludeCell(vtkDataSet* input, VTKViewer_CellData cellData, VTKViewer_CellDataSet& dalaList);
   void IncludeActor(vtkProp3D* prop, vtkDataSet* input, VTKViewer_CellDataSet& dataList);