Salome HOME
Bug 0020029: EDF 845 GEOM: impossible to set a negative angle for the revolution...
[modules/geom.git] / src / GEOM_SWIG / geompyDC.py
index b91591f97ab67ade7fc8c681b7db71cca72c99a5..f0afc1d9c8835c330835be6e66644d5f44a1d4b7 100644 (file)
@@ -217,8 +217,6 @@ class geompyDC(GEOM._objref_GEOM_Gen):
 
         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
         #  To be used from python scripts out of geompy.addToStudy (non-default usage)
-        #  \param theStudy  the study, in which theObject is published already,
-        #                   and in which the arguments will be published
         #  \param theObject published GEOM object, arguments of which will be published
         #  \param theArgs   list of GEOM_Object, operation arguments to be published.
         #                   If this list is empty, all operation arguments will be published
@@ -938,7 +936,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
         #                             orthogonal to the spine tangent in the correspondent point
         #  @return New GEOM_Object, containing the created pipe.
         #
-        #  @ref swig_todo "Example"
+        #  @ref tui_creation_pipe_with_diff_sec "Example"
         def MakePipeWithDifferentSections(self, theSeqBases,
                                           theLocations, thePath,
                                           theWithContact, theWithCorrection):
@@ -949,10 +947,16 @@ class geompyDC(GEOM._objref_GEOM_Gen):
             return anObj
 
         ## Create a shape by extrusion of the profile shape along
-        #  the path shape. The path shape can be a shell or a face.
+        #  the path shape. The path shape can be a wire or a edge.
         #  the several profiles can be specified in the several locations of path.     
-        #  @param theSeqBases - list of  Bases shape to be extruded.
+        #  @param theSeqBases - list of  Bases shape to be extruded. Base shape must be
+        #                       shell or face. If number of faces in neighbour sections
+        #                       aren't coincided result solid between such sections will
+        #                       be created using external boundaries of this shells.
         #  @param theSeqSubBases - list of corresponding subshapes of section shapes.
+        #                          This list is used for searching correspondences between
+        #                          faces in the sections. Size of this list must be equal
+        #                          to size of list of base shapes.
         #  @param theLocations - list of locations on the path corresponding
         #                        specified list of the Bases shapes. Number of locations
         #                        should be equal to number of bases. First and last
@@ -965,7 +969,7 @@ class geompyDC(GEOM._objref_GEOM_Gen):
         #                             orthogonal to the spine tangent in the correspondent point
         #  @return New GEOM_Object, containing the created solids.
         #
-        #  @ref swig_todo "Example"
+        #  @ref tui_creation_pipe_with_shell_sec "Example"
         def MakePipeWithShellSections(self,theSeqBases, theSeqSubBases,
                                       theLocations, thePath,
                                       theWithContact, theWithCorrection):
@@ -975,6 +979,12 @@ class geompyDC(GEOM._objref_GEOM_Gen):
             RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
             return anObj
 
+        ## Create a shape by extrusion of the profile shape along
+        #  the path shape. This function is used only for debug pipe
+        #  functionality - it is a version of previous function
+        #  (MakePipeWithShellSections(...)) which give a possibility to
+        #  recieve information about creating pipe between each pair of
+        #  sections step by step.
         def MakePipeWithShellSectionsBySteps(self, theSeqBases, theSeqSubBases,
                                              theLocations, thePath,
                                              theWithContact, theWithCorrection):
@@ -1011,12 +1021,29 @@ class geompyDC(GEOM._objref_GEOM_Gen):
         #  @param theLocations - list of corresponding vertexes
         #  @return New GEOM_Object, containing the created solids.
         #
-        #  @ref swig_todo "Example"
+        #  @ref tui_creation_pipe_without_path "Example"
         def MakePipeShellsWithoutPath(self, theSeqBases, theLocations):
             anObj = self.PrimOp.MakePipeShellsWithoutPath(theSeqBases, theLocations)
             RaiseIfFailed("MakePipeShellsWithoutPath", self.PrimOp)
             return anObj
 
+        ## Create a shape by extrusion of the base shape along
+        #  the path shape with constant bi-normal direction along the given vector.
+        #  The path shape can be a wire or an edge.
+        #  @param theBase Base shape to be extruded.
+        #  @param thePath Path shape to extrude the base shape along it.
+        #  @param theVec Vector defines a constant binormal direction to keep the
+        #                same angle beetween the direction and the sections
+        #                along the sweep surface.
+        #  @return New GEOM_Object, containing the created pipe.
+        #
+        #  @ref tui_creation_pipe "Example"
+        def MakePipeBiNormalAlongVector(self,theBase, thePath, theVec):
+            # Example: see GEOM_TestAll.py
+            anObj = self.PrimOp.MakePipeBiNormalAlongVector(theBase, thePath, theVec)
+            RaiseIfFailed("MakePipeBiNormalAlongVector", self.PrimOp)
+            return anObj
+
         # end of l3_complex
         ## @}
 
@@ -1671,9 +1698,8 @@ class geompyDC(GEOM._objref_GEOM_Gen):
             RaiseIfFailed("DivideEdge", self.HealOp)
             return anObj
 
-        ## Change orientation of the given object.
+        ## Change orientation of the given object. Updates given shape.
         #  @param theObject Shape to be processed.
-        #  @update given shape
         #
         #  @ref swig_todo "Example"
         def ChangeOrientationShell(self,theObject):
@@ -1996,16 +2022,33 @@ class geompyDC(GEOM._objref_GEOM_Gen):
         ## Scale the given object by the factor, creating its copy before the scaling.
         #  @param theObject The object to be scaled.
         #  @param thePoint Center point for scaling.
+        #                  Passing None for it means scaling relatively the origin of global CS.
         #  @param theFactor Scaling factor value.
         #  @return New GEOM_Object, containing the scaled shape.
         #
         #  @ref tui_scale "Example"
-        def MakeScaleTransform(self,theObject, thePoint, theFactor):
+        def MakeScaleTransform(self, theObject, thePoint, theFactor):
             # Example: see GEOM_TestAll.py
             anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
             RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
             return anObj
 
+        ## Scale the given object by different factors along coordinate axes,
+        #  creating its copy before the scaling.
+        #  @param theObject The object to be scaled.
+        #  @param thePoint Center point for scaling.
+        #                  Passing None for it means scaling relatively the origin of global CS.
+        #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
+        #  @return New GEOM_Object, containing the scaled shape.
+        #
+        #  @ref swig_scale "Example"
+        def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ):
+            # Example: see GEOM_TestAll.py
+            anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
+                                                        theFactorX, theFactorY, theFactorZ)
+            RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
+            return anObj
+
         ## Create an object, symmetrical
         #  to the given one relatively the given plane.
         #  @param theObject The object to be mirrored.