src/FeaturesPlugin/doc/fillet1dFeature.rst

   1 .. |fillet1d.icon|    image:: images/fillet1d.png
   2
   3 .. _featureFillet1D:
   4
   5 1D-fillet
   6 =========
   7
   8 **1D-fillet** feature creates fillets on the vertices of a wire.
   9 The fillet may be performed on sharp corners of a wire, which are shared exactly between 2 edges, and which are placed ona single plane.
  10
  11 To create a 1D-fillet in the active part:
  12
  13 #. select in the Main Menu *Feature - > 1D-fillet* item  or
  14 #. click |fillet1d.icon| **1D-fillet** button in the toolbar
  15
  16 There are 2 types of fillet:
  17
  18 .. image:: images/fillet1d_wire.png
  19   :align: left
  20   :height: 24px
  21
  22 fillet all sharp corners on a wire
  23
  24 .. image:: images/fillet1d_points.png
  25   :align: left
  26   :height: 24px
  27
  28 fillet only the specified corners
  29
  30 Fillet a wire
  31 -------------
  32
  33 The property panel for this mode is shown below.
  34
  35 .. image:: images/Fillet1DPanel_Wire.png
  36   :align: center
  37
  38 .. centered::
  39   Property panel of an operation to fillet all sharp corners on a wire
  40
  41 Input fields:
  42
  43 - **Wires** panel contains the list of wires for the operation. The fillet will be performed to the applicable corners. If the wire has no such corner, the error message will be shown;
  44 - **Radius** defines the fillet radius.
  45
  46 **TUI Command**:
  47
  48 .. py:function:: model.addFillet(Part_doc, wires, radius)
  49
  50     :param document Part_doc: The current part object.
  51     :param list wires: A list of wires subject to fillet operation in format *model.selection(TYPE, shape)*.
  52     :param double radius: Radius value.
  53     :return: Created object.
  54
  55 Result
  56 """"""
  57
  58 Result of **Fillet a wire** is shown below. In this case all vertices were sharp, thus, filleted.
  59
  60 .. image:: images/Fillet1DResult_Wire.png
  61    :align: center
  62
  63 .. centered::
  64    Result of filleting a wire
  65
  66 **See Also** a sample TUI Script of :ref:`tui_create_fillet1d_wire` operation.
  67
  68 Fillet the specified vertices on a wire
  69 ---------------------------------------
  70
  71 Alternatively, there is a possibility to create a fillet on a special sharp corners of a wire.
  72
  73 .. image:: images/Fillet1DPanel_Vertices.png
  74   :align: center
  75
  76 .. centered::
  77   Property panel to fillet the specified vertices of a wire
  78
  79 Input fields:
  80
  81 - **Vertices** panel contains list of vertices on a wires applicable for fillet operation;
  82 - **Radius** defines the fillet radius.
  83
  84 **TUI Command**:
  85
  86 .. py:function:: model.addFillet(Part_doc, vertices, radius)
  87   :noindex:
  88
  89     :param document Part_doc: The current part object.
  90     :param list vertices: A list of vertices subject to fillet operation in format *model.selection(TYPE, shape)*.
  91     :param double radius: Radius value.
  92     :return: Created object.
  93
  94 Result
  95 """"""
  96
  97 Result of **Fillet by vertices** is shown below. The only 2 corners of the wire become smooth.
  98
  99 .. image:: images/Fillet1DResult_Vertices.png
 100    :align: center
 101
 102 .. centered::
 103    Result of filleting the specified vertices of a wire
 104
 105 **See Also** a sample TUI Script of :ref:`tui_create_fillet1d_vertices` operation.