From: jfa Date: Fri, 13 Apr 2007 13:20:46 +0000 (+0000) Subject: Update documentation for geompy Python module X-Git-Tag: V3_2_6~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=83da4517874a4959694c3d7856a7e31311a74909;p=modules%2Fgeom.git Update documentation for geompy Python module --- diff --git a/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html b/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html index 4cc08c421..1a594fd19 100644 --- a/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html +++ b/doc/salome/gui/GEOM/geompy_doc/namespacegeompy.html @@ -69,6 +69,9 @@ def MakeArc  Create an arc of circle, passing through three given points.
+def MakeArcCenter + + Create an arc of circle from a center and 2 points.
def MakeCircle  Create a circle with given center, normal vector and radius.
@@ -147,6 +150,9 @@ def MakePipeWithDifferentSections  Create a shape by extrusion of the profile shape along the path shape.
+def MakePipeWithShellSections + + Create a shape by extrusion of the profile shape along the path shape.
def MakeEdge  Create a linear edge with specified ends.
@@ -297,6 +303,12 @@ def MakeGlueFaces  Replace coincident faces in theShape by one face.
+def GetGlueFaces + + Find coincident faces in theShape for possible gluing.
+def MakeGlueFacesByList + + Replace coincident faces in theShape by one face in compliance with given list of faces.
def MakeBoolean  Perform one of boolean operations on two given shapes.
@@ -426,6 +438,9 @@ def GetPosition  Get position (LCS) of theShape.
+def KindOfShape + + Get kind of theShape.
def Import  Import a shape from the BREP or IGES or STEP file (depends on given format) with given name.
@@ -559,41 +574,6 @@  Add Path to load python scripts from.

Variables

-tuple g = lcc.FindOrLoadComponent("FactoryServer", "GEOM") - -tuple geom = g._narrow( GEOM.GEOM_Gen ) - - myBuilder = None - -int myStudyId = 0 - - father = None - - BasicOp = None - - CurvesOp = None - - PrimOp = None - - ShapesOp = None - - HealOp = None - - InsertOp = None - - BoolOp = None - - TrsfOp = None - - LocalOp = None - - MeasuOp = None - - BlocksOp = None - - GroupOp = None - -dictionary ShapeType = {"COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8} tuple g = lcc.FindOrLoadComponent("FactoryServer", "GEOM") @@ -631,6 +611,8 @@ dictionary ShapeType = {"COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8} + kind = GEOM.GEOM_IKindOfShape +

Function Documentation

@@ -1500,6 +1482,63 @@ Example: see GEOM_TestAll.py Example: see GEOM_TestAll.py +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
def geompy::MakeArcCenter (   thePnt1,
  thePnt2,
  thePnt3,
  theSense
) 
+
+ + + + + +
+   + + +

+

Parameters:
+ + + + +
thePnt1 Center of the arc
thePnt2 Start point of the arc. (Gives also the radius of the arc)
thePnt3 End point of the arc (Gives also a direction)
+
+
Returns:
New GEOM_Object, containing the created arc.
+Example: see GEOM_TestAll.py

@@ -2810,6 +2849,78 @@ The path shape can be a wire or an edge. the several profiles can be specified i Example: see GEOM_TestAll.py
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
def geompy::MakePipeWithShellSections (   theSeqBases,
  theSeqSubBases,
  theLocations,
  thePath,
  theWithContact,
  theWithCorrection
) 
+
+ + + + + +
+   + + +

+The path shape can be a shell or a face. the several profiles can be specified in the several locations of path.

Parameters:
+ + + + + + + +
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 or list of locations can be empty.
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
+
+
Returns:
New GEOM_Object, containing the created solids.
+Example: see GEOM_TestAll.py

@@ -4134,7 +4245,7 @@ Example: see GEOM_TestOthers.py
theShapeWhat Shape, specifying what to find.
-

Returns:
New GEOM_Object for found sub-shape.
+
Returns:
New GEOM_Object for found sub-shape.
@@ -5101,6 +5212,101 @@ Example: see GEOM_TestAll.py Example: see GEOM_Spanner.py +

+ + + + +
+ + + + + + + + + + + + + + + + + + +
def geompy::GetGlueFaces (   theShape,
  theTolerance
) 
+
+ + + + + +
+   + + +

+

Parameters:
+ + + +
theShape Initial shape.
theTolerance Maximum distance between faces, which can be considered as coincident.
+
+
Returns:
ListOfGO.
+Example: see GEOM_Spanner.py
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
def geompy::MakeGlueFacesByList (   theShape,
  theTolerance,
  theFaces
) 
+
+ + + + + +
+   + + +

+

Parameters:
+ + + + +
theShape Initial shape.
theTolerance Maximum distance between faces, which can be considered as coincident.
theFaces List of faces for gluing.
+
+
Returns:
New GEOM_Object, containing a copy of theShape without some faces.
+Example: see GEOM_Spanner.py

@@ -5367,8 +5573,8 @@ Example: see GEOM_TestOthers.py
Parameters:
- - + +
ListShapes Shapes to be intersected.
ListTools Shapes to intersect theShapes. !!!NOTE: Each compound from ListShapes and ListTools will be exploded in order to avoid possible intersection between shapes from this compound.
Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
ListTools Shapes to intersect theShapes. !!!NOTE: Each compound from ListShapes and ListTools will be exploded in order to avoid possible intersection between shapes from this compound.
Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
After implementation new version of PartitionAlgo (October 2006) other parameters are ignored by current functionality. They are kept in this function only for support old versions. Ignored parameters:

Parameters:
@@ -5450,7 +5656,7 @@ Example: see GEOM_TestAll.py This method may be useful if it is needed to make a partition for compound contains nonintersected shapes. Performance will be better since intersection between shapes from compound is not performed.

Description of all parameters as in previous method MakePartition()

!!!NOTE: Passed compounds (via ListShapes or via ListTools) have to consist of nonintersecting shapes.

-

Returns:
New GEOM_Object, containing the result shapes.
+
Returns:
New GEOM_Object, containing the result shapes.
@@ -7217,22 +7423,89 @@ Origin of the LCS is situated at the shape's center of mass. Axes of the LCS are Example: see GEOM_TestMeasures.py -

+

+ +
- + - + + + - - - - - +
def geompy::Import def geompy::KindOfShape (    theFileName, theShape  ) 
  theFormatName
+
+ + + + + +
+   + + +

+

Parameters:
+ + +
theShape Shape to get a kind of.
+
+
Returns:
Returns a kind of shape in terms of GEOM_IKindOfShape.shape_kind enumeration and a list of parameters, describing the shape.
+
Note:
Concrete meaning of each value, returned via theIntegers or theDoubles list depends on the kind of the shape. The full list of possible outputs is:
+geompy.kind.COMPOUND nb_solids nb_faces nb_edges nb_vertices

+geompy.kind.COMPSOLID nb_solids nb_faces nb_edges nb_vertices

+geompy.kind.SHELL geompy.info.CLOSED nb_faces nb_edges nb_vertices

+geompy.kind.SHELL geompy.info.UNCLOSED nb_faces nb_edges nb_vertices

+geompy.kind.WIRE geompy.info.CLOSED nb_edges nb_vertices

+geompy.kind.WIRE geompy.info.UNCLOSED nb_edges nb_vertices

+geompy.kind.SPHERE xc yc zc R

+geompy.kind.CYLINDER xb yb zb dx dy dz R H

+geompy.kind.BOX xc yc zc ax ay az

+geompy.kind.ROTATED_BOX xc yc zc zx zy zz xx xy xz ax ay az

+geompy.kind.TORUS xc yc zc dx dy dz R_1 R_2

+geompy.kind.CONE xb yb zb dx dy dz R_1 R_2 H

+geompy.kind.POLYHEDRON nb_faces nb_edges nb_vertices

+geompy.kind.SOLID nb_faces nb_edges nb_vertices

+geompy.kind.SPHERE2D xc yc zc R

+geompy.kind.CYLINDER2D xb yb zb dx dy dz R H

+geompy.kind.TORUS2D xc yc zc dx dy dz R_1 R_2

+geompy.kind.CONE2D xc yc zc dx dy dz R_1 R_2 H

+geompy.kind.DISK_CIRCLE xc yc zc dx dy dz R

+geompy.kind.DISK_ELLIPSE xc yc zc dx dy dz R_1 R_2

+geompy.kind.POLYGON xo yo zo dx dy dz nb_edges nb_vertices

+geompy.kind.PLANE xo yo zo dx dy dz

+geompy.kind.PLANAR xo yo zo dx dy dz nb_edges nb_vertices

+geompy.kind.FACE nb_edges nb_vertices

+geompy.kind.CIRCLE xc yc zc dx dy dz R

+geompy.kind.ARC_CIRCLE xc yc zc dx dy dz R x1 y1 z1 x2 y2 z2

+geompy.kind.ELLIPSE xc yc zc dx dy dz R_1 R_2

+geompy.kind.ARC_ELLIPSE xc yc zc dx dy dz R_1 R_2 x1 y1 z1 x2 y2 z2

+geompy.kind.LINE xo yo zo dx dy dz

+geompy.kind.SEGMENT x1 y1 z1 x2 y2 z2

+geompy.kind.EDGE nb_vertices

+geompy.kind.VERTEX x y z

+Example: see GEOM_TestMeasures.py

+

+ + +
+ + + + + + + + + + + + @@ -9567,404 +9840,13 @@ If include_min/max == 0, edges with length == min/max_length will not be include
def geompy::Import (   theFileName,
  theFormatName
-

- - - - -
- - - - -
tuple geompy.g = lcc.FindOrLoadComponent("FactoryServer", "GEOM") [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
tuple geompy.geom = g._narrow( GEOM.GEOM_Gen ) [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.myBuilder = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
int geompy.myStudyId = 0 [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.father = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.BasicOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.CurvesOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.PrimOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.ShapesOp = None [static]
-
- - - - - -
-   - - -

-

-

+

- -
- - -
geompy.HealOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.InsertOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.BoolOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.TrsfOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.LocalOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.MeasuOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.BlocksOp = None [static]
-
- - - - - -
-   - - -

-

-

- - - - -
- - - - -
geompy.GroupOp = None [static]
-
- - - - - -
-   - - -

-

-

- - -
- - - +
dictionary geompy.ShapeType = {"COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8} [static] geompy.kind = GEOM.GEOM_IKindOfShape [static]