src/FeaturesPlugin/doc/booleanArguments.rst

   1 .. |common.icon|    image:: images/bool_common.png
   2    :height: 16px
   3 .. |cut.icon|    image:: images/bool_cut.png
   4    :height: 16px
   5 .. |fuse.icon|    image:: images/bool_fuse.png
   6    :height: 16px
   7 .. |smash.icon|    image:: images/bool_smash.png
   8    :height: 16px
   9 .. |split.icon|    image:: images/bool_split.png
  10    :height: 16px
  11 .. |partition.icon|    image:: images/partition_btn.png
  12    :height: 16px
  13 .. |inter.icon|    image:: images/intersection_btn.png
  14    :height: 16px
  15 .. |union.icon|    image:: images/union_btn.png
  16    :height: 16px
  17
  18
  19 .. _bopArguments:
  20
  21 Arguments of Boolean Operations
  22 ===============================
  23
  24 This section describes the shapes applicable as arguments of Boolean Operations.
  25 First of all, the result of Boolean Operations depends on the dimension of arguments. The following table shows the dimension and corresponding types of shapes.
  26
  27 +-----------+----------------------------+
  28 | Dimension | Shape types                |
  29 +===========+============================+
  30 |     0     | VERTEX, COMPOUND           |
  31 +-----------+----------------------------+
  32 |     1     | EDGE, WIRE, COMPOUND       |
  33 +-----------+----------------------------+
  34 |     2     | FACE, SHELL, COMPOUND      |
  35 +-----------+----------------------------+
  36 |     3     | SOLID, COMPSOLID, COMPOUND |
  37 +-----------+----------------------------+
  38
  39 *Note*: COMPOUND may consist of any shape combinations, therefore, it is present is each row.
  40
  41 The next table aligns an operation and the dimensions of its arguments.
  42 Construction planes (mentioned PLANE) can be used in several operations, but not included in the table above due to their infinite nature.
  43
  44 +-------------------------+---------------------------+-------------------------+
  45 |      Operation          | Dimension of objects (DO) | Dimension of tools (DT) |
  46 +=========================+===========================+=========================+
  47 | |common.icon|           |            Any            |      Any (+ PLANE)      |
  48 | :ref:`featureCommon`    |                           |                         |
  49 +-------------------------+---------------------------+-------------------------+
  50 | |cut.icon|              |            Any            |  Not less than **DO**   |
  51 | :ref:`featureCut`       |                           |                         |
  52 +-------------------------+---------------------------+-------------------------+
  53 | |fuse.icon|             |            Any            |          Any            |
  54 | :ref:`featureFuse`      |                           |                         |
  55 +-------------------------+---------------------------+-------------------------+
  56 | |inter.icon|            |          1 or 2           |          ---            |
  57 | :ref:`featureIntersect` |                           |                         |
  58 +-------------------------+---------------------------+-------------------------+
  59 | |partition.icon|        |       Any (+ PLANE)       |          ---            |
  60 | :ref:`featurePartition` |                           |                         |
  61 +-------------------------+---------------------------+-------------------------+
  62 | |smash.icon|            | 2 (planar FACE only) or 3 |    Equal to **DO**      |
  63 | :ref:`featureSmash`     |                           |                         |
  64 +-------------------------+---------------------------+-------------------------+
  65 | |split.icon|            |            Any            |      Any (+ PLANE)      |
  66 | :ref:`featureSplit`     |                           |                         |
  67 +-------------------------+---------------------------+-------------------------+
  68 | |union.icon|            | 3 (SOLIDs from COMPSOLID) |          ---            |
  69 | :ref:`featureUnion`     |                           |                         |
  70 +-------------------------+---------------------------+-------------------------+
  71
  72 The optional fuzzy parameter of each boolean operation is used as an additional tolerance to eliminate tiny results.