packages/vtk/src/bbvtkVolumeRenderer.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbvtkVolumeRenderer.h,v $
   4   Language:  C++
   5   Date:      $Date: 2009/07/08 15:18:18 $
   6   Version:   $Revision: 1.4 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31
  32 /**
  33  * \brief Short description in one line
  34  *
  35  * Long description which
  36  * can span multiple lines
  37  */
  38 /**
  39  * \file
  40  * \brief Pattern for the definition of a new type of Node (header)
  41  */
  42 /**
  43  * \class bbtk::NodePatern
  44  * \brief Pattern for the definition of a new type of Node
  45  */
  46
  47
  48 #ifdef _USE_VTK_
  49
  50
  51 #ifndef __bbvtkVolumeRenderer_h_INCLUDED__
  52 #define __bbvtkVolumeRenderer_h_INCLUDED__
  53
  54
  55 #include "bbtkAtomicBlackBox.h"
  56
  57 #include "vtkImageData.h"
  58 //#include <vtkImageShiftScale.h>
  59 //#include <vtkVolumeRayCastMIPFunction.h>
  60 #include "vtkVolumeProperty.h"
  61 #include "vtkVolumeRayCastCompositeFunction.h"
  62 #include "vtkVolumeRayCastMapper.h"
  63 #include "vtkProp3D.h"
  64 #include "vtkVolume.h"
  65
  66 #include "vtkPiecewiseFunction.h"
  67 #include "vtkColorTransferFunction.h"
  68
  69 #include "bbvtk_EXPORT.h"
  70
  71 namespace bbvtk
  72 {
  73
  74
  75
  76   class bbvtk_EXPORT VolumeRenderer : public bbtk::AtomicBlackBox
  77   {
  78   public:
  79     BBTK_BLACK_BOX_INTERFACE(VolumeRenderer,bbtk::AtomicBlackBox);
  80
  81     BBTK_DECLARE_INPUT(In,vtkImageData *);
  82     BBTK_DECLARE_INPUT(ColorFunction,vtkPiecewiseFunction*);
  83         BBTK_DECLARE_INPUT(ColorFunction1,vtkColorTransferFunction *);
  84     BBTK_DECLARE_INPUT(OpacityFunction,vtkPiecewiseFunction*);
  85     BBTK_DECLARE_OUTPUT(Out,vtkProp3D*);
  86     BBTK_PROCESS(Process);
  87     void Process();
  88
  89   protected:
  90
  91   private:
  92     vtkVolumeProperty * mVolumeProperty;
  93     vtkVolumeRayCastCompositeFunction * mRayCastFunction;
  94     vtkVolumeRayCastMapper* mMapper;
  95     vtkVolume* mVolume;
  96   };
  97
  98   //=================================================================
  99   // UserBlackBox description
 100   BBTK_BEGIN_DESCRIBE_BLACK_BOX(VolumeRenderer,bbtk::AtomicBlackBox);
 101   BBTK_NAME("VolumeRenderer");
 102   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
 103   BBTK_DESCRIPTION("Renders a 3D image. Creates a vtkProp3D object to insert into a 3D scene (e.g. a Viewer3D)");
 104   BBTK_CATEGORY("3D object creator");
 105   BBTK_INPUT(VolumeRenderer,ColorFunction,"Color function",vtkPiecewiseFunction*,"");
 106   BBTK_INPUT(VolumeRenderer,ColorFunction1,"Color function1 instead of Color function",vtkColorTransferFunction*,"");
 107   BBTK_INPUT(VolumeRenderer,OpacityFunction,"Opacity function",vtkPiecewiseFunction*,"");
 108   BBTK_INPUT(VolumeRenderer,In,"Input Image",vtkImageData *,"");
 109   BBTK_OUTPUT(VolumeRenderer,Out,"3D object to plug into a 3D viewer",vtkProp3D*,"");
 110   BBTK_END_DESCRIBE_BLACK_BOX(VolumeRenderer);
 111   //=================================================================
 112
 113
 114 }//namespace bbvtk
 115
 116 #endif  //__bbtvtkVolumeRenderer_h__
 117
 118 #endif //_USE_VTK_
 119