X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2Fdoc%2FdistanceFeature.rst;h=2017ac3d9627c020fd06d6204c944fb5dfb01933;hb=79470833af46e5a11abc700ebd07a26ec3e2d5a0;hp=dd52e8f63edced97e5e0200825e9e5858890c1b8;hpb=1e2eaa713f139d2617c80eba9ede62d4e9976bb7;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/doc/distanceFeature.rst b/src/SketchPlugin/doc/distanceFeature.rst index dd52e8f63..2017ac3d9 100644 --- a/src/SketchPlugin/doc/distanceFeature.rst +++ b/src/SketchPlugin/doc/distanceFeature.rst @@ -1,10 +1,67 @@ +.. |distance.icon| image:: images/Distance.png Distance constraint =================== +Distance constraint fixes the distance between two objects. -.. image:: images/Distance.png - :align: center +The constraint can be defined between such objects as point, line, line or arc end point, center of circle or arc. -.. centered:: - Create a distance constraint +To create a Distance constraint in the active Sketch: + +#. select in the Main Menu *Sketch - > Distance* item or +#. click |distance.icon| **Distance** button in Sketch toolbar: + +Property panel: + +.. figure:: images/Distance_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: + +- **First object** is the first object selected in the view; +- **Second object** is the second object selected in the view; +- **Value** is a distance between the objects, can be modified to set the desirable value; +- **Text location** is a position of the distance value label relating to extension line (in the view): + | |location_left| **Left** inserts text to the left of the distance extension line; + | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left; + | |location_right| **Right** inserts text to the right of the distance extension line; +- **Keep orientation** fixes the relative position between selected objects. + +When both objects are selected, the distance value is displayed in the property panel and in the view. + +When creating a constraint after selection of two objects for the first time: + +- drag the distance presentation in the view to the desired position and click once; +- set the desirable distance value in the input field and press **Enter** or just press **Enter** to keep the current distance. + +.. figure:: images/Distance_field_view.png + :align: center + + Distance input in the view + +**TUI Command**: + +.. py:function:: Sketch_1.setDistance(FirstObject, SecondObject, Value, KeepOrientation) + + :param object: First object. + :param object: Second object. + :param real: Value. + :param boolean: Keep orientation flag. + :return: Result object. + +Result +"""""" + +Created Distance appears in the view. + +.. figure:: images/Distance_res.png + :align: center + + Distance created + +**See Also** a sample TUI Script of :ref:`tui_create_distance` operation.