Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / SketchPlugin / doc / parallelFeature.rst
index 5886038dde4d91fbd4e1767c02af434cdd29a344..c965ab79a40dca0fb5e09eebed50ebcad1839903 100644 (file)
@@ -1,10 +1,43 @@
+.. |parallel.icon|    image:: images/Parallel.png
 
 Parallel constraint
 ===================
 
+Parallel constraint fixes two lines as parallel to one another.
 
-.. image:: images/Parallel.png
-  :align: center
+To create a Parallel constraint in the active Sketch:
 
-.. centered::
-  Create a parallel constraint
+#. select in the Main Menu *Sketch - > Parallel* item  or
+#. click |parallel.icon| **Parallel** button in Sketch toolbar:
+
+Property panel:
+
+.. figure:: images/Parallel_panel.png
+   :align: center
+
+Input fields:
+
+- **First line** is the first line selected in the view.
+- **Second line** is the second line selected in the view.
+
+After the lines are selected **||** sign will be added to each of them in the view.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.setParallel(Line1, Line2)
+
+    :param object: Line 1.
+    :param object: Line 2.
+    :return: Result object.
+
+Result
+""""""
+
+Created Parallel constraint appears in the view.
+
+.. figure:: images/Parallel_res.png
+   :align: center
+
+   Created parallel constraint
+
+**See Also** a sample TUI Script of :ref:`tui_create_parallel` operation.