]> Creatis software - bbtk.git/blob - packages/vtk/src/bbvtkPolyDataToActor.h
Clean Code
[bbtk.git] / packages / vtk / src / bbvtkPolyDataToActor.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: bbvtkPolyDataToActor.h,v $
31   Language:  C++
32   Date:      $Date: 2009/05/15 14:58:01 $
33   Version:   $Revision: 1.12 $
34 =========================================================================*/                                                                  
35
36
37 /**
38  * \brief Short description in one line
39  * 
40  * Long description which 
41  * can span multiple lines
42  */
43 /**
44  * \file 
45  * \brief Pattern for the definition of a new type of Node (header)
46  */
47 /**
48  * \class bbtk::NodePatern 
49  * \brief Pattern for the definition of a new type of Node 
50  */
51
52
53 #ifdef _USE_VTK_
54
55
56 #ifndef __vtkPolyDataToActor_h__
57 #define __vtkPolyDataToActor_h__
58
59 #include "vtkRenderer.h"
60 #include "vtkPolyData.h"
61 #include "vtkPolyDataMapper.h"
62 #include "vtkProp3D.h"
63 #include "vtkActor.h"
64 #include "vtkScalarsToColors.h"
65 #include "vtkProperty.h"
66
67 #include <vector>
68
69 #include "bbtkAtomicBlackBox.h"
70
71 namespace bbvtk
72 {
73   
74   class /*BBTK_EXPORT*/ PolyDataToActor
75     : 
76     public bbtk::AtomicBlackBox
77   {
78     bool              actorAdded;
79     vtkPolyDataMapper *polydatamapper;
80     vtkActor          *vtkactor; 
81     vtkProperty       *backfaceproperty;
82       
83     BBTK_BLACK_BOX_INTERFACE(PolyDataToActor,bbtk::AtomicBlackBox);
84     
85     BBTK_DECLARE_INPUT(Active,bool);
86     BBTK_DECLARE_INPUT(In,vtkPolyData *);
87     BBTK_DECLARE_INPUT(Opacity,double);
88     BBTK_DECLARE_INPUT(Colour,std::vector<double>);
89     BBTK_DECLARE_INPUT(BackFaceColour,std::vector<double>);
90     BBTK_DECLARE_INPUT(Renderer,vtkRenderer *);
91     BBTK_DECLARE_INPUT(Transform, vtkLinearTransform *);
92     BBTK_DECLARE_INPUT(Representation, int);
93     BBTK_DECLARE_INPUT(LineWidth, double);
94     BBTK_DECLARE_INPUT(ScalarVisibility, bool);
95     BBTK_DECLARE_INPUT(ScalarVisibilityOn_LookupTable, vtkScalarsToColors*);
96     BBTK_DECLARE_INPUT(ScalarVisibilityOn_NameColorArray, std::string);
97     BBTK_DECLARE_INPUT(ScalarVisibilityOn_ScalarRange, std::vector<double>);
98
99     BBTK_DECLARE_OUTPUT(Out,vtkProp3D *);
100     
101     BBTK_PROCESS(DoProcess);
102     void DoProcess();
103     
104   protected:
105   };
106   
107   BBTK_BEGIN_DESCRIBE_BLACK_BOX(PolyDataToActor,bbtk::AtomicBlackBox);
108   BBTK_NAME("PolyDataToActor");
109   BBTK_AUTHOR("eduardo.davila at creatis.insa-lyon.fr");
110   BBTK_DESCRIPTION("(C++,Python,JavaScript) Takes a vtkPolyData object to insert into a 3D scene (e.g. a Viewer3D)");
111   typedef std::vector<double> vectorcolour;
112   BBTK_CATEGORY("3D object creator");
113   BBTK_INPUT(PolyDataToActor,In,"Input image",vtkPolyData*,"");
114
115   BBTK_INPUT(PolyDataToActor,Active,"Active true/false (default true)",bool,"");
116   BBTK_INPUT(PolyDataToActor,Opacity,"Opacity",double,"");
117   BBTK_INPUT(PolyDataToActor,Colour,"r g b",vectorcolour,"colour");
118   BBTK_INPUT(PolyDataToActor,BackFaceColour,"(default EMPTY) [r g b]  (0..1)",vectorcolour,"colour");
119   BBTK_INPUT(PolyDataToActor,Renderer,"3D scene in which to insert the surface",vtkRenderer*,"");
120   BBTK_INPUT(PolyDataToActor,Transform,"Linear Transform (4x4 homogeneous)",vtkLinearTransform*,"");
121   BBTK_INPUT(PolyDataToActor,Representation,"0 points,1 wireframe, 2(default) surface",int,"");
122   BBTK_INPUT(PolyDataToActor,LineWidth,"Width of the wireframe (1 default)",double,"");
123   BBTK_INPUT(PolyDataToActor,ScalarVisibility,"(false default)   a) ScalarVisibility:false use color actor.  b) ScalarVisibility:true use PolyData->SetScalars [3-components-RGB] (float 0..1 or int 0..255).  c) ScalarVisibility:true and SetLookupTable use PolyData->SetScalars [1-component] d) ScalarVisibility:true and SetLookupTable SelectColorArray(<NameArray>) use PolyData->SetScalars( scalar(<NameArray>) ). e) For c/d  SetScalarRange just for the mapper. d) [-1,-1] take PolyData->GetScalarRange()",bool,"");
124
125   BBTK_INPUT(PolyDataToActor,ScalarVisibilityOn_LookupTable,"LookupTable (need ScalarVisibility true)",vtkScalarsToColors*,"");
126   BBTK_INPUT(PolyDataToActor,ScalarVisibilityOn_NameColorArray,"Name of the array in PolyData (need ScalarVisibility true)",std::string,"");
127   BBTK_INPUT(PolyDataToActor,ScalarVisibilityOn_ScalarRange,"[min,max] Make ScalarRange independent from  LookupTable (need ScalarVisibility true)", std::vector<double> ,"");
128
129   BBTK_OUTPUT(PolyDataToActor,Out,"Extracted iso-surface",vtkProp3D *,"");
130   
131   BBTK_END_DESCRIBE_BLACK_BOX(PolyDataToActor);
132   
133 }// EO namespace bbtk
134
135
136 #endif  //__PolyDataToActor_h__
137
138 #endif //_USE_VTK_