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 imageMManager.h
28 * @brief This file contains the ImageMManager class.
30 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
34 #ifndef IMAGEMANAGEMENT_H_
35 #define IMAGEMANAGEMENT_H_
41 #include "regionStructUR.h"
43 /*! @class ImageMManager imageMManager.h "imageMManager.cxx"
44 * @brief This class contains the modification manager of the undo/redo
45 * @details This class contains the region and some information about the undo/redo
50 // ----------------------------------------------------------------------------------
51 /*! @fn ImageMManager();
52 * @brief This is the default constructor.
55 // ----------------------------------------------------------------------------------
56 /*! @fn ImageMManager(ImageMManager* manager);
57 * @brief This is the parameterized constructor.
59 ImageMManager(ImageMManager* manager);
60 // ----------------------------------------------------------------------------------
61 /*! @fn virtual ~ImageMManager();
62 * @brief This is the destructor.
64 virtual ~ImageMManager();
65 // ----------------------------------------------------------------------------------
66 /*! @fn void CleanModifiedRegion();
67 * @brief This method cleans the modification Region.
69 void CleanModifiedRegion();
70 // ----------------------------------------------------------------------------------
71 /*! @fn void AddModifiedPixel(const int& i, const int& j, const int& k);
72 * @brief This method adds the coordinates of the region modified.
74 void AddModifiedPixel(const int& i, const int& j, const int& k);
75 // ----------------------------------------------------------------------------------
76 /*! @fn bool ValidateRegion();
77 * @brief This method returns true if the region modified is valid.
80 bool ValidateRegion();
81 // ----------------------------------------------------------------------------------
82 /*! @fn RegionStructUR GetModifiedRegion();
83 * @brief This method returns the modification region.
86 RegionStructUR GetModifiedRegion();
87 // ----------------------------------------------------------------------------------
89 // ----------------------------------------------------------------------------------
91 * @brief This method make the calculation of the minimun and maximum of the region modified.
93 void CalculateMinMaxRegion(const int& i, const int& j, const int& k);
94 // ----------------------------------------------------------------------------------
96 RegionStructUR m_RegionStruct; //!< This is the Region structure.
97 bool m_ValidRegion; //!< This is true if the region is valid.
100 #endif /* IMAGEMANAGEMENT_H_ */