Salome HOME
Copyright update 2022
[modules/shaper.git] / src / SketchPlugin / doc / coincedentFeature.rst
index ef66b0a82e41bfcba78334aacdc753a5efcb6f99..31121057d368b17cf3b4ab17c964fdfd583473f3 100644 (file)
@@ -1,24 +1,19 @@
 .. _sketchCoincident:
+.. |coincedence.icon|    image:: images/coincedence.png
 
 Coincident constraint
 =====================
 
-Coincident constraint makes two points to be coincident, or one point to lie on a line or circumference of a circle (or an arc).
+Coincident constraint forces two points to be coincident, or one point to lie on a line, a circle or an arc.
 
-To create Coincident in the active Sketch:
+To create a Coincident constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Coincident* item  or
-#. click **Coincident** button in Sketch toolbar:
-
-.. image:: images/coincedence.png
-   :align: center
-
-.. centered::
-   **Coincident**  button
+#. click |coincedence.icon| **Coincident** button in Sketch toolbar:
 
 Property panel:
 
-.. image:: images/Coincident_panel.png
+.. figure:: images/Coincident_panel.png
    :align: center
 
 Input fields:
@@ -28,21 +23,24 @@ Input fields:
 
 Note that one of two objects should be a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
 
-After the objects are selected the point becomes yellow colored in the view.
+After the objects are selected, the point is highlighted in yellow in the view.
 
-**TUI Command**: *Sketch_1.setCoincident(Object1, Object2)*
+**TUI Command**:
 
-**Arguments**:  2 objects (one of them is a point, the second one is a point, a circle, an arc or a line)
+.. py:function:: Sketch_1.setCoincident(Object1, Object2)
+
+    :param object: First object.
+    :param object: Second object.
+    :return: Result object.
 
 Result
 """"""
 
 Created Coincident constraint appears in the view.
 
-.. image:: images/Coincident_res.png
-          :align: center
+.. figure:: images/Coincident_res.png
+   :align: center
 
-.. centered::
-   Coincident constraint created
+   Created coincident constraint
 
-**See Also** a sample TUI Script of :ref:`tui_create_coincident` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_coincident` operation.
\ No newline at end of file