Salome HOME
8301d9d181858ac16ff6e2cd3f53f2f8fe2e6e9b
[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"
9         when_nested="accept abort"
10         title="Sketch"
11         tooltip="Create a new 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 a new 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 a new 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       </feature>
27       <feature id="SketchCircle" title="Circle" tooltip="Create a new circle" icon=":icons/circle.png">
28         <sketch-2dpoint_selector id="CircleCenter" title="Center" tooltip="Center coordinates"/>
29         <point2ddistance id="CircleRadius" first_point="CircleCenter" label="Radius:" min="0" step="1.0" default="0" icon=":icons/radius.png" tooltip="Set radius">
30           <validator id="GeomValidators_Positive"/>
31         </point2ddistance>
32         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
33       </feature>
34       <feature id="SketchArc" title="Arc" tooltip="Create a new arc" icon=":icons/arc.png">
35         <sketch-2dpoint_selector id="ArcCenter" title="Center" tooltip="Center of a circle"/>
36         <sketch-2dpoint_selector id="ArcStartPoint" title="Start point" tooltip="Start point"/>
37         <sketch-2dpoint_selector id="ArcEndPoint" title="End point" tooltip="End point"/>
38         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
39       </feature>
40     </group>
41       
42     <group id="Constraints">
43     <!--  SketchConstraintDistance  -->
44       <feature
45         id="SketchConstraintDistance"
46         title="Distance"
47         tooltip="Set fixed distance from a point to an object"
48         icon=":icons/distance.png">
49         <label title="Select objects for distance definition. Following objects can be accepted: point, line or arc end point, center of circle or arc."/>
50         <sketch_shape_selector
51               id="ConstraintEntityA"
52               label="First object"
53               tooltip="Select point, line end point, line, center of circle or arc."
54               shape_types="edge vertex">
55           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
56           <validator id="GeomValidators_EdgeOrVertex"/>
57         </sketch_shape_selector>/>
58         <sketch_shape_selector 
59           id="ConstraintEntityB" 
60           label="Last object" 
61           tooltip="Select point, line end point, line, center of circle or arc." 
62           shape_types="edge vertex">
63           <validator id="PartSet_DifferentObjects"/>
64           <validator id="SketchPlugin_DistanceAttr" parameters="ConstraintEntityA"/>
65           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
66           <validator id="GeomValidators_EdgeOrVertex"/>
67         </sketch_shape_selector>
68         <sketch-2dpoint_selector id="ConstraintFlyoutValuePnt"  default="computed" internal="1" obligatory="0"/>
69         
70         <doublevalue_editor label="Value" tooltip="Distance" id="ConstraintValue" default="computed" min="0">
71           <validator id="GeomValidators_Positive"/>
72         </doublevalue_editor>
73         
74         <validator id="PartSet_DistanceValidator"/>
75       </feature>
76       
77     <!--  SketchConstraintLength  -->      
78       <feature id="SketchConstraintLength" title="Length" tooltip="Set fixed length of a line segment" icon=":icons/length.png">
79         <label title="Select a line on which to calculate length" tooltip="Select a line on which to calculate length"/>
80         <shape_selector id="ConstraintEntityA" label="Line" tooltip="Select an line" 
81             shape_types="edge" >
82         <validator id="GeomValidators_Edge" parameters="line"/>
83     </shape_selector>
84         <sketch-2dpoint_selector id="ConstraintFlyoutValuePnt" default="computed" internal="1" obligatory="0"/>
85         <doublevalue_editor label="Value" tooltip="Length" id="ConstraintValue" default="computed">
86           <validator id="GeomValidators_Positive"/>
87         </doublevalue_editor>
88         <validator id="PartSet_LengthValidator"/>
89       </feature>
90       
91     <!--  SketchConstraintRadius  -->
92       <feature id="SketchConstraintRadius" title="Radius" tooltip="Set fixed radius of a circle or an arc" icon=":icons/radius_constr.png">
93         <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"/>
94         <shape_selector id="ConstraintEntityA" label="Circle or Arc" tooltip="Select a circle or an arc" 
95             shape_types="edge">
96             <validator id="GeomValidators_Edge" parameters="circle"/>
97         </shape_selector>
98         <sketch-2dpoint_selector id="ConstraintFlyoutValuePnt"  default="computed" internal="1" obligatory="0"/>
99         <doublevalue_editor label="Value" tooltip="Radius" id="ConstraintValue" default="computed"/>
100         <validator id="PartSet_RadiusValidator"/>
101       </feature>
102       
103     <!--  SketchConstraintParallel  -->
104       <feature id="SketchConstraintParallel" title="Parallel" tooltip="Create constraint defining two parallel lines" icon=":icons/parallel.png">
105         <sketch_constraint_shape_selector id="ConstraintEntityA" 
106             label="First line" tooltip="Select a line" shape_types="edge">
107             <validator id="GeomValidators_Edge" parameters="line"/>
108             <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
109         </sketch_constraint_shape_selector>
110         
111         <sketch_constraint_shape_selector id="ConstraintEntityB" label="Last line" tooltip="Select a line" 
112             shape_types="edge">
113             <validator id="GeomValidators_Edge" parameters="line"/>
114             <validator id="PartSet_DifferentObjects"/>
115             <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
116         </sketch_constraint_shape_selector>
117         <validator id="PartSet_ParallelValidator"/>
118       </feature>
119       
120     <!--  SketchConstraintPerpendicular  -->
121       <feature id="SketchConstraintPerpendicular" title="Perpendicular" 
122         tooltip="Create constraint defining two perpendicular lines" 
123         icon=":icons/perpendicular.png">
124         <sketch_constraint_shape_selector id="ConstraintEntityA" 
125             label="First line" tooltip="Select an line" 
126             shape_types="edge">
127           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
128             <validator id="GeomValidators_Edge" parameters="line"/>
129         </sketch_constraint_shape_selector>
130         
131         <sketch_constraint_shape_selector id="ConstraintEntityB" 
132             label="Last line" tooltip="Select an line" 
133             shape_types="edge">
134             <validator id="PartSet_DifferentObjects"/>
135           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityA"/>
136             <validator id="GeomValidators_Edge" parameters="line"/>
137         </sketch_constraint_shape_selector>
138         <validator id="PartSet_PerpendicularValidator"/>
139       </feature>
140
141       <!--  SketchConstraintCoincedence  -->
142       <feature id="SketchConstraintCoincidence" title="Coincident" tooltip="Create constraint for the coincidence of two points" icon=":icons/coincedence.png">
143         <sketch_shape_selector id="ConstraintEntityA" label="First point" tooltip="Select a first point" shape_types="vertex"/>
144         <sketch_shape_selector id="ConstraintEntityB" label="Second point" tooltip="Select a second point" shape_types="vertex">
145           <validator id="PartSet_DifferentObjects"/>
146         </sketch_shape_selector>
147       </feature>
148
149       <!--  SketchConstraintRigid  -->
150       <feature id="SketchConstraintRigid" title="Fixed" tooltip="Fix an object" icon=":icons/fixed.png">
151         <shape_selector id="ConstraintEntityA" label="Object" tooltip="Select an object" 
152             shape_types="edge vertex">
153           <validator id="PartSet_SketchEntityValidator" parameters="SketchPoint,SketchLine,SketchCircle,SketchArc"/>
154           <validator id="SketchPlugin_NotFixed"/>
155         </shape_selector>
156         <validator id="PartSet_RigidValidator"/>
157       </feature>
158       
159     <!--  SketchConstraintHorizontal  -->
160       <feature id="SketchConstraintHorizontal" title="Horizontal" tooltip="Create constraint defining horizontal line" icon=":icons/horisontal.png">
161         <sketch_constraint_shape_selector id="ConstraintEntityA" 
162             label="Line" tooltip="Select a line" shape_types="edge">
163             <validator id="GeomValidators_Edge" parameters="line"/>
164         </sketch_constraint_shape_selector>
165       </feature>
166       
167     <!--  SketchConstraintVertical  -->
168       <feature id="SketchConstraintVertical" title="Vertical" tooltip="Create constraint defining vertical line" icon=":icons/vertical.png">
169         <sketch_constraint_shape_selector id="ConstraintEntityA" 
170             label="Line" tooltip="Select a line" shape_types="edge">
171             <validator id="GeomValidators_Edge" parameters="line"/>
172         </sketch_constraint_shape_selector>
173       </feature>
174       
175     <!--  SketchConstraintEqual  -->
176       <feature id="SketchConstraintEqual" title="Equal" tooltip="Create constraint defining equality of two objects" icon=":icons/equal.png">
177         <sketch_constraint_shape_selector id="ConstraintEntityA" 
178             label="First object" tooltip="Select line, circle or arc" shape_types="edge">
179         </sketch_constraint_shape_selector>
180         
181         <sketch_constraint_shape_selector id="ConstraintEntityB"
182             label="Last object" tooltip="Select line, circle or arc" shape_types="edge">
183           <validator id="SketchPlugin_EqualAttr" parameters="ConstraintEntityA"/>
184           <validator id="PartSet_DifferentObjects"/>
185         </sketch_constraint_shape_selector>
186       </feature>
187       
188     <!--  SketchConstraintTangent  -->
189       <feature id="SketchConstraintTangent" title="Tangent" tooltip="Create constraint defining tangency of two objects" icon=":icons/tangent.png">
190         <sketch_constraint_shape_selector id="ConstraintEntityA" 
191             label="First object" tooltip="Select line or arc" shape_types="edge">
192         </sketch_constraint_shape_selector>
193         
194         <sketch_constraint_shape_selector id="ConstraintEntityB"
195             label="Last object" tooltip="Select line or arc" shape_types="edge">
196         <validator id="SketchPlugin_TangentAttr" parameters="ConstraintEntityA"/>
197         </sketch_constraint_shape_selector>
198       </feature>
199       
200     <!--  SketchConstraintMirror  -->
201       <feature
202         id="SketchConstraintMirror"
203         title="Mirror"
204         tooltip="Create constraint, mirroring group of objects">
205         <sketch_constraint_shape_selector id="ConstraintEntityA" 
206             label="Mirror line" tooltip="Select mirror line" shape_types="edge">
207             <validator id="GeomValidators_Edge" parameters="line"/>
208         </sketch_constraint_shape_selector>
209         <multi_selector id="ConstraintMirrorList" 
210             label="List of objects"
211             tooltip="Select list of mirroring objects"
212             type_choice="Edges">
213         </multi_selector>
214       </feature>
215     </group>
216     
217     <group id="Edit">
218       <!--  SketchConstraintFillet  -->
219       <feature id="SketchConstraintFillet" title="Fillet" tooltip="Create constraint defining fillet between two objects" icon=":icons/fillet.png">
220         <sketch_constraint_shape_selector id="ConstraintEntityA" 
221             label="First object" tooltip="Select line or arc" shape_types="edge">
222         </sketch_constraint_shape_selector>
223
224         <sketch_constraint_shape_selector id="ConstraintEntityB"
225             label="Last object" tooltip="Select line or arc" shape_types="edge">
226         </sketch_constraint_shape_selector>
227
228         <doublevalue_editor label="Value" tooltip="Fillet radius" id="ConstraintValue" default="1" min="0" obligatory="0">
229           <validator id="GeomValidators_Positive"/>
230         </doublevalue_editor>
231       </feature>
232     </group>
233   </workbench>
234 </plugin>