Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / mirrorFeature.rst
index deb91a35c3d55286588b53cfa13205af9d73fce5..bf5c9c7fe0cf6189d8df30a55e2c789ef9bcf70b 100644 (file)
@@ -1,3 +1,48 @@
+.. |mirror.icon|    image:: images/Mirror.png
 
-Mirror
-======
+Mirror copy
+===========
+
+Mirror copy operation mirrors sketch entities across a line.
+
+To create a Mirror copy in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Mirror copy* item  or
+#. click |mirror.icon| **Mirror copy** button in Sketch toolbar:
+
+Property panel:
+
+.. image:: images/Mirror_panel.png
+  :align: center
+
+.. centered::
+   Mirror copy
+
+Input fields:
+
+- **Mirror line** is the mirror line selected in the view.
+- **Segments** is the list of segments (lines, circles, arcs) selected in the view.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addMirror(MirrorLine, Objects)
+
+    :param object: A mirror line.
+    :param listg: A list of objects.
+    :return: Result object.
+
+Result
+""""""
+
+Created Mirror copy appears in the view.
+
+| The original and the mirror copy objects are marked with a special sign.
+| Copy object is drawn with a thinner line.
+
+.. image:: images/Mirror_res.png
+          :align: center
+
+.. centered::
+   Mirror copy created
+
+**See Also** a sample TUI Script of :ref:`tui_create_mirror` operation.