X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FimageUndoRedo%2FmanagerUR.h;h=fa18e8e5d0bbe939b50a29436a79e5f851121da4;hb=b2ac7f59e78e33f8e11065cffa2f2072aa9a9ee5;hp=af4691157ebfb00058566d25b2c0a75f0e532a53;hpb=b37bd791f88bd4c1a6146fadcb88864d7cd1a5c3;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 af46911..fa18e8e 100755 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/managerUR.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/managerUR.h @@ -1,8 +1,34 @@ -/* - * managerUR.h - * - * Created on: Sep 26, 2011 - * Author: caceres +/*# --------------------------------------------------------------------- +# +# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image +# pour la Sant�) +# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton +# Previous Authors : Laurent Guigues, Jean-Pierre Roux +# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil +# +# This software is governed by the CeCILL-B license under French law and +# abiding by the rules of distribution of free software. You can use, +# modify and/ or redistribute the software under the terms of the CeCILL-B +# license as circulated by CEA, CNRS and INRIA at the following URL +# http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html +# or in the file LICENSE.txt. +# +# As a counterpart to the access to the source code and rights to copy, +# modify and redistribute granted by the license, users are provided only +# with a limited warranty and the software's author, the holder of the +# economic rights, and the successive licensors have only limited +# liability. +# +# The fact that you are presently reading this means that you have had +# knowledge of the CeCILL-B license and that you accept its terms. +# ------------------------------------------------------------------------ */ + +/*! + * @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_ @@ -15,25 +41,82 @@ #include #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 VTKImageDataPointerType; + * @brief Defines the pointer of vtkImageDate type. + */ typedef vtkSmartPointer VTKImageDataPointerType; + // ---------------------------------------------------------------------------------- + /*! @typedef vtkSmartPointer VTKExtractVOIPointerType; + * @brief Defines the pointer of vtkExtractVOI type. + */ typedef vtkSmartPointer 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(const RegionSType& region); - virtual void SetRedoImage(const RegionSType& region); + // ---------------------------------------------------------------------------------- + /*! @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_ */