]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Modification of plugins documentation
authorvsv <vsv@opencascade.com>
Tue, 4 Sep 2018 14:10:43 +0000 (17:10 +0300)
committervsv <vsv@opencascade.com>
Tue, 4 Sep 2018 14:10:43 +0000 (17:10 +0300)
39 files changed:
src/ExchangePlugin/doc/ExchangePlugin.rst
src/ExchangePlugin/doc/dumpFeature.rst
src/ExchangePlugin/doc/exportFeature.rst
src/ExchangePlugin/doc/images/Export_panel.png
src/ExchangePlugin/doc/images/FileImported.png
src/ExchangePlugin/doc/importFeature.rst
src/FeaturesPlugin/doc/FeaturesPlugin.rst
src/FeaturesPlugin/doc/commonFeature.rst
src/FeaturesPlugin/doc/cutFeature.rst
src/FeaturesPlugin/doc/fillFeature.rst
src/FeaturesPlugin/doc/fuseFeature.rst
src/FeaturesPlugin/doc/images/Common.png
src/FeaturesPlugin/doc/images/CreatedCommon.png
src/FeaturesPlugin/doc/images/CreatedCut.png
src/FeaturesPlugin/doc/images/CreatedFill.png
src/FeaturesPlugin/doc/images/CreatedFuse.png
src/FeaturesPlugin/doc/images/CreatedIntersection.png
src/FeaturesPlugin/doc/images/CreatedPartition.png
src/FeaturesPlugin/doc/images/CreatedPlacement.png
src/FeaturesPlugin/doc/images/CreatedSmash.png
src/FeaturesPlugin/doc/images/CreatedUnion.png
src/FeaturesPlugin/doc/images/Cut.png
src/FeaturesPlugin/doc/images/Fill.png
src/FeaturesPlugin/doc/images/Fuse.png
src/FeaturesPlugin/doc/images/Intersection.png
src/FeaturesPlugin/doc/images/Partition.png
src/FeaturesPlugin/doc/images/Placement.png
src/FeaturesPlugin/doc/images/Smash.png
src/FeaturesPlugin/doc/images/Union.png
src/FeaturesPlugin/doc/intersectionFeature.rst
src/FeaturesPlugin/doc/partitionFeature.rst
src/FeaturesPlugin/doc/placementFeature.rst
src/FeaturesPlugin/doc/smashFeature.rst
src/FeaturesPlugin/doc/unionFeature.rst
src/GDMLPlugin/doc/GDMLPlugin.rst
src/GDMLPlugin/doc/coneFeature.rst
src/GDMLPlugin/doc/ellipsoidFeature.rst
src/GDMLPlugin/doc/images/CreatedCone.png
src/GDMLPlugin/doc/images/CreatedEllipsoid.png

index 55bb7b674ff3630a44e267a9c2e8de91307cde35..518008f092e2dd1f0b234f603b84dea458d8e383 100644 (file)
@@ -4,6 +4,8 @@
 Exchange plug-in
 ================
 
+Exchange plug-in implements features for data exchange. It provides following:
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1
index 3bb2969cdd40e722e9d0e98ec382573a089608cb..ab68b076c3aeffaec4c309a70a9569ba7dd20425 100644 (file)
@@ -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.
index 8c91ee5b067fce27c795f4658b845b6dc150b1d5..922d0d6180164de9581d5eeba894967b1b9346aa 100644 (file)
@@ -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.
index d6e0274c99f414dd71d6b1b3ec67db7647bf8a12..7062e94ff5638871555327d35d26ddfb2d2c461c 100644 (file)
Binary files a/src/ExchangePlugin/doc/images/Export_panel.png and b/src/ExchangePlugin/doc/images/Export_panel.png differ
index b0af4536f1d681f1fa6c6ccfab8cb89a592696f3..e7e3b07c162a1c934a7e32bd72ec43830651e2c2 100644 (file)
Binary files a/src/ExchangePlugin/doc/images/FileImported.png and b/src/ExchangePlugin/doc/images/FileImported.png differ
index 0577b49b9320d49f8a86064bcff4e415cb10b955..c1c604d7ea1129ea6268c84e58833284d96e3dba 100644 (file)
@@ -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
index c9e95313f465966f62395eefef92f847681e458d..b4a9e292a818eb1586d24fe858f7b40fce0ad185 100644 (file)
@@ -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
index d4f4e72faa8b87fdfc63b7a2174b567631bcedbf..7324955eb634f4e7fb15a0cb1966ecbf1f803a52 100644 (file)
@@ -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
index 07f77f07e4df2d2a4dec64fcfc548533bfaad663..053bfa3a8ec603bdc0b1a27cb4208e2b62ca7312 100644 (file)
@@ -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
index e5a3c7dc1a7162886910f2a11a080bb4cbdbd895..40d16ad6d4b54b9cecc8b535f23b22e501e836bd 100644 (file)
@@ -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
index 2508013a6ca8ef340c693cef576bd27351094b7e..c04c1ea8a8de15dda84a1e196a8cf6a592ee08b8 100644 (file)
@@ -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
index 99d43ae03697aa7959b964112e4bc84185e46ee1..0aaf5351ef2d28a39fabb3e3af49992e96094ba2 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Common.png and b/src/FeaturesPlugin/doc/images/Common.png differ
index 7a4566d66e0ad0cadb5ab7969c55d1d507101be4..ea27ef6562bdbb3f39d0878bcff21520de91f11d 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedCommon.png and b/src/FeaturesPlugin/doc/images/CreatedCommon.png differ
index e4d3777e45f0fad5e04c2a4a013db7981618f2f5..0c927fdd9c5e00a5ab7d7393b1dc2963bc43b8c1 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedCut.png and b/src/FeaturesPlugin/doc/images/CreatedCut.png differ
index 6ee9060708f7cf388aa20ea290d4d301a9942940..68b7ac2de982948e658b87ed763dfa451a30df1e 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedFill.png and b/src/FeaturesPlugin/doc/images/CreatedFill.png differ
index 424e31503aa97865f92fc4829466a02cf2100634..65c69dde2344a37023fc2952af6afdf93422f44a 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedFuse.png and b/src/FeaturesPlugin/doc/images/CreatedFuse.png differ
index e4d3fe9393eada5a2fc96ab6046a2e5a5227cbd7..3ca9179d1cf3345bbeed9dd1ab7b37e333dc3116 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedIntersection.png and b/src/FeaturesPlugin/doc/images/CreatedIntersection.png differ
index 9c4d2be980e6803c7984fa9ce2609a80859ac2fd..f1b197934b8a907e08fce779bee2ce35830f53c9 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedPartition.png and b/src/FeaturesPlugin/doc/images/CreatedPartition.png differ
index e35e982b8b1b44957362c594d3cae63e769714cf..81e2301eea038ba1d7809b132403c054b1bed809 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedPlacement.png and b/src/FeaturesPlugin/doc/images/CreatedPlacement.png differ
index db6e813282b46609a20fc33f455ab8745c16fda2..2e4d296e5dd1e230c5fa0824aabeafabf1db476d 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedSmash.png and b/src/FeaturesPlugin/doc/images/CreatedSmash.png differ
index 760985a514b2d3bfad1c58acda1293817a8c9437..2df9dba2454b6eeb8d9e62ca1adb94946c7854ca 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/CreatedUnion.png and b/src/FeaturesPlugin/doc/images/CreatedUnion.png differ
index 16a798d38bbb7a22f514eeb1d956dac2081d4460..d971a74b2f324f6828dc0b615c970e321841ebfe 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Cut.png and b/src/FeaturesPlugin/doc/images/Cut.png differ
index 75f1cbd214d24f1d5b009c4da626b7171d238dcc..c5e11d29e6935bf03132805259c532080cf1b1a2 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Fill.png and b/src/FeaturesPlugin/doc/images/Fill.png differ
index 25677dca71091c3a288f53306982317660b1bb58..bf281ea0ba1dde4b47d52229d05b4ccf4094b58e 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Fuse.png and b/src/FeaturesPlugin/doc/images/Fuse.png differ
index 3d564d2e471f4306d48b8cf7ae9e8a96448a6d3d..a1fc6f3aa73411893f1183c8cac55dd8dd66d051 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Intersection.png and b/src/FeaturesPlugin/doc/images/Intersection.png differ
index 10050b1d48c0dbbd34f9a36ca2ebdbb246ff2fd0..101001e3918d1ef2cf5a3d77e8d84c931ca741f3 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Partition.png and b/src/FeaturesPlugin/doc/images/Partition.png differ
index da97d83718fbc8e3c6f2b4ffb2df2f9371343fa5..b937e6d74071e09a881d1c6143355dfface08544 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Placement.png and b/src/FeaturesPlugin/doc/images/Placement.png differ
index 1bfbc40baa36f6cff1a4e51f3ddece2906b9c5f1..c3f27f19ba3946b802fac2321dd5bbf3bce0149a 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Smash.png and b/src/FeaturesPlugin/doc/images/Smash.png differ
index 940d31903d0c24541584b81e1a5c86d4d8a5f4d6..50b90188b40aa68223d63d837b3f05de60bafc00 100644 (file)
Binary files a/src/FeaturesPlugin/doc/images/Union.png and b/src/FeaturesPlugin/doc/images/Union.png differ
index cff31851f9b637d85a4942681e4672e681f627bb..1b93530f3b1ad867a50f0246753683023aa77bf0 100644 (file)
@@ -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
index f03c28eb92fb1df3bfe0d2b6880c9204ae2886d4..2d64521b21f5dee6667b9442e0a08590a7747e40 100644 (file)
@@ -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
index e213b9bdd85e7882c256ca343d39c0189cf99a39..51d6a0a38e4ea177e37ca52238e04d7df5cf3c1f 100644 (file)
@@ -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
index 364aa0aa6223133863af51b7e3b3029e4bd9b485..e9364a3f741bebff42212fca44fb17437a32dfcf 100644 (file)
@@ -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
index 190d4b2fcfafda00c899b051dbce2acd23257c87..a311dac3255d4cab220f79ea831615c8e73f6e2f 100644 (file)
@@ -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
index ae3a4d3b8207fe1ef351b48b04c4ed6c5fad3d77..47760164f90b9547f96c7c7f53f5df59e1601368 100644 (file)
@@ -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
index 00597ec1539b3886d0ea6ddcc5e2391ccdaeb728..d92cb73cd3353cf9440fd5b17e0ac83eeaeaafc1 100644 (file)
@@ -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
index 6cb83ae30cede407d441ecc251aac2898758b501..3e1501deb5f50ce28ac6ff6a88f3c30199ab9bb9 100644 (file)
@@ -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
index be2bb3a0d8655fe779a11bc73d26f6c38048aa46..9ac9e0fcb09667c39add95e271d8fd94a5a485a6 100644 (file)
Binary files a/src/GDMLPlugin/doc/images/CreatedCone.png and b/src/GDMLPlugin/doc/images/CreatedCone.png differ
index 51340712c405b60a01d41fec4c97d5fdb4a5f74e..b94fa85fadc3ca61827de5f274e3eecbd9cdd518 100644 (file)
Binary files a/src/GDMLPlugin/doc/images/CreatedEllipsoid.png and b/src/GDMLPlugin/doc/images/CreatedEllipsoid.png differ