src/SketchPlugin/doc/SketchPlugin.rst

   1
   2 .. _sketchPlugin:
   3 .. |SketchButton.icon|    image:: images/SketchButton.png
   4
   5
   6 Sketch plug-in
   7 ================
   8
   9 Sketch plug-in includes features for creation of 2D shapes.
  10
  11 The sketch creation takes the following steps:
  12
  13 - definition of sketch plane;
  14 - creation of sketch objects from scratch;
  15 - generation of sketch objects via operations on the existing operations;
  16 - definition of constraints.
  17
  18 Sketch can be created in the active part or in a partset (if there is no active part).
  19
  20 To create a Sketch:
  21
  22 #. select in the Main Menu *Sketch - > Sketch* item  or
  23 #. click |SketchButton.icon| **Sketch** button in Sketch toolbar:
  24
  25 First define a plane for the sketch:
  26
  27 .. image:: images/PlaneDefinition.png
  28    :align: center
  29
  30 - specify plane size (equal to 25 in the example above);
  31 - select the appropriate plane in the viewer.
  32
  33 Note that coordinate planes will be suggested for selection if no convenient objects for plane selection are displayed in the viewer:
  34
  35 .. image:: images/CoordinatePlanes.png
  36    :align: center
  37
  38 After the plane for sketch is selected, the following property panel will be opened:
  39
  40 .. image:: images/SketchPanel.png
  41    :align: center
  42
  43 .. centered::
  44   Sketch general panel
  45
  46 - **Reversed** check box - allows reversing the sketch plane normal;
  47 - **Set plane view** button - switches the viewer to the top view for the sketch plane;
  48 - **Show geometrical constraints** check box - displays/hides geometrical constraints:
  49 - **Show dimensional constraints** check box - displays/hides dimensional constraints;
  50 - **Show existing expressions** check box - displays/hides expressions.
  51 - **Show free points** check box - highlights free points in the current sketch if it is checked.
  52 - **Automatic constraints** - automatically create horizontal or vertical constraints if angle between created line and horizontal or vertical less then angular tolerance (defined in preferences).
  53 - **Change sketch plane** button - allows to change working plane of the current sketch.
  54
  55 Now it is possible to:
  56
  57 - create :ref:`sketch objects <sketch_objects>`
  58 - create :ref:`constraints <sketch_constraints>`
  59 - perform :ref:`sketch operations <sketch_operations>`
  60
  61 To apply or cancel sketch creation use Apply and Cancel buttons from the
  62 Sketch panel as well as equivalent buttons from Sketch toolbar.
  63
  64 The Result of operation will be a COMPOUND. In the object tree, Result node is located in
  65 **Constructions** folder.
  66
  67 The Name is assigned automatically: **Sketch_1**, **Sketch_2**, ... both for Feature and Result.
  68
  69 **TUI Command**:
  70
  71 .. py:function:: model.addSketch(PartOrPartSet, plane)
  72
  73     :param part: The current part object.
  74     :param object: A plane.
  75     :return: Result object.
  76
  77 .. _sketch_objects:
  78
  79 Sketch objects
  80 --------------
  81
  82 The plug-in includes the following features for creation of 2D objects:
  83
  84 .. toctree::
  85    :maxdepth: 1
  86
  87    pointFeature.rst
  88    lineFeature.rst
  89    rectangleFeature.rst
  90    circleFeature.rst
  91    arcFeature.rst
  92    ellipseFeature.rst
  93    arcEllipseFeature.rst
  94
  95 .. _sketch_constraints:
  96
  97 Constraints
  98 -----------
  99
 100 Constraints are available and viewable during sketch creation or editing.
 101
 102 The goal of constraints creation is to fix sketch geometry, i.e. set degrees of freedom to zero.
 103
 104 If all degrees of freedom are eliminated, the sketch is fixed and displayed with green color.
 105
 106 .. image:: images/Sketch_fixed.png
 107    :align: center
 108
 109 .. centered::
 110   Fixed Sketch
 111
 112 If any degrees of freedom remain unsolved, the sketch is under-constrained and displayed with red color.
 113
 114 .. image:: images/Sketch_underconstrained.png
 115    :align: center
 116
 117 .. centered::
 118   Underconstrained Sketch
 119
 120 The plug-in includes the following constraints:
 121
 122 .. toctree::
 123    :maxdepth: 1
 124
 125    distanceFeature.rst
 126    horizontalDistFeature.rst
 127    verticalDistFeature.rst
 128    lengthFeature.rst
 129    angleFeature.rst
 130    radiusFeature.rst
 131    horizontalFeature.rst
 132    verticalFeature.rst
 133    fixedFeature.rst
 134    parallelFeature.rst
 135    perpendicularFeature.rst
 136    tangentFeature.rst
 137    coincedentFeature.rst
 138    middleFeature.rst
 139    equalFeature.rst
 140    collinearFeature.rst
 141
 142 .. _sketch_operations:
 143
 144 Operations
 145 ----------
 146 Operations modify existing features of the sketch or create new ones by copying them.
 147
 148 The plug-in includes the following operations:
 149
 150 .. toctree::
 151    :maxdepth: 1
 152
 153    filletFeature.rst
 154    splitFeature.rst
 155    trimFeature.rst
 156    projectionFeature.rst
 157    intersectionFeature.rst
 158    mirrorFeature.rst
 159    translationFeature.rst
 160    rotationFeature.rst
 161    sketchDrawer.rst