Salome HOME
Revert "bos#35152 [EDF] (2023-T1) Sketch Circle should allow user to position constru...
[modules/shaper.git] / src / SketchPlugin / doc / collinearFeature.rst
index 1a43b42a7f38f6ae59e4afc022c266a10aae7d44..ffa767acd860438f3642cf63b4efa2dc13bfb9c7 100644 (file)
@@ -1,10 +1,44 @@
+.. |collinear.icon|    image:: images/collinear.png
 
 Collinear constraint
 ====================
 
+Collinear constraint forces lines to be collinear.
 
-.. image:: images/Colinear.png
-  :align: center
+To create a Collinear constraint in the active Sketch:
 
-.. centered::
-  Create a collinear constraint
+#. select in the Main Menu *Sketch - > Collinear* item  or
+#. click |collinear.icon| **Collinear** button in Sketch toolbar:
+
+Property panel:
+
+.. figure:: images/Collinear_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, they are translated to become collinear.
+| The lines are marked with a special sign.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.setCollinear(Line1, Line2)
+
+    :param object: First object.
+    :param object: Second object.
+    :return: Result object.
+
+Result
+""""""
+
+Created Collinear constraint appears in the view.
+
+.. figure:: images/Collinear_res.png
+   :align: center
+
+   Created collinear constraint
+
+**See Also** a sample TUI Script of :ref:`tui_create_collinear` operation.