src/BuildPlugin/doc/subShapesFeature.rst

   1 .. |feature_subshapes.icon|    image:: images/feature_subshapes.png
   2
   3 Sub-shapes
   4 ==========
   5
   6 The feature **Sub-shapes** modifies the selected entity by creating a non-manifold topology. It gives the possibility to:
   7
   8 * add/remove vertices lying on edges of a wire;
   9 * add/remove edges and vertices lying on a face.
  10
  11 To create Sub-shapes in the active part:
  12
  13 #. select in the Main Menu *Build - > Sub-shapes* item  or
  14 #. click |feature_subshapes.icon| **Sub-shapes** button in the toolbar
  15
  16 The following property panel appears.
  17
  18 .. image:: images/SubShapes.png
  19   :align: center
  20
  21 .. centered::
  22   Sub-shapes property panel
  23
  24 Input fields:
  25
  26 - **Shape** panel contains the shape to be modified. The shape is selected in 3D OCC viewer or object browser. For today it has to be a wire or a face;
  27 - **Sub-shapes** panel contains the list of sub-shapes which are already included into result. A sub-shape can be deleted from the list or the list can be extended with new shapes selected in the view.
  28
  29 **TUI Command**:
  30
  31 .. py:function:: model.addSubShapes(Part_doc, shape, sub-shapes)
  32
  33     :param part: The current part object.
  34     :param object: A shape in format *model.selection(TYPE, shape)*.
  35     :param list: A list of sub-shapes in format *model.selection(TYPE, subshape)*.
  36     :return: Result object.
  37
  38 Result
  39 """"""
  40 The result replaces the original shape with its copy with added/removed sub-shapes.
  41
  42 .. image:: images/CreateSubShapes.png
  43    :align: center
  44
  45 .. centered::
  46    Sub-shapes
  47
  48 **See Also** a sample TUI Script of :ref:`tui_create_subshape` operation.
  49
  50
  51
  52