X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FimageUndoRedo%2FimageModificationManager.h;h=44561d38f0ff614991de89d2dc68c38adddb89b3;hb=f050938d3947f6b785289da6d58f8fec2da57421;hp=3e11b7e488806b9ead628a06551766833d9ec9f0;hpb=f4bdb751aba1f5fce1d4305365d6309f993d9c32;p=creaMaracasVisu.git

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageModificationManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageModificationManager.h
index 3e11b7e..44561d3 100644
--- 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,24 +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
-	//void SetRegion(const RegionStructUR& region);
-	//void SetPixelModMap(const PixelModMap& map); //DFCH
-	RegionStructUR GetModifiedRegion(); //DFCH
-	PixelModMap GetModificationMap(); //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;
-	PixelModMap m_PixelMap;
+	RegionStructUR m_RegionStruct; //!< This is the Region structure.
+	bool m_ValidRegion; //!< This is true if the region is valid.
 };
 
 #endif /* IMAGEMANAGEMENT_H_ */