DFCH: ManualPaint + imageUndoRedo: Undo/Redo functionality its now working =) =)

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageModificationManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageModificationManager.h
index 196d65eb552622012f2f3ee1a2199aa81ca79f7e..44561d38f0ff614991de89d2dc68c38adddb89b3 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageModificationManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageModificationManager.h
@@ -1,8 +1,9 @@
-/*
- * imageManagement.h
- *
- *  Created on: Oct 28, 2011
- *      Author: caceres
+/*!
+ * @file       imageMManager.h
+ * @brief      This file contains the ImageMManager class.
+ * @author     Info-Dev
+ * @author     Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date       2011-11-15
  */
 
 #ifndef IMAGEMANAGEMENT_H_
@@ -14,22 +15,60 @@
 
 #include "regionStructUR.h"
 
+/*! @class ImageMManager imageMManager.h "imageMManager.cxx"
+ *     @brief This class contains the modification manager of the undo/redo
+ *     @details This class contains the region and some information about the undo/redo
+ */
 class ImageMManager {
 public:
-       typedef std::map<int, std::map<int, std::map<int, bool> > > PixelModMap; //x,y,z
-public:
+       // ----------------------------------------------------------------------------------
+       /*! @fn ImageMManager();
+        * @brief This is the default constructor.
+        */
        ImageMManager();
+       // ----------------------------------------------------------------------------------
+       /*! @fn ImageMManager(ImageMManager* manager);
+        * @brief This is the parameterized constructor.
+        */
        ImageMManager(ImageMManager* manager);
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ~ImageMManager();
+        * @brief This is the destructor.
+        */
        virtual ~ImageMManager();
-       void CleanModifiedRegion(); //DFCH
-       void AddModifiedPixel(const int& i, const int& j, const int& k); //DFCH
-       bool ValidateRegion();//DFCH
-       RegionStructUR GetModifiedRegion(); //DFCH
+       // ----------------------------------------------------------------------------------
+       /*! @fn void CleanModifiedRegion();
+        * @brief This method cleans the modification Region.
+        */
+       void CleanModifiedRegion();
+       // ----------------------------------------------------------------------------------
+       /*! @fn void AddModifiedPixel(const int& i, const int& j, const int& k);
+        * @brief This method adds the coordinates of the region modified.
+        */
+       void AddModifiedPixel(const int& i, const int& j, const int& k);
+       // ----------------------------------------------------------------------------------
+       /*! @fn bool ValidateRegion();
+        * @brief This method returns true if the region modified is valid.
+        * @return
+        */
+       bool ValidateRegion();
+       // ----------------------------------------------------------------------------------
+       /*! @fn RegionStructUR GetModifiedRegion();
+        * @brief This method returns the modification region.
+        * @return
+        */
+       RegionStructUR GetModifiedRegion();
+       // ----------------------------------------------------------------------------------
 private:
-       void CalculateMinMaxRegion(const int& i, const int& j, const int& k); //DFCH
+       // ----------------------------------------------------------------------------------
+       /*! @fn
+        * @brief This method make the calculation of the minimun and maximum of the region modified.
+        */
+       void CalculateMinMaxRegion(const int& i, const int& j, const int& k);
+       // ----------------------------------------------------------------------------------
 private:
-       RegionStructUR m_RegionStruct;
-       bool m_ValidRegion;
+       RegionStructUR m_RegionStruct; //!< This is the Region structure.
+       bool m_ValidRegion; //!< This is true if the region is valid.
 };
 
 #endif /* IMAGEMANAGEMENT_H_ */