From b390e66e0c33a9c63053731b5799364094e365f6 Mon Sep 17 00:00:00 2001 From: jfa Date: Fri, 5 Oct 2007 06:48:46 +0000 Subject: [PATCH] Update geompy documentation for 3.2.8 version. --- .../GEOM/geompy_doc/classgeompy_1_1info.html | 2 +- .../gui/GEOM/geompy_doc/namespacegeompy.html | 180 +++++++++++++++++- 2 files changed, 177 insertions(+), 5 deletions(-) diff --git a/doc/salome/gui/GEOM/geompy_doc/classgeompy_1_1info.html b/doc/salome/gui/GEOM/geompy_doc/classgeompy_1_1info.html index d9f324afe..506e54cf3 100644 --- a/doc/salome/gui/GEOM/geompy_doc/classgeompy_1_1info.html +++ b/doc/salome/gui/GEOM/geompy_doc/classgeompy_1_1info.html @@ -96,6 +96,6 @@
-Generated on Wed Jun 20 12:05:38 2007 for SALOME - GEOM - v.3.2.6 by doxygen 1.4.6
+Generated on Fri Oct 5 10:42:14 2007 for SALOME - GEOM - v.3.2.8 by doxygen 1.4.6 diff --git a/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html b/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html index 1e2efe332..44e46b76d 100644 --- a/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html +++ b/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html @@ -157,6 +157,11 @@ def MakePipeWithShellSections  Create a shape by extrusion of the profile shape along the path shape.
+def MakePipeWithShellSectionsBySteps + +def MakePipeShellsWithoutPath + + Create solids between given sections.
def MakeEdge  Create a linear edge with specified ends.
@@ -238,6 +243,9 @@ def GetInPlace  Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.
+def GetInPlaceByHistory + + Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.
def GetSame  Get sub-shape of theShapeWhere, which is equal to theShapeWhat.
@@ -2914,7 +2922,7 @@ The path shape can be a shell or a face. the several profiles can be specified i - + @@ -2924,6 +2932,111 @@ The path shape can be a shell or a face. the several profiles can be specified i Example: see GEOM_TestAll.py
theSeqBases - list of Bases shape to be extruded.
theSeqSubBases - list of corresponding subshapes of section shapes.
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 locations must be coincided with first and last vertexes of path correspondingly.
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 locations must be coincided with first and last vertexes of path correspondingly.
thePath - Path shape to extrude the base shape along it.
theWithContact - the mode defining that the section is translated to be in contact with the spine.
- WithCorrection - defining that the section is rotated to be orthogonal to the spine tangent in the correspondent point
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
def geompy.MakePipeWithShellSectionsBySteps (   theSeqBases,
  theSeqSubBases,
  theLocations,
  thePath,
  theWithContact,
  theWithCorrection
) 
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
def geompy.MakePipeShellsWithoutPath (   theSeqBases,
  theLocations
) 
+
+ + + + + +
+   + + +

+

Parameters:
+ + + +
theSeqBases - list of sections (shell or face).
theLocations - list of corresponding vertexes
+
+
Returns:
New GEOM_Object, containing the created solids.
+Example: see GEOM_TestAll.py

@@ -4208,6 +4321,51 @@ Example: see GEOM_TestOthers.py Example: see GEOM_TestOthers.py
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
def geompy.GetInPlaceByHistory (   theShapeWhere,
  theShapeWhat
) 
+
+ + + + + +
+   + + +

+Implementation of this method is based on a saved history of an operation, produced theShapeWhere. The theShapeWhat must be among this operation's arguments (an argument shape or a sub-shape of an argument shape). The operation could be the Partition or one of boolean operations, performed on simple shapes (not on compounds).

+

Parameters:
+ + + +
theShapeWhere Shape to find sub-shapes of.
theShapeWhat Shape, specifying what to find (must be in the building history of the ShapeWhere).
+
+
Returns:
Group of all found sub-shapes or a single found sub-shape.
+Example: see GEOM_TestOthers.py

@@ -5186,7 +5344,13 @@ Example: see GEOM_TestAll.py - + + + + + + + @@ -5209,6 +5373,7 @@ Example: see GEOM_TestAll.py
  theTolerance theTolerance,
  doKeepNonSolids = True
+
theShape Initial shape.
theTolerance Maximum distance between faces, which can be considered as coincident.
doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.

Returns:
New GEOM_Object, containing a copy of theShape without coincident faces.
@@ -5280,7 +5445,13 @@ Example: see GEOM_Spanner.py   - theFaces + theFaces, + + + + +   + doKeepNonSolids = True @@ -5304,6 +5475,7 @@ Example: see GEOM_Spanner.py theShape Initial shape. theTolerance Maximum distance between faces, which can be considered as coincident. theFaces List of faces for gluing. + doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
Returns:
New GEOM_Object, containing a copy of theShape without some faces.
@@ -9862,6 +10034,6 @@ If include_min/max == 0, edges with length == min/max_length will not be include
-Generated on Wed Jun 20 12:05:38 2007 for SALOME - GEOM - v.3.2.6 by doxygen 1.4.6
+Generated on Fri Oct 5 10:42:14 2007 for SALOME - GEOM - v.3.2.8 by doxygen 1.4.6 -- 2.39.2