From: Grigory ZHIVOTOVSKY Date: Fri, 17 Aug 2018 10:18:39 +0000 (+0300) Subject: Create Build/Vertex help page X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d8a24260383c9d63b7edab1f67a4d50e97768ba7;p=modules%2Fshaper.git Create Build/Vertex help page --- diff --git a/src/FeaturesPlugin/doc/FeaturesPlugin.rst b/src/FeaturesPlugin/doc/FeaturesPlugin.rst index 16bb3210f..57f9c8e10 100644 --- a/src/FeaturesPlugin/doc/FeaturesPlugin.rst +++ b/src/FeaturesPlugin/doc/FeaturesPlugin.rst @@ -1,16 +1,13 @@ .. _featuresPlugin: - Features plug-in ================ - .. toctree:: :titlesonly: :maxdepth: 1 - - angularCopyFeature.rst + commonFeature.rst cutFeature.rst extrusionCutFeature.rst @@ -19,20 +16,13 @@ Features plug-in fillFeature.rst filletFeature.rst fuseFeature.rst - intersectionFeature.rst - linearCopyFeature.rst - measurementFeature.rst + intersectionFeature.rst partitionFeature.rst - pipeFeature.rst - placementFeature.rst + pipeFeature.rst recoverFeature.rst removeSubShapesFeature.rst revolutionCutFeature.rst revolutionFeature.rst revolutionFuseFeature.rst - rotationFeature.rst - smashFeature.rst - symmetryFeature.rst - transformationFeature.rst - translationFeature.rst + smashFeature.rst unionFeature.rst diff --git a/src/FeaturesPlugin/doc/TUI_placementFeature.rst b/src/FeaturesPlugin/doc/TUI_placementFeature.rst deleted file mode 100644 index 4f46ec6dd..000000000 --- a/src/FeaturesPlugin/doc/TUI_placementFeature.rst +++ /dev/null @@ -1,12 +0,0 @@ - - .. _tui_create_placement: - -Create Placement -================ - -.. literalinclude:: examples/placement.py - :linenos: - :language: python - -:download:`Download this script ` - diff --git a/src/FeaturesPlugin/doc/angularCopyFeature.rst b/src/FeaturesPlugin/doc/angularCopyFeature.rst deleted file mode 100644 index 3d3fec12c..000000000 --- a/src/FeaturesPlugin/doc/angularCopyFeature.rst +++ /dev/null @@ -1,10 +0,0 @@ - -Angular copy -============ - - -.. image:: images/AngularCopy.png - :align: center - -.. centered:: - Angular copy definition diff --git a/src/FeaturesPlugin/doc/examples/placement.py b/src/FeaturesPlugin/doc/examples/placement.py deleted file mode 100644 index d74ab4d23..000000000 --- a/src/FeaturesPlugin/doc/examples/placement.py +++ /dev/null @@ -1,21 +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) -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/images/AngularCopy.png b/src/FeaturesPlugin/doc/images/AngularCopy.png deleted file mode 100644 index efa4d6eb8..000000000 Binary files a/src/FeaturesPlugin/doc/images/AngularCopy.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/CreatedPlacement.png b/src/FeaturesPlugin/doc/images/CreatedPlacement.png deleted file mode 100644 index e35e982b8..000000000 Binary files a/src/FeaturesPlugin/doc/images/CreatedPlacement.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/LinearCopy.png b/src/FeaturesPlugin/doc/images/LinearCopy.png deleted file mode 100644 index 1daa1ef9b..000000000 Binary files a/src/FeaturesPlugin/doc/images/LinearCopy.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Measurement1.png b/src/FeaturesPlugin/doc/images/Measurement1.png deleted file mode 100644 index 77b426e94..000000000 Binary files a/src/FeaturesPlugin/doc/images/Measurement1.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Measurement2.png b/src/FeaturesPlugin/doc/images/Measurement2.png deleted file mode 100644 index 5d951ae4d..000000000 Binary files a/src/FeaturesPlugin/doc/images/Measurement2.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Measurement3.png b/src/FeaturesPlugin/doc/images/Measurement3.png deleted file mode 100644 index b3f64ba14..000000000 Binary files a/src/FeaturesPlugin/doc/images/Measurement3.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Measurement4.png b/src/FeaturesPlugin/doc/images/Measurement4.png deleted file mode 100644 index b43c36a81..000000000 Binary files a/src/FeaturesPlugin/doc/images/Measurement4.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Measurement5.png b/src/FeaturesPlugin/doc/images/Measurement5.png deleted file mode 100644 index b5d860a01..000000000 Binary files a/src/FeaturesPlugin/doc/images/Measurement5.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Placement.png b/src/FeaturesPlugin/doc/images/Placement.png deleted file mode 100644 index da97d8371..000000000 Binary files a/src/FeaturesPlugin/doc/images/Placement.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Rotation1.png b/src/FeaturesPlugin/doc/images/Rotation1.png deleted file mode 100644 index 9549eeabf..000000000 Binary files a/src/FeaturesPlugin/doc/images/Rotation1.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Rotation2.png b/src/FeaturesPlugin/doc/images/Rotation2.png deleted file mode 100644 index 4b1224b51..000000000 Binary files a/src/FeaturesPlugin/doc/images/Rotation2.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Symmetry.png b/src/FeaturesPlugin/doc/images/Symmetry.png deleted file mode 100644 index a369a0f81..000000000 Binary files a/src/FeaturesPlugin/doc/images/Symmetry.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Translation1.png b/src/FeaturesPlugin/doc/images/Translation1.png deleted file mode 100644 index 3d1729564..000000000 Binary files a/src/FeaturesPlugin/doc/images/Translation1.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Translation2.png b/src/FeaturesPlugin/doc/images/Translation2.png deleted file mode 100644 index 8b367d1cb..000000000 Binary files a/src/FeaturesPlugin/doc/images/Translation2.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/Translation3.png b/src/FeaturesPlugin/doc/images/Translation3.png deleted file mode 100644 index 82cdb8d61..000000000 Binary files a/src/FeaturesPlugin/doc/images/Translation3.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/placement_btn.png b/src/FeaturesPlugin/doc/images/placement_btn.png deleted file mode 100644 index c100a3153..000000000 Binary files a/src/FeaturesPlugin/doc/images/placement_btn.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/linearCopyFeature.rst b/src/FeaturesPlugin/doc/linearCopyFeature.rst deleted file mode 100644 index 38509c3b9..000000000 --- a/src/FeaturesPlugin/doc/linearCopyFeature.rst +++ /dev/null @@ -1,10 +0,0 @@ - -Linear copy -=========== - - -.. image:: images/LinearCopy.png - :align: center - -.. centered:: - Linear copy diff --git a/src/FeaturesPlugin/doc/measurementFeature.rst b/src/FeaturesPlugin/doc/measurementFeature.rst deleted file mode 100644 index 9f999a097..000000000 --- a/src/FeaturesPlugin/doc/measurementFeature.rst +++ /dev/null @@ -1,42 +0,0 @@ - -Measurement -=========== - - -.. image:: images/Measurement1.png - :align: center - -.. centered:: - Edge length - - - -.. image:: images/Measurement2.png - :align: center - -.. centered:: - Distance between objects - - - -.. image:: images/Measurement3.png - :align: center - -.. centered:: - Radius - - - -.. image:: images/Measurement4.png - :align: center - -.. centered:: - Angle between edges - - - -.. image:: images/Measurement5.png - :align: center - -.. centered:: - Angle by 3 points diff --git a/src/FeaturesPlugin/doc/placementFeature.rst b/src/FeaturesPlugin/doc/placementFeature.rst deleted file mode 100644 index e213b9bdd..000000000 --- a/src/FeaturesPlugin/doc/placementFeature.rst +++ /dev/null @@ -1,52 +0,0 @@ - -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 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/rotationFeature.rst b/src/FeaturesPlugin/doc/rotationFeature.rst deleted file mode 100644 index ff0380d0c..000000000 --- a/src/FeaturesPlugin/doc/rotationFeature.rst +++ /dev/null @@ -1,17 +0,0 @@ - -Rotation -======== - - -.. image:: images/Rotation1.png - :align: center - -.. centered:: - Rotation by axis and angle - - -.. image:: images/Rotation2.png - :align: center - -.. centered:: - Rotation by center and points diff --git a/src/FeaturesPlugin/doc/symmetryFeature.rst b/src/FeaturesPlugin/doc/symmetryFeature.rst deleted file mode 100644 index dc8150c74..000000000 --- a/src/FeaturesPlugin/doc/symmetryFeature.rst +++ /dev/null @@ -1,10 +0,0 @@ - -Symmetry -======== - - -.. image:: images/Symmetry.png - :align: center - -.. centered:: - Symmetry definition diff --git a/src/FeaturesPlugin/doc/transformationFeature.rst b/src/FeaturesPlugin/doc/transformationFeature.rst deleted file mode 100644 index 5e8f204d7..000000000 --- a/src/FeaturesPlugin/doc/transformationFeature.rst +++ /dev/null @@ -1,17 +0,0 @@ - -Scale -===== - - -.. image:: images/Scale1.png - :align: center - -.. centered:: - Scale: define by a one common factor - - -.. image:: images/Scale2.png - :align: center - -.. centered:: - Scale: define by different factors diff --git a/src/FeaturesPlugin/doc/translationFeature.rst b/src/FeaturesPlugin/doc/translationFeature.rst deleted file mode 100644 index 99ce5db72..000000000 --- a/src/FeaturesPlugin/doc/translationFeature.rst +++ /dev/null @@ -1,24 +0,0 @@ - -Translation -=========== - - -.. image:: images/Translation1.png - :align: center - -.. centered:: - Translation by axis and distance - - -.. image:: images/Translation2.png - :align: center - -.. centered:: - By vector - - -.. image:: images/Translation3.png - :align: center - -.. centered:: - By two points diff --git a/src/PartSetPlugin/doc/TUI_placementFeature.rst b/src/PartSetPlugin/doc/TUI_placementFeature.rst new file mode 100644 index 000000000..4f46ec6dd --- /dev/null +++ b/src/PartSetPlugin/doc/TUI_placementFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_placement: + +Create Placement +================ + +.. literalinclude:: examples/placement.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/PartSetPlugin/doc/angularCopyFeature.rst b/src/PartSetPlugin/doc/angularCopyFeature.rst new file mode 100644 index 000000000..3d3fec12c --- /dev/null +++ b/src/PartSetPlugin/doc/angularCopyFeature.rst @@ -0,0 +1,10 @@ + +Angular copy +============ + + +.. image:: images/AngularCopy.png + :align: center + +.. centered:: + Angular copy definition diff --git a/src/PartSetPlugin/doc/examples/placement.py b/src/PartSetPlugin/doc/examples/placement.py new file mode 100644 index 000000000..d74ab4d23 --- /dev/null +++ b/src/PartSetPlugin/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/PartSetPlugin/doc/images/AngularCopy.png b/src/PartSetPlugin/doc/images/AngularCopy.png new file mode 100644 index 000000000..efa4d6eb8 Binary files /dev/null and b/src/PartSetPlugin/doc/images/AngularCopy.png differ diff --git a/src/PartSetPlugin/doc/images/CreatedPlacement.png b/src/PartSetPlugin/doc/images/CreatedPlacement.png new file mode 100644 index 000000000..e35e982b8 Binary files /dev/null and b/src/PartSetPlugin/doc/images/CreatedPlacement.png differ diff --git a/src/PartSetPlugin/doc/images/LinearCopy.png b/src/PartSetPlugin/doc/images/LinearCopy.png new file mode 100644 index 000000000..1daa1ef9b Binary files /dev/null and b/src/PartSetPlugin/doc/images/LinearCopy.png differ diff --git a/src/PartSetPlugin/doc/images/Measurement1.png b/src/PartSetPlugin/doc/images/Measurement1.png new file mode 100644 index 000000000..77b426e94 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Measurement1.png differ diff --git a/src/PartSetPlugin/doc/images/Measurement2.png b/src/PartSetPlugin/doc/images/Measurement2.png new file mode 100644 index 000000000..5d951ae4d Binary files /dev/null and b/src/PartSetPlugin/doc/images/Measurement2.png differ diff --git a/src/PartSetPlugin/doc/images/Measurement3.png b/src/PartSetPlugin/doc/images/Measurement3.png new file mode 100644 index 000000000..b3f64ba14 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Measurement3.png differ diff --git a/src/PartSetPlugin/doc/images/Measurement4.png b/src/PartSetPlugin/doc/images/Measurement4.png new file mode 100644 index 000000000..b43c36a81 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Measurement4.png differ diff --git a/src/PartSetPlugin/doc/images/Measurement5.png b/src/PartSetPlugin/doc/images/Measurement5.png new file mode 100644 index 000000000..b5d860a01 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Measurement5.png differ diff --git a/src/PartSetPlugin/doc/images/Placement.png b/src/PartSetPlugin/doc/images/Placement.png new file mode 100644 index 000000000..da97d8371 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Placement.png differ diff --git a/src/PartSetPlugin/doc/images/Rotation1.png b/src/PartSetPlugin/doc/images/Rotation1.png new file mode 100644 index 000000000..9549eeabf Binary files /dev/null and b/src/PartSetPlugin/doc/images/Rotation1.png differ diff --git a/src/PartSetPlugin/doc/images/Rotation2.png b/src/PartSetPlugin/doc/images/Rotation2.png new file mode 100644 index 000000000..4b1224b51 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Rotation2.png differ diff --git a/src/PartSetPlugin/doc/images/Symmetry.png b/src/PartSetPlugin/doc/images/Symmetry.png new file mode 100644 index 000000000..a369a0f81 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Symmetry.png differ diff --git a/src/PartSetPlugin/doc/images/Translation1.png b/src/PartSetPlugin/doc/images/Translation1.png new file mode 100644 index 000000000..3d1729564 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Translation1.png differ diff --git a/src/PartSetPlugin/doc/images/Translation2.png b/src/PartSetPlugin/doc/images/Translation2.png new file mode 100644 index 000000000..8b367d1cb Binary files /dev/null and b/src/PartSetPlugin/doc/images/Translation2.png differ diff --git a/src/PartSetPlugin/doc/images/Translation3.png b/src/PartSetPlugin/doc/images/Translation3.png new file mode 100644 index 000000000..82cdb8d61 Binary files /dev/null and b/src/PartSetPlugin/doc/images/Translation3.png differ diff --git a/src/PartSetPlugin/doc/images/placement_btn.png b/src/PartSetPlugin/doc/images/placement_btn.png new file mode 100644 index 000000000..c100a3153 Binary files /dev/null and b/src/PartSetPlugin/doc/images/placement_btn.png differ diff --git a/src/PartSetPlugin/doc/linearCopyFeature.rst b/src/PartSetPlugin/doc/linearCopyFeature.rst new file mode 100644 index 000000000..38509c3b9 --- /dev/null +++ b/src/PartSetPlugin/doc/linearCopyFeature.rst @@ -0,0 +1,10 @@ + +Linear copy +=========== + + +.. image:: images/LinearCopy.png + :align: center + +.. centered:: + Linear copy diff --git a/src/PartSetPlugin/doc/measurementFeature.rst b/src/PartSetPlugin/doc/measurementFeature.rst new file mode 100644 index 000000000..9f999a097 --- /dev/null +++ b/src/PartSetPlugin/doc/measurementFeature.rst @@ -0,0 +1,42 @@ + +Measurement +=========== + + +.. image:: images/Measurement1.png + :align: center + +.. centered:: + Edge length + + + +.. image:: images/Measurement2.png + :align: center + +.. centered:: + Distance between objects + + + +.. image:: images/Measurement3.png + :align: center + +.. centered:: + Radius + + + +.. image:: images/Measurement4.png + :align: center + +.. centered:: + Angle between edges + + + +.. image:: images/Measurement5.png + :align: center + +.. centered:: + Angle by 3 points diff --git a/src/PartSetPlugin/doc/placementFeature.rst b/src/PartSetPlugin/doc/placementFeature.rst new file mode 100644 index 000000000..e213b9bdd --- /dev/null +++ b/src/PartSetPlugin/doc/placementFeature.rst @@ -0,0 +1,52 @@ + +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 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/PartSetPlugin/doc/rotationFeature.rst b/src/PartSetPlugin/doc/rotationFeature.rst new file mode 100644 index 000000000..ff0380d0c --- /dev/null +++ b/src/PartSetPlugin/doc/rotationFeature.rst @@ -0,0 +1,17 @@ + +Rotation +======== + + +.. image:: images/Rotation1.png + :align: center + +.. centered:: + Rotation by axis and angle + + +.. image:: images/Rotation2.png + :align: center + +.. centered:: + Rotation by center and points diff --git a/src/PartSetPlugin/doc/symmetryFeature.rst b/src/PartSetPlugin/doc/symmetryFeature.rst new file mode 100644 index 000000000..dc8150c74 --- /dev/null +++ b/src/PartSetPlugin/doc/symmetryFeature.rst @@ -0,0 +1,10 @@ + +Symmetry +======== + + +.. image:: images/Symmetry.png + :align: center + +.. centered:: + Symmetry definition diff --git a/src/PartSetPlugin/doc/transformationFeature.rst b/src/PartSetPlugin/doc/transformationFeature.rst new file mode 100644 index 000000000..5e8f204d7 --- /dev/null +++ b/src/PartSetPlugin/doc/transformationFeature.rst @@ -0,0 +1,17 @@ + +Scale +===== + + +.. image:: images/Scale1.png + :align: center + +.. centered:: + Scale: define by a one common factor + + +.. image:: images/Scale2.png + :align: center + +.. centered:: + Scale: define by different factors diff --git a/src/PartSetPlugin/doc/translationFeature.rst b/src/PartSetPlugin/doc/translationFeature.rst new file mode 100644 index 000000000..99ce5db72 --- /dev/null +++ b/src/PartSetPlugin/doc/translationFeature.rst @@ -0,0 +1,24 @@ + +Translation +=========== + + +.. image:: images/Translation1.png + :align: center + +.. centered:: + Translation by axis and distance + + +.. image:: images/Translation2.png + :align: center + +.. centered:: + By vector + + +.. image:: images/Translation3.png + :align: center + +.. centered:: + By two points