src/FeaturesPlugin/doc/symmetryFeature.rst

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