Create Features plugin help pages

diff --git a/src/FeaturesPlugin/doc/TUI_commonFeature.rst b/src/FeaturesPlugin/doc/TUI_commonFeature.rst
new file mode 100644 (file)
index 0000000..993773f
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_commonFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_common:
+
+Create Common
+=============
+
+.. literalinclude:: examples/common.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/common.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_cutFeature.rst b/src/FeaturesPlugin/doc/TUI_cutFeature.rst
new file mode 100644 (file)
index 0000000..fadc784
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_cutFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_cut:
+
+Create Cut
+==========
+
+.. literalinclude:: examples/cut.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/cut.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_fillFeature.rst b/src/FeaturesPlugin/doc/TUI_fillFeature.rst
new file mode 100644 (file)
index 0000000..becb9ee
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_fillFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_fill:
+
+Create Fill
+===========
+
+.. literalinclude:: examples/fill.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/fill.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_fuseFeature.rst b/src/FeaturesPlugin/doc/TUI_fuseFeature.rst
new file mode 100644 (file)
index 0000000..ffe84bf
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_fuseFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_fuse:
+
+Create Fuse
+===========
+
+.. literalinclude:: examples/fuse.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/fuse.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_intersectionFeature.rst b/src/FeaturesPlugin/doc/TUI_intersectionFeature.rst
new file mode 100644 (file)
index 0000000..8eb115b
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_intersectionFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_intersection:
+
+Create Intersection
+===================
+
+.. literalinclude:: examples/intersection.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/intersection.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_partitionFeature.rst b/src/FeaturesPlugin/doc/TUI_partitionFeature.rst
new file mode 100644 (file)
index 0000000..9763549
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_partitionFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_partition:
+
+Create Partition
+================
+
+.. literalinclude:: examples/partition.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/partition.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_placementFeature.rst b/src/FeaturesPlugin/doc/TUI_placementFeature.rst
new file mode 100644 (file)
index 0000000..4f46ec6
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_placementFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_placement:
+
+Create Placement
+================
+
+.. literalinclude:: examples/placement.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/placement.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_smashFeature.rst b/src/FeaturesPlugin/doc/TUI_smashFeature.rst
new file mode 100644 (file)
index 0000000..ae92c58
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_smashFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_smash:
+
+Create Smash
+============
+
+.. literalinclude:: examples/smash.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/smash.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/TUI_unionFeature.rst b/src/FeaturesPlugin/doc/TUI_unionFeature.rst
new file mode 100644 (file)
index 0000000..bafb7c4
--- /dev/null
+++ b/src/FeaturesPlugin/doc/TUI_unionFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_union:
+
+Create Union
+============
+
+.. literalinclude:: examples/union.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/union.py>` 
+   

diff --git a/src/FeaturesPlugin/doc/commonFeature.rst b/src/FeaturesPlugin/doc/commonFeature.rst
index ff245795bbdb461e44ba11d99bf1abbc4098e341..afdbdcda32a01a9dc723ca1fe01859239aac0a3b 100644 (file)
--- a/src/FeaturesPlugin/doc/commonFeature.rst
+++ b/src/FeaturesPlugin/doc/commonFeature.rst
@@ -2,9 +2,41 @@
 Common
 ======
 
+To a create boolean opration Common in the active part:
 
+#. select in the Main Menu *Features - > Common* item  or
+#. click **Common** button in the toolbar
+
+.. image:: images/common_btn.png
+   :align: center
+
+.. centered::
+   **Common**  button 
+
+The following property panel will be opened:
+   
 .. image:: images/Common.png
   :align: center
 
 .. centered::
-  Common definition
+  **Common operation**
+
+It is necessary to select main objects and tool objects.
+
+**Apply** button creates the common shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addCommon(Part_doc, mainObjects, toolObjects)*
+
+**Arguments**:   Part + list of main objects + list of tool objects.
+
+The Result of the operation will be a shape which is a common for all selected shapes:
+
+.. image:: images/CreatedCommon.png
+          :align: center
+
+.. centered::
+   **Common created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_common` operation.

diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst
index e381c7c984ee0b038d64dde3009fcbb7138746e9..947d7affeef00bf13ba0fc4632ccd160412566b1 100644 (file)
--- a/src/FeaturesPlugin/doc/cutFeature.rst
+++ b/src/FeaturesPlugin/doc/cutFeature.rst
@@ -2,9 +2,41 @@
 Cut
 ===
 
+To a create boolean opration Cut in the active part:
+
+#. select in the Main Menu *Features - > Cut* item  or
+#. click **Cut** button in the toolbar
+
+.. image:: images/bool_cut.png
+   :align: center
+
+.. centered::
+   **Cut**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Cut.png
   :align: center
 
 .. centered::
-  Cut definition
+  **Cut operation**
+
+Here it is necessary to select main objects and tool objects.
+
+**Apply** button creates the cut shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addCut(Part_doc, mainObjects, toolObjects)*
+
+**Arguments**:   Part + list of main objects + list of tool objects.
+
+The Result of the operation will be a shape which is a cut of tool objects from main objects:
+
+.. image:: images/CreatedCut.png
+          :align: center
+
+.. centered::
+   **Cut created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_cut` operation.

diff --git a/src/FeaturesPlugin/doc/examples/common.py b/src/FeaturesPlugin/doc/examples/common.py
new file mode 100644 (file)
index 0000000..a55432e
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/common.py
@@ -0,0 +1,17 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Common_1 = model.addCommon(Part_1_doc,
+                           [model.selection("SOLID", "Cylinder_1_1")],
+                           [model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/cut.py b/src/FeaturesPlugin/doc/examples/cut.py
new file mode 100644 (file)
index 0000000..419345f
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/cut.py
@@ -0,0 +1,17 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Cut_1 = model.addCut(Part_1_doc,
+                     [model.selection("SOLID", "Cylinder_1_1")],
+                     [model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/fill.py b/src/FeaturesPlugin/doc/examples/fill.py
new file mode 100644 (file)
index 0000000..866345f
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/fill.py
@@ -0,0 +1,17 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Fill_1 = model.addFill(Part_1_doc,
+                       [model.selection("SOLID", "Cylinder_1_1")],
+                       [model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/fuse.py b/src/FeaturesPlugin/doc/examples/fuse.py
new file mode 100644 (file)
index 0000000..5425569
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/fuse.py
@@ -0,0 +1,17 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Fuse_1 = model.addFuse(Part_1_doc,
+                       [model.selection("SOLID", "Cylinder_1_1")],
+                       [model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/intersection.py b/src/FeaturesPlugin/doc/examples/intersection.py
new file mode 100644 (file)
index 0000000..bdafc79
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/intersection.py
@@ -0,0 +1,17 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Intersection_1 = model.addIntersection(Part_1_doc,
+                                       [model.selection("SOLID", "Cylinder_1_1"),
+                                        model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/partition.py b/src/FeaturesPlugin/doc/examples/partition.py
new file mode 100644 (file)
index 0000000..0243dc0
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/partition.py
@@ -0,0 +1,16 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Partition_1 = model.addPartition(Part_1_doc,
+                                 [model.selection("SOLID", "Cylinder_1_1"), model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/placement.py b/src/FeaturesPlugin/doc/examples/placement.py
new file mode 100644 (file)
index 0000000..d74ab4d
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/placement.py
@@ -0,0 +1,21 @@
+# -*- 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)
+Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Front"))
+SketchCircle_1 = Sketch_1.addCircle(20, 6, 3)
+model.do()
+Extrusion_1 = model.addExtrusion(Part_1_doc,
+                                 [model.selection("FACE", "Sketch_1/Face-SketchCircle_1_2f")],
+                                 model.selection(), -10, 0)
+Placement_1 = model.addPlacement(Part_1_doc,
+                                 [model.selection("SOLID", "Extrusion_1_1")],
+                                 model.selection("FACE", "Extrusion_1_1/From_Face_1"),
+                                 model.selection("FACE", "Box_1_1/Front"), False, True)
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/smash.py b/src/FeaturesPlugin/doc/examples/smash.py
new file mode 100644 (file)
index 0000000..0106567
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/smash.py
@@ -0,0 +1,17 @@
+# -*- 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)
+Cylinder_1 = model.addCylinder(Part_1_doc,
+                               model.selection("VERTEX", "PartSet/Origin"),
+                               model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Smash_1 = model.addSmash(Part_1_doc,
+                         [model.selection("SOLID", "Cylinder_1_1")],
+                         [model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/examples/union.py b/src/FeaturesPlugin/doc/examples/union.py
new file mode 100644 (file)
index 0000000..f5ce125
--- /dev/null
+++ b/src/FeaturesPlugin/doc/examples/union.py
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(71, -15, -32, -15)
+SketchLine_2 = Sketch_1.addLine(-32, -15, -32, -56)
+SketchLine_3 = Sketch_1.addLine(-32, -56, 71, -56)
+SketchLine_4 = Sketch_1.addLine(71, -56, 71, -15)
+SketchConstraintCoincidence_1 = Sketch_1.setCoincident(SketchLine_4.endPoint(), SketchLine_1.startPoint())
+SketchConstraintCoincidence_2 = Sketch_1.setCoincident(SketchLine_1.endPoint(), SketchLine_2.startPoint())
+SketchConstraintCoincidence_3 = Sketch_1.setCoincident(SketchLine_2.endPoint(), SketchLine_3.startPoint())
+SketchConstraintCoincidence_4 = Sketch_1.setCoincident(SketchLine_3.endPoint(), SketchLine_4.startPoint())
+SketchConstraintHorizontal_1 = Sketch_1.setHorizontal(SketchLine_1.result())
+SketchConstraintVertical_1 = Sketch_1.setVertical(SketchLine_2.result())
+SketchConstraintHorizontal_2 = Sketch_1.setHorizontal(SketchLine_3.result())
+SketchConstraintVertical_2 = Sketch_1.setVertical(SketchLine_4.result())
+SketchLine_5 = Sketch_1.addLine(3, -15, 36, -56)
+SketchConstraintCoincidence_5 = Sketch_1.setCoincident(SketchLine_5.startPoint(), SketchLine_1.result())
+SketchConstraintCoincidence_6 = Sketch_1.setCoincident(SketchLine_5.endPoint(), SketchLine_3.result())
+model.do()
+Extrusion_1 = model.addExtrusion(Part_1_doc,
+                                 [model.selection("FACE", "Sketch_1/Face-SketchLine_1f-SketchLine_2f-SketchLine_3f-SketchLine_5r"),
+                                  model.selection("FACE", "Sketch_1/Face-SketchLine_1f-SketchLine_3f-SketchLine_4f-SketchLine_5f")],
+                                 model.selection(), 10, 0)
+Union_1 = model.addUnion(Part_1_doc,
+                         [model.selection("SOLID", "Extrusion_1_1_1"),
+                          model.selection("SOLID", "Extrusion_1_1_2")])
+model.do()
+model.end()

diff --git a/src/FeaturesPlugin/doc/fillFeature.rst b/src/FeaturesPlugin/doc/fillFeature.rst
index 6e265d85d6ff5ba91ada1b5d82e3b0989a2356c0..82f68cd6f6d6c8fff9befda1e3b1421573d6bdfa 100644 (file)
--- a/src/FeaturesPlugin/doc/fillFeature.rst
+++ b/src/FeaturesPlugin/doc/fillFeature.rst
@@ -2,9 +2,41 @@
 Fill
 ====
 
+To a create boolean opration Fill in the active part:
+
+#. select in the Main Menu *Features - > Fill* item  or
+#. click **Fill** button in the toolbar
+
+.. image:: images/bool_fill.png
+   :align: center
+
+.. centered::
+   **Fill**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Fill.png
   :align: center
 
 .. centered::
-  Fill definition
+   **Fill operation**
+
+Here it is necessary to select main objects and tool objects.
+
+**Apply** button creates the fill shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addFill(Part_doc, mainObjects, toolObjects)*
+
+**Arguments**:   Part + list of main objects + list of tool objects.
+
+The Result of the operation will be a shape which is a fill of tool objects with main objects:
+
+.. image:: images/CreatedFill.png
+          :align: center
+
+.. centered::
+   **Fill created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_fill` operation.

diff --git a/src/FeaturesPlugin/doc/fuseFeature.rst b/src/FeaturesPlugin/doc/fuseFeature.rst
index 9944cfcc40c11cad26f59d626d5c383245a258c5..c6131a3360b14ca549165f0e6956fb263b721b16 100644 (file)
--- a/src/FeaturesPlugin/doc/fuseFeature.rst
+++ b/src/FeaturesPlugin/doc/fuseFeature.rst
@@ -2,9 +2,41 @@
 Fuse
 ====
 
+To a create boolean opration Fuse in the active part:
+
+#. select in the Main Menu *Features - > Fuse* item  or
+#. click **Fuse** button in the toolbar
+
+.. image:: images/bool_fuse.png
+   :align: center
+
+.. centered::
+   **Fuse**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Fuse.png
   :align: center
 
 .. centered::
-  Fuse definition
+  **Fuse operation**
+
+Here it is necessary to select main objects and tool objects.
+
+**Apply** button creates the fuse shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addFuse(Part_doc, mainObjects, toolObjects)*
+
+**Arguments**:   Part + list of main objects + list of tool objects.
+
+The Result of the operation will be a shape which is a fuse of tool objects with main objects:
+
+.. image:: images/CreatedFuse.png
+          :align: center
+
+.. centered::
+   **Fuse created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_fuse` operation.

diff --git a/src/FeaturesPlugin/doc/images/Common.png b/src/FeaturesPlugin/doc/images/Common.png
index a6abdef228037e733a1c542048f20a12df64eee7..99d43ae03697aa7959b964112e4bc84185e46ee1 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Common.png and b/src/FeaturesPlugin/doc/images/Common.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedCommon.png b/src/FeaturesPlugin/doc/images/CreatedCommon.png
new file mode 100644 (file)
index 0000000..7a4566d
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedCommon.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedCut.png b/src/FeaturesPlugin/doc/images/CreatedCut.png
new file mode 100644 (file)
index 0000000..e4d3777
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedCut.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedFill.png b/src/FeaturesPlugin/doc/images/CreatedFill.png
new file mode 100644 (file)
index 0000000..6ee9060
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedFill.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedFuse.png b/src/FeaturesPlugin/doc/images/CreatedFuse.png
new file mode 100644 (file)
index 0000000..424e315
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedFuse.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedIntersection.png b/src/FeaturesPlugin/doc/images/CreatedIntersection.png
new file mode 100644 (file)
index 0000000..e4d3fe9
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedIntersection.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedPartition.png b/src/FeaturesPlugin/doc/images/CreatedPartition.png
new file mode 100644 (file)
index 0000000..9c4d2be
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedPartition.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedPlacement.png b/src/FeaturesPlugin/doc/images/CreatedPlacement.png
new file mode 100644 (file)
index 0000000..e35e982
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedPlacement.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedSmash.png b/src/FeaturesPlugin/doc/images/CreatedSmash.png
new file mode 100644 (file)
index 0000000..db6e813
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedSmash.png differ

diff --git a/src/FeaturesPlugin/doc/images/CreatedUnion.png b/src/FeaturesPlugin/doc/images/CreatedUnion.png
new file mode 100644 (file)
index 0000000..760985a
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedUnion.png differ

diff --git a/src/FeaturesPlugin/doc/images/Cut.png b/src/FeaturesPlugin/doc/images/Cut.png
index 7f0f886d4416b9e74d8dd80cc821d1112f396bb8..16a798d38bbb7a22f514eeb1d956dac2081d4460 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Cut.png and b/src/FeaturesPlugin/doc/images/Cut.png differ

diff --git a/src/FeaturesPlugin/doc/images/Fill.png b/src/FeaturesPlugin/doc/images/Fill.png
index 377be10ab1250ea083171d5fe294a5be025d489a..75f1cbd214d24f1d5b009c4da626b7171d238dcc 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Fill.png and b/src/FeaturesPlugin/doc/images/Fill.png differ

diff --git a/src/FeaturesPlugin/doc/images/Fuse.png b/src/FeaturesPlugin/doc/images/Fuse.png
index f1495f2bffe4edafe0f0f37ca376d99c492cb8b6..25677dca71091c3a288f53306982317660b1bb58 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Fuse.png and b/src/FeaturesPlugin/doc/images/Fuse.png differ

diff --git a/src/FeaturesPlugin/doc/images/Intersection.png b/src/FeaturesPlugin/doc/images/Intersection.png
index 6bc0a43db458bc16df73cc0ed6b8f74924ca1d11..3d564d2e471f4306d48b8cf7ae9e8a96448a6d3d 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Intersection.png and b/src/FeaturesPlugin/doc/images/Intersection.png differ

diff --git a/src/FeaturesPlugin/doc/images/Partition.png b/src/FeaturesPlugin/doc/images/Partition.png
index 6e131f973a51ec75a6090f6b10626c3887b688be..10050b1d48c0dbbd34f9a36ca2ebdbb246ff2fd0 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Partition.png and b/src/FeaturesPlugin/doc/images/Partition.png differ

diff --git a/src/FeaturesPlugin/doc/images/Placement.png b/src/FeaturesPlugin/doc/images/Placement.png
index 4d5beb7c7f38e9abc5ed0f8f7211ffd077baf58f..da97d83718fbc8e3c6f2b4ffb2df2f9371343fa5 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Placement.png and b/src/FeaturesPlugin/doc/images/Placement.png differ

diff --git a/src/FeaturesPlugin/doc/images/Smash.png b/src/FeaturesPlugin/doc/images/Smash.png
index 8ec0ae6119ccff10e1454d8d5839c7351f429189..1bfbc40baa36f6cff1a4e51f3ddece2906b9c5f1 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Smash.png and b/src/FeaturesPlugin/doc/images/Smash.png differ

diff --git a/src/FeaturesPlugin/doc/images/Union.png b/src/FeaturesPlugin/doc/images/Union.png
index b45f8fd5048a919722deff04ee508f92cef3020d..940d31903d0c24541584b81e1a5c86d4d8a5f4d6 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Union.png and b/src/FeaturesPlugin/doc/images/Union.png differ

diff --git a/src/FeaturesPlugin/doc/images/bool_cut.png b/src/FeaturesPlugin/doc/images/bool_cut.png
new file mode 100644 (file)
index 0000000..8f52d3a
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/bool_cut.png differ

diff --git a/src/FeaturesPlugin/doc/images/bool_fill.png b/src/FeaturesPlugin/doc/images/bool_fill.png
new file mode 100644 (file)
index 0000000..5e03aa2
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/bool_fill.png differ

diff --git a/src/FeaturesPlugin/doc/images/bool_fuse.png b/src/FeaturesPlugin/doc/images/bool_fuse.png
new file mode 100644 (file)
index 0000000..b005af1
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/bool_fuse.png differ

diff --git a/src/FeaturesPlugin/doc/images/bool_smash.png b/src/FeaturesPlugin/doc/images/bool_smash.png
new file mode 100644 (file)
index 0000000..6a12a0a
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/bool_smash.png differ

diff --git a/src/FeaturesPlugin/doc/images/common_btn.png b/src/FeaturesPlugin/doc/images/common_btn.png
new file mode 100644 (file)
index 0000000..c8f86a1
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/common_btn.png differ

diff --git a/src/FeaturesPlugin/doc/images/intersection_btn.png b/src/FeaturesPlugin/doc/images/intersection_btn.png
new file mode 100644 (file)
index 0000000..bba96f4
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/intersection_btn.png differ

diff --git a/src/FeaturesPlugin/doc/images/partition_btn.png b/src/FeaturesPlugin/doc/images/partition_btn.png
new file mode 100755 (executable)
index 0000000..eb34d43
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/partition_btn.png differ

diff --git a/src/FeaturesPlugin/doc/images/placement_btn.png b/src/FeaturesPlugin/doc/images/placement_btn.png
new file mode 100644 (file)
index 0000000..c100a31
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/placement_btn.png differ

diff --git a/src/FeaturesPlugin/doc/images/union_btn.png b/src/FeaturesPlugin/doc/images/union_btn.png
new file mode 100644 (file)
index 0000000..268512c
Binary files /dev/null and b/src/FeaturesPlugin/doc/images/union_btn.png differ

diff --git a/src/FeaturesPlugin/doc/intersectionFeature.rst b/src/FeaturesPlugin/doc/intersectionFeature.rst
index 21e2be6f013b5543374469da88ba52b3a5880098..52580bc5c221e29d99bb66d2a0b02a98d04881c6 100644 (file)
--- a/src/FeaturesPlugin/doc/intersectionFeature.rst
+++ b/src/FeaturesPlugin/doc/intersectionFeature.rst
@@ -2,9 +2,41 @@
 Intersection
 ============
 
+To a create boolean opration Intersection in the active part:
+
+#. select in the Main Menu *Features - > Intersection* item  or
+#. click **Intersection** button in the toolbar
+
+.. image:: images/intersection_btn.png
+   :align: center
+
+.. centered::
+   **Intersection**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Intersection.png
   :align: center
 
 .. centered::
-  Intersection definition
+   **Intersection operation**
+
+Here it is necessary to select some objects.
+
+**Apply** button creates the intersection shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addIntersection(Part_doc, Objects)*
+
+**Arguments**:   Part + list of objects.
+
+The Result of the operation will be a shape which is an intersection of selected objects:
+
+.. image:: images/CreatedIntersection.png
+          :align: center
+
+.. centered::
+   **Intersection created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_intersection` operation.

diff --git a/src/FeaturesPlugin/doc/partitionFeature.rst b/src/FeaturesPlugin/doc/partitionFeature.rst
index 4b2ac1068d31504d9326bc449f73fbf0b9aaf65c..9a1b1e4b2379c1b428683215758ba566dfeaca3c 100644 (file)
--- a/src/FeaturesPlugin/doc/partitionFeature.rst
+++ b/src/FeaturesPlugin/doc/partitionFeature.rst
@@ -2,9 +2,41 @@
 Partition
 =========
 
+To a create boolean opration Partition in the active part:
+
+#. select in the Main Menu *Features - > Partition* item  or
+#. click **Partition** button in the toolbar
+
+.. image:: images/partition_btn.png
+   :align: center
+
+.. centered::
+   **Partition**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Partition.png
   :align: center
 
 .. centered::
-  Partition definition
+   **Partition operation**
+
+Here it is necessary to select several objects.
+
+**Apply** button creates the partition shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addPartition(Part_doc, objects)*
+
+**Arguments**:   Part + list of objects.
+
+The Result of the operation will be a shape which is a partition of selected objects:
+
+.. image:: images/CreatedPartition.png
+          :align: center
+
+.. centered::
+   **Partition created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_partition` operation.

diff --git a/src/FeaturesPlugin/doc/placementFeature.rst b/src/FeaturesPlugin/doc/placementFeature.rst
index bc45a835ebeb6ef35ca78a77850461c97bb9d239..6609bac59ca0e24c3b719256c231788ea5c6e319 100644 (file)
--- a/src/FeaturesPlugin/doc/placementFeature.rst
+++ b/src/FeaturesPlugin/doc/placementFeature.rst
@@ -2,9 +2,46 @@
 Placement
 =========
 
+Placement lets to place a one object relatively to another object. To make a placement:
+
+#. select in the Main Menu *Part - > Placement* item  or
+#. click **Placement** button in the toolbar
+
+.. image:: images/placement_btn.png
+   :align: center
+
+.. centered::
+   **Placement**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Placement.png
   :align: center
 
 .. centered::
-  Placement definition
+   **Placement operation**
+
+In this property panel it is necessary:
+- Select objects which will be moved.
+- Select a face, edge or vertex as a start for moving
+- Select a face, edge or vertex as an end of moving
+- Define state of **Reverse** and **Centering** check boxes.
+
+
+**Apply** button creates the placement.
+  
+**Cancel** button cancels the operation.
+
+**TUI Command**:  *model.addPlacement(Part_doc, placeObjects, startShape, endShape, isReverse, isCentering)*
+
+**Arguments**:   Part + list of objects to move + start shape + end shape + is reverse flag + is centering flag.
+
+The Result of the operation will be a new placement of selected objects:
+
+.. image:: images/CreatedPlacement.png
+          :align: center
+
+.. centered::
+   **Placement created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_placement` operation.

diff --git a/src/FeaturesPlugin/doc/smashFeature.rst b/src/FeaturesPlugin/doc/smashFeature.rst
index dbeb1642b7217e723ba071c33e719a5ed9f5ef68..364aa0aa6223133863af51b7e3b3029e4bd9b485 100644 (file)
--- a/src/FeaturesPlugin/doc/smashFeature.rst
+++ b/src/FeaturesPlugin/doc/smashFeature.rst
@@ -2,9 +2,41 @@
 Smash
 =====
 
+To a create boolean opration Smash in the active part:
+
+#. select in the Main Menu *Features - > Smash* item  or
+#. click **Smash** button in the toolbar
+
+.. image:: images/bool_smash.png
+   :align: center
+
+.. centered::
+   **Smash**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Smash.png
   :align: center
 
 .. centered::
-  Smash definition
+  **Smash operation**
+
+Here it is necessary to select main objects and tool objects.
+
+**Apply** button creates the smash shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addSmash(Part_doc, mainObjects, toolObjects)*
+
+**Arguments**:   Part + list of main objects + list of tool objects.
+
+The Result of the operation will be a shape which is a smash of tool objects from main objects:
+
+.. image:: images/CreatedSmash.png
+          :align: center
+
+.. centered::
+   **Smash created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_smash` operation.

diff --git a/src/FeaturesPlugin/doc/unionFeature.rst b/src/FeaturesPlugin/doc/unionFeature.rst
index 6e3d9a2b0c474682fb659a2e03ddd6eec2b9d37d..190d4b2fcfafda00c899b051dbce2acd23257c87 100644 (file)
--- a/src/FeaturesPlugin/doc/unionFeature.rst
+++ b/src/FeaturesPlugin/doc/unionFeature.rst
@@ -2,9 +2,41 @@
 Union
 =====
 
+To a create boolean opration Union in the active part:
+
+#. select in the Main Menu *Features - > Union* item  or
+#. click **Union** button in the toolbar
+
+.. image:: images/union_btn.png
+   :align: center
+
+.. centered::
+   **Union**  button 
+
+The following property panel will be opened:
 
 .. image:: images/Union.png
   :align: center
 
 .. centered::
-  Union definition
+   **Union operation**
+
+Here it is necessary to select some objects.
+
+**Apply** button creates the union shape.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addUnion(Part_doc, objects)*
+
+**Arguments**:   Part + list of objects.
+
+The Result of the operation will be a shape which is a union of selected objects:
+
+.. image:: images/CreatedUnion.png
+          :align: center
+
+.. centered::
+   **Union created**
+
+**See Also** a sample TUI Script of a :ref:`tui_create_union` operation.