src/FeaturesPlugin/doc/boundingBoxFeature.rst

   1 .. |boundingBox.icon|    image:: images/bounding.png
   2
   3 Bounding box
   4 ============
   5
   6 The **Bounding box** feature displays the bounding box of sub-elements of a geometrical object (shape).
   7
   8 The property panel displays the coordinates of inferior (**Min**) and superior (**Max**) points.
   9 the resulting bounding box can be created via a dedicated check-box **Create Box**. If this last is checked corresponding result and feature would be created.
  10
  11 If the check-box **Create Box** isn't checked, **Apply** button does not generate any result and has the same effect as **Cancel** for this feature.
  12
  13 To display the bounding box in the active part:
  14
  15 #. select in the Main Menu *Inspection - > Bounding box* item  or
  16 #. click |boundingBox.icon| **Bounding box** button in the toolbar
  17
  18 Coordinates of the two points (inferior and superior) of the bounding box can be displayed for a selected object in the property panel :
  19
  20 .. figure:: images/boundingBoxPropertyPanel.png
  21    :align: center
  22
  23    Bounding Box
  24
  25
  26 Input fields:
  27
  28 - **Object** contains object selected in 3D OCC viewer or object browser.
  29 - **Create box** check-box allow the creation of the bounding box (result and feature).
  30
  31 Note, the coordinates of two points displayed can be selected.
  32
  33 **TUI Command**:
  34
  35 .. py:function:: model.getBoundingBox(Part_doc, shape)
  36
  37     :param part: The current part object.
  38     :param object: A shape in format *model.selection("Type", shape)*.
  39     :return: Created bounding box.
  40
  41 Result
  42 """"""
  43
  44 Result of **Bounding box** where **Create box** is checked.
  45
  46 .. figure:: images/BoundingBoxResult.png
  47    :align: center
  48
  49    Object selected
  50
  51 **See Also** a sample TUI Script of :ref:`tui_create_Bounding_Box` operation.