]> Creatis software - bbtk.git/blob - packages/vtk/src/bbvtkVolumeRenderer.h
Feature #1774
[bbtk.git] / packages / vtk / src / bbvtkVolumeRenderer.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: bbvtkVolumeRenderer.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:51:58 $
33   Version:   $Revision: 1.7 $
34 =========================================================================*/
35
36
37
38 /**
39  * \brief Short description in one line
40  * 
41  * Long description which 
42  * can span multiple lines
43  */
44 /**
45  * \file 
46  * \brief Pattern for the definition of a new type of Node (header)
47  */
48 /**
49  * \class bbtk::NodePatern 
50  * \brief Pattern for the definition of a new type of Node 
51  */
52
53
54 #ifdef _USE_VTK_
55
56
57 #ifndef __bbvtkVolumeRenderer_h_INCLUDED__
58 #define __bbvtkVolumeRenderer_h_INCLUDED__
59
60
61 #include "bbtkAtomicBlackBox.h"
62
63 #include "vtkImageData.h"
64 //#include <vtkImageShiftScale.h>
65 //#include <vtkVolumeRayCastMIPFunction.h>
66 #include "vtkVolumeProperty.h"
67 #include "vtkVolumeRayCastCompositeFunction.h"
68 #include "vtkVolumeRayCastMapper.h"
69 #include "vtkProp3D.h"
70 #include "vtkVolume.h"
71
72 #include "vtkPiecewiseFunction.h"
73 #include "vtkColorTransferFunction.h"
74
75 #include "bbvtk_EXPORT.h"
76 #include "vtkVolumeProperty.h"
77
78 namespace bbvtk
79 {
80   class bbvtk_EXPORT VolumeRenderer : public bbtk::AtomicBlackBox
81   { 
82   public:
83     BBTK_BLACK_BOX_INTERFACE(VolumeRenderer,bbtk::AtomicBlackBox);
84
85     BBTK_DECLARE_INPUT(In,             vtkImageData *);
86     BBTK_DECLARE_INPUT(ColorFunction,  vtkPiecewiseFunction*);
87     BBTK_DECLARE_INPUT(ColorFunction1, vtkColorTransferFunction *);
88     BBTK_DECLARE_INPUT(OpacityFunction,vtkPiecewiseFunction*);
89     
90     BBTK_DECLARE_OUTPUT(Out, vtkProp3D*);
91     BBTK_PROCESS(Process);
92     void Process();
93     
94   protected:
95
96   private:
97     vtkVolumeProperty                 *mVolumeProperty;
98     vtkVolumeRayCastCompositeFunction *mRayCastFunction;
99     vtkVolumeRayCastMapper            *mMapper;
100     vtkVolume                         *mVolume;
101     vtkVolumeProperty                 *_volumeProperty;
102   };
103    
104   //=================================================================
105   // UserBlackBox description
106   BBTK_BEGIN_DESCRIBE_BLACK_BOX(VolumeRenderer,bbtk::AtomicBlackBox);
107   BBTK_NAME("VolumeRenderer");
108   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
109   BBTK_DESCRIPTION("Renders a 3D image. Creates a vtkProp3D object to insert into a 3D scene (e.g. a Viewer3D)");
110   BBTK_CATEGORY("3D object creator");
111   BBTK_INPUT(VolumeRenderer,ColorFunction,  "Color function",                           vtkPiecewiseFunction*,"");
112   BBTK_INPUT(VolumeRenderer,ColorFunction1, "Color function1 instead of Color function",vtkColorTransferFunction*,"");
113   BBTK_INPUT(VolumeRenderer,OpacityFunction,"Opacity function",                         vtkPiecewiseFunction*,"");
114   BBTK_INPUT(VolumeRenderer,In,             "Input Image",                              vtkImageData *,"");
115   
116   BBTK_OUTPUT(VolumeRenderer,Out, "3D object to plug into a 3D viewer",vtkProp3D*, "");
117   BBTK_END_DESCRIBE_BLACK_BOX(VolumeRenderer);
118   //=================================================================
119
120
121 }//namespace bbvtk
122
123 #endif  //__bbtvtkVolumeRenderer_h__
124
125 #endif //_USE_VTK_
126