0020695: EDF 1076 GEOM: Add a new shape in GEOM: T-shape

Update documentation

doc/salome/gui/GEOM/input/creating_adv_obj.doc

@@ -17,6 +17,7 @@ entities:
 <b>New Entity -> Advanced </b> submenu allows to create additional complex topological objects.
 
 <ul>
+<li>\subpage create_pipetshape_page</li>
 <!--@@ insert new functions before this line @@-->
 </ul>
 

doc/salome/gui/GEOM/input/creating_pipetshape.doc

@@ -0,0 +1,58 @@
+/*!
+
+\page create_pipetshape_page PipeTShape
+
+To create a \b PipeTShape in the <b>Main Menu</b> select <b>New Entity - >
+Advanced - > PipeTShape </b>
+
+Specify the parameters of the PipeTShape object creation in the opened dialog
+box and press "Apply" or "Apply & Close" button.
+Result of each operation will be a GEOM_Object.
+
+<b>TUI Command:</b> <em>geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None)</em>
+
+<b>Arguments:</b>
+- \b R1 - Radius of main T-shape pipe.
+- \b W1 - Thickness of main T-shape pipe.
+- \b L1 - Length of main T-shape pipe.
+- \b R2 - Radius of incident T-shape pipe.
+- \b W2 - Thickness of incident T-shape pipe.
+- \b L2 - Length of incident T-shape pipe.
+- \b HexMesh - If True, the shape is splitted in blocks (suitable for hexaedral mesh).
+- \b P1 - First junction point of main pipe (GEOM Vertex).
+- \b P2 - Second junction point of main pipe (GEOM Vertex).
+- \b P3 - Junction point of incident pipe (GEOM Vertex).
+
+\image html pipetshape_dlg.png
+
+Example:
+
+\image html pipetshape.png
+
+A Pipe T-Shape can be created with a chamfer at the junction of the main and the incident pipes:
+
+<b>TUI Command:</b> <em>geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None)</em>
+
+<b>Arguments are the same as normal Pipe T-Shape plus:</b>
+- \b H - Height of the chamfer along incident pipe.
+- \b W - Width of the chamfer along the main pipe.
+
+Example:
+
+\image html pipetshapechamfer.png
+
+A Pipe T-Shape can be created with a fillet at the junction of the main and the incident pipes:
+
+<b>TUI Command:</b> <em>geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None)</em>
+
+<b>Arguments are the same as normal Pipe T-Shape plus:</b>
+- \b RF - Radius of the fillet.
+
+Example:
+
+\image html pipetshapefillet.png
+
+Our <b>TUI Scripts</b> provide you with useful examples of creation of
+\ref tui_creation_pipetshape "Advanced objects".
+
+*/

doc/salome/gui/GEOM/input/tui_advanced_geom_objs.doc

@@ -218,5 +218,83 @@ id_compound = geompy.addToStudy(compound,"Compound")
 gg.createAndDisplayGO(id_compound) 
 \endcode
 
+\anchor tui_creation_pipetshape
+<br><h2>Creation of PipeTShape</h2>
+
+\code
+import geompy
+import salome
+gg = salome.ImportComponentGUI("GEOM")
+
+# create PipeTShape object
+pipetshape = geompy.MakePipeTShape(80.0, 20.0, 200.0, 50.0, 20.0, 200.0)
+
+# add object in the study
+id_pipetshape = geompy.addToStudy(pipetshape[0],"PipeTShape")
+# add groups in the study
+for g in pipetshape[1:]:
+    geompy.addToStudyInFather(pipetshape[0], g, g.GetName())
+    
+# Create junction vertices
+P1 = geompy.MakeVertex(0.0, 0.0, 0.0)
+P2 = geompy.MakeVertex(400.0, 0.0, 0.0)
+P3 = geompy.MakeVertex(200.0, 0.0, 200.0)
+
+# create PipeTShape object with position
+pipetshape_position = geompy.MakePipeTShape(80.0, 20.0, 200.0, 50.0, 20.0, 200.0, True, P1, P2, P3)
+
+# add object in the study
+id_pipetshape_position = geompy.addToStudy(pipetshape_position[0],"PipeTShape_position")
+# add groups in the study
+for g in pipetshape_position[1:]:
+    geompy.addToStudyInFather(pipetshape_position[0], g, g.GetName())
+
+# create PipeTShape with chamfer object
+pipetshapechamfer = geompy.MakePipeTShapeChamfer(80.0, 20.0, 200.0, 50.0, 20.0, 200.0, 20.0, 20.0)
+
+# add object in the study
+id_pipetshapechamfer = geompy.addToStudy(pipetshapechamfer[0],"PipeTShapeChamfer")
+# add groups in the study
+for g in pipetshapechamfer[1:]:
+    geompy.addToStudyInFather(pipetshapechamfer[0], g, g.GetName())
+
+# create PipeTShape with chamfer object with position
+pipetshapechamfer_position = geompy.MakePipeTShapeChamfer(80.0, 20.0, 200.0, 50.0, 20.0, 200.0, 20.0, 20.0, True, P1, P2, P3)
+
+# add object in the study
+id_pipetshapechamfer_position = geompy.addToStudy(pipetshapechamfer_position[0],"PipeTShapeChamfer_position")
+# add groups in the study
+for g in pipetshapechamfer_position[1:]:
+    geompy.addToStudyInFather(pipetshapechamfer_position[0], g, g.GetName())
+
+# create PipeTShape with fillet object
+pipetshapefillet = geompy.MakePipeTShapeFillet(80.0, 20.0, 200.0, 50.0, 20.0, 200.0, 5.0)
+
+# add object in the study
+id_pipetshapefillet = geompy.addToStudy(pipetshapefillet[0],"PipeTShapeFillet")
+# add groups in the study
+for g in pipetshapefillet[1:]:
+    geompy.addToStudyInFather(pipetshapefillet[0], g, g.GetName())
+
+# create PipeTShape with fillet object with position
+pipetshapefillet_position = geompy.MakePipeTShapeFillet(80.0, 20.0, 200.0, 50.0, 20.0, 200.0, 5.0, True, P1, P2, P3)
+
+# add object in the study
+id_pipetshapefillet_position = geompy.addToStudy(pipetshapefillet_position[0],"PipeTShapeFillet_position")
+# add groups in the study
+for g in pipetshapefillet_position[1:]:
+    geompy.addToStudyInFather(pipetshapefillet_position[0], g, g.GetName())
+    
+
+# display pipetshapes
+gg.createAndDisplayGO(id_pipetshape)
+gg.createAndDisplayGO(id_pipetshape_position)
+gg.createAndDisplayGO(id_pipetshapechamfer)
+gg.createAndDisplayGO(id_pipetshapechamfer_position)
+gg.createAndDisplayGO(id_pipetshapefillet)
+gg.createAndDisplayGO(id_pipetshapefillet_position)
+
+\endcode
+
 <!--@@ insert new functions before this line @@-->
 */