]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Modification of Primitives plugin documentation
authorvsv <vsv@opencascade.com>
Wed, 26 Sep 2018 15:43:29 +0000 (18:43 +0300)
committervsv <vsv@opencascade.com>
Wed, 26 Sep 2018 15:43:29 +0000 (18:43 +0300)
19 files changed:
src/PrimitivesPlugin/doc/TUI_boxByPoints.rst [new file with mode: 0644]
src/PrimitivesPlugin/doc/TUI_boxDimensions.rst [new file with mode: 0644]
src/PrimitivesPlugin/doc/TUI_boxFeature.rst [deleted file]
src/PrimitivesPlugin/doc/TUI_cylinderFeature.rst
src/PrimitivesPlugin/doc/TUI_cylinderPortion.rst [new file with mode: 0644]
src/PrimitivesPlugin/doc/boxFeature.rst
src/PrimitivesPlugin/doc/cylinderFeature.rst
src/PrimitivesPlugin/doc/examples/box.py [deleted file]
src/PrimitivesPlugin/doc/examples/box1.py [new file with mode: 0644]
src/PrimitivesPlugin/doc/examples/box2.py [new file with mode: 0644]
src/PrimitivesPlugin/doc/examples/cylinder.py [deleted file]
src/PrimitivesPlugin/doc/examples/cylinder1.py [new file with mode: 0644]
src/PrimitivesPlugin/doc/examples/cylinder2.py [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/Box1.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/Box2.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/Boxes.png [deleted file]
src/PrimitivesPlugin/doc/images/Cylinder1.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/Cylinder2.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/Cylinders.png [deleted file]

diff --git a/src/PrimitivesPlugin/doc/TUI_boxByPoints.rst b/src/PrimitivesPlugin/doc/TUI_boxByPoints.rst
new file mode 100644 (file)
index 0000000..31eaf4b
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_boxpnt:
+
+Create Box by points
+====================
+
+.. literalinclude:: examples/box2.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/box2.py>` 
diff --git a/src/PrimitivesPlugin/doc/TUI_boxDimensions.rst b/src/PrimitivesPlugin/doc/TUI_boxDimensions.rst
new file mode 100644 (file)
index 0000000..ddeabf1
--- /dev/null
@@ -0,0 +1,12 @@
+
+ .. _tui_create_boxdim:
+
+Create Box by dimensions
+========================
+
+.. literalinclude:: examples/box1.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/box1.py>` 
+
diff --git a/src/PrimitivesPlugin/doc/TUI_boxFeature.rst b/src/PrimitivesPlugin/doc/TUI_boxFeature.rst
deleted file mode 100644 (file)
index 78ae3ad..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-
-  .. _tui_create_box:
-
-Create Box
-==========
-
-.. literalinclude:: examples/box.py
-    :linenos:
-    :language: python
-
-:download:`Download this script <examples/box.py>` 
-   
index 9256a9d66b7582f69b8bbfc3cd3b8274302fc9f9..dc326819c09a2f66d32f2cef1a77646fb938d7a3 100644 (file)
@@ -1,12 +1,12 @@
 
   .. _tui_create_cylinder:
 
-Create /Cylinder
+Create cylinder
 ================
 
-.. literalinclude:: examples/cylinder.py
+.. literalinclude:: examples/cylinder1.py
     :linenos:
     :language: python
 
-:download:`Download this script <examples/cylinder.py>` 
+:download:`Download this script <examples/cylinder1.py>` 
    
diff --git a/src/PrimitivesPlugin/doc/TUI_cylinderPortion.rst b/src/PrimitivesPlugin/doc/TUI_cylinderPortion.rst
new file mode 100644 (file)
index 0000000..8d2bad8
--- /dev/null
@@ -0,0 +1,12 @@
+
+  .. _tui_create_cylportion:
+
+Create portion of cylinder
+==========================
+
+.. literalinclude:: examples/cylinder2.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/cylinder2.py>` 
+   
index b1eb661dd97ab59aa0b4f64091c1bdfe55814e3d..ac3a81a8e4ac4c0fb23f4243825a55cf78cf2a42 100644 (file)
@@ -28,7 +28,7 @@ There are 2 algorithms for creation of a Box:
 
 
 By dimensions
-"""""""""""""
+-------------
 
 Box is created by dimensions along X, Y, Z axis starting from the origin.
 
@@ -43,9 +43,18 @@ Input fields:
   
 **Arguments**:    Part + 3 real values (dimensions at origin).
 
+Result
+""""""
+
+A solid box based on origin and with edges parallel to the coordinate axes.
+
+.. image:: images/Box1.png
+          :align: center
+
+**See Also** a sample TUI Script of a :ref:`tui_create_boxdim` operation.
 
 By two points
-"""""""""""""
+-------------
 
 Box is created by two points of the box diagonal.
 
@@ -63,12 +72,12 @@ Input fields:
 Result
 """"""
 
-The edges of the created boxes are parallel to the coordinate axes.
+A solid box based on two points and with edges parallel to the coordinate axes.
 
-.. image:: images/Boxes.png
+.. image:: images/Box2.png
           :align: center
                   
 .. centered::
    Boxes created  
 
-**See Also** a sample TUI Script of a :ref:`tui_create_box` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of a :ref:`tui_create_boxpnt` operation.
index d04badfb8b1bee6d4b2121143ea2eec2a314954c..0308890ad4f1f57e1f591d9cff5866912d9737c0 100644 (file)
@@ -26,7 +26,7 @@ There are 2 algorithms for creation of a Cylinder:
 **Portion of cylinder** creates one segment of cylinder.
 
 Cylinder
-""""""""
+--------
 
 .. image:: images/Cylinder.png
    :align: center
@@ -42,14 +42,25 @@ Input fields:
    - **Radius**;
    - **Height**.    
 
-**TUI Commands**:
-
-* *model.addCylinder(Part_doc, Point, Axis, Radius, Height)*
+**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height)*
 
 **Arguments**:   Part + 1 vertex +1 vector +  2 real values (radius, height).
 
+Result
+""""""
+
+Example is shown below.
+
+.. image:: images/Cylinder1.png
+          :align: center
+                  
+.. centered::
+   Cylinder  
+
+**See Also** a sample TUI Script of a :ref:`tui_create_cylinder` operation.
+
 Portion of cylinder
-"""""""""""""""""""
+-------------------
 
 .. image:: images/Portion_cylinder.png
           :align: center
@@ -59,9 +70,7 @@ Portion of cylinder
 
 Input fields for ***Portion of cylinder** tab includes in addition **Angle** to create a portion of cylinder.
 
-**TUI Commands**:
-
-* *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)*
+**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)*
   
 **Arguments**:   1 Part + 1 vertex +1 vector +  3 real values (radius, height and angle).
 
@@ -70,10 +79,10 @@ Result
 
 Example is shown below.
 
-.. image:: images/Cylinders.png
+.. image:: images/Cylinder2.png
           :align: center
                   
 .. centered::
-   Cylinders created  
+   Portion of cylinder  
 
-**See Also** a sample TUI Script of a :ref:`tui_create_cylinder` operation.
+**See Also** a sample TUI Script of a :ref:`tui_create_cylportion` operation.
diff --git a/src/PrimitivesPlugin/doc/examples/box.py b/src/PrimitivesPlugin/doc/examples/box.py
deleted file mode 100644 (file)
index 0b9b5e6..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from salome.shaper import model
-
-model.begin()
-partSet = model.moduleDocument()
-Part_1 = model.addPart(partSet)
-Part_1_doc = Part_1.document()
-Box_1 = model.addBox(Part_1_doc, 10, 10, 10)
-Point_2 = model.addPoint(Part_1_doc, 20, 30, 40)
-Point_3 = model.addPoint(Part_1_doc, 40, 40, 50)
-Box_2 = model.addBox(Part_1_doc, model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Point_2"))
-model.do()
-model.end()
diff --git a/src/PrimitivesPlugin/doc/examples/box1.py b/src/PrimitivesPlugin/doc/examples/box1.py
new file mode 100644 (file)
index 0000000..2b2392e
--- /dev/null
@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Box_1 = model.addBox(Part_1_doc, 10, 10, 10)
+model.do()
+model.end()
diff --git a/src/PrimitivesPlugin/doc/examples/box2.py b/src/PrimitivesPlugin/doc/examples/box2.py
new file mode 100644 (file)
index 0000000..e7b4228
--- /dev/null
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Point_2 = model.addPoint(Part_1_doc, 20, 30, 40)
+Point_3 = model.addPoint(Part_1_doc, 40, 40, 50)
+Box_2 = model.addBox(Part_1_doc, model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Point_2"))
+model.do()
+model.end()
diff --git a/src/PrimitivesPlugin/doc/examples/cylinder.py b/src/PrimitivesPlugin/doc/examples/cylinder.py
deleted file mode 100644 (file)
index 7c7c2bf..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from salome.shaper import model
-
-model.begin()
-partSet = model.moduleDocument()
-Part_1 = model.addPart(partSet)
-Part_1_doc = Part_1.document()
-Cylinder_1 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "PartSet/Origin"), model.selection("EDGE", "PartSet/OZ"), 5, 10)
-Cylinder_2 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "Cylinder_1_1/Face_1&Cylinder_1_1/Face_2"), model.selection("EDGE", "PartSet/OX"), 5, 10, 45)
-model.do()
-model.end()
diff --git a/src/PrimitivesPlugin/doc/examples/cylinder1.py b/src/PrimitivesPlugin/doc/examples/cylinder1.py
new file mode 100644 (file)
index 0000000..6420883
--- /dev/null
@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Cylinder_1 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "PartSet/Origin"), model.selection("EDGE", "PartSet/OZ"), 5, 10)
+model.do()
+model.end()
diff --git a/src/PrimitivesPlugin/doc/examples/cylinder2.py b/src/PrimitivesPlugin/doc/examples/cylinder2.py
new file mode 100644 (file)
index 0000000..f84d24c
--- /dev/null
@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Cylinder_2 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "Cylinder_1_1/Face_1&Cylinder_1_1/Face_2"), model.selection("EDGE", "PartSet/OX"), 5, 10, 45)
+model.do()
+model.end()
diff --git a/src/PrimitivesPlugin/doc/images/Box1.png b/src/PrimitivesPlugin/doc/images/Box1.png
new file mode 100644 (file)
index 0000000..4e8a1d2
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Box1.png differ
diff --git a/src/PrimitivesPlugin/doc/images/Box2.png b/src/PrimitivesPlugin/doc/images/Box2.png
new file mode 100644 (file)
index 0000000..53dffcc
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Box2.png differ
diff --git a/src/PrimitivesPlugin/doc/images/Boxes.png b/src/PrimitivesPlugin/doc/images/Boxes.png
deleted file mode 100644 (file)
index 2d24ec8..0000000
Binary files a/src/PrimitivesPlugin/doc/images/Boxes.png and /dev/null differ
diff --git a/src/PrimitivesPlugin/doc/images/Cylinder1.png b/src/PrimitivesPlugin/doc/images/Cylinder1.png
new file mode 100644 (file)
index 0000000..ecc30d6
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Cylinder1.png differ
diff --git a/src/PrimitivesPlugin/doc/images/Cylinder2.png b/src/PrimitivesPlugin/doc/images/Cylinder2.png
new file mode 100644 (file)
index 0000000..087db9b
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Cylinder2.png differ
diff --git a/src/PrimitivesPlugin/doc/images/Cylinders.png b/src/PrimitivesPlugin/doc/images/Cylinders.png
deleted file mode 100644 (file)
index 5c637ff..0000000
Binary files a/src/PrimitivesPlugin/doc/images/Cylinders.png and /dev/null differ