Salome HOME
Merge remote branch 'origin/Doc_update_ver741' into V7_5_BR
authorvsr <vsr@opencascade.com>
Mon, 10 Nov 2014 08:25:00 +0000 (11:25 +0300)
committervsr <vsr@opencascade.com>
Mon, 10 Nov 2014 11:20:45 +0000 (14:20 +0300)
1  2 
doc/salome/examples/CMakeLists.txt
doc/salome/gui/GEOM/images/tree_example.png
doc/salome/gui/GEOM/input/creating_polyline.doc
doc/salome/gui/GEOM/input/dependency_tree.doc
doc/salome/gui/GEOM/input/geompy.doc
doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc

index 3d9da70360de5086702583e23a08f01ee76bef1b,3d9da70360de5086702583e23a08f01ee76bef1b..f21bae342270b65b18bd1f65b246598518f62bae
@@@ -74,6 -74,6 +74,7 @@@ SET(GOOD_TEST
    min_distance.py  
    normal_face.py  
    notebook_geom.py  
++  polyline.py
    point_coordinates.py  
    primitives_ex01.py  
    primitives_ex02.py  
index e41c1b1f857dc47a80fc62eeb3a7792a52a19d22,e41c1b1f857dc47a80fc62eeb3a7792a52a19d22..bb75713c8aa5a6b6c5d11610e567b0829ad2f6b2
Binary files differ
index 7ec36434dfee03817d6e96adaaa7e73f06858204,f7fa7c9a12271f8ce3d748580650640db79ed7bf..2ca7f4ba9fd79e04fb2c0b5a85234884159a2a21
@@@ -14,34 -14,23 +14,23 @@@ connected  by either linear segments o
  - \b Type (Polyline or Spline),
  - \b Closed flag.
  
- A Polyline created represents a shape that lies on the XOY plane. It can have the following types:
+ A created Polyline represents a shape that lies on the XOY plane. Its type can be one of the following:
  - \b Vertex for a single section with only 1 point.
- - \b Wire for a single section with 2 or more points. A Wire can have multiple edges for more then 2 points if the section type is Polyline.
- A single edge in the result wire is obtained for a Spline or Polyline with 2 points.
+ - \b Wire for a single section with 2 or more points. A Wire can have multiple edges for more then 2 points if the section type is Polyline. A single edge in the resulting wire is obtained for a Spline or Polyline with 2 points.
  - \b Compound of Wires and/or Vertices if there are several sections.
  
- For the moment only one reference coordinate system for polyline creation is supported. The XOY plane of the <b>Global coordinate system</b>
- is suggested. Implementation of another reference coordinate system is a subject of further development of this functionality.
- Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects.
+ For the moment only one reference coordinate system for polyline creation is supported, which is the XOY plane of the <b>Global coordinate system</b>. 
+ \b Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects.
  For the moment this button works with only one plane.
  
- It is possible to import a shape in this dialog using <b>Import polyline</b> selection button. To do it an imported object should satisfy conditions
- for polyline shapes mentioned above. If a valid shape is selected, when dialog is opened, it is initialized by this shape.
- Though the shape can be on any plane, an imported polyline will be defined on XOY plane only due to the limitation.
+ It is possible to import a shape in this dialog using <b>Import polyline</b> selection button. An imported object should meet the conditions for polyline shapes mentioned above. If a valid shape is selected, when the dialog is opened, it is initialized by this shape.
+ Though the shape can be on any plane, the imported polyline will be defined on XOY plane only due to the limitation.
  
- The group \b Sections in this dialog represents the Polyline construction framework. Its toolbar has the following operations:
- - \b Undo
- - \b Redo
- - <b>Insert new section</b>
- - <b>Addition mode</b>
- - <b>Modification mode</b> - not implemented
- - <b>Detection mode</b> - not implemented
- - \b Remove
- - <b>Join selected sections</b>
+ The group \b Sections in this dialog represents the Polyline construction framework. 
  
- <b>Undo/Redo</b> buttons allows to undo/redo changes of the polyline.
 -The buttons <b>Undo</b> and <b>Redo</b> allows to undo or redo the changes of the polyline.
++The buttons <b>Undo</b> and <b>Redo</b> allow to undo or redo the changes of the polyline.
  
- <b>Insert new section</b> button opens a dialog that allows to add a new section:
+ <b>Insert new section</b> button opens the corresponding dialog:
  
  \image html polyline_dlg_add_section.png
  
@@@ -65,33 -53,21 +53,21 @@@ and left-click in the viewer to add ne
  
  <b>Modification mode</b> and <b>Detection mode</b> are not implemented for the moment.
  
- \b Remove button allows to remove a section. It is available if all modes are deactivated and one section is selected.
+ \b Remove button allows removing a section. It is available if all modes are deactivated and one section is selected.
  
  <b>Join selected sections</b> button is available in modification mode if two or more sections are selected. It is used to
- merge several sections into the first one from selection list. Joined section has parameters of the first selected one. Points of
- the other sections are appended at the end of the list of the first section points.
+ merge several sections into the first one from the selection list. The points of the merged sections are appended at the end of the list of points of the first section.
  
- Some actions are available via popup menu by right mouse button click.
+ Some actions are available via the context menu activated by right mouse button click.
+ - <b>Join all sections</b> - joins all defined sections into the first one.
+ - \b Join - joins two or more selected sections.
+ - <b>Clear all</b> - removes all selected sections. 
+ - <b>Set closed</b> - sets \b Closed flag for all selected section.
+ - <b>Set open</b>  - unset \b Closed flag for all selected sections.
+ - <b>Set polyline</b> - sets the type of all selected sections to Polyline.
 -- <b>Set spline</b>  - set the type of all selected sections to Splineall. 
++- <b>Set spline</b>  - set the type of all selected sections to Spline. 
  
- If all modes are deactivated:
- - <b>Join all sections</b> - join all defined sections into the first one.
- - \b Join - join sections. Available if two or more sections are selected.
- In <b>Addition mode</b>:
- - <b>Join all sections</b> - join all defined sections into the first one.
- In <b>Modification mode</b>:
- - <b>Join all sections</b> - join all defined sections into the first one.
- - \b Join - join sections. Available if two or more sections are selected.
- - <b>Clear all</b> - remove all sections. Available if at least one section is selected.
- - <b>Set closed</b> - set all selected section's Closed flag. Available if at least one section is selected.
- - <b>Set open</b>  - reset all selected section's Closed flag. Available if at least one section is selected.
- - <b>Set polyline</b> - set all selected section's type to Polyline. Available if at least one section is selected.
- - <b>Set spline</b>  - set all selected section's type to Spline. Available if at least one section is selected.
- In <b>Detection mode</b>:
- - <b>Join all sections</b> - join all defined sections into the first one.
- - \b Join - join sections. Available if two or more sections are selected.
+ Different actions are available depending on the mode and selection.  
  
  <h2>TUI Commands</h2>
  
@@@ -103,5 -78,5 +78,5 @@@ To create the 2D polyline in TUI Polyli
  See the \ref gsketcher.Polyline2D "Polyline2D" interface documentation for more information.
  
  Our <b>TUI Scripts</b> provide you with useful examples of the use of
--\ref tui_polyline_page "2D Polyline".
++\ref tui_creation_polyline "2D Polyline".
  */
index e44dba4004e11d2995b53040551f5384bbaa9f21,62bd3bbe86e6c99186a943d0a98e97816f87b6ee..9afc744bceedf7ae992f1f49fe11597d7fef95e2
@@@ -71,24 -59,20 +59,19 @@@ Browser, OCC Viewer or Dependency Tree 
  \anchor dependency_tree_links_anchor <h2>Links</h2>
  
  Dependency Tree Viewer shows oriented links between nodes to 
- represent dependency direction. Viewer supports the following states 
- of links:
+ represent the dependency direction. The viewer supports the following states of links:
  
- <ul><li><b>Unidirectional link</b> - shows that A object depends on 
- B object;</li></ul>
 -<ul><li><b>Unidirectional link</b> - shows that object A depends on object B;</li></ul>
++<ul><li><b>Unidirectional link</b> - shows that object B depends on object A;</li></ul>
  \image html tree_unidir_link.png
  
- <ul><li><b>Bidirectional link</b> - shows that A object depends on 
- B object and, at the same time, B object depends on 
- A object;</li></ul>
 -<ul><li><b>Bidirectional link</b> - shows that object A depends on 
 -object B and, at the same time, object B depends on object A;</li></ul>
++<ul><li><b>Bidirectional link</b> - shows that object B depends on 
++object A and, at the same time, object A depends on object B;</li></ul>
  \image html tree_bidir_link.png
  
- <ul><li><b>Self-dependency link</b> - shows that object depends on 
- itself;</li></ul>
+ <ul><li><b>Self-dependency link</b> - shows that an object depends on itself;</li></ul>
  \image html tree_selfdep_link.png
  
--<ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of 
--some nodes.</li></ul>
++<ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of some nodes.</li></ul>
  \image html tree_cycldep_link.png
  
  <hr>
index c483ca71ccd6c90c64b4df02bcaeed659b3e3d6f,c483ca71ccd6c90c64b4df02bcaeed659b3e3d6f..a39809963aee53de68a9f52c947374d30301cb38
@@@ -31,6 -31,6 +31,7 @@@ provided by Geometry module
      <li>\ref tui_working_with_groups_page</li>
      <li>\ref tui_building_by_blocks_page</li>
      <li>\ref tui_sketcher_page</li>
++    <li>\ref tui_3dsketcher_page</li>
      <li>\ref tui_advanced_geom_objs_page</li>
    </ul>
    <li>\subpage tui_viewing_geom_objs_page</li>
index 89be6f64b4bb13c51c72a33057bc4f25f9bc6553,7266034d7ceddf4fd2e544ded80b79ae51670584..d7edb52275f6ecb6ff587fe8b72b2fb8e58526e4
@@@ -38,4 -38,7 +38,8 @@@
  <br><h2>Creation of a Local Coordinate System</h2>
  \tui_script{basic_geom_objs_ex09.py}
  
 -\page tui_polyline_page 2D Polyline
++\anchor tui_creation_polyline
++<br><h2>Creation of 2D Polyline</h2>
+ \tui_script{polyline.py}
  */