]> Creatis software - bbtk.git/blob - kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
Feature #1774
[bbtk.git] / kernel / appli / bbCreateBlackBox / xml-templates / VTK_PolyDataAlgorithm-template.xml
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 <?xml version="1.0" encoding="iso-8859-1"?>
29 <!--==========================================================================
30    STARTS THE DESCRIPTION OF THE BLACK BOX -->
31 <blackbox name="__BLACKBOXNAME__" type="VTK_PolyDataAlgorithm">
32
33  <!--========================================================================
34     THE BOX DOCUMENTATION -->
35
36 <author>__AUTHOR__</author>
37 <description><PRE>__DESCRIPTION__</PRE></description>
38 <category>__CategoryBlackBox__</category>
39
40 <!--========================================================================
41     #include directives to be put in the .h generated
42     There must be one tag per file to include -->
43
44 <include>vtkAppendPolyData.h</include> 
45
46   <!--========================================================================
47     THE vtk class the box inherits from (if any) -->
48 <vtkparent>vtkAppendPolyData</vtkparent>
49
50  <!--========================================================================
51     INPUTS/OUTPUTS DECLARATION -->
52 <output name="Out" type="vtkPolyData*" special="vtk output" description="Output Mesh"/>
53 <input name="In1" type="vtkPolyData *" description="PolyData 1"/>
54 <input name="In2" type="vtkPolyData *" description="PolyData 2"/>
55 <input name="In3" type="vtkPolyData *" description="PolyData 3"/>
56 <input name="In4" type="vtkPolyData *" description="PolyData 4"/>
57 <input name="In5" type="vtkPolyData *" description="PolyData 5"/>
58
59  <!--========================================================================
60     PROCESS section -->
61
62 <process>
63 <PRE>
64   bbSetOutput((vtkPolyData *)0);
65
66   Update();
67 </PRE>
68 </process>
69
70   <!--========================================================================
71     CONSTRUCTORS / DESTRUCTORS (OPTIONAL) 
72     THE CONSTRUCTION METHOD BODY :
73     Generaly you initialize the Input variables with their default values
74     This is also where you should allocate the output pointers -->
75
76 <constructor>
77 <PRE>
78   bbSetInputIn1((vtkPolyData *)0);
79   bbSetInputIn2((vtkPolyData *)0);
80   bbSetInputIn3((vtkPolyData *)0);
81   bbSetInputIn4((vtkPolyData *)0);
82   bbSetInputIn5((vtkPolyData *)0);
83   bbSetOutputOut((vtkPolyData *)0);
84 </PRE>
85 </constructor>
86
87   <!-- THE COPY-CONSTRUCTION METHOD BODY :
88     Here does nothing 
89     But this is where you should allocate the output pointers if any
90     and copy the pointed values (to avoid bug caused by multiple references)-->
91   <copyconstructor>
92   <PRE>
93   </PRE>
94   </copyconstructor>
95
96   <!-- THE DESTRUCTION METHOD BODY :
97     Here does nothing 
98     but this is where you should desallocate the output pointers if any -->
99
100   <destructor>
101   <PRE>
102
103   </PRE>
104   </destructor>
105
106 <!--=======================================================================-->
107 <!-- END OF BLACK BOX DESCRIPTION -->
108 </blackbox>
109
110