Salome HOME
ed807cd230c84fda84ccb6a89a66d4e62088e9cc
[modules/shaper.git] / src / SketchPlugin / plugin-Sketch.xml
1 <!-- Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
2
3 <plugin>
4   <workbench id="Sketch">
5     <group id="Basic">
6       <feature
7         id="Sketch"
8         nested="SketchPoint SketchLine SketchCircle SketchArc SketchConstraintLength SketchConstraintRadius SketchConstraintDistance SketchConstraintParallel SketchConstraintPerpendicular SketchConstraintRigid SketchConstraintHorizontal SketchConstraintVertical SketchConstraintEqual SketchConstraintTangent SketchConstraintFillet SketchConstraintCoincidence SketchConstraintMirror SketchMultiRotation SketchMultiTranslation"
9         when_nested="accept abort"
10         title="Sketch"
11         tooltip="Create sketch"
12         icon=":icons/sketch.png">
13         <sketch-start-label id="External" title="Select a plane on which to create a sketch" tooltip="Select a plane on which to create a sketch">
14           <validator id="GeomValidators_Face" parameters="plane"/>
15         </sketch-start-label>
16       <!--icon=":pictures/x_point.png"-->
17       </feature>
18       <feature id="SketchPoint" title="Point" tooltip="Create point" icon=":icons/point.png">
19         <sketch-2dpoint_selector id="PointCoordindates" title="Point" tooltip="Point coordinates"/>
20         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
21       </feature>
22       <feature id="SketchLine" title="Line" tooltip="Create line" icon=":icons/line.png">
23         <sketch-2dpoint_selector id="StartPoint" title="Start point" tooltip="Start point coordinates" previous_feature_param="EndPoint"/>
24         <sketch-2dpoint_selector id="EndPoint" title="End point" tooltip="End point coordinates"/>
25         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
26         <validator id="GeomValidators_Different" parameters="StartPoint,EndPoint"/>
27       </feature>
28       <feature id="SketchCircle" title="Circle" tooltip="Create circle" icon=":icons/circle.png">
29         <sketch-2dpoint_selector id="CircleCenter" title="Center" tooltip="Center coordinates"/>
30         <point2ddistance id="CircleRadius" first_point="CircleCenter" label="Radius:" min="0" step="1.0" default="0" icon=":icons/radius.png" tooltip="Set radius">
31           <validator id="GeomValidators_Positive"/>
32         </point2ddistance>
33         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
34       </feature>
35       <feature id="SketchArc" title="Arc" tooltip="Create arc" icon=":icons/arc.png">
36         <sketch-2dpoint_selector id="ArcCenter" title="Center" tooltip="Center of a circle"/>
37         <sketch-2dpoint_selector id="ArcStartPoint" title="Start point" tooltip="Start point"/>
38         <sketch-2dpoint_selector id="ArcEndPoint" title="End point" tooltip="End point"/>
39         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
40         <validator id="GeomValidators_Different" parameters="ArcCenter,ArcStartPoint,ArcEndPoint"/>
41       </feature>
42     </group>
43       
44     <group id="Constraints">
45     <!--  SketchConstraintDistance  -->
46       <feature
47         id="SketchConstraintDistance"
48         title="Distance"
49         tooltip="Set fixed distance from a point to an object"
50         icon=":icons/distance.png">
51         <label title="Select objects for distance definition. Following objects can be accepted: point, line or arc end point, center of circle or arc."/>
52         <sketch_shape_selector
53               id="ConstraintEntityA"
54               label="First object"
55               tooltip="Select point, line end point, line, center of circle or arc."
56               shape_types="edge vertex">
57           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
58           <validator id="PartSet_DifferentObjects"/>
59           <validator id="GeomValidators_ShapeType" parameters="vertex,line"/>
60         </sketch_shape_selector>
61         <sketch_shape_selector 
62           id="ConstraintEntityB" 
63           label="Second object" 
64           tooltip="Select point, line end point, line, center of circle or arc." 
65           shape_types="edge vertex">
66           <validator id="PartSet_DifferentObjects"/>
67           <validator id="SketchPlugin_DistanceAttr" parameters="ConstraintEntityA"/>
68           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
69           <validator id="GeomValidators_ShapeType" parameters="vertex,line"/>
70         </sketch_shape_selector>
71         <sketch-2dpoint_selector id="ConstraintFlyoutValuePnt"  default="computed" internal="1" obligatory="0"/>
72         
73         <doublevalue_editor label="Value" tooltip="Distance" id="ConstraintValue" default="computed" min="0">
74           <validator id="GeomValidators_Positive"/>
75         </doublevalue_editor>
76         
77         <validator id="PartSet_DistanceSelection"/>
78       </feature>
79       
80     <!--  SketchConstraintLength  -->      
81       <feature id="SketchConstraintLength" title="Length" tooltip="Set fixed length of a line segment" icon=":icons/length.png">
82         <label title="Select a line on which to calculate length" tooltip="Select a line on which to calculate length"/>
83         <shape_selector id="ConstraintEntityA" label="Line" tooltip="Select an line" shape_types="edge" >
84           <validator id="GeomValidators_ShapeType" parameters="line"/>
85         </shape_selector>
86         <sketch-2dpoint_selector id="ConstraintFlyoutValuePnt" default="computed" internal="1" obligatory="0"/>
87         <doublevalue_editor label="Value" tooltip="Length" id="ConstraintValue" default="computed">
88           <validator id="GeomValidators_Positive"/>
89         </doublevalue_editor>
90         <validator id="PartSet_LengthSelection"/>
91       </feature>
92       
93     <!--  SketchConstraintRadius  -->
94       <feature id="SketchConstraintRadius" title="Radius" tooltip="Set fixed radius of a circle or an arc" icon=":icons/radius_constr.png">
95         <label title="Select a circle or an arc on which to calculate radius" tooltip="Select a circle or an arc on which to calculate radius"/>
96         <shape_selector id="ConstraintEntityA" label="Circle or Arc" tooltip="Select a circle or an arc" 
97             shape_types="edge">
98             <validator id="GeomValidators_ShapeType" parameters="circle"/>
99         </shape_selector>
100         <sketch-2dpoint_selector id="ConstraintFlyoutValuePnt"  default="computed" internal="1" obligatory="0"/>
101         <doublevalue_editor label="Value" tooltip="Radius" id="ConstraintValue" default="computed"/>
102         <validator id="PartSet_RadiusSelection"/>
103       </feature>
104       
105     <!--  SketchConstraintParallel  -->
106       <feature id="SketchConstraintParallel" title="Parallel" tooltip="Create constraint defining two parallel lines" icon=":icons/parallel.png">
107         <sketch_shape_selector id="ConstraintEntityA" 
108             label="First line" tooltip="Select a line" shape_types="edge">
109           <validator id="GeomValidators_ShapeType" parameters="line"/>
110           <validator id="PartSet_DifferentObjects"/>
111           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
112         </sketch_shape_selector>
113         
114         <sketch_shape_selector id="ConstraintEntityB" label="Second line" tooltip="Select a line" 
115             shape_types="edge">
116             <validator id="GeomValidators_ShapeType" parameters="line"/>
117             <validator id="PartSet_DifferentObjects"/>
118             <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
119         </sketch_shape_selector>
120         <validator id="PartSet_ParallelSelection"/>
121       </feature>
122       
123     <!--  SketchConstraintPerpendicular  -->
124       <feature id="SketchConstraintPerpendicular" title="Perpendicular" 
125         tooltip="Create constraint defining two perpendicular lines" 
126         icon=":icons/perpendicular.png">
127         <sketch_shape_selector id="ConstraintEntityA" 
128             label="First line" tooltip="Select an line" 
129             shape_types="edge">
130           <validator id="PartSet_DifferentObjects"/>
131           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
132             <validator id="GeomValidators_ShapeType" parameters="line"/>
133         </sketch_shape_selector>
134         
135         <sketch_shape_selector id="ConstraintEntityB" 
136             label="Second line" tooltip="Select an line" 
137             shape_types="edge">
138             <validator id="PartSet_DifferentObjects"/>
139           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
140             <validator id="GeomValidators_ShapeType" parameters="line"/>
141         </sketch_shape_selector>
142         <validator id="PartSet_PerpendicularSelection"/>
143       </feature>
144
145       <!--  SketchConstraintCoincedence  -->
146       <feature id="SketchConstraintCoincidence" title="Coincident" tooltip="Create constraint for the coincidence of two points or point on line or circle" icon=":icons/coincedence.png">
147         <sketch_shape_selector id="ConstraintEntityA" label="First object" tooltip="Select a first object" shape_types="vertex edge">
148           <validator id="PartSet_DifferentObjects"/>
149           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
150         </sketch_shape_selector>
151         <sketch_shape_selector id="ConstraintEntityB" label="Second object" tooltip="Select a second object" shape_types="vertex edge">
152           <validator id="PartSet_DifferentObjects"/>
153           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
154           <validator id="SketchPlugin_CoincidenceAttr" parameters="ConstraintEntityA"/>
155         </sketch_shape_selector>
156         <validator id="PartSet_CoincidentSelection"/>
157       </feature>
158
159       <!--  SketchConstraintRigid  -->
160       <feature id="SketchConstraintRigid" title="Fixed" tooltip="Fix an object" icon=":icons/fixed.png">
161         <sketch_shape_selector id="ConstraintEntityA" label="Object"
162                         tooltip="Select point, line end point, line, center of circle or arc."
163                         shape_types="edge vertex">
164           <validator id="GeomValidators_ShapeType" parameters="vertex,line,circle"/>
165           <validator id="SketchPlugin_NotFixed"/>
166         </sketch_shape_selector>
167         <validator id="PartSet_RigidSelection"/>
168       </feature>
169
170       <!--  SketchConstraintHorizontal  -->
171       <feature id="SketchConstraintHorizontal" title="Horizontal" tooltip="Create constraint defining horizontal line" icon=":icons/horisontal.png">
172         <sketch_shape_selector id="ConstraintEntityA" 
173             label="Line" tooltip="Select a line" shape_types="edge" use_external="false">
174             <validator id="GeomValidators_ShapeType" parameters="line"/>
175         </sketch_shape_selector>
176         <validator id="PartSet_HVDirSelection"/>
177       </feature>
178       
179     <!--  SketchConstraintVertical  -->
180       <feature id="SketchConstraintVertical" title="Vertical" tooltip="Create constraint defining vertical line" icon=":icons/vertical.png">
181         <sketch_shape_selector id="ConstraintEntityA" 
182             label="Line" tooltip="Select a line" shape_types="edge" use_external="false">
183             <validator id="GeomValidators_ShapeType" parameters="line"/>
184         </sketch_shape_selector>
185         <validator id="PartSet_HVDirSelection"/>
186       </feature>
187       
188     <!--  SketchConstraintEqual  -->
189       <feature id="SketchConstraintEqual" title="Equal"
190         tooltip="Create constraint defining equal lengths of two lines or line and arc or equal radii of two arcs or two circles or arc and circle"
191         icon=":icons/equal.png">
192         <sketch_shape_selector id="ConstraintEntityA" 
193             label="First object" tooltip="Select line, circle or arc" shape_types="edge">
194           <validator id="PartSet_DifferentObjects"/>
195           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
196         </sketch_shape_selector>
197         
198         <sketch_shape_selector id="ConstraintEntityB"
199             label="Second object" tooltip="Select line, circle or arc" shape_types="edge">
200           <validator id="SketchPlugin_EqualAttr" parameters="ConstraintEntityA"/>
201           <validator id="PartSet_DifferentObjects"/>
202           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
203         </sketch_shape_selector>
204       </feature>
205       
206     <!--  SketchConstraintTangent  -->
207       <feature id="SketchConstraintTangent" title="Tangent" tooltip="Create constraint defining tangency of two objects" icon=":icons/tangent.png">
208         <sketch_shape_selector id="ConstraintEntityA" 
209             label="First object" tooltip="Select line or arc" shape_types="edge">
210           <validator id="PartSet_CoincidentAttr" parameters="ConstraintEntityB"/>
211           <validator id="PartSet_DifferentObjects"/>
212         </sketch_shape_selector>
213         
214         <sketch_shape_selector id="ConstraintEntityB"
215             label="Second object" tooltip="Select line or arc" shape_types="edge">
216           <validator id="PartSet_CoincidentAttr" parameters="ConstraintEntityA"/>
217           <validator id="SketchPlugin_TangentAttr" parameters="ConstraintEntityA"/>
218           <validator id="PartSet_DifferentObjects"/>
219         </sketch_shape_selector>
220         <validator id="PartSet_TangentSelection"/>
221       </feature>
222       
223          
224     </group>
225     
226     <group id="Edit">
227       <!--  SketchConstraintFillet  -->
228       <feature id="SketchConstraintFillet" title="Fillet" tooltip="Create constraint defining fillet between two objects" icon=":icons/fillet.png">
229         <sketch_shape_selector id="ConstraintEntityA" 
230             label="First object" tooltip="Select line or arc" shape_types="edge">
231           <validator id="PartSet_DifferentObjects"/>
232           <validator id="PartSet_CoincidentAttr" parameters="ConstraintEntityB"/>
233         </sketch_shape_selector>
234
235         <sketch_shape_selector id="ConstraintEntityB"
236             label="Second object" tooltip="Select line or arc" shape_types="edge">
237           <validator id="PartSet_DifferentObjects"/>
238           <validator id="PartSet_CoincidentAttr" parameters="ConstraintEntityA"/>
239         </sketch_shape_selector>
240
241         <doublevalue label="Value" tooltip="Fillet radius" id="ConstraintValue" min="0" default="1" use_reset="false">
242           <validator id="GeomValidators_Positive"/>
243         </doublevalue>
244         <validator id="PartSet_FilletSelection"/>
245       </feature>
246       
247       <!--  SketchConstraintMirror  -->
248       <feature
249         id="SketchConstraintMirror"
250         title="Mirror" icon=":icons/mirror.png"
251         tooltip="Create constraint, mirroring group of objects">
252         <sketch_shape_selector id="ConstraintEntityA"
253             label="Mirror line" tooltip="Select mirror line" shape_types="edge">
254             <validator id="GeomValidators_ShapeType" parameters="line"/>
255         </sketch_shape_selector>
256         <sketch_multi_selector id="ConstraintMirrorList"
257             label="Segments:"
258             tooltip="Select list of mirroring objects"
259             type_choice="Edges"
260             use_external="true">
261             <validator id="SketchPlugin_MirrorAttr" />
262         </sketch_multi_selector>
263       </feature>
264       
265       <!--  SketchMultiTranslation  -->
266       <feature
267         id="SketchMultiTranslation"
268         title="Translation" icon=":icons/translate.png"
269         tooltip="Translation">
270         <sketch_multi_selector id="MultiTranslationList"
271             label="Segments:"
272             tooltip="Select list of translating objects"
273             type_choice="Edges"
274             use_external="true">
275           <validator id="SketchPlugin_CopyValidator" />
276         </sketch_multi_selector>
277         <groupbox title="Direction">
278           <sketch-2dpoint_selector
279               id="MultiTranslationStartPoint"
280               title="Start point"
281               tooltip="Start point of translation"/>
282           <sketch-2dpoint_selector
283               id="MultiTranslationEndPoint"
284               title="End point"
285               tooltip="Final point of translation"/>
286         </groupbox>
287         <integervalue id="MultiTranslationCopies"
288             label="Number of copies"
289             tooltip="Number of copies" 
290             default="1" min="1" use_reset="false">
291           <validator id="GeomValidators_Positive"/>
292         </integervalue>
293       </feature>
294       
295       <!--  SketchMultiRotation  -->
296       <feature
297         id="SketchMultiRotation"
298         title="Rotation" icon=":icons/rotate.png"
299         tooltip="Rotation">
300         <sketch_multi_selector id="MultiRotationList"
301             label="Segments:"
302             tooltip="Select list of rotating objects"
303             type_choice="Edges"
304             use_external="true">
305           <validator id="SketchPlugin_CopyValidator" />
306         </sketch_multi_selector>
307         <sketch-2dpoint_selector
308             id="MultiRotationCenter"
309             title="Center of rotation"
310             tooltip="Center of rotation"/>
311         <point2dangle id="MultiRotationAngle"
312                          first_point="MultiRotationCenter"
313                          label="Angle"
314                          icon=":icons/angle.png"
315                          tooltip="Rotation angle"
316                          default="90"/>
317         <integervalue id="MultiRotationCopies"
318             label="Number of copies"
319             tooltip="Number of copies" 
320             default="1" min="1" use_reset="false">
321           <validator id="GeomValidators_Positive"/>
322         </integervalue>
323       </feature>
324     </group>
325   </workbench>
326 </plugin>