From: vsv Date: Tue, 14 Aug 2018 15:44:29 +0000 (+0300) Subject: Create Build plugin help pages X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=27bb4eee56421ac90f03509bfdf31961f70f4534;p=modules%2Fshaper.git Create Build plugin help pages --- diff --git a/src/BuildPlugin/doc/TUI_compoundFeature.rst b/src/BuildPlugin/doc/TUI_compoundFeature.rst new file mode 100644 index 000000000..22d29f8e8 --- /dev/null +++ b/src/BuildPlugin/doc/TUI_compoundFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_compound: + +Create Compound +=============== + +.. literalinclude:: examples/compound.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/BuildPlugin/doc/TUI_compsolidFeature.rst b/src/BuildPlugin/doc/TUI_compsolidFeature.rst new file mode 100644 index 000000000..ce9307bb8 --- /dev/null +++ b/src/BuildPlugin/doc/TUI_compsolidFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_compsolid: + +Create CompSolid +================ + +.. literalinclude:: examples/compsolid.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/BuildPlugin/doc/TUI_fillingFeature.rst b/src/BuildPlugin/doc/TUI_fillingFeature.rst new file mode 100644 index 000000000..751bafb94 --- /dev/null +++ b/src/BuildPlugin/doc/TUI_fillingFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_filling: + +Create Filling +============== + +.. literalinclude:: examples/filling.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/BuildPlugin/doc/TUI_interpolationFeature.rst b/src/BuildPlugin/doc/TUI_interpolationFeature.rst new file mode 100644 index 000000000..cfcaf78bd --- /dev/null +++ b/src/BuildPlugin/doc/TUI_interpolationFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_interpolation: + +Create Interpolation +==================== + +.. literalinclude:: examples/interpolation.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/BuildPlugin/doc/compoundFeature.rst b/src/BuildPlugin/doc/compoundFeature.rst index 3a5850f00..b3b535630 100644 --- a/src/BuildPlugin/doc/compoundFeature.rst +++ b/src/BuildPlugin/doc/compoundFeature.rst @@ -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. diff --git a/src/BuildPlugin/doc/compsolidFeature.rst b/src/BuildPlugin/doc/compsolidFeature.rst index 59428f615..2688bf0d1 100644 --- a/src/BuildPlugin/doc/compsolidFeature.rst +++ b/src/BuildPlugin/doc/compsolidFeature.rst @@ -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. diff --git a/src/BuildPlugin/doc/edgeFeature.rst b/src/BuildPlugin/doc/edgeFeature.rst index b16c72b19..c524f3fb7 100644 --- a/src/BuildPlugin/doc/edgeFeature.rst +++ b/src/BuildPlugin/doc/edgeFeature.rst @@ -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 index 000000000..0394678d5 --- /dev/null +++ b/src/BuildPlugin/doc/examples/compound.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) +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 index 000000000..87234f13a --- /dev/null +++ b/src/BuildPlugin/doc/examples/compsolid.py @@ -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 index 000000000..d912bd387 --- /dev/null +++ b/src/BuildPlugin/doc/examples/filling.py @@ -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 index 000000000..be911ea94 --- /dev/null +++ b/src/BuildPlugin/doc/examples/interpolation.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) +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() diff --git a/src/BuildPlugin/doc/faceFeature.rst b/src/BuildPlugin/doc/faceFeature.rst index 0eb6c65e1..a2e16e062 100644 --- a/src/BuildPlugin/doc/faceFeature.rst +++ b/src/BuildPlugin/doc/faceFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/fillingFeature.rst b/src/BuildPlugin/doc/fillingFeature.rst index 5e5fc9182..175ef8379 100644 --- a/src/BuildPlugin/doc/fillingFeature.rst +++ b/src/BuildPlugin/doc/fillingFeature.rst @@ -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. diff --git a/src/BuildPlugin/doc/images/Compound.png b/src/BuildPlugin/doc/images/Compound.png index a4987cbfe..800c1bd34 100644 Binary files a/src/BuildPlugin/doc/images/Compound.png and b/src/BuildPlugin/doc/images/Compound.png differ diff --git a/src/BuildPlugin/doc/images/Compsolid.png b/src/BuildPlugin/doc/images/Compsolid.png index 502297722..71b68c491 100644 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 index 000000000..41f9066db 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 index 000000000..ffb289418 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 index 000000000..927973c03 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 index 000000000..40d4456f5 Binary files /dev/null and b/src/BuildPlugin/doc/images/CreateInterpolation.png differ diff --git a/src/BuildPlugin/doc/images/Filling.png b/src/BuildPlugin/doc/images/Filling.png index 6bb76e55e..2e7912326 100644 Binary files a/src/BuildPlugin/doc/images/Filling.png and b/src/BuildPlugin/doc/images/Filling.png differ diff --git a/src/BuildPlugin/doc/images/Interpolation.png b/src/BuildPlugin/doc/images/Interpolation.png index 1335ae6e0..c7a41627c 100644 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 index 000000000..800dc6f52 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 index 000000000..6fdf0dbf3 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 index 000000000..e8a46f662 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 index 000000000..9f1e3adff Binary files /dev/null and b/src/BuildPlugin/doc/images/feature_interpolation.png differ diff --git a/src/BuildPlugin/doc/interpolationFeature.rst b/src/BuildPlugin/doc/interpolationFeature.rst index 377bc0ad4..98885782a 100644 --- a/src/BuildPlugin/doc/interpolationFeature.rst +++ b/src/BuildPlugin/doc/interpolationFeature.rst @@ -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. diff --git a/src/BuildPlugin/doc/shellFeature.rst b/src/BuildPlugin/doc/shellFeature.rst index c7bff0966..18d40fd74 100644 --- a/src/BuildPlugin/doc/shellFeature.rst +++ b/src/BuildPlugin/doc/shellFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/solidFeature.rst b/src/BuildPlugin/doc/solidFeature.rst index 41d55300a..193491a7b 100644 --- a/src/BuildPlugin/doc/solidFeature.rst +++ b/src/BuildPlugin/doc/solidFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/vertexFeature.rst b/src/BuildPlugin/doc/vertexFeature.rst index e314d3c4c..0ce441291 100644 --- a/src/BuildPlugin/doc/vertexFeature.rst +++ b/src/BuildPlugin/doc/vertexFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/wireFeature.rst b/src/BuildPlugin/doc/wireFeature.rst index 17c560910..6f3a6d32e 100644 --- a/src/BuildPlugin/doc/wireFeature.rst +++ b/src/BuildPlugin/doc/wireFeature.rst @@ -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