src/FeaturesPlugin/doc/symmetryFeature.rst

   1 .. |symmetry.icon|    image:: images/symmetry.png
   2
   3 Symmetry
   4 ========
   5
   6 **Symmetry** feature makes a symmetrical copy of the selected shape.
   7
   8 To create a Symmetry in the active part:
   9
  10 #. select in the Main Menu *Part - > Symmetry* item  or
  11 #. click |symmetry.icon| **Symmetry** button in the toolbar
  12
  13 Symmetrical copy of an Object can be mirrored in three different ways:
  14
  15   .. image:: images/symmetry_point_32x32.png
  16     :align: left
  17   through a Point of symmetry
  18
  19   .. image:: images/symmetry_axis_32x32.png
  20     :align: left
  21   through an Axis of symmetry
  22
  23   .. image:: images/symmetry_plane_32x32.png
  24     :align: left
  25   through a Plane of symmetry
  26
  27 Symmetry through a Point of symmetry
  28 ------------------------------------
  29
  30 .. image:: images/symmetryPoint.png
  31   :align: center
  32
  33 .. centered::
  34   Symmetry through a Point of symmetry property panel
  35
  36 Input fields:
  37
  38 - **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
  39 - **Point**  defines a point of symmetry selected in 3D OCC viewer or object browser;
  40 - **Create a copy** checkbox preserves/removes the initial object.
  41
  42 **TUI Command**:
  43
  44 .. py:function:: model.addSymmetry(Part_doc, [shape], point, copy)
  45
  46     :param part: The current part object.
  47     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  48     :param object: A point in format *model.selection(TYPE, shape)*.
  49     :param boolean: A flag to create a copy.
  50     :return: Result object.
  51
  52 Result
  53 """"""
  54
  55 The result of operation is a mirrored initial shape with **Create a copy** = *True*.
  56
  57 .. image:: images/symmetryPointres.png
  58    :align: center
  59
  60 .. centered::
  61    Symmetry through a Point of symmetry
  62
  63 **See Also** a sample TUI Script of :ref:`tui_symmetry_point` operation.
  64
  65 Symmetry through an Axis of symmetry
  66 ------------------------------------
  67
  68 .. image:: images/symmetryAxis.png
  69   :align: center
  70
  71 .. centered::
  72   Symmetry through an Axis of symmetry property panel
  73
  74 Input fields:
  75
  76 - **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
  77 - **Axis**  defines an axis of symmetry selected in 3D OCC viewer or object browser;
  78 - **Create a copy** checkbox preserves/removes the initial object.
  79
  80 **TUI Command**:
  81
  82 .. py:function:: model.addSymmetry(Part_doc, [shape], axis, copy)
  83
  84     :param part: The current part object.
  85     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  86     :param object: An axis in format *model.selection(TYPE, shape)*.
  87     :param boolean: A flag to create a copy.
  88     :return: Result object.
  89
  90 Result
  91 """"""
  92
  93 The result of operation is a mirrored initial shape with **Create a copy** = *False*.
  94
  95 .. image:: images/symmetryAxisres.png
  96    :align: center
  97
  98 .. centered::
  99    Symmetry through an Axis of symmetry
 100
 101 **See Also** a sample TUI Script of :ref:`tui_symmetry_axis` operation.
 102
 103 Symmetry through a Plane of symmetry
 104 ------------------------------------
 105
 106 .. image:: images/symmetryPlane.png
 107   :align: center
 108
 109 .. centered::
 110   Symmetry through a Plane of symmetry property panel
 111
 112 Input fields:
 113
 114 - **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
 115 - **Plane**  defines a plane of symmetry selected in 3D OCC viewer or object browser;
 116 - **Create a copy** checkbox preserves/removes the initial object.
 117
 118 **TUI Command**:
 119
 120 .. py:function:: model.addSymmetry(Part_doc, [shape], plane, copy)
 121
 122     :param part: The current part object.
 123     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
 124     :param object: A plane in format *model.selection(TYPE, shape)*.
 125     :param boolean: A flag to create a copy.
 126     :return: Result object.
 127
 128 Result
 129 """"""
 130
 131 The result of operation is a mirrored initial shape with **Create a copy** = *False*.
 132
 133 .. image:: images/symmetryPlaneres.png
 134    :align: center
 135
 136 .. centered::
 137    Symmetry through a Plane of symmetry
 138
 139 **See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation.