Salome HOME
Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.
[modules/shaper.git] / src / SketchPlugin / doc / lengthFeature.rst
index 3b5ab83912624527debce63f1633ed7457055214..bc5399b1c0231d0079f0a5960036b38889e7da94 100644 (file)
@@ -1,3 +1,62 @@
+.. _sketchLength:
+.. |length.icon|    image:: images/Length.png
 
 Length constraint
 =================
+
+Length constraint fixes the length of lines, such as standalone line or rectangle side.
+
+To create a Length constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Length* item  or
+#. click |length.icon| **Length** button in Sketch toolbar:
+
+Property panel:
+
+.. figure:: images/Length_panel.png
+   :align: center
+
+.. |location_left| image:: images/location_left.png
+.. |location_auto| image:: images/location_automatic.png
+.. |location_right| image:: images/location_right.png
+
+Input fields:
+
+- **Line** is the the line object selected in the view;
+- **Value** is a line length, can be modified to set the desirable value;
+- **Text location** is a position of the length value label relating to extension line (in the view):
+   | |location_left| **Left** inserts text to the left of the length extension line;
+   | |location_auto| **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left;
+   | |location_right| **Right** inserts text to the right of the length extension line.
+
+When the line is selected, the length value is displayed in the property panel and in the view.
+
+When creating the constraint, after selection of a line for the first time:
+
+- drag the length presentation in the view to the desired position and click once;
+- set desirable length value in the input field in the view and press **Enter** or just press **Enter** to keep the current length.
+
+.. figure:: images/Length_field_view.png
+   :align: center
+
+   Length input in the view
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.setLength(LineObject, Value)
+
+    :param object: A line.
+    :param real: Length value.
+    :return: Result object.
+
+Result
+""""""
+
+Created Length appears in the view.
+
+.. figure:: images/Length_res.png
+   :align: center
+
+   Length created
+
+**See Also** a sample TUI Script of :ref:`tui_create_length` operation.