src/FeaturesPlugin/doc/chamferFeature.rst

   1 .. |chamfer.icon|    image:: images/chamfer.png
   2
   3 .. _featureChamfer:
   4
   5 Chamfer
   6 ======
   7
   8 **Chamfer** feature creates chamfers on the edges or on the faces of a shape.
   9
  10 To create a Chamfer in the active part:
  11
  12 #. select in the Main Menu *Feature - > Chamfer* item  or
  13 #. click |chamfer.icon| **Chamfer** button in the toolbar
  14
  15 There are 2 types of chamfer:
  16
  17   .. image:: images/chamfer_distances.png
  18     :align: left
  19   chamfer by two distances
  20
  21   .. image:: images/chamfer_dist_angle.png
  22     :align: left
  23   chamfer by a distance and an angle
  24
  25 Chamfer by two distances
  26 ------------------------
  27
  28 The  property panel is shown below.
  29
  30 .. image:: images/ChamferDistances.png
  31   :align: center
  32
  33 .. centered::
  34   Chamfer by two distances property panel
  35
  36 Input fields:
  37
  38 - **Faces or/and edges** panel contains chamfered faces and edges. All edges of a face are subject to chamfer operation. Faces and edges are selected in 3D OCC viewer;
  39 - **D1** define the first chamfer distance;
  40 - **D2** define the second chamfer distance;
  41
  42 **TUI Command**:
  43
  44 .. py:function:: model.addChamfer(Part_doc, [face,edge], perfomDistances, D1, D2)
  45
  46     :param part: The current part object.
  47     :param list: A list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)*.
  48     :param boolean: A "True" flag to indicate that the type of chamfer is by two distances.
  49     :param number: D1 value.
  50     :param number: D2 value.
  51     :return: Created object.
  52
  53 Result
  54 """"""
  55
  56 Result of **Chamfer by two distances** is shown below.
  57
  58 .. image:: images/chamfer_res_distances.png
  59    :align: center
  60
  61 .. centered::
  62    Chamfer by two distances
  63
  64 **See Also** a sample TUI Script of :ref:`tui_create_chamfer1` operation.
  65
  66 Chamfer by a distance and an angle
  67 ----------------------------------
  68
  69 Alternatively, there is a possibility to create a chamfer with a distance and an angle.
  70
  71 .. image:: images/ChamferDistAngle.png
  72   :align: center
  73
  74 .. centered::
  75   Chamfer by a distance and an angle
  76
  77 Input fields:
  78
  79 - **Faces or/and edges** panel contains filleted faces and edges. All edges of a face are subject to fillet operation. Faces and edges are selected in 3D OCC viewer;
  80 - **D** defines the chamfer distance;
  81 - **Angle** defines the chamfer angle.
  82
  83 **TUI Command**:
  84
  85 .. py:function:: model.addChamfer(Part_doc, [face,edge], perfomDistances, D, Angle)
  86
  87     :param part: The current part object.
  88     :param list: A list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)*.
  89     :param boolean: A "False" flag to indicate that the type of chamfer is by a distance and an angle.
  90     :param number: D value.
  91     :param number: Angle value.
  92     :return: Created object.
  93
  94 Result
  95 """"""
  96
  97 Result of **Chamfer by a distance and an angle** is shown below.
  98
  99 .. image:: images/chamfer_res_dist_angle.png
 100    :align: center
 101
 102 .. centered::
 103    Chamfer by a distance and an angle
 104
 105 **See Also** a sample TUI Script of :ref:`tui_create_chamfer2` operation.