]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
corrections to Python addons
authorgzy <gzy@opencascade.com>
Thu, 20 Sep 2018 13:30:32 +0000 (16:30 +0300)
committergzy <gzy@opencascade.com>
Thu, 20 Sep 2018 13:30:32 +0000 (16:30 +0300)
src/PythonAddons/doc/addons_Features.rst
src/PythonAddons/doc/boxFeature.rst
src/PythonAddons/doc/pyFile_boxFeature.rst [new file with mode: 0644]
src/PythonAddons/doc/pyFile_rectangleFeature.rst [new file with mode: 0644]
src/PythonAddons/doc/rectangleFeature.rst
src/PythonAddons/doc/xmlFile_boxFeature.rst [new file with mode: 0644]
src/PythonAddons/doc/xmlFile_rectangleFeature.rst [new file with mode: 0644]
src/SketchPlugin/doc/rectangleFeature.rst

index fe87c8a1ca683d199393c8ca673a69b50fbf8e32..26ba489c298ccb5d8a825418b448623da8081994 100644 (file)
@@ -4,14 +4,14 @@ Python addons
 
 User can create his own custom features.
 
-Corresponding folder should be created for each feature at ..\sources\src\PythonAddons\macros\.
+Corresponding folder should be created for each feature at *../sources/src/PythonAddons/macros*.
 
 Feature description includes 4 files:
 
-- widget.xml,
+- widget.xml with description of property panel,
 -  __init__.py,
-- feature.py, 
-- icon.png located at sub-folder \icons.
+- feature.py with python commands
+- icon.png with image of button in toolbar (file is located at sub-folder /icons).
 
 Two examples of custom features already created are:
 
index 354c5422e5d2a0f56da437846d55f924c47605ce..0d3674083ee6048343552c6ae011c5f15f647383 100644 (file)
@@ -2,34 +2,25 @@
 Box
 ===
 
-Custom feature box is located at ..\sources\src\PythonAddons\macros\box.
+Custom files for feature **Box** are:
 
-.. literalinclude:: examples/box/feature.py   
-    :linenos:
-    :language: python
+-  empty __init__.py,
+- :ref:`create_custom_box_py`,
+- :ref:`create_custom_box_xml`,
+- icon.png located at sub-folder */icons*.
 
-:download:`Download this script <examples/box/feature.py>`
-
-.. literalinclude:: examples/box/widget.xml    
-    :linenos:
-    :language: html
-
-:download:`Download this script <examples/box/widget.xml>`
+.. image:: images/box_ico.png
+   :align: center
 
-The feature Box creates a box solid by extrusion of rectangle.
+.. centered::
+   File icon.png
 
-Result in Shaper module is described below.
+The custom feature **Box** creates a box solid by extrusion of rectangle.
 
 To create a Box in the active part:
 
 #. select in the Main Menu *Macros - > Box* item  or
-#. click **Box** button in the Macros toolbar:
-
-.. image:: images/box.png
-   :align: center
-
-.. centered::
-   **Box**  button 
+#. click **Box** button in the Macros toolbar corresponding to file icon.png:
 
 The following property panel appears. 
 
@@ -41,22 +32,17 @@ The following property panel appears.
 
 Input fields: 
 
-- **DX**, **DY**, **DZ** sizes of the box along corresponded coordinate axes. The box will be created starting from the origin.   
+- **Width**, **Length**, **Height** are sizes of the box along corresponding coordinate axes. The box will be created starting from the origin.   
 
 Result
 """"""
 
-The Result of operation will be a SOLID. The edges of the box will be parallel to the coordinate axes.
-
-Name is assigned automatically:
-    
-* **Box_1**, **Box_2**, ... to Feature;
-* **Box_1_1**, **Box_2_1**, ... to Result.
+The Result of operation will be Extrusion and Sketch. 
 
-Example is shown below.
+The edges of the box will be parallel to the coordinate axes.
 
 .. image:: images/Boxes.png
           :align: center
                   
 .. centered::
-   Box created  
+   Box created 
\ No newline at end of file
diff --git a/src/PythonAddons/doc/pyFile_boxFeature.rst b/src/PythonAddons/doc/pyFile_boxFeature.rst
new file mode 100644 (file)
index 0000000..dd2f5fa
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _create_custom_box_py:
+
+File feature.py 
+===============
+
+.. literalinclude:: examples/box/feature.py   
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/box/feature.py>`
\ No newline at end of file
diff --git a/src/PythonAddons/doc/pyFile_rectangleFeature.rst b/src/PythonAddons/doc/pyFile_rectangleFeature.rst
new file mode 100644 (file)
index 0000000..bbe2eaf
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _create_custom_rectangle_py:
+
+File feature.py 
+===============
+
+.. literalinclude:: examples/rectangle/feature.py   
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/rectangle/feature.py>`
\ No newline at end of file
index 3148b08e2faa06f0da99778f15f5c1143cdb9bd8..98b9247ae69616f499d4d8814520c36375941e63 100644 (file)
@@ -1,3 +1,18 @@
 
 Rectangle
 =========
+
+Custom files for feature **Rectangle** are:
+
+-  empty __init__.py,
+- :ref:`create_custom_rectangle_py`,
+- :ref:`create_custom_rectangle_xml`,
+- icon.png located at sub-folder */icons*.
+
+.. image:: images/rectangle.png
+   :align: center
+
+.. centered::
+   File icon.png
+
+Description of custom feature :ref:`create_sketch_rectangle` is given in Sketch plug-in.
\ No newline at end of file
diff --git a/src/PythonAddons/doc/xmlFile_boxFeature.rst b/src/PythonAddons/doc/xmlFile_boxFeature.rst
new file mode 100644 (file)
index 0000000..cd3e5c8
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _create_custom_box_xml:
+
+File widget.xml 
+===============
+
+.. literalinclude:: examples/box/widget.xml    
+    :linenos:
+    :language: html
+
+:download:`Download this script <examples/box/widget.xml>`
\ No newline at end of file
diff --git a/src/PythonAddons/doc/xmlFile_rectangleFeature.rst b/src/PythonAddons/doc/xmlFile_rectangleFeature.rst
new file mode 100644 (file)
index 0000000..1901d96
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _create_custom_rectangle_xml:
+
+File widget.xml 
+===============
+
+.. literalinclude:: examples/rectangle/widget.xml    
+    :linenos:
+    :language: html
+
+:download:`Download this script <examples/rectangle/widget.xml>`
\ No newline at end of file
index 5a27626eefaa0dfc08bc1db44c7f4d70f47ab97a..3e90a11d7206041af0d29272279a29a515c118f8 100644 (file)
@@ -1,3 +1,4 @@
+  .. _create_sketch_rectangle:
 
 Rectangle
 =========