Salome HOME
Fix bunch of issues for B-splines (#3155, #3156, #3157, #3159)
[modules/shaper.git] / src / SketchPlugin / doc / lengthFeature.rst
index f4197f5cbaf0edb5cdc1db6c69e6d127c44bc79c..939a98ee18f4710827e2c3e7f00099619582c0e7 100644 (file)
@@ -1,10 +1,68 @@
+.. _sketchLength:
+.. |length.icon|    image:: images/length.png
 
 Length constraint
 =================
 
+Length constraint fixes the length of lines, such as standalone line or rectangle side.
 
-.. image:: images/Length.png
-  :align: center
+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:
+
+.. image:: images/Length_panel.png
+   :align: center
+
+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):
+   .. image:: images/location_left.png
+      :align: left
+   **Left** inserts text to the left of the length extension line;
+
+   .. image:: images/location_automatic.png
+      :align: left
+   **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left;
+
+   .. image:: images/location_right.png
+      :align: left
+   **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.
+
+.. image:: images/Length_field_view.png
+   :align: center
+
+.. centered::
+   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.
+
+.. image:: images/Length_res.png
+          :align: center
 
 .. centered::
-  Create a length constraint
+   Length created
+
+**See Also** a sample TUI Script of :ref:`tui_create_length` operation.