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

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h
index 53e3e4a0cf18bb2bcbe4c4f603b27ffab94b5351..86a6473ab3da3876b0b93b45bb8f814dc08f5251 100755 (executable)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h
@@ -1,8 +1,9 @@
-/*
- * image3DDequeUR.h
- *
- *  Created on: Sep 26, 2011
- *      Author: caceres
+/*!
+ * @file       image3DDequeUR.h
+ * @brief      This file contains the Image3DDequeUR class.
+ * @author     Info-Dev
+ * @author     Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date       2011-11-15
  */
 
 #ifndef IMAGE3DDEQUEUR_H_
@@ -11,25 +12,94 @@
 #include "imageDequeUR.h"
 #include <ctime>
 
+/*! @class Image3DDequeUR image3DDequeUR.h "image3DDequeUR.cxx"
+ *     @brief This class contains the management of the undo/redo deque - Concrete Class
+ *  @details This class derives from ImageDequeUR.
+ */
 class Image3DDequeUR: public ImageDequeUR {
 public:
+       //typedef definition
+       // ----------------------------------------------------------------------------------
+       /*!     @typedef std::deque<ImageInfoUR*> ImageInfoDeque;
+        *      @brief Defines the deque of ImageInfoUR for the undo/redo.
+        */
+       typedef std::deque<ImageInfoUR*> ImageInfoDeque;
+       // ----------------------------------------------------------------------------------
+public:
+       // ----------------------------------------------------------------------------------
+       /*! @fn Image3DDequeUR();
+        * @brief This is the default constructor.
+        */
        Image3DDequeUR();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ~Image3DDequeUR();
+        * @brief This is the destructor.
+        */
        virtual ~Image3DDequeUR();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
+        VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
+        * @brief This method adds the images for undo and redo in a container
+        * @param imgUndo The undoImage cropped.
+        * @param imgRedo The redoImage cropped.
+        * @param imManager The image manager.
+        */
        virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
                        VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void CleanURContainerFromIndex(const int& index);
+        * @brief This method allows to clean the container from a given index.
+        * @param index The index.
+        */
        virtual void CleanURContainerFromIndex(const int& index);
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void ManageMemory();
+        * @brief This method cleans the memory.
+        * @details This method cleans the principal memory when the images are not in use.
+        */
        virtual void ManageMemory();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ImageInfoUR* Undo();
+        * @brief This method is the undo action.
+        * @return
+        */
        virtual ImageInfoUR* Undo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ImageInfoUR* Redo();
+        * @brief This method is the redo action.
+        * @return
+        */
        virtual ImageInfoUR* Redo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn void SetGlobalPath(const StringType& globalPath);
+        * @brief This method sets the global path where the temporary files will be stored.
+        * @param globalPath The String with the path.
+        */
        void SetGlobalPath(const StringType& globalPath);
+       // ----------------------------------------------------------------------------------
+       /*! @fn StringType GetGlobalPath();
+        * @brief This method returns a String with the global path.
+        * @return
+        */
        StringType GetGlobalPath();
+       // ----------------------------------------------------------------------------------
+       /*! @fn StringType GetImageName(const int & pos);
+        * @brief This method returns a String with an image name which won't be repeated.
+        * @param pos The position of the container to manage a sequence.
+        * @return
+        */
        StringType GetImageName(const int & pos);
+       // ----------------------------------------------------------------------------------
+       /*! @fn void CleanHardDisk();
+        * @brief This method cleans the hard disk of the temporary files.
+        */
        void CleanHardDisk();
+       // ----------------------------------------------------------------------------------
 protected:
-       ImageInfoDeque m_ImgURDeque;
-       int m_CurrentURPos;
-       StringType m_GlobalPath;
-       StringType m_IDImages;
+       ImageInfoDeque m_ImgURDeque; //!<This is the container of the images for undo and redo.
+       int m_CurrentURPos; //!<This is the index where is located the undo and redo state.
+       StringType m_GlobalPath; //!<This is the string with the global path.
+       StringType m_IDImages; //!<This is the string with the ID of the images (For the filenames).
 };
 
 #endif /* IMAGE3DDEQUEUR_H_ */