]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Create Build plugin help pages
authorvsv <vsv@opencascade.com>
Tue, 14 Aug 2018 15:44:29 +0000 (18:44 +0300)
committervsv <vsv@opencascade.com>
Tue, 14 Aug 2018 15:44:29 +0000 (18:44 +0300)
30 files changed:
src/BuildPlugin/doc/TUI_compoundFeature.rst [new file with mode: 0644]
src/BuildPlugin/doc/TUI_compsolidFeature.rst [new file with mode: 0644]
src/BuildPlugin/doc/TUI_fillingFeature.rst [new file with mode: 0644]
src/BuildPlugin/doc/TUI_interpolationFeature.rst [new file with mode: 0644]
src/BuildPlugin/doc/compoundFeature.rst
src/BuildPlugin/doc/compsolidFeature.rst
src/BuildPlugin/doc/edgeFeature.rst
src/BuildPlugin/doc/examples/compound.py [new file with mode: 0644]
src/BuildPlugin/doc/examples/compsolid.py [new file with mode: 0644]
src/BuildPlugin/doc/examples/filling.py [new file with mode: 0644]
src/BuildPlugin/doc/examples/interpolation.py [new file with mode: 0644]
src/BuildPlugin/doc/faceFeature.rst
src/BuildPlugin/doc/fillingFeature.rst
src/BuildPlugin/doc/images/Compound.png
src/BuildPlugin/doc/images/Compsolid.png
src/BuildPlugin/doc/images/CreateCompound.png [new file with mode: 0644]
src/BuildPlugin/doc/images/CreateCompsolid.png [new file with mode: 0644]
src/BuildPlugin/doc/images/CreateFilling.png [new file with mode: 0644]
src/BuildPlugin/doc/images/CreateInterpolation.png [new file with mode: 0644]
src/BuildPlugin/doc/images/Filling.png
src/BuildPlugin/doc/images/Interpolation.png
src/BuildPlugin/doc/images/feature_compound.png [new file with mode: 0644]
src/BuildPlugin/doc/images/feature_compsolid.png [new file with mode: 0644]
src/BuildPlugin/doc/images/feature_filling.png [new file with mode: 0644]
src/BuildPlugin/doc/images/feature_interpolation.png [new file with mode: 0644]
src/BuildPlugin/doc/interpolationFeature.rst
src/BuildPlugin/doc/shellFeature.rst
src/BuildPlugin/doc/solidFeature.rst
src/BuildPlugin/doc/vertexFeature.rst
src/BuildPlugin/doc/wireFeature.rst

diff --git a/src/BuildPlugin/doc/TUI_compoundFeature.rst b/src/BuildPlugin/doc/TUI_compoundFeature.rst
new file mode 100644 (file)
index 0000000..22d29f8
--- /dev/null
@@ -0,0 +1,12 @@
+
+  .. _tui_create_compound:
+
+Create Compound
+===============
+
+.. literalinclude:: examples/compound.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/compound.py>` 
+   
diff --git a/src/BuildPlugin/doc/TUI_compsolidFeature.rst b/src/BuildPlugin/doc/TUI_compsolidFeature.rst
new file mode 100644 (file)
index 0000000..ce9307b
--- /dev/null
@@ -0,0 +1,12 @@
+
+  .. _tui_create_compsolid:
+
+Create CompSolid
+================
+
+.. literalinclude:: examples/compsolid.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/compsolid.py>` 
+   
diff --git a/src/BuildPlugin/doc/TUI_fillingFeature.rst b/src/BuildPlugin/doc/TUI_fillingFeature.rst
new file mode 100644 (file)
index 0000000..751bafb
--- /dev/null
@@ -0,0 +1,12 @@
+
+  .. _tui_create_filling:
+
+Create Filling
+==============
+
+.. literalinclude:: examples/filling.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/filling.py>` 
+   
diff --git a/src/BuildPlugin/doc/TUI_interpolationFeature.rst b/src/BuildPlugin/doc/TUI_interpolationFeature.rst
new file mode 100644 (file)
index 0000000..cfcaf78
--- /dev/null
@@ -0,0 +1,12 @@
+
+  .. _tui_create_interpolation:
+
+Create Interpolation
+====================
+
+.. literalinclude:: examples/interpolation.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/interpolation.py>` 
+   
index 3a5850f004f9bca16efc67de4ebebe8edfa345be..b3b535630789d46a32f9ae940ca2a583e0811d60 100644 (file)
@@ -2,10 +2,41 @@
 Compound
 ========
 
-The feature lets to create
+To create compound in the active part:
+
+#. select in the Main Menu *Build - > Compound* item  or
+#. click **Compound** button in the toolbar
+
+.. image:: images/feature_compound.png
+  :align: center
+
+.. centered::
+  **Compound** button
+
+The following property panel will be opened:
 
 .. image:: images/Compound.png
   :align: center
 
 .. centered::
   Create a compound
+
+Select one or several shapes in a viewer. Selected shapes can be of any type (vertex, edge, face and so on).
+
+**Apply** button creates compound.
+
+**Cancel** button cancels operation. 
+
+**TUI Command**:  *model.addCompound(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
+The result of the operation will be a compound created from selected shapes:
+
+.. image:: images/CreateCompound.png
+  :align: center
+
+.. centered::
+  Result of the operation.
+
+**See Also** a sample TUI Script of a :ref:`tui_create_compound` operation.
index 59428f615642f7802ebdf032388e49dca83d6282..2688bf0d1618ef28cc9862ff292181552efbbff3 100644 (file)
@@ -2,9 +2,41 @@
 CompSolid
 =========
 
+To create compsolid in the active part:
+
+#. select in the Main Menu *Build - > CompSolid* item  or
+#. click **CompSolid** button in the toolbar
+
+.. image:: images/feature_compsolid.png
+  :align: center
+
+.. centered::
+  **CompSolid** button
+
+The following property panel will be opened:
 
 .. image:: images/Compsolid.png
   :align: center
 
 .. centered::
   Create a compsolid
+
+Select one or several shapes in a viewer.
+
+**Apply** button creates compsolid.
+
+**Cancel** button cancels operation. 
+
+**TUI Command**:  *model.addCompSolid(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
+The result of the operation will be a compsolid created from the selected shapes:
+
+.. image:: images/CreateCompsolid.png
+  :align: center
+
+.. centered::
+  Result of the operation.
+
+**See Also** a sample TUI Script of a :ref:`tui_create_compsolid` operation.
index b16c72b1921e6ab1a2466804bceaf17fbfe2990e..c524f3fb78318d85150af779accf51813e04fb19 100644 (file)
@@ -27,7 +27,11 @@ Select one or several edges in viewer.
 
 **Cancel** button cancels operation. 
 
-The result of the operation will be set of vertices created from selected shapes:
+**TUI Command**:  *model.addEdge(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
+The result of the operation will be set of edges created from selected shapes:
 
 .. image:: images/CreateEdge.png
   :align: center
diff --git a/src/BuildPlugin/doc/examples/compound.py b/src/BuildPlugin/doc/examples/compound.py
new file mode 100644 (file)
index 0000000..0394678
--- /dev/null
@@ -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)
+Compound_1_objects = [model.selection("FACE", "Box_1_1/Front"),
+                      model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"),
+                      model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top"),
+                      model.selection("EDGE", "Box_1_1/Back&Box_1_1/Top")]
+Compound_1 = model.addCompound(Part_1_doc, Compound_1_objects)
+model.do()
+model.end()
diff --git a/src/BuildPlugin/doc/examples/compsolid.py b/src/BuildPlugin/doc/examples/compsolid.py
new file mode 100644 (file)
index 0000000..87234f1
--- /dev/null
@@ -0,0 +1,12 @@
+# -*- 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)
+CompSolid_1 = model.addCompSolid(Part_1_doc, [model.selection("SOLID", "Box_1_1")])
+model.do()
+model.end()
diff --git a/src/BuildPlugin/doc/examples/filling.py b/src/BuildPlugin/doc/examples/filling.py
new file mode 100644 (file)
index 0000000..d912bd3
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- 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)
+Edges = [model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"),
+         model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top")]
+Filling_1 = model.addFilling(Part_1_doc, Edges)
+model.do()
+model.end()
diff --git a/src/BuildPlugin/doc/examples/interpolation.py b/src/BuildPlugin/doc/examples/interpolation.py
new file mode 100644 (file)
index 0000000..be911ea
--- /dev/null
@@ -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)
+Interpolation_1_objects = [model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"),
+                           model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top"),
+                           model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Top"),
+                           model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top")]
+Interpolation_1 = model.addInterpolation(Part_1_doc, Interpolation_1_objects, True, False)
+model.do()
+model.end()
index 0eb6c65e1cfadaf74c5cd2d66b17c348a2925894..a2e16e0628541b5104131f834b4f555934e7f04e 100644 (file)
@@ -27,6 +27,10 @@ Select one or several faces in viewer.
 
 **Cancel** button cancels operation. 
 
+**TUI Command**:  *model.addFace(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
 The result of the operation will be set of faces created from selected shapes:
 
 .. image:: images/CreateFace.png
index 5e5fc91826151d7e9fba27d7d13b13ccaf71c8b3..175ef837959ba955eda19cd3b5307664a709eebc 100644 (file)
@@ -1,10 +1,44 @@
 
- Filling
- =======
+Filling
+=======
 
+To create filling in the active part:
+
+#. select in the Main Menu *Build - > Filling* item  or
+#. click **Filling** button in the toolbar
+
+.. image:: images/feature_filling.png
+  :align: center
+
+.. centered::
+  **Filling** button
+
+The following property panel will be opened:
 
 .. image:: images/Filling.png
   :align: center
 
 .. centered::
   Create a filling
+
+Select two or more edges in a viewer.
+
+**Advanced options** lets to manage filling process.
+
+**Apply** button creates a filling.
+
+**Cancel** button cancels operation.
+
+**TUI Command**:  *model.addFilling(Part_doc, Edges)*
+
+**Arguments**:   Part document + list of edges.
+
+The result of the operation will be set of faces created from selected shapes:
+
+.. image:: images/CreateFilling.png
+  :align: center
+
+.. centered::
+  Result of the operation.
+
+**See Also** a sample TUI Script of a :ref:`tui_create_filling` operation.
index a4987cbfe7dc612c1eda9452cc3f50262539e989..800c1bd34d11be57a3cc71e15a8d3cbbb45316e1 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Compound.png and b/src/BuildPlugin/doc/images/Compound.png differ
index 5022977220df7558143a0370e1b2e835f7badac2..71b68c49188478a17d97f4dd71a17aca85d48ea0 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Compsolid.png and b/src/BuildPlugin/doc/images/Compsolid.png differ
diff --git a/src/BuildPlugin/doc/images/CreateCompound.png b/src/BuildPlugin/doc/images/CreateCompound.png
new file mode 100644 (file)
index 0000000..41f9066
Binary files /dev/null and b/src/BuildPlugin/doc/images/CreateCompound.png differ
diff --git a/src/BuildPlugin/doc/images/CreateCompsolid.png b/src/BuildPlugin/doc/images/CreateCompsolid.png
new file mode 100644 (file)
index 0000000..ffb2894
Binary files /dev/null and b/src/BuildPlugin/doc/images/CreateCompsolid.png differ
diff --git a/src/BuildPlugin/doc/images/CreateFilling.png b/src/BuildPlugin/doc/images/CreateFilling.png
new file mode 100644 (file)
index 0000000..927973c
Binary files /dev/null and b/src/BuildPlugin/doc/images/CreateFilling.png differ
diff --git a/src/BuildPlugin/doc/images/CreateInterpolation.png b/src/BuildPlugin/doc/images/CreateInterpolation.png
new file mode 100644 (file)
index 0000000..40d4456
Binary files /dev/null and b/src/BuildPlugin/doc/images/CreateInterpolation.png differ
index 6bb76e55efd660db217bfe8c4d48f42056a842e1..2e79123265eb84f8625de82b24911ace5af4c54f 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Filling.png and b/src/BuildPlugin/doc/images/Filling.png differ
index 1335ae6e0b0e7f42bdf6eefbe474b9a995e2f1d6..c7a41627c4f293877c031a77f4bbdf694db60e7f 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Interpolation.png and b/src/BuildPlugin/doc/images/Interpolation.png differ
diff --git a/src/BuildPlugin/doc/images/feature_compound.png b/src/BuildPlugin/doc/images/feature_compound.png
new file mode 100644 (file)
index 0000000..800dc6f
Binary files /dev/null and b/src/BuildPlugin/doc/images/feature_compound.png differ
diff --git a/src/BuildPlugin/doc/images/feature_compsolid.png b/src/BuildPlugin/doc/images/feature_compsolid.png
new file mode 100644 (file)
index 0000000..6fdf0db
Binary files /dev/null and b/src/BuildPlugin/doc/images/feature_compsolid.png differ
diff --git a/src/BuildPlugin/doc/images/feature_filling.png b/src/BuildPlugin/doc/images/feature_filling.png
new file mode 100644 (file)
index 0000000..e8a46f6
Binary files /dev/null and b/src/BuildPlugin/doc/images/feature_filling.png differ
diff --git a/src/BuildPlugin/doc/images/feature_interpolation.png b/src/BuildPlugin/doc/images/feature_interpolation.png
new file mode 100644 (file)
index 0000000..9f1e3ad
Binary files /dev/null and b/src/BuildPlugin/doc/images/feature_interpolation.png differ
index 377bc0ad44d42cd2113bd8a604613f2dab925035..98885782a3d275c30d4db5580ff08a9315753d56 100644 (file)
@@ -2,9 +2,53 @@
 Interpolation
 =============
 
+To create interpolation in the active part:
+
+#. select in the Main Menu *Build - > Interpolation* item  or
+#. click **Interpolation** button in the toolbar
+
+.. image:: images/feature_interpolation.png
+  :align: center
+
+.. centered::
+  **Interpolation** button
+
+The following property panel will be opened:
 
 .. image:: images/Interpolation.png
   :align: center
 
 .. centered::
   Create an interpolation
+
+Select one or several vertices or points in a viewer.
+
+- **Closed** makes the interpolation curve closed.
+
+- **Reorder** reorders selected points to minimize length of the curve.
+
+- **Tangents** makes start and end of the curve tangent to selected edges. User has to select edges for start and end in corresponded fields.
+
+**Apply** button creates an interpolation.
+
+**Cancel** button cancels operation. 
+
+**TUI Command**:
+
+- *model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)*.
+
+**Arguments**:   Part document + list of points + is closed + is reordered.
+
+- *model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)*.
+
+**Arguments**:   Part document + list of points + start edge + end edge + is closed + is reordered.
+
+The result of the operation will be a curve created from selected shapes:
+
+.. image:: images/CreateInterpolation.png
+  :align: center
+
+.. centered::
+  Result of the operation.
+
+**See Also** a sample TUI Script of a :ref:`tui_create_interpolation` operation.
index c7bff096603a6d130cf348d3d95fb152579eb966..18d40fd74e4a76930115de77e95d2e35ff327d9f 100644 (file)
@@ -27,6 +27,10 @@ Select one or several faces in viewer.
 
 **Cancel** button cancels operation. 
 
+**TUI Command**:  *model.addShell(Part_doc, Objects)*
+
+**Arguments**:   Part document + list of shapes.
+
 The result of the operation will be shell created from selected shapes:
 
 .. image:: images/CreateShell.png
index 41d55300a87429e69f9f407e3109237822b42447..193491a7bdae3486283569b1907e1c09ccfd80df 100644 (file)
@@ -27,6 +27,10 @@ Select one or several faces in viewer. Selected faces have to define a closed vo
 
 **Cancel** button cancels operation. 
 
+**TUI Command**:  *model.addSolid(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
 The result of the operation will be a solid created from selected shapes:
 
 .. image:: images/CreateSolid.png
index e314d3c4ca71d8092a40e8d45b604f921f15197a..0ce4412911c4dfd27196ed6d744155a1538dc7b1 100644 (file)
@@ -27,6 +27,10 @@ Select one or several vertices in viewer.
 
 **Cancel** button cancels operation. 
 
+**TUI Command**:  *model.addVertex(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
 The result of the operation will be set of vertices created from selected shapes:
 
 .. image:: images/CreateVertex.png
index 17c560910ee7c1218f10d89648f7c8d339499f3f..6f3a6d32efa7de40bbcd621d8fe5e358b7a9ee10 100644 (file)
@@ -27,6 +27,10 @@ Select one or several edges in viewer. For automatic selection of closed contour
 
 **Cancel** button cancels operation. 
 
+**TUI Command**:  *model.addWire(Part_doc, Shapes)*
+
+**Arguments**:   Part document + list of shapes.
+
 The result of the operation will be a wire created from selected shapes:
 
 .. image:: images/CreateWire.png