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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/managerUR.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/managerUR.h
index aae2158..e467941 100755
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/managerUR.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/managerUR.h
@@ -1,8 +1,9 @@
-/*
- * managerUR.h
- *
- *  Created on: Sep 26, 2011
- *      Author: caceres
+/*!
+ * @file	managerUR.h
+ * @brief	This file contains the ManagerUR class. -- Abstract class
+ * @author 	Info-Dev
+ * @author	Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 	2011-11-15
  */
 
 #ifndef MANAGERUR_H_
@@ -17,26 +18,80 @@
 #include "image3DDequeUR.h"
 #include "imageModificationManager.h"
 #include "regionStructUR.h"
+#include "imageInfoUR.h"
 
+/*! @class ManagerUR managerUR.h "managerUR.cxx"
+ *	@brief This class manages the Undo/Redo -- Abstract Class.
+ *	@details This class allows the communication between others libraries who wants to use it.
+ */
 class ManagerUR {
 public:
-	typedef Image3DDequeUR IDequeType;
+	//typedef definition
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef RegionStructUR RegionSType;
+	 *	@brief Redefines the ImageMManagerType.
+	 */
 	typedef RegionStructUR RegionSType;
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef ImageMManager ImageMManagerType;
+	 *	@brief Redefines the ImageMManager type.
+	 */
 	typedef ImageMManager ImageMManagerType;
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
+	 *	@brief Defines the pointer of vtkImageDate type.
+	 */
 	typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef vtkSmartPointer<vtkExtractVOI> VTKExtractVOIPointerType;
+	 *	@brief Defines the pointer of vtkExtractVOI type.
+	 */
 	typedef vtkSmartPointer<vtkExtractVOI> VTKExtractVOIPointerType;
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef std::string StringType;
+	 *	@brief Redefinition of the string type
+	 */
 	typedef std::string StringType;
+	// ----------------------------------------------------------------------------------
 public:
+	// ----------------------------------------------------------------------------------
+	/*! @fn ManagerUR();
+	 * @brief This is the default constructor.
+	 */
 	ManagerUR();
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual ~ManagerUR();
+	 * @brief This is the destructor.
+	 */
 	virtual ~ManagerUR();
-	virtual void SetImage(vtkImageData *image);
+	// ----------------------------------------------------------------------------------
+	/*! @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();
-	virtual void SetUndoImage(ImageMManagerType* imMManager);
-	virtual void SetRedoImage(ImageMManagerType* imMManager);
+	// ----------------------------------------------------------------------------------
+	/*! @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);
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual void SetURImages(ImageMManagerType* imMManager);
+	 * @brief This methods adds a new image Undo/Redo.
+	 */
+	virtual void SetURImages(ImageMManagerType* imMManager);
+	// ----------------------------------------------------------------------------------
 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);
+	// ----------------------------------------------------------------------------------
 };
 
 #endif /* MANAGERUR_H_ */