X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FBuildPlugin%2Fdoc%2FwireFeature.rst;h=32d03e58fe62f36773f649833cc24c97f68ca754;hb=0fcd69345a4dfdb31e252574c68bc70e123999e8;hp=0cf5bc4087212994235113b52c7882bf0b779bad;hpb=db1f629785c83f9691b1707b3fd11a26625c7a26;p=modules%2Fshaper.git diff --git a/src/BuildPlugin/doc/wireFeature.rst b/src/BuildPlugin/doc/wireFeature.rst index 0cf5bc408..32d03e58f 100644 --- a/src/BuildPlugin/doc/wireFeature.rst +++ b/src/BuildPlugin/doc/wireFeature.rst @@ -1,19 +1,14 @@ +.. |feature_wire.icon| image:: images/feature_wire.png Wire ==== -The Wire feature creates a wire using already existing edges in other objects. +Wire feature creates a wire using edges already existing in other objects. -To create wire in the active part: +To create a wire in the active part: #. select in the Main Menu *Build - > Wire* item or -#. click **Wire** button in the toolbar - -.. image:: images/feature_wire.png - :align: center - -.. centered:: - **Wire** button +#. click |feature_wire.icon| **Wire** button in the toolbar The following property panel will be opened: @@ -23,20 +18,24 @@ The following property panel will be opened: .. centered:: Create a wire -Select one or several edges in viewer. For automatic selection of closed contour starting from a selected edge it is necessary to press **Add contour** button. +Select one or several edges in the viewer. For automatic selection of a closed contour starting from the selected edge it is necessary to press **Add contour** button. + +**Apply** button creates a wire. -**Apply** button creates wire. +**Cancel** button cancels the operation. -**Cancel** button cancels operation. +**TUI Command**: -**TUI Command**: *model.addWire(Part_doc, Shapes)* +.. py:function:: model.addWire(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" -The result of the operation will be a wire created from selected shapes: +The result of the operation will be a wire created from the selected shapes: .. image:: images/CreateWire.png :align: center @@ -44,4 +43,4 @@ The result of the operation will be a wire created from selected shapes: .. centered:: Result of the operation. -**See Also** a sample TUI Script of a :ref:`tui_create_wire` operation. +**See Also** a sample TUI Script of :ref:`tui_create_wire` operation.