Create documentation

doc/salome/gui/GEOM/input/extension_operation.doc

@@ -0,0 +1,58 @@
+/*!
+
+\page extension_operation_page Extension of an Edge or a Face
+
+\n To produce an \b Extension in the <b>Main Menu</b> select
+<b>Operations - > Transformation - > Extension</b>
+
+\n This operation resizes an \b Edge by means of first
+ and last parameters modification or a \b Face by means of modification
+ of minimal and maximal U- and V-Parameters. \n
+\ref restore_presentation_parameters_page "Advanced options".
+
+The type of extension is defined using the radio buttons.
+
+Firstly it is possible to resize an \b Edge.
+\n <b>TUI Command:</b> <em>geompy.ExtendEdge(theEdge, theMin, theMax)</em>,
+where \em theEdge the input edge to be resized, \em theMin the minimal
+parameter value, \em theMax the maximal parameter value.
+\n <b>Arguments:</b> Name + Object (Edge) + 2 values (Min and Max Parameters).
+
+\image html extension1.png "Extension of an Edge"
+
+\n <b>Example:</b>
+
+\image html extend_edge_example.png "Original edge (white) and extended edge"
+
+\note The input Edge parameters range is [0, 1]. If \b theMin parameter is
+      negative, the input Edge is extended, otherwise it is shrinked by
+      \b theMin parameter. If \b theMax is greater than 1, the Edge is
+      extended, otherwise it is shrinked by \btheMax parameter.
+
+Secondly it is possible to resize a \b Face.
+\n <b>TUI Command:</b> <em>geompy.ExtendFace(theFace, theUMin, theUMax,
+theVMin, theVMax)</em>, where \em theFace the input face to be resized,
+\em theUMin the minimal U-Parameter value, \em theUMax the maximal U-Parameter
+value, \em theVMin the minimal V-Parameter value, \em theVMax the maximal
+V-Parameter value.
+\n <b>Arguments:</b> Name + Object (Face) + 4 values (Min and Max U- and
+V-Parameters).
+
+\image html extension2.png "Extension of a Face"
+
+\n <b>Example:</b>
+
+\image html extend_face_example.png "The original face (gray) and a result
+       face shrinked along U-Direction and extended along V-Direction"
+
+\note The input Face U- and V-Parameters range is [0, 1]. If \b theUMin
+      parameter is negative, the input Face is extended, otherwise it is
+      shrinked along U-Direction by \b theUMin parameter. If theUMax is
+      greater than 1, the Face is extended, otherwise it is shrinked along
+      U-Direction by \b theUMax parameter. So as for \b theVMin, \b theVMax
+      and V-Direction of the input Face.
+
+Our <b>TUI Scripts</b> provide you with useful examples of the use of
+\ref tui_extend "Extension Operations".
+
+*/

doc/salome/gui/GEOM/input/transformation_operations.doc

@@ -16,6 +16,7 @@ which allow to:
 <li>\subpage scale_operation_page "Scale" an object by one or several scale factors.</li>
 <li>Create an \subpage offset_operation_page "Offset" of an object.</li>
 <li>Create a \subpage projection_operation_page "Projection" of an object on a face.</li>
+<li>Create an \subpage extension_operation_page "Extension" of an edge or a face.</li>
 <li>Create a simultaneous \subpage multi_translation_operation_page "Translation in several directions".</li>
 <li>Create a simultaneous \subpage multi_rotation_operation_page</li> "Rotation in several directions".</li>
 </ul>

resources/CMakeLists.txt

@@ -89,10 +89,12 @@ SET( _res_files
   displayonly.png
   displayall.png
   draft.png
+  edgeextension.png
   erase.png
   eraseall.png
   extruded_boss.png
   extruded_cut.png
+  faceextension.png
   face_hw.png
   face_vechw.png
   feature_detect.png

src/GEOMGUI/GEOM_images.ts

@@ -429,11 +429,11 @@
         </message>
         <message>
             <source>ICON_DLG_EXTEND_EDGE</source>
-            <translation>filling.png</translation>
+            <translation>edgeextension.png</translation>
         </message>
         <message>
             <source>ICON_DLG_EXTEND_FACE</source>
-            <translation>projection.png</translation>
+            <translation>faceextension.png</translation>
         </message>
         <message>
             <source>ICON_DLG_PARTITION</source>
@@ -1105,7 +1105,7 @@
         </message>
         <message>
             <source>ICO_EXTENSION</source>
-            <translation>filling.png</translation>
+            <translation>edgeextension.png</translation>
         </message>
         <message>
             <source>ICO_ORIGIN_AND_VECTORS</source>

src/GEOM_SWIG/GEOM_TestAll.py

@@ -255,6 +255,8 @@ def TestAll (geompy, math):
   Offset      = geompy.MakeOffset(Box, 10.)          #(GEOM_Object, Double)->GEOM_Object
   Orientation = geompy.ChangeOrientation(Box)
   ProjOnWire  = geompy.MakeProjectionOnWire(p0, Wire)
+  ExtEdge     = geompy.ExtendEdge(Edge1, -0.3, 1.3)
+  ExtFace     = geompy.ExtendFace(Face5, -0.3, 1.3, -0.1, 1.1)
 
   #IDList for Fillet/Chamfer
   prism_edges = geompy.ExtractShapes(Prism, geompy.ShapeType["EDGE"], True)
@@ -469,6 +471,8 @@ def TestAll (geompy, math):
   id_Offset      = geompy.addToStudy(Offset,        "Offset")
   id_Orientation = geompy.addToStudy(Orientation,   "Orientation")
   id_ProjOnWire  = geompy.addToStudy(ProjOnWire[1], "ProjOnWire")
+  id_ExtEdge     = geompy.addToStudy(ExtEdge,       "ExtendedEdge")
+  id_ExtFace     = geompy.addToStudy(ExtFace,       "ExtendedFace")
 
   id_Fillet   = geompy.addToStudy(Fillet,   "Fillet")
   id_Fillet2  = geompy.addToStudy(Fillet2,  "Fillet2")

src/TransformationGUI/TransformationGUI_ExtensionDlg.cxx

@@ -123,7 +123,7 @@ TransformationGUI_ExtensionDlg::TransformationGUI_ExtensionDlg
   layout->addWidget(aGrp);
   /***************************************************************/
 
-  setHelpFileName("create_extension_page.html");
+  setHelpFileName("extension_operation_page.html");
 
   /* Initialisations */
   Init();