]> Creatis software - bbtk.git/blob - packages/kw/src/bbkwSlicer.h
Feature #1774
[bbtk.git] / packages / kw / src / bbkwSlicer.h
1 /*
2 # ---------------------------------------------------------------------
3 #
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 #                        pour la SantÈ)
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 #
10 #  This software is governed by the CeCILL-B license under French law and
11 #  abiding by the rules of distribution of free software. You can  use,
12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
13 #  license as circulated by CEA, CNRS and INRIA at the following URL
14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15 #  or in the file LICENSE.txt.
16 #
17 #  As a counterpart to the access to the source code and  rights to copy,
18 #  modify and redistribute granted by the license, users are provided only
19 #  with a limited warranty  and the software's author,  the holder of the
20 #  economic rights,  and the successive licensors  have only  limited
21 #  liability.
22 #
23 #  The fact that you are presently reading this means that you have had
24 #  knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------ */
26
27
28 /*=========================================================================
29   Program:   bbtk
30   Module:    $RCSfile: bbkwSlicer.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:51:05 $
33   Version:   $Revision: 1.4 $
34 =========================================================================*/
35
36
37 /**
38  * \file 
39  * \brief Short description in one line
40  * 
41  * Long description which 
42  * can span multiple lines
43 */
44
45 /**
46  * \class bbkw::Slicer
47  * \brief 
48
49  * \class bbkw::SlicerWidget
50  * \brief 
51  */
52
53 #ifdef USE_KWWIDGETS
54
55 // Prevents multiple inclusions : use symbols of the form
56 // __FILENAME_INCLUDED__ 
57 // where FILENAME must be replaced by the actual file name
58 #ifndef __bbkwSlicer_h_INCLUDED__
59 #define __bbkwSlicer_h_INCLUDED__
60
61 // Include KWBlackBox definition
62 #include "bbtkKWBlackBox.h"
63
64 class vtkImageData;
65
66 // Namespace of the package "kw" is "bbkw" 
67 // Namespace associated to packages should be of the form :
68 // bbPACKAGENAME
69 namespace bbkw
70 {
71   
72   
73   //------------------------------------------------------------------------
74   class /*BBTK_EXPORT*/ Slicer : public bbtk::KWBlackBox
75   {
76     
77     BBTK_BLACK_BOX_INTERFACE(Slicer,bbtk::KWBlackBox);
78     BBTK_DECLARE_INPUT(In,vtkImageData*);
79     BBTK_PROCESS(Process);
80     BBTK_CREATE_KWWIDGET(CreateWidget);
81     void Process();
82     void CreateWidget(vtkKWFrame*);
83
84   protected:
85     virtual void bbUserConstructor();
86   };
87   //=================================================================
88  
89   //=================================================================
90   // the black box description
91   BBTK_BEGIN_DESCRIBE_BLACK_BOX(Slicer,bbtk::KWBlackBox);
92   BBTK_NAME("kwSlicer");
93   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
94   // Already inserted for any KWBlackBox  BBTK_CATEGORY("widget");
95   BBTK_DESCRIPTION("Slicer widget (vtkKWSlicer)");
96   BBTK_INPUT(Slicer,In,"Image to display",vtkImageData*,"");
97   BBTK_END_DESCRIBE_BLACK_BOX(Slicer);
98   //=================================================================
99   
100
101
102 } //namespace bbkw
103
104 #endif  //__bbtkkwSlicer_h_INCLUDED__
105
106 #endif // USE_KWWIDGETS