1 /*# ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
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
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.
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
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 # ------------------------------------------------------------------------ */
27 * @file imageDequeUR.h
28 * @brief This file contains the Image3DDequeUR class. -- Abstract class
30 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
37 #include "imageInfoUR.h"
39 /*! @class ImageDequeUR imageDequeUR.h "imageDequeUR.cxx"
40 * @brief This class contains the management of the undo/redo - Abstract Class
45 // ----------------------------------------------------------------------------------
46 /*! @typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
47 * @brief Defines the pointer of vtkImageDate type.
49 typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
50 // ----------------------------------------------------------------------------------
51 /*! @typedef std::string StringType;
52 * @brief Redefinition of the string type.
54 typedef std::string StringType;
55 // ----------------------------------------------------------------------------------
56 /*! @typedef ImageMManager ImageMManagerType;
57 * @brief Definition of the ImageMManager type.
59 typedef ImageMManager ImageMManagerType;
60 // ----------------------------------------------------------------------------------
62 // ----------------------------------------------------------------------------------
63 /*! @fn ImageDequeUR();
64 * @brief This is the default constructor.
67 // ----------------------------------------------------------------------------------
68 /*! @fn virtual ~ImageDequeUR();
69 * @brief This is the destructor.
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.
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.
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.
93 virtual void ManageMemory();
94 // ----------------------------------------------------------------------------------
95 /*! @fn virtual ImageInfoUR* Undo();
96 * @brief This method is the undo action.
99 virtual ImageInfoUR* Undo();
100 // ----------------------------------------------------------------------------------
101 /*! @fn virtual ImageInfoUR* Redo();
102 * @brief This method is the redo action.
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.
113 #endif /* IMAGEDEQUE_H_ */