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    :height: 24px
  20
  21 chamfer by two distances
  22
  23 .. image:: images/chamfer_dist_angle.png
  24    :align: left
  25    :height: 24px
  26
  27 chamfer by a distance and an angle
  28
  29 --------------------------------------------------------------------------------
  30
  31 Chamfer by two distances
  32 ------------------------
  33
  34 The  property panel is shown below.
  35
  36 .. image:: images/ChamferDistances.png
  37   :align: center
  38
  39 .. centered::
  40   Chamfer by two distances property panel
  41
  42 Input fields:
  43
  44 - **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;
  45 - **D1** define the first chamfer distance;
  46 - **D2** define the second chamfer distance;
  47
  48 **TUI Command**:
  49
  50 .. py:function:: model.addChamfer(Part_doc, [face,edge], perfomDistances, D1, D2)
  51
  52     :param part: The current part object.
  53     :param list: A list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)*.
  54     :param boolean: A "True" flag to indicate that the type of chamfer is by two distances.
  55     :param number: D1 value.
  56     :param number: D2 value.
  57     :return: Created object.
  58
  59 Result
  60 """"""
  61
  62 Result of **Chamfer by two distances** is shown below.
  63
  64 .. image:: images/chamfer_res_distances.png
  65    :align: center
  66
  67 .. centered::
  68    Chamfer by two distances
  69
  70 **See Also** a sample TUI Script of :ref:`tui_create_chamfer1` operation.
  71
  72 Chamfer by a distance and an angle
  73 ----------------------------------
  74
  75 Alternatively, there is a possibility to create a chamfer with a distance and an angle.
  76
  77 .. image:: images/ChamferDistAngle.png
  78   :align: center
  79
  80 .. centered::
  81   Chamfer by a distance and an angle
  82
  83 Input fields:
  84
  85 - **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;
  86 - **D** defines the chamfer distance;
  87 - **Angle** defines the chamfer angle.
  88
  89 **TUI Command**:
  90
  91 .. py:function:: model.addChamfer(Part_doc, [face,edge], perfomDistances, D, Angle)
  92
  93     :param part: The current part object.
  94     :param list: A list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)*.
  95     :param boolean: A "False" flag to indicate that the type of chamfer is by a distance and an angle.
  96     :param number: D value.
  97     :param number: Angle value.
  98     :return: Created object.
  99
 100 Result
 101 """"""
 102
 103 Result of **Chamfer by a distance and an angle** is shown below.
 104
 105 .. image:: images/chamfer_res_dist_angle.png
 106    :align: center
 107
 108 .. centered::
 109    Chamfer by a distance and an angle
 110
 111 **See Also** a sample TUI Script of :ref:`tui_create_chamfer2` operation.