lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h

   1 /*# ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Sant�)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26 /*!
  27  * @file        imageDequeUR.h
  28  * @brief       This file contains the Image3DDequeUR class. -- Abstract class
  29  * @author      Info-Dev
  30  * @author      Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  31  * @date        2011-11-15
  32  */
  33
  34 #ifndef IMAGEDEQUE_H_
  35 #define IMAGEDEQUE_H_
  36
  37 #include "imageInfoUR.h"
  38
  39 /*! @class ImageDequeUR imageDequeUR.h "imageDequeUR.cxx"
  40  *      @brief This class contains the management of the undo/redo - Abstract Class
  41  */
  42 class ImageDequeUR {
  43 public:
  44         //typedef definition
  45         // ----------------------------------------------------------------------------------
  46         /*!     @typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
  47          *      @brief Defines the pointer of vtkImageDate type.
  48          */
  49         typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
  50         // ----------------------------------------------------------------------------------
  51         /*!     @typedef std::string StringType;
  52          *      @brief Redefinition of the string type.
  53          */
  54         typedef std::string StringType;
  55         // ----------------------------------------------------------------------------------
  56         /*!     @typedef ImageMManager ImageMManagerType;
  57          *      @brief Definition of the ImageMManager type.
  58          */
  59         typedef ImageMManager ImageMManagerType;
  60         // ----------------------------------------------------------------------------------
  61 public:
  62         // ----------------------------------------------------------------------------------
  63         /*! @fn ImageDequeUR();
  64          * @brief This is the default constructor.
  65          */
  66         ImageDequeUR();
  67         // ----------------------------------------------------------------------------------
  68         /*! @fn virtual ~ImageDequeUR();
  69          * @brief This is the destructor.
  70          */
  71         virtual ~ImageDequeUR();
  72         // ----------------------------------------------------------------------------------
  73         /*! @fn virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
  74          VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
  75          * @brief This method adds the images for undo and redo in a container
  76          * @param imgUndo The undoImage cropped.
  77          * @param imgRedo The redoImage cropped.
  78          * @param imManager The image manager.
  79          */
  80         virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
  81                         VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
  82         // ----------------------------------------------------------------------------------
  83         /*! @fn virtual void CleanURContainerFromIndex(const int& index);
  84          * @brief This method allows to clean the container from a given index.
  85          * @param index The index.
  86          */
  87         virtual void CleanURContainerFromIndex(const int& index);
  88         // ----------------------------------------------------------------------------------
  89         /*! @fn virtual void ManageMemory();
  90          * @brief This method cleans the memory.
  91          * @details This method cleans the principal memory when the images are not in use.
  92          */
  93         virtual void ManageMemory();
  94         // ----------------------------------------------------------------------------------
  95         /*! @fn virtual ImageInfoUR* Undo();
  96          * @brief This method is the undo action.
  97          * @return
  98          */
  99         virtual ImageInfoUR* Undo();
 100         // ----------------------------------------------------------------------------------
 101         /*! @fn virtual ImageInfoUR* Redo();
 102          * @brief This method is the redo action.
 103          * @return
 104          */
 105         virtual ImageInfoUR* Redo();
 106         // ----------------------------------------------------------------------------------
 107         /*! @fn void SetGlobalPath(const StringType& globalPath);
 108          * @brief This method sets the global path where the temporary files will be stored.
 109          * @param globalPath The String with the path.
 110          */
 111 };
 112
 113 #endif /* IMAGEDEQUE_H_ */