Documents the sources

diff --git a/src/SVTK/SVTK_MainWindow.cxx b/src/SVTK/SVTK_MainWindow.cxx
index 22cf09b2f3915914e57a2957d9d63902851cb357..f1b6867d91dfe23cbb8962ff1bc4dc9d42d370c8 100644 (file)
--- a/src/SVTK/SVTK_MainWindow.cxx
+++ b/src/SVTK/SVTK_MainWindow.cxx
@@ -121,14 +121,6 @@ SVTK_MainWindow
   return GetInteractor()->getRenderWindow();
 }
 
-//----------------------------------------------------------------------------
-void
-SVTK_MainWindow
-::Repaint() 
-{ 
-  Repaint( true ); 
-}
-
 //----------------------------------------------------------------------------
 void
 SVTK_MainWindow

diff --git a/src/SVTK/SVTK_MainWindow.h b/src/SVTK/SVTK_MainWindow.h
index 7d8d9738d9945e9a7a59a43ad9447350a6b1e7a6..223a4a6b50660f02cdbf874818d5836685d2964c 100644 (file)
--- a/src/SVTK/SVTK_MainWindow.h
+++ b/src/SVTK/SVTK_MainWindow.h
@@ -36,6 +36,11 @@ class SVTK_Selector;
 
 
 //----------------------------------------------------------------------------
+//! The class is a container for #SVTK_RenderWindowInteractor.
+/*!
+  The class contains #SVTK_RenderWindowInteractor instance and
+  adds predefined viewer actions and toolbar for user interaction.
+*/
 class SVTK_EXPORT SVTK_MainWindow: public QMainWindow
 {
   Q_OBJECT;
@@ -44,7 +49,8 @@ public:
   SVTK_MainWindow(QWidget* theParent, 
                  const char* theName,
                  SUIT_ResourceMgr* theResourceMgr);
-
+  
+  //! To initialize the class
   virtual
   void
   Initialize(SVTK_RenderWindowInteractor* theInteractor);
@@ -53,94 +59,114 @@ public:
   ~SVTK_MainWindow();
 
   //----------------------------------------------------------------------------
-  void
-  SetInteractor(SVTK_RenderWindowInteractor* theInteractor);
-
+  //! Get used #SVTK_RenderWindowInteractor
   SVTK_RenderWindowInteractor*
   GetInteractor();
 
+  //! Get used #vtkRenderWindowInteractor (obsolete)
   vtkRenderWindowInteractor*
   getInteractor();
 
+  //! Get used #vtkRenderWindow (obsolete)
   vtkRenderWindow*
   getRenderWindow();
 
+  //! To repaint the view
   void
-  Repaint();
-
-  void
-  Repaint(bool theUpdateTrihedron);
+  Repaint(bool theUpdateTrihedron = true);
 
+  //! To invoke a VTK event on #SVTK_RenderWindowInteractor instance
   void
   InvokeEvent(unsigned long theEvent, void* theCallData);
 
   //----------------------------------------------------------------------------
+  //! Redirect the request to #SVTK_RenderWindowInteractor::GetInteractorStyle
   vtkInteractorStyle* 
   GetInteractorStyle();
 
+  //! Redirect the request to #SVTK_RenderWindowInteractor::PushInteractorStyle
   void
   PushInteractorStyle(vtkInteractorStyle* theStyle);
 
+  //! Redirect the request to #SVTK_RenderWindowInteractor::PopInteractorStyle
   void
   PopInteractorStyle();
 
   //----------------------------------------------------------------------------
+  //! Redirect the request to #SVTK_RenderWindowInteractor::GetSelector
   SVTK_Selector* 
   GetSelector();
 
+  //! Redirect the request to #SVTK_RenderWindowInteractor::SelectionMode
   Selection_Mode
   SelectionMode();
 
+  //! Redirect the request to #SVTK_RenderWindowInteractor::SetSelectionMode
   void 
   SetSelectionMode(Selection_Mode theMode);
 
   //----------------------------------------------------------------------------
+  //! Redirect the request to #SVTK_RenderWindowInteractor::GetRenderer
   SVTK_Renderer* 
   GetRenderer();
 
+  //! Redirect the request to #SVTK_RenderWindowInteractor::getRenderer
   vtkRenderer* 
   getRenderer();
 
+  //! Set background color to the view
   void
   SetBackgroundColor(const QColor& theColor);
 
+  //! Get background color of the view
   QColor 
   BackgroundColor();
 
+  //! Redirect the request to #SVTK_Renderer::SetScale
   void
   SetScale(double theScale[3]);
 
+  //! Redirect the request to #SVTK_Renderer::GetScale
   void
   GetScale(double theScale[3]);
 
+  //! Redirect the request to #SVTK_Renderer::AddActor
   virtual
   void 
   AddActor(VTKViewer_Actor* theActor, 
           bool theIsUpdate = false);
 
+  //! Redirect the request to #SVTK_Renderer::RemoveActor
   virtual
   void 
   RemoveActor(VTKViewer_Actor* theActor, 
              bool theIsUpdate = false);
 
+  //! Redirect the request to #SVTK_Renderer::GetTrihedronSize
   int  
   GetTrihedronSize();
 
+  //! Redirect the request to #SVTK_Renderer::SetTrihedronSize
   void
   SetTrihedronSize(const int theSize);
 
+  //! Redirect the request to #SVTK_Renderer::AdjustActors
   void 
   AdjustActors();
 
+  //! Redirect the request to #SVTK_Renderer::IsTrihedronDisplayed
   bool
   IsTrihedronDisplayed();
  
+  //! Redirect the request to #SVTK_Renderer::IsCubeAxesDisplayed
   bool
   IsCubeAxesDisplayed();
 
+  //! Redirect the request to #SVTK_Renderer::GetTrihedron
   VTKViewer_Trihedron* 
   GetTrihedron();
 
+  //! Redirect the request to #SVTK_Renderer::GetCubeAxes
   SVTK_CubeAxesActor2D*
   GetCubeAxes();
 

diff --git a/src/SVTK/SVTK_ViewWindow.h b/src/SVTK/SVTK_ViewWindow.h
index 988be22eade331469bb05bbf61b6cfd7b164a314..1985742090d82ff74d0f0e289a507b2f93180b58 100755 (executable)
--- a/src/SVTK/SVTK_ViewWindow.h
+++ b/src/SVTK/SVTK_ViewWindow.h
@@ -55,19 +55,19 @@ class SVTK_EXPORT SVTK_ViewWindow : public SUIT_ViewWindow
   SVTK_MainWindow* 
   getMainWindow();
 
-  //! Get #vtkRenderWindow (obsolete)
+  //! Redirect the request to #SVTK_MainWindow::getRenderWindow
   vtkRenderWindow* 
   getRenderWindow();
 
-  //! Get #vtkRenderWindow (obsolete)
+  //! Redirect the request to #SVTK_MainWindow::getInteractor
   vtkRenderWindowInteractor*
   getInteractor();
 
-  //! Get #vtkRenderer
+  //! Redirect the request to #SVTK_MainWindow::getRenderer 
   vtkRenderer* 
   getRenderer();
 
-  //! Get #SVTK_Selector
+  //! Redirect the request to #SVTK_MainWindow::GetSelector 
   SVTK_Selector* 
   GetSelector();
   
@@ -80,12 +80,12 @@ class SVTK_EXPORT SVTK_ViewWindow : public SUIT_ViewWindow
   void
   SetSelectionMode(Selection_Mode theMode);
 
-  //! Set background color
+  //! Redirect the request to #SVTK_MainWindow::SetBackgroundColor 
   virtual
   void
   setBackgroundColor( const QColor& );
 
-  //! Get current background color
+  //! Redirect the request to #SVTK_MainWindow::SetBackgroundColor 
   QColor
   backgroundColor() const;