From: vsv Date: Tue, 4 Sep 2018 14:10:43 +0000 (+0300) Subject: Modification of plugins documentation X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f9b1cf46e819f323a9e97487a950c212fb648c9b;p=modules%2Fshaper.git Modification of plugins documentation --- diff --git a/src/ExchangePlugin/doc/ExchangePlugin.rst b/src/ExchangePlugin/doc/ExchangePlugin.rst index 55bb7b674..518008f09 100644 --- a/src/ExchangePlugin/doc/ExchangePlugin.rst +++ b/src/ExchangePlugin/doc/ExchangePlugin.rst @@ -4,6 +4,8 @@ Exchange plug-in ================ +Exchange plug-in implements features for data exchange. It provides following: + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/src/ExchangePlugin/doc/dumpFeature.rst b/src/ExchangePlugin/doc/dumpFeature.rst index 3bb2969cd..ab68b076c 100644 --- a/src/ExchangePlugin/doc/dumpFeature.rst +++ b/src/ExchangePlugin/doc/dumpFeature.rst @@ -2,6 +2,8 @@ Dump ==== +The feature Dump allows to export a current study to a Python script wich dumps process of creation of the study as a sequence of Python commands. + It is possible to dump current study state into a Python script. To dump a study: #. select in the Main Menu *Part - > Dump* item or @@ -35,4 +37,7 @@ In this panel it is necessary to enter a file name directly into input field or **TUI Command**: Is not supported. +Result +"""""" + The Result of the operation is a Python file. diff --git a/src/ExchangePlugin/doc/exportFeature.rst b/src/ExchangePlugin/doc/exportFeature.rst index 8c91ee5b0..922d0d618 100644 --- a/src/ExchangePlugin/doc/exportFeature.rst +++ b/src/ExchangePlugin/doc/exportFeature.rst @@ -2,6 +2,8 @@ Export ====== +The feature export allows to export objects from the current study to an external file. + It is possible to export objects into files in following formats: BREP, STEP, IGES, XAO. To export objects to a file: #. select in the Main Menu *Part - > Export* item or @@ -39,6 +41,9 @@ Selection list in property panel should contain a list of exporting objects whic **Arguments**: Part + file name string + list of objects. +Result +"""""" + The Result of operation is exported file. There are no any changes in object browser or viewer. **See Also** a sample TUI Script of a :ref:`tui_export_file` operation. diff --git a/src/ExchangePlugin/doc/images/Export_panel.png b/src/ExchangePlugin/doc/images/Export_panel.png index d6e0274c9..7062e94ff 100644 Binary files a/src/ExchangePlugin/doc/images/Export_panel.png and b/src/ExchangePlugin/doc/images/Export_panel.png differ diff --git a/src/ExchangePlugin/doc/images/FileImported.png b/src/ExchangePlugin/doc/images/FileImported.png index b0af4536f..e7e3b07c1 100644 Binary files a/src/ExchangePlugin/doc/images/FileImported.png and b/src/ExchangePlugin/doc/images/FileImported.png differ diff --git a/src/ExchangePlugin/doc/importFeature.rst b/src/ExchangePlugin/doc/importFeature.rst index 0577b49b9..c1c604d7e 100644 --- a/src/ExchangePlugin/doc/importFeature.rst +++ b/src/ExchangePlugin/doc/importFeature.rst @@ -2,6 +2,8 @@ Import ====== +The feature Import allows to import an external file into a current study. + It is possible to import files in following formats: BREP, STEP, IGES, XAO. To import a file into active part: #. select in the Main Menu *Part - > Import* item or @@ -37,6 +39,9 @@ In this panel it is possible to enter a file name directly into input field or p **Arguments**: Part + file name string. +Result +"""""" + The Result of the operation depends on content of imported file. .. image:: images/FileImported.png diff --git a/src/FeaturesPlugin/doc/FeaturesPlugin.rst b/src/FeaturesPlugin/doc/FeaturesPlugin.rst index c9e95313f..b4a9e292a 100644 --- a/src/FeaturesPlugin/doc/FeaturesPlugin.rst +++ b/src/FeaturesPlugin/doc/FeaturesPlugin.rst @@ -4,6 +4,8 @@ Features plug-in ================ +Features plug-in implements a set of common topological operations. It implements following features: + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/src/FeaturesPlugin/doc/commonFeature.rst b/src/FeaturesPlugin/doc/commonFeature.rst index d4f4e72fa..7324955eb 100644 --- a/src/FeaturesPlugin/doc/commonFeature.rst +++ b/src/FeaturesPlugin/doc/commonFeature.rst @@ -2,6 +2,8 @@ Common ====== +The feature Common implements a boolean operation for extraction of a common part from a set of selected shapes. + To perform a boolean opration Common in the active part: #. select in the Main Menu *Features - > Common* item or @@ -29,6 +31,9 @@ The following property panel will be opened: **Arguments**: Part + list of main objects + list of tool objects. +Result +"""""" + The Result of the operation will be a shape which is a common for all selected shapes: .. image:: images/CreatedCommon.png diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst index 07f77f07e..053bfa3a8 100644 --- a/src/FeaturesPlugin/doc/cutFeature.rst +++ b/src/FeaturesPlugin/doc/cutFeature.rst @@ -2,6 +2,8 @@ Cut === +The feature Cut implements a boolean operation to cut tool objects from a main objects. + To perform a boolean opration Cut in the active part: #. select in the Main Menu *Features - > Cut* item or @@ -29,6 +31,9 @@ The following property panel will be opened: **Arguments**: Part + list of main objects + list of tool objects. +Result +"""""" + The Result of the operation will be a shape which is a cut of tool objects from main objects: .. image:: images/CreatedCut.png diff --git a/src/FeaturesPlugin/doc/fillFeature.rst b/src/FeaturesPlugin/doc/fillFeature.rst index e5a3c7dc1..40d16ad6d 100644 --- a/src/FeaturesPlugin/doc/fillFeature.rst +++ b/src/FeaturesPlugin/doc/fillFeature.rst @@ -2,6 +2,8 @@ Fill ==== +The feature Fill implements a boolean operation for filling of main objects by parts of tool objects. + To perform a boolean opration Fill in the active part: #. select in the Main Menu *Features - > Fill* item or @@ -29,6 +31,9 @@ The following property panel will be opened: **Arguments**: Part + list of main objects + list of tool objects. +Result +"""""" + The Result of the operation will be a shape which is a fill of tool objects with main objects: .. image:: images/CreatedFill.png diff --git a/src/FeaturesPlugin/doc/fuseFeature.rst b/src/FeaturesPlugin/doc/fuseFeature.rst index 2508013a6..c04c1ea8a 100644 --- a/src/FeaturesPlugin/doc/fuseFeature.rst +++ b/src/FeaturesPlugin/doc/fuseFeature.rst @@ -2,6 +2,8 @@ Fuse ==== +The feature Fuse implements a boolean operation for fision of a set of main objects with a set of tool objects. + To perform a boolean opration Fuse in the active part: #. select in the Main Menu *Features - > Fuse* item or @@ -29,6 +31,9 @@ The following property panel will be opened: **Arguments**: Part + list of main objects + list of tool objects. +Result +"""""" + The Result of the operation will be a shape which is a fuse of tool objects with main objects: .. image:: images/CreatedFuse.png diff --git a/src/FeaturesPlugin/doc/images/Common.png b/src/FeaturesPlugin/doc/images/Common.png index 99d43ae03..0aaf5351e 100644 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 index 7a4566d66..ea27ef656 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedCommon.png 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 index e4d3777e4..0c927fdd9 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedCut.png 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 index 6ee906070..68b7ac2de 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedFill.png 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 index 424e31503..65c69dde2 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedFuse.png 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 index e4d3fe939..3ca9179d1 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedIntersection.png 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 index 9c4d2be98..f1b197934 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedPartition.png 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 index e35e982b8..81e2301ee 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedPlacement.png 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 index db6e81328..2e4d296e5 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedSmash.png 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 index 760985a51..2df9dba24 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedUnion.png 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 16a798d38..d971a74b2 100644 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 75f1cbd21..c5e11d29e 100644 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 25677dca7..bf281ea0b 100644 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 3d564d2e4..a1fc6f3aa 100644 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 10050b1d4..101001e39 100644 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 da97d8371..b937e6d74 100644 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 1bfbc40ba..c3f27f19b 100644 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 940d31903..50b90188b 100644 Binary files a/src/FeaturesPlugin/doc/images/Union.png and b/src/FeaturesPlugin/doc/images/Union.png differ diff --git a/src/FeaturesPlugin/doc/intersectionFeature.rst b/src/FeaturesPlugin/doc/intersectionFeature.rst index cff31851f..1b93530f3 100644 --- a/src/FeaturesPlugin/doc/intersectionFeature.rst +++ b/src/FeaturesPlugin/doc/intersectionFeature.rst @@ -2,6 +2,8 @@ Intersection ============ +The feature Intersection implements a boolean operation for intersection of a set of main objects with a set of tool objects. + To perform a boolean opration Intersection in the active part: #. select in the Main Menu *Features - > Intersection* item or @@ -27,6 +29,9 @@ The following property panel will be opened: **Arguments**: Part + list of objects. +Result +"""""" + The Result of the operation will be a shape which is an intersection of selected objects: .. image:: images/CreatedIntersection.png diff --git a/src/FeaturesPlugin/doc/partitionFeature.rst b/src/FeaturesPlugin/doc/partitionFeature.rst index f03c28eb9..2d64521b2 100644 --- a/src/FeaturesPlugin/doc/partitionFeature.rst +++ b/src/FeaturesPlugin/doc/partitionFeature.rst @@ -2,6 +2,8 @@ Partition ========= +The feature Partition implements a boolean operation for partitioning of a set of selected objects. + To perform a boolean opration Partition in the active part: #. select in the Main Menu *Features - > Partition* item or @@ -27,6 +29,9 @@ The following property panel will be opened: **Arguments**: Part + list of objects. +Result +"""""" + The Result of the operation will be a shape which is a partition of selected objects: .. image:: images/CreatedPartition.png diff --git a/src/FeaturesPlugin/doc/placementFeature.rst b/src/FeaturesPlugin/doc/placementFeature.rst index e213b9bdd..51d6a0a38 100644 --- a/src/FeaturesPlugin/doc/placementFeature.rst +++ b/src/FeaturesPlugin/doc/placementFeature.rst @@ -41,6 +41,9 @@ In this property panel it is necessary: **Arguments**: Part + list of objects to move + start shape + end shape + is reverse flag + is centering flag. +Result +"""""" + The Result of the operation will be a new placement of selected objects: .. image:: images/CreatedPlacement.png diff --git a/src/FeaturesPlugin/doc/smashFeature.rst b/src/FeaturesPlugin/doc/smashFeature.rst index 364aa0aa6..e9364a3f7 100644 --- a/src/FeaturesPlugin/doc/smashFeature.rst +++ b/src/FeaturesPlugin/doc/smashFeature.rst @@ -2,6 +2,8 @@ Smash ===== +The feature Smash implements a boolean operation for smashing a set of main objects by a set of tool objects. + To a create boolean opration Smash in the active part: #. select in the Main Menu *Features - > Smash* item or @@ -31,6 +33,9 @@ Here it is necessary to select main objects and tool objects. **Arguments**: Part + list of main objects + list of tool objects. +Result +"""""" + The Result of the operation will be a shape which is a smash of tool objects from main objects: .. image:: images/CreatedSmash.png diff --git a/src/FeaturesPlugin/doc/unionFeature.rst b/src/FeaturesPlugin/doc/unionFeature.rst index 190d4b2fc..a311dac32 100644 --- a/src/FeaturesPlugin/doc/unionFeature.rst +++ b/src/FeaturesPlugin/doc/unionFeature.rst @@ -2,6 +2,8 @@ Union ===== +The feature Union implements a boolean operation for creation of a uniono of selected objects. + To a create boolean opration Union in the active part: #. select in the Main Menu *Features - > Union* item or @@ -31,6 +33,9 @@ Here it is necessary to select some objects. **Arguments**: Part + list of objects. +Result +"""""" + The Result of the operation will be a shape which is a union of selected objects: .. image:: images/CreatedUnion.png diff --git a/src/GDMLPlugin/doc/GDMLPlugin.rst b/src/GDMLPlugin/doc/GDMLPlugin.rst index ae3a4d3b8..47760164f 100644 --- a/src/GDMLPlugin/doc/GDMLPlugin.rst +++ b/src/GDMLPlugin/doc/GDMLPlugin.rst @@ -4,6 +4,8 @@ GDML plug-in ============= +GDML plug-in provides a set of features for creation of geometry primitives using GDML language. It implements following features: + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/src/GDMLPlugin/doc/coneFeature.rst b/src/GDMLPlugin/doc/coneFeature.rst index 00597ec15..d92cb73cd 100644 --- a/src/GDMLPlugin/doc/coneFeature.rst +++ b/src/GDMLPlugin/doc/coneFeature.rst @@ -2,6 +2,8 @@ Cone segment ============ +The feature Cone segment creates a cone or its segment using GDML language. + To create a Cone segment in the active part: #. select in the Main Menu *GDML - > Cone segment* item or @@ -33,6 +35,9 @@ The property panel contains image which explains meaning of input values: **Arguments**: Part + Rmin of base + Rmax of base + Rmin of top + Rmax of top + height + start angle + end angle. +Result +"""""" + The Result of the operation will be a SOLID. .. image:: images/CreatedCone.png diff --git a/src/GDMLPlugin/doc/ellipsoidFeature.rst b/src/GDMLPlugin/doc/ellipsoidFeature.rst index 6cb83ae30..3e1501deb 100644 --- a/src/GDMLPlugin/doc/ellipsoidFeature.rst +++ b/src/GDMLPlugin/doc/ellipsoidFeature.rst @@ -2,6 +2,8 @@ Ellipsoid ========= +The feature Ellipsoid creates a 3d ellipsoid or its part using GDML language. + To create a Ellipsoid in the active part: #. select in the Main Menu *GDML - > Ellipsoid* item or @@ -33,6 +35,9 @@ The property panel contains image which explains meaning of input values: **Arguments**: Part + ax + by + cz. +Result +"""""" + The Result of the operation will be a SOLID. .. image:: images/CreatedEllipsoid.png diff --git a/src/GDMLPlugin/doc/images/CreatedCone.png b/src/GDMLPlugin/doc/images/CreatedCone.png index be2bb3a0d..9ac9e0fcb 100644 Binary files a/src/GDMLPlugin/doc/images/CreatedCone.png and b/src/GDMLPlugin/doc/images/CreatedCone.png differ diff --git a/src/GDMLPlugin/doc/images/CreatedEllipsoid.png b/src/GDMLPlugin/doc/images/CreatedEllipsoid.png index 51340712c..b94fa85fa 100644 Binary files a/src/GDMLPlugin/doc/images/CreatedEllipsoid.png and b/src/GDMLPlugin/doc/images/CreatedEllipsoid.png differ