Salome HOME
Update documentation of arcs.
[modules/shaper.git] / src / SketchPlugin / doc / sketchDrawer.rst
1 .. _create_sketch_drawer:
2 .. |SketchDrawer.icon|    image:: images/SketchDrawer.png
3
4 Sketch Drawer
5 =========
6
7 Sketch Drawer featrure is a macro-feature, i.e. it is removed after its execution.
8 It allows simplify creation of sketches basing on existing models without referencing to
9 these models.
10
11 For an example, to create a sketch on exising STEP file model planar face
12 and then remove the original model, to keep only the sketch with copy of contour. So, to be
13 able to remove the initial model, there are no references created by this feature.
14
15 To add a new Sketch Drawing:
16
17 #. select in the Main Menu *Macros - > Sketch drawer* item  or
18 #. click |SketchDrawer.icon| **Sketch drawer** button in Macros toolbar:
19
20 The following property panel appears:
21
22 .. image:: images/SketchDrawer_panel.png
23   :align: center
24
25 .. centered::
26    Sketch drawer
27
28 Click in the view once to set the whole original model, then click a second time to set the
29 plane or planar face - a base of sketch. This can be plane on the original model.
30
31 Flag "Create dimensions" allows to disable creation of dimensional constraints in the resulting sketch.
32 So, if it is disabled, then lengths and radiuses will be omitted. It allows to avoid overconstraint
33 situation and simplify work of the sketch solver.
34
35 On Apply button press the new sketch will be created in the Object Browser tree.
36
37 Result
38 """"""
39
40 A resulting sketch will contain linear and circular edges as well as circular arcs corresponding to the
41 original model edges that lay in the sketch plane. Other types of edges are not supported.
42
43 Radius, length, vertical, horizontal and points-coincidence constraints will be created
44 automatically where it is possible. The resulting sketch may be overconstrained or not fully
45 constrained. So, it is just a helper for the sketch creation, not universal tool. After this
46 sketch creation normally user must edit this sketch to input reasonable constraints and
47 parametrization, or remove not needed constraints or sketch lements.
48
49 .. image:: images/SketchDrawer_res.png
50            :align: center
51
52 .. centered::
53    Drawn sketch