annotate icqsol_create_shape.xml @ 10:15e64b9e9f01 draft default tip

Uploaded
author greg
date Tue, 12 Jul 2016 14:15:41 -0400
parents cb3e79d1e85e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d1d206669437 Uploaded
greg
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
5
cb3e79d1e85e Uploaded
greg
parents: 2
diff changeset
2 <tool id="icqsol_create_shape" name="Create shape" version="@WRAPPER_VERSION@.0">
0
d1d206669437 Uploaded
greg
parents:
diff changeset
3 <description></description>
d1d206669437 Uploaded
greg
parents:
diff changeset
4 <macros>
d1d206669437 Uploaded
greg
parents:
diff changeset
5 <import>icqsol_macros.xml</import>
d1d206669437 Uploaded
greg
parents:
diff changeset
6 </macros>
d1d206669437 Uploaded
greg
parents:
diff changeset
7 <expand macro="requirements" />
d1d206669437 Uploaded
greg
parents:
diff changeset
8 <command>
d1d206669437 Uploaded
greg
parents:
diff changeset
9 <![CDATA[
d1d206669437 Uploaded
greg
parents:
diff changeset
10 python $__tool_directory__/icqsol_create_shape.py
d1d206669437 Uploaded
greg
parents:
diff changeset
11 --create_process $create_process_cond.create_process
d1d206669437 Uploaded
greg
parents:
diff changeset
12 #if $create_process_cond.create_process == 'create':
d1d206669437 Uploaded
greg
parents:
diff changeset
13 --shape $create_process_cond.shape_cond.shape
d1d206669437 Uploaded
greg
parents:
diff changeset
14 #if $create_process_cond.shape_cond.shape == 'box':
d1d206669437 Uploaded
greg
parents:
diff changeset
15 @origin_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
16 @lengths_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
17 #else if $create_process_cond.shape_cond.shape == 'cone':
d1d206669437 Uploaded
greg
parents:
diff changeset
18 @radius_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
19 @origin_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
20 @lengths_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
21 @n_theta_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
22 #else if $create_process_cond.shape_cond.shape == 'cylinder':
d1d206669437 Uploaded
greg
parents:
diff changeset
23 @radius_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
24 @origin_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
25 @lengths_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
26 @n_theta_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
27 #else if $create_process_cond.shape_cond.shape == 'sphere':
d1d206669437 Uploaded
greg
parents:
diff changeset
28 @radius_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
29 @origin_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
30 @n_theta_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
31 @n_phi_cmd_args@
d1d206669437 Uploaded
greg
parents:
diff changeset
32 #end if
d1d206669437 Uploaded
greg
parents:
diff changeset
33 --output_vtk_type $create_process_cond.output_vtk_type
d1d206669437 Uploaded
greg
parents:
diff changeset
34 --output "$output_create"
d1d206669437 Uploaded
greg
parents:
diff changeset
35 #else:
d1d206669437 Uploaded
greg
parents:
diff changeset
36 --shape_input "$create_process_cond.shape_input"
d1d206669437 Uploaded
greg
parents:
diff changeset
37 --rotate $create_process_cond.rotate_cond.rotate
d1d206669437 Uploaded
greg
parents:
diff changeset
38 #if $create_process_cond.rotate_cond.rotate == 'yes':
d1d206669437 Uploaded
greg
parents:
diff changeset
39 --rotation_axis_x $create_process_cond.rotate_cond.rotation_axis_x
d1d206669437 Uploaded
greg
parents:
diff changeset
40 --rotation_axis_y $create_process_cond.rotate_cond.rotation_axis_y
d1d206669437 Uploaded
greg
parents:
diff changeset
41 --rotation_axis_z $create_process_cond.rotate_cond.rotation_axis_z
d1d206669437 Uploaded
greg
parents:
diff changeset
42 --rotation_degree $create_process_cond.rotate_cond.rotation_degree
d1d206669437 Uploaded
greg
parents:
diff changeset
43 #end if
d1d206669437 Uploaded
greg
parents:
diff changeset
44 #if $create_process_cond.translate_cond.translate == 'yes':
d1d206669437 Uploaded
greg
parents:
diff changeset
45 --translate $create_process_cond.translate_cond.translate
d1d206669437 Uploaded
greg
parents:
diff changeset
46 --origin_x $create_process_cond.translate_cond.translate_origin_x
d1d206669437 Uploaded
greg
parents:
diff changeset
47 --origin_y $create_process_cond.translate_cond.translate_origin_y
d1d206669437 Uploaded
greg
parents:
diff changeset
48 --origin_z $create_process_cond.translate_cond.translate_origin_z
d1d206669437 Uploaded
greg
parents:
diff changeset
49 #end if
d1d206669437 Uploaded
greg
parents:
diff changeset
50 --output_vtk_type $create_process_cond.shape_input.ext
d1d206669437 Uploaded
greg
parents:
diff changeset
51 --output "$output_clone"
d1d206669437 Uploaded
greg
parents:
diff changeset
52 #end if
d1d206669437 Uploaded
greg
parents:
diff changeset
53 ]]>
d1d206669437 Uploaded
greg
parents:
diff changeset
54 </command>
d1d206669437 Uploaded
greg
parents:
diff changeset
55 <inputs>
d1d206669437 Uploaded
greg
parents:
diff changeset
56 <conditional name="create_process_cond">
d1d206669437 Uploaded
greg
parents:
diff changeset
57 <param name="create_process" type="select" label="Create or clone?" help="Create a new shape or clone a shape in your history.">
d1d206669437 Uploaded
greg
parents:
diff changeset
58 <option value="create" selected="True">Create a shape</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
59 <option value="clone">Clone a shape in your history</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
60 </param>
d1d206669437 Uploaded
greg
parents:
diff changeset
61 <when value="create">
d1d206669437 Uploaded
greg
parents:
diff changeset
62 <conditional name="shape_cond">
d1d206669437 Uploaded
greg
parents:
diff changeset
63 <param name="shape" type="select" label="Select shape">
d1d206669437 Uploaded
greg
parents:
diff changeset
64 <option value="box" selected="True">Box</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
65 <option value="cone">Cone</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
66 <option value="cylinder">Cylinder</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
67 <option value="sphere">Sphere</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
68 </param>
d1d206669437 Uploaded
greg
parents:
diff changeset
69 <when value="box">
d1d206669437 Uploaded
greg
parents:
diff changeset
70 <expand macro="origin_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
71 <expand macro="lengths_exclude_min_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
72 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
73 <when value="cone">
d1d206669437 Uploaded
greg
parents:
diff changeset
74 <expand macro="radius_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
75 <expand macro="origin_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
76 <expand macro="lengths_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
77 <expand macro="n_theta_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
78 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
79 <when value="cylinder">
d1d206669437 Uploaded
greg
parents:
diff changeset
80 <expand macro="radius_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
81 <expand macro="origin_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
82 <expand macro="lengths_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
83 <expand macro="n_theta_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
84 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
85 <when value="sphere">
d1d206669437 Uploaded
greg
parents:
diff changeset
86 <expand macro="radius_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
87 <expand macro="origin_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
88 <expand macro="n_theta_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
89 <expand macro="n_phi_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
90 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
91 </conditional>
d1d206669437 Uploaded
greg
parents:
diff changeset
92 <expand macro="output_vtk_type_params" />
d1d206669437 Uploaded
greg
parents:
diff changeset
93 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
94 <when value="clone">
d1d206669437 Uploaded
greg
parents:
diff changeset
95 <param name="shape_input" type="data" format="plyascii,plybinary,vtkascii,vtkbinary" label="Shape to clone" help="Select shape for cloning.">
d1d206669437 Uploaded
greg
parents:
diff changeset
96 <validator type="dataset_ok_validator" />
d1d206669437 Uploaded
greg
parents:
diff changeset
97 </param>
d1d206669437 Uploaded
greg
parents:
diff changeset
98 <conditional name="rotate_cond">
d1d206669437 Uploaded
greg
parents:
diff changeset
99 <param name="rotate" type="select" label="Rotate cloned shape?">
d1d206669437 Uploaded
greg
parents:
diff changeset
100 <option value="no" selected="True">No</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
101 <option value="yes">Yes</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
102 </param>
d1d206669437 Uploaded
greg
parents:
diff changeset
103 <when value="no"/>
d1d206669437 Uploaded
greg
parents:
diff changeset
104 <when value="yes">
2
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
105 <param name="rotation_axis_x" type="float" value="0.0" label="X coordinate of rotation axis" help="Floating point number"/>
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
106 <param name="rotation_axis_y" type="float" value="0.0" label="Y coordinate of rotation axis" help="Floating point number"/>
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
107 <param name="rotation_axis_z" type="float" value="0.0" label="Z coordinate of rotation axis" help="Floating point number"/>
0
d1d206669437 Uploaded
greg
parents:
diff changeset
108 <param name="rotation_degree" type="float" value="0.0" label="Degree of rotation" help="Floating point number"/>
d1d206669437 Uploaded
greg
parents:
diff changeset
109 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
110 </conditional>
d1d206669437 Uploaded
greg
parents:
diff changeset
111 <conditional name="translate_cond">
d1d206669437 Uploaded
greg
parents:
diff changeset
112 <param name="translate" type="select" label="Translate cloned shape?">
d1d206669437 Uploaded
greg
parents:
diff changeset
113 <option value="no" selected="True">No</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
114 <option value="yes">Yes</option>
d1d206669437 Uploaded
greg
parents:
diff changeset
115 </param>
d1d206669437 Uploaded
greg
parents:
diff changeset
116 <when value="no"/>
d1d206669437 Uploaded
greg
parents:
diff changeset
117 <when value="yes">
d1d206669437 Uploaded
greg
parents:
diff changeset
118 <param name="translate_origin_x" type="float" value="0.0" label="X coordinate of new origin" help="Floating point number"/>
d1d206669437 Uploaded
greg
parents:
diff changeset
119 <param name="translate_origin_y" type="float" value="0.0" label="Y coordinate of new origin" help="Floating point number"/>
d1d206669437 Uploaded
greg
parents:
diff changeset
120 <param name="translate_origin_z" type="float" value="0.0" label="Z coordinate of new origin" help="Floating point number"/>
d1d206669437 Uploaded
greg
parents:
diff changeset
121 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
122 </conditional>
d1d206669437 Uploaded
greg
parents:
diff changeset
123 </when>
d1d206669437 Uploaded
greg
parents:
diff changeset
124 </conditional>
d1d206669437 Uploaded
greg
parents:
diff changeset
125 </inputs>
d1d206669437 Uploaded
greg
parents:
diff changeset
126 <outputs>
d1d206669437 Uploaded
greg
parents:
diff changeset
127 <data name="output_create" format="vtkascii" label="${tool.name} ${on_string}: ${create_process_cond.shape_cond.shape}">
d1d206669437 Uploaded
greg
parents:
diff changeset
128 <filter>create_process_cond['create_process'] == "create"</filter>
d1d206669437 Uploaded
greg
parents:
diff changeset
129 <actions>
d1d206669437 Uploaded
greg
parents:
diff changeset
130 <action type="format">
d1d206669437 Uploaded
greg
parents:
diff changeset
131 <option type="from_param" name="create_process_cond.output_vtk_type" />
d1d206669437 Uploaded
greg
parents:
diff changeset
132 </action>
d1d206669437 Uploaded
greg
parents:
diff changeset
133 </actions>
d1d206669437 Uploaded
greg
parents:
diff changeset
134 </data>
d1d206669437 Uploaded
greg
parents:
diff changeset
135 <data name="output_clone" format_source="shape_input" label="${tool.name}: Cloned ${on_string}">
d1d206669437 Uploaded
greg
parents:
diff changeset
136 <filter>create_process_cond['create_process'] == "clone"</filter>
d1d206669437 Uploaded
greg
parents:
diff changeset
137 </data>
d1d206669437 Uploaded
greg
parents:
diff changeset
138 </outputs>
d1d206669437 Uploaded
greg
parents:
diff changeset
139 <tests>
d1d206669437 Uploaded
greg
parents:
diff changeset
140 <test>
d1d206669437 Uploaded
greg
parents:
diff changeset
141 <param name="shape" value="cone" />
d1d206669437 Uploaded
greg
parents:
diff changeset
142 <param name="radius" value="0.25" />
d1d206669437 Uploaded
greg
parents:
diff changeset
143 <param name="origin_x" value="-0.06" />
d1d206669437 Uploaded
greg
parents:
diff changeset
144 <param name="length_x" value="0.14" />
d1d206669437 Uploaded
greg
parents:
diff changeset
145 <param name="output_vtk_type" value="vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
146 <output name="output" file="head.vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
147 </test>
d1d206669437 Uploaded
greg
parents:
diff changeset
148 <test>
d1d206669437 Uploaded
greg
parents:
diff changeset
149 <param name="shape" value="box" />
d1d206669437 Uploaded
greg
parents:
diff changeset
150 <param name="origin_x" value="-0.06" />
d1d206669437 Uploaded
greg
parents:
diff changeset
151 <param name="origin_y" value="-0.015" />
d1d206669437 Uploaded
greg
parents:
diff changeset
152 <param name="origin_z" value="-0.15" />
d1d206669437 Uploaded
greg
parents:
diff changeset
153 <param name="length_x" value="0.03" />
d1d206669437 Uploaded
greg
parents:
diff changeset
154 <param name="length_y" value="0.03" />
d1d206669437 Uploaded
greg
parents:
diff changeset
155 <param name="length_z" value="0.30" />
d1d206669437 Uploaded
greg
parents:
diff changeset
156 <param name="output_vtk_type" value="vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
157 <output name="output" file="notch1.vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
158 </test>
d1d206669437 Uploaded
greg
parents:
diff changeset
159 <test>
d1d206669437 Uploaded
greg
parents:
diff changeset
160 <param name="shape" value="cylinder" />
d1d206669437 Uploaded
greg
parents:
diff changeset
161 <param name="radius" value="0.1" />
d1d206669437 Uploaded
greg
parents:
diff changeset
162 <param name="origin_x" value="0.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
163 <param name="origin_y" value="0.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
164 <param name="origin_z" value="0.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
165 <param name="length_x" value="1.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
166 <param name="length_y" value="0.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
167 <param name="length_z" value="0.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
168 <param name="n_theta" value="16" />
d1d206669437 Uploaded
greg
parents:
diff changeset
169 <param name="output_vtk_type" value="vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
170 <output name="output" file="shaft.vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
171 </test>
d1d206669437 Uploaded
greg
parents:
diff changeset
172 <test>
d1d206669437 Uploaded
greg
parents:
diff changeset
173 <param name="create_process" value="clone" />
d1d206669437 Uploaded
greg
parents:
diff changeset
174 <param name="shape_input" value="notch1.vtkascii" ftype="vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
175 <param name="rotate" value="yes" />
d1d206669437 Uploaded
greg
parents:
diff changeset
176 <param name="rotation_axis_x" value="1.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
177 <param name="rotation_degree" value="90.0" />
d1d206669437 Uploaded
greg
parents:
diff changeset
178 <output name="output" file="notch2.vtkascii" ftype="vtkascii" />
d1d206669437 Uploaded
greg
parents:
diff changeset
179 </test>
d1d206669437 Uploaded
greg
parents:
diff changeset
180 </tests>
d1d206669437 Uploaded
greg
parents:
diff changeset
181 <help>
d1d206669437 Uploaded
greg
parents:
diff changeset
182 **What it does**
d1d206669437 Uploaded
greg
parents:
diff changeset
183
d1d206669437 Uploaded
greg
parents:
diff changeset
184 **Create a shape** - creates a selected primitive shape where shapes are Box, Cone, Cylinder and Sphere.
d1d206669437 Uploaded
greg
parents:
diff changeset
185
2
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
186 * **Origin X,Y,Z** - Origin coordinate for all shapes.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
187 * **Lengths X,Y,Z** - Edge lengths for Box, Cone and Cylinder.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
188 * **Radius** - Radius length for Cone, Cylinder and Sphere.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
189 * **Number of slices** - Controls the tessellation along the longitude direction for all shapes.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
190 * **Number of stacks** - Controls the tessellation along the latitude direction for all shapes.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
191 * **Output format and file type** - Choose the output format **ply** or **vtk** and file type **ascii** or **binary**.
0
d1d206669437 Uploaded
greg
parents:
diff changeset
192
d1d206669437 Uploaded
greg
parents:
diff changeset
193 -----
d1d206669437 Uploaded
greg
parents:
diff changeset
194
d1d206669437 Uploaded
greg
parents:
diff changeset
195 **Clone a shape from your history** - creates a new copy of a shape selected from your history.
d1d206669437 Uploaded
greg
parents:
diff changeset
196
2
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
197 * **Shape to clone** - Shape selected from your history for cloning.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
198 * **Rotate cloned shape?** - Enables rotation of the cloned shape around a defined axis.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
199 * **Rotation axis X,Y,Z** - The axis of rotation for the cloned shape.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
200 * **Degree of rotation** - The degree of rotation around the axis.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
201 * **Translate cloned shape?** - Enables resetting the origin of the cloned shape, moving the shape.
27dc5b183e19 Uploaded
greg
parents: 0
diff changeset
202 * **New origin X,Y,Z** - Translated origin of cloned shape.
0
d1d206669437 Uploaded
greg
parents:
diff changeset
203
d1d206669437 Uploaded
greg
parents:
diff changeset
204 </help>
d1d206669437 Uploaded
greg
parents:
diff changeset
205 <expand macro="citations" />
d1d206669437 Uploaded
greg
parents:
diff changeset
206 </tool>