From: vsv Date: Mon, 20 Aug 2018 11:36:33 +0000 (+0300) Subject: Fix for help pages X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=29b981b9596d76e8c421de48977233fa3c629eca;p=modules%2Fshaper.git Fix for help pages --- diff --git a/doc/gui/CMakeLists.txt b/doc/gui/CMakeLists.txt index f66b3e2c8..40e5dd665 100644 --- a/doc/gui/CMakeLists.txt +++ b/doc/gui/CMakeLists.txt @@ -22,6 +22,12 @@ SET(input ${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in) SET(output ${CMAKE_CURRENT_BINARY_DIR}/conf.py) +SET(DOC_FILES + Introduction.rst + ) + +FILE( COPY ${DOC_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + CONFIGURE_FILE(${input} ${output}) #sphinx-build -b html -c doc -D latex_paper_size=a4 -d doc/doctree /dn23/PPGP/vsv/SALOME730/SOURCES/PPGP_SRC/doc doc/html diff --git a/doc/gui/Introduction.rst b/doc/gui/Introduction.rst new file mode 100644 index 000000000..7ff6e4573 --- /dev/null +++ b/doc/gui/Introduction.rst @@ -0,0 +1,84 @@ + +.. _introduction: + + +Introduction to SHAPER +====================== + +Application desktop +------------------- + +The main window of the application consists of the following components: + +- :ref:`main_menu` +- :ref:`doc_windows` +- :ref:`viewer` + +.. _main_menu: + +Main menu +--------- + +Main menu provides access to all commands of the application. + +.. _doc_windows: + +Dock windows +------------ + +Standard dock windows are: + +- :ref:`object_browser` +- :ref:`inspection_panel` +- :ref:`python console` +- :ref:`property_panel` + + +Dock windows can be placed in three dock areas: +- left, +- right, +- bottom. + +By default object browser window is placed at left area of the main window and Python console is placed as at bottom area of the main menu. +user can close any dock window. To open it again he can use a corresponded command from pop-up menu on static part of main menu + +.. _object_browser: + +Object browser +^^^^^^^^^^^^^^ + +.. _property_panel: + +Property panel +^^^^^^^^^^^^^^ + +By default Property Panel is hidden, and it is shown on operation start. + +By default the Property Panel is shown at left side of the main window. + +If Object Browser is shown at the same side then they will be tabbed + +.. _inspection_panel: + +Inspection panel +^^^^^^^^^^^^^^^^ + +.. _python console: + +Python console +^^^^^^^^^^^^^^ + +.. _viewer: + +Viewer +------ + +The application supports one OCC viewer and is able to show only one 3D space. + +This 3d space can be represented in several view windows. + +Each of view windows represents its own point of view on the 3d scene. + +This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on. + +Architecture and functionality of viewer is very similar to OCCViewer component from SALOME. diff --git a/doc/gui/index.rst.in b/doc/gui/index.rst.in index fefd59609..8493bbaca 100644 --- a/doc/gui/index.rst.in +++ b/doc/gui/index.rst.in @@ -6,6 +6,8 @@ Welcome to SHAPER's documentation! ================================== +- :ref:`introduction` + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/src/FeaturesPlugin/doc/FeaturesPlugin.rst b/src/FeaturesPlugin/doc/FeaturesPlugin.rst index bb1d02b69..c9e95313f 100644 --- a/src/FeaturesPlugin/doc/FeaturesPlugin.rst +++ b/src/FeaturesPlugin/doc/FeaturesPlugin.rst @@ -7,7 +7,8 @@ Features plug-in .. toctree:: :titlesonly: :maxdepth: 1 - + + angularCopyFeature.rst commonFeature.rst cutFeature.rst extrusionCutFeature.rst @@ -16,14 +17,20 @@ Features plug-in fillFeature.rst filletFeature.rst fuseFeature.rst - intersectionFeature.rst + intersectionFeature.rst + linearCopyFeature.rst + measurementFeature.rst partitionFeature.rst - pipeFeature.rst + pipeFeature.rst + placementFeature.rst recoverFeature.rst removeSubShapesFeature.rst revolutionCutFeature.rst revolutionFeature.rst revolutionFuseFeature.rst + rotationFeature.rst smashFeature.rst - transformationFeature.rst + symmetryFeature.rst + transformationFeature.rst + translationFeature.rst unionFeature.rst diff --git a/src/FeaturesPlugin/doc/TUI_placementFeature.rst b/src/FeaturesPlugin/doc/TUI_placementFeature.rst new file mode 100644 index 000000000..4f46ec6dd --- /dev/null +++ b/src/FeaturesPlugin/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/FeaturesPlugin/doc/angularCopyFeature.rst b/src/FeaturesPlugin/doc/angularCopyFeature.rst new file mode 100644 index 000000000..3d3fec12c --- /dev/null +++ b/src/FeaturesPlugin/doc/angularCopyFeature.rst @@ -0,0 +1,10 @@ + +Angular copy +============ + + +.. image:: images/AngularCopy.png + :align: center + +.. centered:: + Angular copy definition diff --git a/src/FeaturesPlugin/doc/commonFeature.rst b/src/FeaturesPlugin/doc/commonFeature.rst index afdbdcda3..d4f4e72fa 100644 --- a/src/FeaturesPlugin/doc/commonFeature.rst +++ b/src/FeaturesPlugin/doc/commonFeature.rst @@ -2,7 +2,7 @@ Common ====== -To a create boolean opration Common in the active part: +To perform a boolean opration Common in the active part: #. select in the Main Menu *Features - > Common* item or #. click **Common** button in the toolbar @@ -21,11 +21,9 @@ The following property panel will be opened: .. centered:: **Common operation** -It is necessary to select main objects and tool objects. - -**Apply** button creates the common shape. - -**Cancel** button cancels operation. +- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be common with tool objects. +- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be common with main objects. +- **See preview** button shows a result of the operation. **TUI Command**: *model.addCommon(Part_doc, mainObjects, toolObjects)* diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst index 947d7affe..07f77f07e 100644 --- a/src/FeaturesPlugin/doc/cutFeature.rst +++ b/src/FeaturesPlugin/doc/cutFeature.rst @@ -2,7 +2,7 @@ Cut === -To a create boolean opration Cut in the active part: +To perform a boolean opration Cut in the active part: #. select in the Main Menu *Features - > Cut* item or #. click **Cut** button in the toolbar @@ -21,11 +21,9 @@ The following property panel will be opened: .. centered:: **Cut operation** -Here it is necessary to select main objects and tool objects. - -**Apply** button creates the cut shape. - -**Cancel** button cancels operation. +- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut by tool objects. +- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut main objects. +- **See preview** button shows a result of the operation. **TUI Command**: *model.addCut(Part_doc, mainObjects, toolObjects)* diff --git a/src/FeaturesPlugin/doc/examples/placement.py b/src/FeaturesPlugin/doc/examples/placement.py new file mode 100644 index 000000000..d74ab4d23 --- /dev/null +++ b/src/FeaturesPlugin/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/FeaturesPlugin/doc/fillFeature.rst b/src/FeaturesPlugin/doc/fillFeature.rst index 82f68cd6f..e5a3c7dc1 100644 --- a/src/FeaturesPlugin/doc/fillFeature.rst +++ b/src/FeaturesPlugin/doc/fillFeature.rst @@ -2,7 +2,7 @@ Fill ==== -To a create boolean opration Fill in the active part: +To perform a boolean opration Fill in the active part: #. select in the Main Menu *Features - > Fill* item or #. click **Fill** button in the toolbar @@ -21,11 +21,9 @@ The following property panel will be opened: .. centered:: **Fill operation** -Here it is necessary to select main objects and tool objects. - -**Apply** button creates the fill shape. - -**Cancel** button cancels operation. +- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut and filled by tool objects. +- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut and filled the main objects. +- **See preview** button shows a result of the operation. **TUI Command**: *model.addFill(Part_doc, mainObjects, toolObjects)* diff --git a/src/FeaturesPlugin/doc/fuseFeature.rst b/src/FeaturesPlugin/doc/fuseFeature.rst index c6131a336..2508013a6 100644 --- a/src/FeaturesPlugin/doc/fuseFeature.rst +++ b/src/FeaturesPlugin/doc/fuseFeature.rst @@ -2,7 +2,7 @@ Fuse ==== -To a create boolean opration Fuse in the active part: +To perform a boolean opration Fuse in the active part: #. select in the Main Menu *Features - > Fuse* item or #. click **Fuse** button in the toolbar @@ -21,11 +21,9 @@ The following property panel will be opened: .. centered:: **Fuse operation** -Here it is necessary to select main objects and tool objects. - -**Apply** button creates the fuse shape. - -**Cancel** button cancels operation. +- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects. +- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will fused with main objects. +- **See preview** button shows a result of the operation. **TUI Command**: *model.addFuse(Part_doc, mainObjects, toolObjects)* diff --git a/src/FeaturesPlugin/doc/images/AngularCopy.png b/src/FeaturesPlugin/doc/images/AngularCopy.png new file mode 100644 index 000000000..efa4d6eb8 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/AngularCopy.png differ diff --git a/src/FeaturesPlugin/doc/images/CreatedPlacement.png b/src/FeaturesPlugin/doc/images/CreatedPlacement.png new file mode 100644 index 000000000..e35e982b8 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/CreatedPlacement.png differ diff --git a/src/FeaturesPlugin/doc/images/LinearCopy.png b/src/FeaturesPlugin/doc/images/LinearCopy.png new file mode 100644 index 000000000..1daa1ef9b Binary files /dev/null and b/src/FeaturesPlugin/doc/images/LinearCopy.png differ diff --git a/src/FeaturesPlugin/doc/images/Measurement1.png b/src/FeaturesPlugin/doc/images/Measurement1.png new file mode 100644 index 000000000..77b426e94 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Measurement1.png differ diff --git a/src/FeaturesPlugin/doc/images/Measurement2.png b/src/FeaturesPlugin/doc/images/Measurement2.png new file mode 100644 index 000000000..5d951ae4d Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Measurement2.png differ diff --git a/src/FeaturesPlugin/doc/images/Measurement3.png b/src/FeaturesPlugin/doc/images/Measurement3.png new file mode 100644 index 000000000..b3f64ba14 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Measurement3.png differ diff --git a/src/FeaturesPlugin/doc/images/Measurement4.png b/src/FeaturesPlugin/doc/images/Measurement4.png new file mode 100644 index 000000000..b43c36a81 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Measurement4.png differ diff --git a/src/FeaturesPlugin/doc/images/Measurement5.png b/src/FeaturesPlugin/doc/images/Measurement5.png new file mode 100644 index 000000000..b5d860a01 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Measurement5.png differ diff --git a/src/FeaturesPlugin/doc/images/Placement.png b/src/FeaturesPlugin/doc/images/Placement.png new file mode 100644 index 000000000..da97d8371 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Placement.png differ diff --git a/src/FeaturesPlugin/doc/images/Rotation1.png b/src/FeaturesPlugin/doc/images/Rotation1.png new file mode 100644 index 000000000..9549eeabf Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Rotation1.png differ diff --git a/src/FeaturesPlugin/doc/images/Rotation2.png b/src/FeaturesPlugin/doc/images/Rotation2.png new file mode 100644 index 000000000..4b1224b51 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Rotation2.png differ diff --git a/src/FeaturesPlugin/doc/images/Symmetry.png b/src/FeaturesPlugin/doc/images/Symmetry.png new file mode 100644 index 000000000..a369a0f81 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Symmetry.png differ diff --git a/src/FeaturesPlugin/doc/images/Translation1.png b/src/FeaturesPlugin/doc/images/Translation1.png new file mode 100644 index 000000000..3d1729564 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Translation1.png differ diff --git a/src/FeaturesPlugin/doc/images/Translation2.png b/src/FeaturesPlugin/doc/images/Translation2.png new file mode 100644 index 000000000..8b367d1cb Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Translation2.png differ diff --git a/src/FeaturesPlugin/doc/images/Translation3.png b/src/FeaturesPlugin/doc/images/Translation3.png new file mode 100644 index 000000000..82cdb8d61 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/Translation3.png differ diff --git a/src/FeaturesPlugin/doc/images/placement_btn.png b/src/FeaturesPlugin/doc/images/placement_btn.png new file mode 100644 index 000000000..c100a3153 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/placement_btn.png differ diff --git a/src/FeaturesPlugin/doc/intersectionFeature.rst b/src/FeaturesPlugin/doc/intersectionFeature.rst index 52580bc5c..cff31851f 100644 --- a/src/FeaturesPlugin/doc/intersectionFeature.rst +++ b/src/FeaturesPlugin/doc/intersectionFeature.rst @@ -2,7 +2,7 @@ Intersection ============ -To a create boolean opration Intersection in the active part: +To perform a boolean opration Intersection in the active part: #. select in the Main Menu *Features - > Intersection* item or #. click **Intersection** button in the toolbar @@ -21,11 +21,7 @@ The following property panel will be opened: .. centered:: **Intersection operation** -Here it is necessary to select some objects. - -**Apply** button creates the intersection shape. - -**Cancel** button cancels operation. +**Base Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be intersected. **TUI Command**: *model.addIntersection(Part_doc, Objects)* diff --git a/src/FeaturesPlugin/doc/linearCopyFeature.rst b/src/FeaturesPlugin/doc/linearCopyFeature.rst new file mode 100644 index 000000000..38509c3b9 --- /dev/null +++ b/src/FeaturesPlugin/doc/linearCopyFeature.rst @@ -0,0 +1,10 @@ + +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 new file mode 100644 index 000000000..9f999a097 --- /dev/null +++ b/src/FeaturesPlugin/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/FeaturesPlugin/doc/partitionFeature.rst b/src/FeaturesPlugin/doc/partitionFeature.rst index 9a1b1e4b2..f03c28eb9 100644 --- a/src/FeaturesPlugin/doc/partitionFeature.rst +++ b/src/FeaturesPlugin/doc/partitionFeature.rst @@ -2,7 +2,7 @@ Partition ========= -To a create boolean opration Partition in the active part: +To perform a boolean opration Partition in the active part: #. select in the Main Menu *Features - > Partition* item or #. click **Partition** button in the toolbar @@ -21,11 +21,7 @@ The following property panel will be opened: .. centered:: **Partition operation** -Here it is necessary to select several objects. - -**Apply** button creates the partition shape. - -**Cancel** button cancels operation. +**Base Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be partitioned. **TUI Command**: *model.addPartition(Part_doc, objects)* diff --git a/src/FeaturesPlugin/doc/placementFeature.rst b/src/FeaturesPlugin/doc/placementFeature.rst new file mode 100644 index 000000000..e213b9bdd --- /dev/null +++ b/src/FeaturesPlugin/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/FeaturesPlugin/doc/rotationFeature.rst b/src/FeaturesPlugin/doc/rotationFeature.rst new file mode 100644 index 000000000..ff0380d0c --- /dev/null +++ b/src/FeaturesPlugin/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/FeaturesPlugin/doc/symmetryFeature.rst b/src/FeaturesPlugin/doc/symmetryFeature.rst new file mode 100644 index 000000000..dc8150c74 --- /dev/null +++ b/src/FeaturesPlugin/doc/symmetryFeature.rst @@ -0,0 +1,10 @@ + +Symmetry +======== + + +.. image:: images/Symmetry.png + :align: center + +.. centered:: + Symmetry definition diff --git a/src/FeaturesPlugin/doc/translationFeature.rst b/src/FeaturesPlugin/doc/translationFeature.rst new file mode 100644 index 000000000..99ce5db72 --- /dev/null +++ b/src/FeaturesPlugin/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 diff --git a/src/GDMLPlugin/doc/coneFeature.rst b/src/GDMLPlugin/doc/coneFeature.rst index 9760c29b9..00597ec15 100644 --- a/src/GDMLPlugin/doc/coneFeature.rst +++ b/src/GDMLPlugin/doc/coneFeature.rst @@ -1,8 +1,8 @@ -Cone -==== +Cone segment +============ -To create a Cone in the active part: +To create a Cone segment in the active part: #. select in the Main Menu *GDML - > Cone segment* item or #. click **Cone segment** button in the toolbar. @@ -21,7 +21,15 @@ The following property panel will be opened: .. centered:: **Cone property panel** -**TUI Command**: *model.addConeSegment(Part_doc, 7, 11, 5, 8, 12, 0 , 270)* +The property panel contains image which explains meaning of input values: + +- **rmin1, rmax1** - minimal and maximal radiuses of a base of the cone. +- **rmin2, rmax2** - minimal and maximal rediuses of a top of the cone. +- **z** is a heighth of the cone. +- **startphi** is a starting angle of the cone segment. +- **deltaphi** is an angle to end of the cone segment. + +**TUI Command**: *model.addConeSegment(Part_doc, rmin1, rmax1, rmin2, rmax2, z, startphi, deltaphi)* **Arguments**: Part + Rmin of base + Rmax of base + Rmin of top + Rmax of top + height + start angle + end angle. diff --git a/src/GDMLPlugin/doc/ellipsoidFeature.rst b/src/GDMLPlugin/doc/ellipsoidFeature.rst index a8bd95158..6cb83ae30 100644 --- a/src/GDMLPlugin/doc/ellipsoidFeature.rst +++ b/src/GDMLPlugin/doc/ellipsoidFeature.rst @@ -21,7 +21,15 @@ The following property panel will be opened: .. centered:: **Ellipsoid property panel** -**TUI Command**: *model.addEllipsoid(Part_doc, 10, 20, 40)* +The property panel contains image which explains meaning of input values: + +- **ax** is a size of the ellipsoind along X axis. +- **by** is a size of the ellipsoind along Y axis. +- **cz** is a size of the ellipsoind along Z axis. +- **zcut1** is a z coordinate of a lower cut plane. +- **zcut2** is a z coordinate of a upper cut plane. + +**TUI Command**: *model.addEllipsoid(Part_doc, ax, by, cz)* **Arguments**: Part + ax + by + cz. diff --git a/src/IntroductionPlugin/doc/IntroductionPlugin.rst b/src/IntroductionPlugin/doc/IntroductionPlugin.rst deleted file mode 100755 index 30e17a6b0..000000000 --- a/src/IntroductionPlugin/doc/IntroductionPlugin.rst +++ /dev/null @@ -1,81 +0,0 @@ - -Introduction to SHAPER -====================== - -Application desktop -------------------- - -The main window of the application consists of the following components: - -- :ref:`main_menu` -- :ref:`doc_windows` -- :ref:`viewer` - -.. _main_menu: - -Main menu ---------- - -Main menu provides access to all commands of the application. - -.. _doc_windows: - -Dock windows ------------- - -Standard dock windows are: - -- :ref:`object_browser` -- :ref:`inspection_panel` -- :ref:`python console` -- :ref:`property_panel` - - -Dock windows can be placed in three dock areas: -- left, -- right, -- bottom. - -By default object browser window is placed at left area of the main window and Python console is placed as at bottom area of the main menu. -user can close any dock window. To open it again he can use a corresponded command from pop-up menu on static part of main menu - -.. _object_browser: - -Object browser -^^^^^^^^^^^^^^ - -.. _property_panel: - -Property panel -^^^^^^^^^^^^^^ - -By default Property Panel is hidden, and it is shown on operation start. - -By default the Property Panel is shown at left side of the main window. - -If Object Browser is shown at the same side then they will be tabbed - -.. _inspection_panel: - -Inspection panel -^^^^^^^^^^^^^^^^ - -.. _python console: - -Python console -^^^^^^^^^^^^^^ - -.. _viewer: - -Viewer ------- - -The application supports one OCC viewer and is able to show only one 3D space. - -This 3d space can be represented in several view windows. - -Each of view windows represents its own point of view on the 3d scene. - -This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on. - -Architecture and functionality of viewer is very similar to OCCViewer component from SALOME. diff --git a/src/IntroductionPlugin/doc/index.rst_add.in b/src/IntroductionPlugin/doc/index.rst_add.in deleted file mode 100755 index 15b9bc96a..000000000 --- a/src/IntroductionPlugin/doc/index.rst_add.in +++ /dev/null @@ -1,56 +0,0 @@ -The main window of the application consists of the following components: - -- :ref:`main_menu` - -.. _main_menu: - -Main menu ---------- - -Main menu provides access to all commands of the application. - - -Dock windows ------------- - -Standard dock windows are: - -- :ref:`object_browser` -- :ref:`inspection_panel` -- :ref:`python console` -- :ref:`property_panel` - - - -Dock windows can be placed in three dock areas: -- left, -- right, -- bottom. - -By default object browser window is placed at left area of the main window and Python console is placed as a one tab in main menu (see Figure 2) in order to make them more compact. -user can close any dock window. To open it again he can use a corresponded command from pop-up menu on static part of main menu -.. _object_browser: - -Object browser -^^^^^^^^^^^^^^ - -.. _property_panel: - -Property panel -^^^^^^^^^^^^^^ - -By default Property Panel is hidden. It can be shown on operation start if XML description of this operation is not empty. By default the Property Panel is shown at left side. If Object Browser is shown at the same side then they will be tabbed - -.. _inspection_panel: - -Inspection panel -^^^^^^^^^^^^^^^^ - -.. _python console: - -Python console -^^^^^^^^^^^^^^ - - -It is supposed that the application only a one OCC viewer will support. It means that the application will be able to show only a one 3d space. This 3d space can be represented in several view windows. Each of view windows will represent its own point of view on the 3d scene. This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on. -Architecture and functionality of viewer will be very similar to OCCViewer component from SALOME with modifications of view window look&feel. diff --git a/src/PartSetPlugin/doc/PartSetPlugin.rst b/src/PartSetPlugin/doc/PartSetPlugin.rst index 50a5545a6..9dfd89688 100644 --- a/src/PartSetPlugin/doc/PartSetPlugin.rst +++ b/src/PartSetPlugin/doc/PartSetPlugin.rst @@ -3,17 +3,3 @@ Part plug-in ============= - - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - angularCopyFeature.rst - linearCopyFeature.rst - measurementFeature.rst - placementFeature.rst - rotationFeature.rst - symmetryFeature.rst - translationFeature.rst - diff --git a/src/PartSetPlugin/doc/TUI_placementFeature.rst b/src/PartSetPlugin/doc/TUI_placementFeature.rst deleted file mode 100644 index 4f46ec6dd..000000000 --- a/src/PartSetPlugin/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/PartSetPlugin/doc/angularCopyFeature.rst b/src/PartSetPlugin/doc/angularCopyFeature.rst deleted file mode 100644 index 3d3fec12c..000000000 --- a/src/PartSetPlugin/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/PartSetPlugin/doc/examples/placement.py b/src/PartSetPlugin/doc/examples/placement.py deleted file mode 100644 index d74ab4d23..000000000 --- a/src/PartSetPlugin/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/PartSetPlugin/doc/images/AngularCopy.png b/src/PartSetPlugin/doc/images/AngularCopy.png deleted file mode 100644 index efa4d6eb8..000000000 Binary files a/src/PartSetPlugin/doc/images/AngularCopy.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/CreatedPlacement.png b/src/PartSetPlugin/doc/images/CreatedPlacement.png deleted file mode 100644 index e35e982b8..000000000 Binary files a/src/PartSetPlugin/doc/images/CreatedPlacement.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/LinearCopy.png b/src/PartSetPlugin/doc/images/LinearCopy.png deleted file mode 100644 index 1daa1ef9b..000000000 Binary files a/src/PartSetPlugin/doc/images/LinearCopy.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Measurement1.png b/src/PartSetPlugin/doc/images/Measurement1.png deleted file mode 100644 index 77b426e94..000000000 Binary files a/src/PartSetPlugin/doc/images/Measurement1.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Measurement2.png b/src/PartSetPlugin/doc/images/Measurement2.png deleted file mode 100644 index 5d951ae4d..000000000 Binary files a/src/PartSetPlugin/doc/images/Measurement2.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Measurement3.png b/src/PartSetPlugin/doc/images/Measurement3.png deleted file mode 100644 index b3f64ba14..000000000 Binary files a/src/PartSetPlugin/doc/images/Measurement3.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Measurement4.png b/src/PartSetPlugin/doc/images/Measurement4.png deleted file mode 100644 index b43c36a81..000000000 Binary files a/src/PartSetPlugin/doc/images/Measurement4.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Measurement5.png b/src/PartSetPlugin/doc/images/Measurement5.png deleted file mode 100644 index b5d860a01..000000000 Binary files a/src/PartSetPlugin/doc/images/Measurement5.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Placement.png b/src/PartSetPlugin/doc/images/Placement.png deleted file mode 100644 index da97d8371..000000000 Binary files a/src/PartSetPlugin/doc/images/Placement.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Rotation1.png b/src/PartSetPlugin/doc/images/Rotation1.png deleted file mode 100644 index 9549eeabf..000000000 Binary files a/src/PartSetPlugin/doc/images/Rotation1.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Rotation2.png b/src/PartSetPlugin/doc/images/Rotation2.png deleted file mode 100644 index 4b1224b51..000000000 Binary files a/src/PartSetPlugin/doc/images/Rotation2.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Symmetry.png b/src/PartSetPlugin/doc/images/Symmetry.png deleted file mode 100644 index a369a0f81..000000000 Binary files a/src/PartSetPlugin/doc/images/Symmetry.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Translation1.png b/src/PartSetPlugin/doc/images/Translation1.png deleted file mode 100644 index 3d1729564..000000000 Binary files a/src/PartSetPlugin/doc/images/Translation1.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Translation2.png b/src/PartSetPlugin/doc/images/Translation2.png deleted file mode 100644 index 8b367d1cb..000000000 Binary files a/src/PartSetPlugin/doc/images/Translation2.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/Translation3.png b/src/PartSetPlugin/doc/images/Translation3.png deleted file mode 100644 index 82cdb8d61..000000000 Binary files a/src/PartSetPlugin/doc/images/Translation3.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/images/placement_btn.png b/src/PartSetPlugin/doc/images/placement_btn.png deleted file mode 100644 index c100a3153..000000000 Binary files a/src/PartSetPlugin/doc/images/placement_btn.png and /dev/null differ diff --git a/src/PartSetPlugin/doc/linearCopyFeature.rst b/src/PartSetPlugin/doc/linearCopyFeature.rst deleted file mode 100644 index 38509c3b9..000000000 --- a/src/PartSetPlugin/doc/linearCopyFeature.rst +++ /dev/null @@ -1,10 +0,0 @@ - -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 deleted file mode 100644 index 9f999a097..000000000 --- a/src/PartSetPlugin/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/PartSetPlugin/doc/placementFeature.rst b/src/PartSetPlugin/doc/placementFeature.rst deleted file mode 100644 index e213b9bdd..000000000 --- a/src/PartSetPlugin/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/PartSetPlugin/doc/rotationFeature.rst b/src/PartSetPlugin/doc/rotationFeature.rst deleted file mode 100644 index ff0380d0c..000000000 --- a/src/PartSetPlugin/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/PartSetPlugin/doc/symmetryFeature.rst b/src/PartSetPlugin/doc/symmetryFeature.rst deleted file mode 100644 index dc8150c74..000000000 --- a/src/PartSetPlugin/doc/symmetryFeature.rst +++ /dev/null @@ -1,10 +0,0 @@ - -Symmetry -======== - - -.. image:: images/Symmetry.png - :align: center - -.. centered:: - Symmetry definition diff --git a/src/PartSetPlugin/doc/translationFeature.rst b/src/PartSetPlugin/doc/translationFeature.rst deleted file mode 100644 index 99ce5db72..000000000 --- a/src/PartSetPlugin/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