No newline at end of file

[creaImageIO.git] / src2 / creaImageIOWxViewer.h

diff --git a/src2/creaImageIOWxViewer.h b/src2/creaImageIOWxViewer.h
index e64704af6c579c452e69aee775bb3483b560fe91..528336455f0fedb5e9cd2be74f5b83b78e83f13b 100644 (file)
--- a/src2/creaImageIOWxViewer.h
+++ b/src2/creaImageIOWxViewer.h
@@ -26,7 +26,7 @@ namespace creaImageIO
   {
  
   public:
-    /// Ctor 
+    /// Ctors 
     WxViewer();
     WxViewer(wxWindow *parent, 
                   const wxWindowID id,
@@ -35,45 +35,40 @@ namespace creaImageIO
                   const wxSize& size);
     /// Dtor
     virtual ~WxViewer();
-    /// 
+    /// Shows the next image in the image vector
     void ShowNextImage();
-
+       ///Starts the image player
        void StartPlayer();
-
+       ///Stops the image player
     void StopPlayer();
-
+       ///Refreshes the interface if the current image shown has changed
     bool RefreshIfNecessary();
-
+       ///Sets a new image vector to be read
        void SetImageVector(std::vector<ImagePointerHolder*>& pointers);
   
 
   private:
-   ///Shows the image passed as parameter
+    ///Shows the image passed as parameter
     void ShowImage(vtkImageData* im);
-
     /// Previewer
     vtkImageViewer2* mViewer;
     /// Associated wxvtk interactor
     crea::creawxVTKRenderWindowInteractor  *mInteractor;
-    
     /// Current extent 
     int mx1,mx2,my1,my2,mz1,mz2;
     /// Current spacing
     double mspx,mspy,mspz;
-
-    /// 
+    /// Current image shown
     int mCurrent;
     ///The threaded movie player
     WxViewerPlayer* mPlayer;
-
     /// The mutex
     wxMutex mMutex;
-
-    /// 
+    /// Boolean that declares if the player needs to be refreshed
     bool mNeedRefresh;
-
-       
+       ///Last image shown
     vtkImageData* mLastImageShown;
+       ///The vectors of images to be shown
        std::vector<ImagePointerHolder*> imagePointers;
 
   };