Salome HOME
Merge branch 'master' into cgt/devCEA
[modules/shaper.git] / src / PythonAPI / doc / source / sketcher.rst
1 Sketch interface
2 ================
3
4 .. automodule:: model.sketcher.sketch
5 .. :members:
6
7 .. currentmodule:: model.sketcher.sketch
8
9 Create a sketch
10 ---------------
11
12 .. autosummary::
13    addSketch
14
15 Add geometries
16 --------------
17
18 .. autosummary::
19
20    Sketch.addPoint
21    Sketch.addLine
22    Sketch.addArc
23    Sketch.addCircle
24
25 Set constraints
26 ---------------
27
28 .. autosummary::
29
30    Sketch.setRadius
31    Sketch.setParallel
32
33 Detailed description
34 --------------------
35
36 Add a sketch to the document
37 ............................
38
39 .. autofunction:: addSketch
40
41 Sketch object
42 .............
43
44 The sketch object returned by the above described :meth:`~model.sketcher.sketch.addSketch` method
45 provides an interface for:
46
47   * creating geometries
48   * setting and modifying constraints
49
50 .. autoclass:: Sketch
51    :members: