src/FeaturesPlugin/doc/limitToleranceFeature.rst

   1 .. |limit_tol_btn.icon|    image:: images/limit_tol_btn.png
   2
   3 Limit Tolerance
   4 ===============
   5
   6 Limit Tolerance feature tries to set a new value of tolerance for the given shape. However, the final tolerance value also
   7 depends on the initial shape topology (takes into consideration the existing gaps) to obtain a valid resulting shape.
   8
   9 To limit the tolerance in the active part:
  10
  11 #. select in the Main Menu *Features - > Limit Tolerance* item  or
  12 #. click |limit_tol_btn.icon| **Limit Tolerance** button in the toolbar
  13
  14 The following property panel will be opened:
  15
  16 .. figure:: images/LimitTolerance.png
  17    :align: center
  18
  19    **Limit Tolerance operation**
  20
  21 Here it is necessary to select a shape and give a value for the desired tolerance value.
  22
  23 - **Shape** sets the shape to be modified.
  24 - **Tolerance** sets the desired tolerance value for the selected shape.
  25
  26 Example of usage:
  27
  28 #. Partition objects obj1 and obj2.
  29 #. Partition fails.
  30 #. Perform Limit Tolerance on objects obj1 and obj2.
  31 #. Try to partition them again.
  32
  33 **TUI Command**:
  34
  35 .. py:function:: model.addLimitTolerance(Part_doc, shape, tolerance)
  36
  37     :param part: The current part object.
  38     :param shape: A shape.
  39     :param tolerance: A tolerance value.
  40     :return: Result shape with the modified tolerance.
  41
  42 Result
  43 """"""
  44
  45 The Result of the operation will be the selected shape with an updated tolerance, where possible.
  46
  47 **See Also** a sample TUI Script of :ref:`tui_limit_tolerance` operation.