From: apo <apo@opencascade.com>
Date: Wed, 26 Oct 2005 07:55:43 +0000 (+0000)
Subject: Documentation of the sources
X-Git-Tag: TG-D5-38-2003_D2005-29-12~42
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f33d0aa311e297f646a7a1092258a7d57ebac567;p=modules%2Fgui.git

Documentation of the sources
---

diff --git a/src/SVTK/SALOME_Actor.h b/src/SVTK/SALOME_Actor.h
index 190109341..8ef2f4d53 100644
--- a/src/SVTK/SALOME_Actor.h
+++ b/src/SVTK/SALOME_Actor.h
@@ -74,9 +74,11 @@ extern int SALOME_LINE_WIDTH;
 
 class SALOME_Actor;
 
-//! The class is a basic class for all SALOME VTK presentation.
+//! The class is a basic one for all SALOME VTK presentation.
 /*!
-  The 
+  It provide highlight and prehighlight capabilites,
+  common way to publish and remove VTK presentation, 
+  mapping of VTK and object IDs and so on.
  */
 class SVTK_EXPORT SALOME_Actor : public VTKViewer_Actor 
 {
@@ -306,66 +308,77 @@ class SVTK_EXPORT SALOME_Actor : public VTKViewer_Actor
   SetVisibility( int );
 
   //----------------------------------------------------------------------------
-  //! 
+  //! To publish the actor an all its internal devices
   virtual
   void
   AddToRender(vtkRenderer* theRendere); 
 
+  //! To remove the actor an all its internal devices
   virtual
   void
   RemoveFromRender(vtkRenderer* theRendere);
 
+  //! Get reference on renderer where it is published
   vtkRenderer*
   GetRenderer();
 
-  // Used to obtain all dependent actors
+  //! Used to obtain all dependent actors
   virtual
   void
   GetChildActors(vtkActorCollection*);
 
   //----------------------------------------------------------------------------
+  //! To set interactor in order to use #vtkInteractorObserver devices
   virtual
   void
   SetInteractor(vtkRenderWindowInteractor* theInteractor);
 
+  //! Put a request to redraw the view 
   virtual
   void
   Update();
 
   //----------------------------------------------------------------------------
-  // To generate highlight automaticaly
+  //! Ask, if the descendant of the SALOME_Actor will implement its own highlight or not
   virtual
   bool
   hasHighlight(); 
 
+  //! Ask, if the SALOME_Actor is already highlighted
   virtual
   bool
   isHighlighted();
 
+  //! Set preselection mode
   virtual
   void
   SetPreSelected(bool thePreselect = false);
 
   //----------------------------------------------------------------------------
+  //! Set selector in order to the actor at any time can restore current selection
   virtual
   void
   SetSelector(SVTK_Selector* theSelector);
 
+  //! Just to update visibility of the highlight devices
   virtual
   void
   highlight(bool theHighlight);  
 
+  //! To map current selection to VTK representation
   virtual
   void
   Highlight(bool theHighlight);  
 
   //----------------------------------------------------------------------------
+  //! To process prehighlight (called from #SVTK_InteractorStyle)
   virtual
   bool
   PreHighlight(vtkInteractorStyle* theInteractorStyle, 
 	       SVTK_SelectionEvent* theSelectionEvent,
 	       bool theIsHighlight);
 
+  //! To process highlight (called from #SVTK_InteractorStyle)
   virtual 
   bool
   Highlight(vtkInteractorStyle* theInteractorStyle, 
@@ -373,19 +386,24 @@ class SVTK_EXPORT SALOME_Actor : public VTKViewer_Actor
 	    bool theIsHighlight);
 
   //----------------------------------------------------------------------------
+  //! To set up a picker for nodal selection (initialized by #SVTK_Renderer::AddActor)
   void
   SetPointPicker(vtkPointPicker* thePointPicker); 
 
+  //! To set up a picker for cell selection (initialized by #SVTK_Renderer::AddActor)
   void
   SetCellPicker(vtkCellPicker* theCellPicker); 
 
+  //! To set up a picker for cell rectangle selection (initialized by #SVTK_Renderer::AddActor)
   void
   SetCellRectPicker(VTKViewer_CellRectPicker* theCellRectPicker);
 
   //----------------------------------------------------------------------------
+  //! To set up a prehighlight property (initialized by #SVTK_Renderer::AddActor)
   void
   SetPreHighlightProperty(vtkProperty* theProperty);
 
+  //! To set up a highlight property (initialized by #SVTK_Renderer::AddActor)
   void
   SetHighlightProperty(vtkProperty* theProperty);
 
diff --git a/src/SVTK/SVTK_ViewWindow.h b/src/SVTK/SVTK_ViewWindow.h
index f06b39586..988be22ea 100755
--- a/src/SVTK/SVTK_ViewWindow.h
+++ b/src/SVTK/SVTK_ViewWindow.h
@@ -89,11 +89,11 @@ class SVTK_EXPORT SVTK_ViewWindow : public SUIT_ViewWindow
   QColor
   backgroundColor() const;
 
-  //! Redirect the request to #SVTK_Renderer::isTrihedronDisplayed
+  //! Redirect the request to #SVTK_Renderer::IsTrihedronDisplayed
   bool
   isTrihedronDisplayed();
 
-  //! Redirect the request to #SVTK_Renderer::isCubeAxesDisplayed
+  //! Redirect the request to #SVTK_Renderer::IsCubeAxesDisplayed
   bool
   isCubeAxesDisplayed();