Feature #1606 Add a new entry to ColorLayerImageView to select the fitting mode betwe...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / imageUndoRedo / imageUndoRedo.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageUndoRedo.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageUndoRedo.h
index 78ff99b2e2497ec3f7d00d268ecaee68f10c4ff9..66be0fc17e432259e2668f3db4ffa884847f0e24 100755 (executable)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageUndoRedo.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageUndoRedo.h
@@ -1,8 +1,9 @@
-/*
- * imageUndoRedo.h
- *
- *  Created on: Sep 26, 2011
- *      Author: caceres
+/*!
+ * @file       imageUndoRedo.h
+ * @brief      This file contains the ImageUndoRedo class.
+ * @author     Info-Dev
+ * @author     Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date       2011-11-15
  */
 
 #ifndef IMAGEUNDOREDO_H_
@@ -10,27 +11,80 @@
 
 #include "managerUR.h"
 
+/*! @class ImageUndoRedo imageUndoRedo.h "imageUndoRedo.cxx"
+ *     @brief This class manages the undo/redo -- Concrete Class
+ *     @details This class derives from ManagerUR
+ */
 class ImageUndoRedo: public ManagerUR {
+
 public:
+       //typedef definition
+       // ----------------------------------------------------------------------------------
+       /*!     @typedef typedef Image3DDequeUR IDequeType;
+        *      @brief Redefines the Image3DDequeUR type
+        */
+       typedef Image3DDequeUR IDequeType;
+       // ----------------------------------------------------------------------------------
+public:
+       // ----------------------------------------------------------------------------------
+       /*! @fn ImageUndoRedo();
+        * @brief This is the default constructor.
+        */
        ImageUndoRedo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ~ImageUndoRedo();
+        * @brief This is the destructor.
+        */
        virtual ~ImageUndoRedo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void Undo();
+        * @brief This method manages the undo action.
+        */
        virtual void Undo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void Redo();
+        * @brief This method manages the redo action.
+        */
        virtual void Redo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void SetImage(VTKImageDataPointerType image);
+        * @brief This method sets the modification image (The image which will be modified an manipulated)
+        */
        virtual void SetImage(VTKImageDataPointerType image);
-       virtual void SetUndoImage(ImageMManagerType* imMManager);
-       virtual void SetRedoImage(const ImageMManagerType* imMManager);
-       void SetOriginalImage(VTKImageDataPointerType img);
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void SetURImages(ImageMManagerType* imMManager);
+        * @brief This methods adds a new image Undo/Redo.
+        */
+       virtual void SetURImages(ImageMManagerType* imMManager);
+       // ----------------------------------------------------------------------------------
+       /*! @fn void UpdateUndoImage();
+        * @brief This method updates the undo image t(m_CurrentImage - 1).
+        */
+       void UpdateUndoImage();
+       // ----------------------------------------------------------------------------------
+       /*! @fn void SetCurrentImage(VTKImageDataPointerType img);
+        * @brief This method sets the image to be manipulated.
+        */
        void SetCurrentImage(VTKImageDataPointerType img);
+       // ----------------------------------------------------------------------------------
+       /*! @fn VTKImageDataPointerType GetImageRegion(const RegionSType& region,
+        VTKImageDataPointerType img);
+        * @brief This method extract from an image the region of interest (In the undo/redo returns the volume of the modified or t-1 image).
+        */
        VTKImageDataPointerType GetImageRegion(const RegionSType& region,
                        VTKImageDataPointerType img);
 protected:
-       virtual void DrawUR(ImageInfoUR* imageInfo);
-
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void DrawUR(ImageInfoUR* imageInfo, const bool& undo);
+        * @brief This method writes in the visualized image the changes of the undo/redo.
+        */
+       virtual void DrawUR(ImageInfoUR* imageInfo, const bool& undo);
+       // ----------------------------------------------------------------------------------
 protected:
 
-       IDequeType* m_ImagesDeque;
-       VTKImageDataPointerType m_OriginalImage;
-       VTKImageDataPointerType m_CurrentImage;
+       IDequeType* m_ImagesDeque; //!<The manager of the ImagesDeque.
+       VTKImageDataPointerType m_UndoImage; //!< This is the image for undo t(m_CurrentImage - 1).
+       VTKImageDataPointerType m_CurrentImage; //!< This is the current image (The modification image).
 
 };