src/BuildPlugin/doc/subShapesFeature.rst

   1
   2 Sub-shapes
   3 ==========
   4
   5 The feature **Sub-shapes** lets to modify selected entity creating a non-manifold topology. It provides:
   6
   7 * add/remove vertices laying on edges of a wire;
   8 * add/remove edges and vertices laying on a face.
   9
  10 To create Sub-shapes in the active part:
  11
  12 #. select in the Main Menu *Build - > Sub-shapes* item  or
  13 #. click **Sub-shapes** button in the toolbar
  14
  15 .. image:: images/feature_subshapes.png
  16    :align: center
  17
  18 .. centered::
  19    **Sub-shapes** button
  20
  21 The following property panel appears.
  22
  23 .. image:: images/SubShapes.png
  24   :align: center
  25
  26 .. centered::
  27   Sub-shapes property panel
  28
  29 Input fields:
  30
  31 - **Shape** panel contains a shape to be modified. Shape is selected in 3D OCC viewer or object browser. For today it has to be wire or face;
  32 - **Sub-shapes** panel contains 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.
  33
  34 **TUI Command**:  *model.addSubShapes(Part_doc, shape, sub-shapes)*
  35
  36 **Arguments**: 1 part + shape in format *model.selection(TYPE, shape)* + list of sub-shapes in format *model.selection(TYPE, subshape)*.
  37
  38 Result
  39 """"""
  40 Result replaces original shape with the same one 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 a :ref:`tui_create_subshape` operation.
  49
  50
  51
  52