Salome HOME
6d47c038af51cf2c34beea0f479da9418e845548
[modules/geom.git] / src / GEOM_SWIG / geompy.py
1 #  GEOM GEOM_SWIG : binding of C++ omplementaion with Python
2 #
3 #  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 #  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 #
6 #  This library is free software; you can redistribute it and/or
7 #  modify it under the terms of the GNU Lesser General Public
8 #  License as published by the Free Software Foundation; either
9 #  version 2.1 of the License.
10 #
11 #  This library is distributed in the hope that it will be useful,
12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 #  Lesser General Public License for more details.
15 #
16 #  You should have received a copy of the GNU Lesser General Public
17 #  License along with this library; if not, write to the Free Software
18 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 #
20 #  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
21 #
22 #
23 #
24 #  File   : geompy.py
25 #  Author : Paul RASCLE, EDF
26 #  Module : GEOM
27 #  $Header$
28
29 from salome import *
30 import GEOM
31
32 """
33     \namespace geompy
34     \brief Module geompy
35 """
36
37 g = lcc.FindOrLoadComponent("FactoryServer", "GEOM")
38 geom = g._narrow( GEOM.GEOM_Gen )
39 gg = ImportComponentGUI("GEOM")
40 gg.initGeomGen()
41
42 #SRN: modified on Mar 18, 2005
43
44 myBuilder = None
45 myStudyId = 0
46 father    = None
47
48 BasicOp  = None
49 CurvesOp = None
50 PrimOp   = None
51 ShapesOp = None
52 HealOp   = None
53 InsertOp = None
54 BoolOp   = None
55 TrsfOp   = None
56 LocalOp  = None
57 MeasuOp  = None
58 BlocksOp = None
59 GroupOp  = None
60
61 def init_geom(theStudy):
62
63     global myStudy, myBuilder, myStudyId, BasicOp, CurvesOp, PrimOp, ShapesOp, HealOp
64     global InsertOp, BoolOp, TrsfOp, LocalOp, MeasuOp, BlocksOp, GroupOp, father
65
66     myStudy = theStudy
67     myStudyId = myStudy._get_StudyId()
68     myBuilder = myStudy.NewBuilder()
69     father = myStudy.FindComponent("GEOM")
70     if father is None:
71         father = myBuilder.NewComponent("GEOM")
72         A1 = myBuilder.FindOrCreateAttribute(father, "AttributeName")
73         FName = A1._narrow(SALOMEDS.AttributeName)
74         FName.SetValue("Geometry")
75         A2 = myBuilder.FindOrCreateAttribute(father, "AttributePixMap")
76         aPixmap = A2._narrow(SALOMEDS.AttributePixMap)
77         aPixmap.SetPixMap("ICON_OBJBROWSER_Geometry")
78         myBuilder.DefineComponentInstance(father,geom)
79         pass
80
81     # -----------------------------------------------------------------------------
82     # Assign Operations Interfaces
83     # -----------------------------------------------------------------------------
84
85     BasicOp  = geom.GetIBasicOperations    (myStudyId)
86     CurvesOp = geom.GetICurvesOperations   (myStudyId)
87     PrimOp   = geom.GetI3DPrimOperations   (myStudyId)
88     ShapesOp = geom.GetIShapesOperations   (myStudyId)
89     HealOp   = geom.GetIHealingOperations  (myStudyId)
90     InsertOp = geom.GetIInsertOperations   (myStudyId)
91     BoolOp   = geom.GetIBooleanOperations  (myStudyId)
92     TrsfOp   = geom.GetITransformOperations(myStudyId)
93     LocalOp  = geom.GetILocalOperations    (myStudyId)
94     MeasuOp  = geom.GetIMeasureOperations  (myStudyId)
95     BlocksOp = geom.GetIBlocksOperations   (myStudyId)
96     GroupOp  = geom.GetIGroupOperations   (myStudyId)
97     pass
98
99 init_geom(myStudy)
100
101 #SRN: end of modifications
102
103 def SubShapeName(aSubObj, aMainObj):
104     """
105      *  Get name for sub-shape aSubObj of shape aMainObj
106
107      *  Example: see GEOM_TestAll.py
108     """
109     aSubId  = orb.object_to_string(aSubObj)
110     aMainId = orb.object_to_string(aMainObj)
111     index = gg.getIndexTopology(aSubId, aMainId)
112     name = gg.getShapeTypeString(aSubId) + "_%d"%(index)
113     return name
114
115 def addToStudy(aShape, aName):
116     """
117      *  Publish in study aShape with name aName
118
119      *  Example: see GEOM_TestAll.py
120     """
121     try:
122         aSObject = geom.AddInStudy(myStudy, aShape, aName, None)
123     except:
124         print "addToStudy() failed"
125         return ""
126     return aShape.GetStudyEntry()
127
128 def addToStudyInFather(aFather, aShape, aName):
129     """
130      *  Publish in study aShape with name aName as sub-object of previously published aFather
131
132      *  Example: see GEOM_TestAll.py
133     """
134     try:
135         aSObject = geom.AddInStudy(myStudy, aShape, aName, aFather)
136     except:
137         print "addToStudyInFather() failed"
138         return ""
139     return aShape.GetStudyEntry()
140
141 # -----------------------------------------------------------------------------
142 # enumeration ShapeType as a dictionary
143 # -----------------------------------------------------------------------------
144
145 ShapeType = {"COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8}
146
147 # -----------------------------------------------------------------------------
148 # Basic primitives
149 # -----------------------------------------------------------------------------
150
151 def MakeVertex(theX, theY, theZ):
152     """
153      *  Create point by three coordinates.
154      *  \param theX The X coordinate of the point.
155      *  \param theY The Y coordinate of the point.
156      *  \param theZ The Z coordinate of the point.
157      *  \return New GEOM_Object, containing the created point.
158
159      *  Example: see GEOM_TestAll.py
160     """
161     anObj = BasicOp.MakePointXYZ(theX, theY, theZ)
162     if BasicOp.IsDone() == 0:
163       print "MakePointXYZ : ", BasicOp.GetErrorCode()
164     return anObj
165
166 def MakeVertexWithRef(theReference, theX, theY, theZ):
167     """
168      *  Create a point, distant from the referenced point
169      *  on the given distances along the coordinate axes.
170      *  \param theReference The referenced point.
171      *  \param theX Displacement from the referenced point along OX axis.
172      *  \param theY Displacement from the referenced point along OY axis.
173      *  \param theZ Displacement from the referenced point along OZ axis.
174      *  \return New GEOM_Object, containing the created point.
175
176      *  Example: see GEOM_TestAll.py
177     """
178     anObj = BasicOp.MakePointWithReference(theReference, theX, theY, theZ)
179     if BasicOp.IsDone() == 0:
180       print "MakePointWithReference : ", BasicOp.GetErrorCode()
181     return anObj
182
183 def MakeVertexOnCurve(theRefCurve, theParameter):
184     """
185      *  Create a point, corresponding to the given parameter on the given curve.
186      *  \param theRefCurve The referenced curve.
187      *  \param theParameter Value of parameter on the referenced curve.
188      *  \return New GEOM_Object, containing the created point.
189
190      *  Example: see GEOM_TestAll.py
191     """
192     anObj = BasicOp.MakePointOnCurve(theRefCurve, theParameter)
193     if BasicOp.IsDone() == 0:
194       print "MakePointOnCurve : ", BasicOp.GetErrorCode()
195     return anObj
196
197 def MakeVectorDXDYDZ(theDX, theDY, theDZ):
198     """
199      *  Create a vector with the given components.
200      *  \param theDX X component of the vector.
201      *  \param theDY Y component of the vector.
202      *  \param theDZ Z component of the vector.
203      *  \return New GEOM_Object, containing the created vector.
204
205      *  Example: see GEOM_TestAll.py
206     """
207     anObj = BasicOp.MakeVectorDXDYDZ(theDX, theDY, theDZ)
208     if BasicOp.IsDone() == 0:
209       print "MakeVectorDXDYDZ : ", BasicOp.GetErrorCode()
210     return anObj
211
212 def MakeVector(thePnt1, thePnt2):
213     """
214      *  Create a vector between two points.
215      *  \param thePnt1 Start point for the vector.
216      *  \param thePnt2 End point for the vector.
217      *  \return New GEOM_Object, containing the created vector.
218
219      *  Example: see GEOM_TestAll.py
220     """
221     anObj = BasicOp.MakeVectorTwoPnt(thePnt1, thePnt2)
222     if BasicOp.IsDone() == 0:
223       print "MakeVectorTwoPnt : ", BasicOp.GetErrorCode()
224     return anObj
225
226 def MakeLine(thePnt, theDir):
227     """
228      *  Create a line, passing through the given point
229      *  and parrallel to the given direction
230      *  \param thePnt Point. The resulting line will pass through it.
231      *  \param theDir Direction. The resulting line will be parallel to it.
232      *  \return New GEOM_Object, containing the created line.
233
234      *  Example: see GEOM_TestAll.py
235     """
236     anObj = BasicOp.MakeLine(thePnt, theDir)
237     if BasicOp.IsDone() == 0:
238       print "MakeLine : ", BasicOp.GetErrorCode()
239     return anObj
240
241 def MakeLineTwoPnt(thePnt1, thePnt2):
242     """
243      *  Create a line, passing through the given points
244      *  \param thePnt1 First of two points, defining the line.
245      *  \param thePnt2 Second of two points, defining the line.
246      *  \return New GEOM_Object, containing the created line.
247
248      *  Example: see GEOM_TestAll.py
249     """
250     anObj = BasicOp.MakeLineTwoPnt(thePnt1, thePnt2)
251     if BasicOp.IsDone() == 0:
252       print "MakeLineTwoPnt : ", BasicOp.GetErrorCode()
253     return anObj
254
255 def MakePlane(thePnt, theVec, theTrimSize):
256     """
257      *  Create a plane, passing through the given point
258      *  and normal to the given vector.
259      *  \param thePnt Point, the plane has to pass through.
260      *  \param theVec Vector, defining the plane normal direction.
261      *  \param theTrimSize Half size of a side of quadrangle face, representing the plane.
262      *  \return New GEOM_Object, containing the created plane.
263
264      *  Example: see GEOM_TestAll.py
265     """
266     anObj = BasicOp.MakePlanePntVec(thePnt, theVec, theTrimSize)
267     if BasicOp.IsDone() == 0:
268       print "MakePlanePntVec : ", BasicOp.GetErrorCode()
269     return anObj
270
271 def MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize):
272     """
273      *  Create a plane, passing through the three given points
274      *  \param thePnt1 First of three points, defining the plane.
275      *  \param thePnt2 Second of three points, defining the plane.
276      *  \param thePnt3 Fird of three points, defining the plane.
277      *  \param theTrimSize Half size of a side of quadrangle face, representing the plane.
278      *  \return New GEOM_Object, containing the created plane.
279
280      *  Example: see GEOM_TestAll.py
281     """
282     anObj = BasicOp.MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize)
283     if BasicOp.IsDone() == 0:
284       print "MakePlaneThreePnt : ", BasicOp.GetErrorCode()
285     return anObj
286
287 def MakePlaneFace(theFace, theTrimSize):
288     """
289      *  Create a plane, similar to the existing one, but with another size of representing face.
290      *  \param theFace Referenced plane.
291      *  \param theTrimSize New half size of a side of quadrangle face, representing the plane.
292      *  \return New GEOM_Object, containing the created plane.
293
294      *  Example: see GEOM_TestAll.py
295     """
296     anObj = BasicOp.MakePlaneFace(theFace, theTrimSize)
297     if BasicOp.IsDone() == 0:
298       print "MakePlaneFace : ", BasicOp.GetErrorCode()
299     return anObj
300
301 def MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ):
302     """
303      *  Create a local coordinate system.
304      *  \param OX,OY,OZ Three coordinates of coordinate system origin.
305      *  \param XDX,XDY,XDZ Three components of OX direction
306      *  \param YDX,YDY,YDZ Three components of OY direction
307      *  \return New GEOM_Object, containing the created coordinate system.
308
309      *  Example: see GEOM_TestAll.py
310     """
311     anObj = BasicOp.MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ)
312     if BasicOp.IsDone() == 0:
313       print "MakeMarker : ", BasicOp.GetErrorCode()
314     return anObj
315
316 def MakeMarkerPntTwoVec(theOrigin, theXVec, theYVec):
317     """
318      *  Create a local coordinate system.
319      *  \param theOrigin Point of coordinate system origin.
320      *  \param theXVec Vector of X direction
321      *  \param theYVec Vector of Y direction
322      *  \return New GEOM_Object, containing the created coordinate system.
323     """
324     O = PointCoordinates( theOrigin )
325     OXOY = []
326     for vec in [ theXVec, theYVec ]:
327         v1, v2 = SubShapeAll( vec, ShapeType["VERTEX"] )
328         p1 = PointCoordinates( v1 )
329         p2 = PointCoordinates( v2 )
330         for i in range( 0, 3 ):
331              OXOY.append( p2[i] - p1[i] )
332     #
333     anObj = BasicOp.MakeMarker( O[0], O[1], O[2],
334                                 OXOY[0], OXOY[1], OXOY[2],
335                                 OXOY[3], OXOY[4], OXOY[5], )
336     if BasicOp.IsDone() == 0:
337       print "MakeMarker : ", BasicOp.GetErrorCode()
338     return anObj
339
340 # -----------------------------------------------------------------------------
341 # Curves
342 # -----------------------------------------------------------------------------
343
344 def MakeArc(thePnt1, thePnt2, thePnt3):
345     """
346      *  Create an arc of circle, passing through three given points.
347      *  \param thePnt1 Start point of the arc.
348      *  \param thePnt2 Middle point of the arc.
349      *  \param thePnt3 End point of the arc.
350      *  \return New GEOM_Object, containing the created arc.
351
352      *  Example: see GEOM_TestAll.py
353     """
354     anObj = CurvesOp.MakeArc(thePnt1, thePnt2, thePnt3)
355     if CurvesOp.IsDone() == 0:
356       print "MakeArc : ", CurvesOp.GetErrorCode()
357     return anObj
358
359 def MakeCircle(thePnt, theVec, theR):
360     """
361      *  Create a circle with given center, normal vector and radius.
362      *  \param thePnt Circle center.
363      *  \param theVec Vector, normal to the plane of the circle.
364      *  \param theR Circle radius.
365      *  \return New GEOM_Object, containing the created circle.
366
367      *  Example: see GEOM_TestAll.py
368     """
369     anObj = CurvesOp.MakeCirclePntVecR(thePnt, theVec, theR)
370     if CurvesOp.IsDone() == 0:
371       print "MakeCirclePntVecR : ", CurvesOp.GetErrorCode()
372     return anObj
373
374 def MakeCircleThreePnt(thePnt1, thePnt2, thePnt3):
375     """
376      *  Create a circle, passing through three given points
377      *  \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
378      *  \return New GEOM_Object, containing the created circle.
379
380      *  Example: see GEOM_TestAll.py
381     """
382     anObj = CurvesOp.MakeCircleThreePnt(thePnt1, thePnt2, thePnt3)
383     if CurvesOp.IsDone() == 0:
384       print "MakeCircleThreePnt : ", CurvesOp.GetErrorCode()
385     return anObj
386
387 def MakeEllipse(thePnt, theVec, theRMajor, theRMinor):
388     """
389      *  Create an ellipse with given center, normal vector and radiuses.
390      *  \param thePnt Ellipse center.
391      *  \param theVec Vector, normal to the plane of the ellipse.
392      *  \param theRMajor Major ellipse radius.
393      *  \param theRMinor Minor ellipse radius.
394      *  \return New GEOM_Object, containing the created ellipse.
395
396      *  Example: see GEOM_TestAll.py
397     """
398     anObj = CurvesOp.MakeEllipse(thePnt, theVec, theRMajor, theRMinor)
399     if CurvesOp.IsDone() == 0:
400       print "MakeEllipse : ", CurvesOp.GetErrorCode()
401     return anObj
402
403 def MakePolyline(thePoints):
404     """
405      *  Create a polyline on the set of points.
406      *  \param thePoints Sequence of points for the polyline.
407      *  \return New GEOM_Object, containing the created polyline.
408
409      *  Example: see GEOM_TestAll.py
410     """
411     anObj = CurvesOp.MakePolyline(thePoints)
412     if CurvesOp.IsDone() == 0:
413       print "MakePolyline : ", CurvesOp.GetErrorCode()
414     return anObj
415
416 def MakeBezier(thePoints):
417     """
418      *  Create bezier curve on the set of points.
419      *  \param thePoints Sequence of points for the bezier curve.
420      *  \return New GEOM_Object, containing the created bezier curve.
421
422      *  Example: see GEOM_TestAll.py
423     """
424     anObj = CurvesOp.MakeSplineBezier(thePoints)
425     if CurvesOp.IsDone() == 0:
426       print "MakeSplineBezier : ", CurvesOp.GetErrorCode()
427     return anObj
428
429 def MakeInterpol(thePoints):
430     """
431      *  Create B-Spline curve on the set of points.
432      *  \param thePoints Sequence of points for the B-Spline curve.
433      *  \return New GEOM_Object, containing the created B-Spline curve.
434
435      *  Example: see GEOM_TestAll.py
436     """
437     anObj = CurvesOp.MakeSplineInterpolation(thePoints)
438     if CurvesOp.IsDone() == 0:
439       print "MakeSplineInterpolation : ", CurvesOp.GetErrorCode()
440     return anObj
441
442 def MakeSketcher(theCommand, theWorkingPlane = [0,0,0, 0,0,1, 1,0,0]):
443     """
444      *  Create a sketcher (wire or face), following the textual description,
445      *  passed through \a theCommand argument. \n
446      *  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
447      *  Format of the description string have to be the following:
448      *
449      *  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
450      *
451      *  Where:
452      *  - x1, y1 are coordinates of the first sketcher point (zero by default),
453      *  - CMD is one of
454      *     - "R angle" : Set the direction by angle
455      *     - "D dx dy" : Set the direction by DX & DY
456      *     .
457      *       \n
458      *     - "TT x y" : Create segment by point at X & Y
459      *     - "T dx dy" : Create segment by point with DX & DY
460      *     - "L length" : Create segment by direction & Length
461      *     - "IX x" : Create segment by direction & Intersect. X
462      *     - "IY y" : Create segment by direction & Intersect. Y
463      *     .
464      *       \n
465      *     - "C radius length" : Create arc by direction, radius and length(in degree)
466      *     .
467      *       \n
468      *     - "WW" : Close Wire (to finish)
469      *     - "WF" : Close Wire and build face (to finish)
470      *
471      *  \param theCommand String, defining the sketcher in local
472      *                    coordinates of the working plane.
473      *  \param theWorkingPlane Nine double values, defining origin,
474      *                         OZ and OX directions of the working plane.
475      *  \return New GEOM_Object, containing the created wire.
476
477      *  Example: see GEOM_TestAll.py
478     """
479     anObj = CurvesOp.MakeSketcher(theCommand, theWorkingPlane)
480     if CurvesOp.IsDone() == 0:
481       print "MakeSketcher : ", CurvesOp.GetErrorCode()
482     return anObj
483
484 def MakeSketcherOnPlane(theCommand, theWorkingPlane):
485     """
486      *  Create a sketcher (wire or face), following the textual description,
487      *  passed through \a theCommand argument. \n
488      *  For format of the description string see the previous method.\n
489      *  \param theCommand String, defining the sketcher in local
490      *                    coordinates of the working plane.
491      *  \param theWorkingPlane Planar Face of the working plane.
492      *  \return New GEOM_Object, containing the created wire.
493     """
494     anObj = CurvesOp.MakeSketcherOnPlane(theCommand, theWorkingPlane)
495     if CurvesOp.IsDone() == 0:
496       print "MakeSketcher : ", CurvesOp.GetErrorCode()
497     return anObj
498
499 # -----------------------------------------------------------------------------
500 # Create 3D Primitives
501 # -----------------------------------------------------------------------------
502
503 def MakeBox(x1,y1,z1,x2,y2,z2):
504     """
505      *  Create a box by coordinates of two opposite vertices.
506
507      *  Example: see GEOM_TestAll.py
508     """
509     pnt1 = MakeVertex(x1,y1,z1)
510     pnt2 = MakeVertex(x2,y2,z2)
511     return MakeBoxTwoPnt(pnt1,pnt2)
512
513 def MakeBoxDXDYDZ(theDX, theDY, theDZ):
514     """
515      *  Create a box with specified dimensions along the coordinate axes
516      *  and with edges, parallel to the coordinate axes.
517      *  Center of the box will be at point (DX/2, DY/2, DZ/2).
518      *  \param theDX Length of Box edges, parallel to OX axis.
519      *  \param theDY Length of Box edges, parallel to OY axis.
520      *  \param theDZ Length of Box edges, parallel to OZ axis.
521      *  \return New GEOM_Object, containing the created box.
522
523      *  Example: see GEOM_TestAll.py
524     """
525     anObj = PrimOp.MakeBoxDXDYDZ(theDX, theDY, theDZ)
526     if PrimOp.IsDone() == 0:
527       print "MakeBoxDXDYDZ : ", PrimOp.GetErrorCode()
528     return anObj
529
530 def MakeBoxTwoPnt(thePnt1, thePnt2):
531     """
532      *  Create a box with two specified opposite vertices,
533      *  and with edges, parallel to the coordinate axes
534      *  \param thePnt1 First of two opposite vertices.
535      *  \param thePnt2 Second of two opposite vertices.
536      *  \return New GEOM_Object, containing the created box.
537
538      *  Example: see GEOM_TestAll.py
539     """
540     anObj = PrimOp.MakeBoxTwoPnt(thePnt1, thePnt2)
541     if PrimOp.IsDone() == 0:
542       print "MakeBoxTwoPnt : ", PrimOp.GetErrorCode()
543     return anObj
544
545 def MakeCylinder(thePnt, theAxis, theR, theH):
546     """
547      *  Create a cylinder with given base point, axis, radius and height.
548      *  \param thePnt Central point of cylinder base.
549      *  \param theAxis Cylinder axis.
550      *  \param theR Cylinder radius.
551      *  \param theH Cylinder height.
552      *  \return New GEOM_Object, containing the created cylinder.
553
554      *  Example: see GEOM_TestAll.py
555     """
556     anObj = PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
557     if PrimOp.IsDone() == 0:
558       print "MakeCylinderPntVecRH : ", PrimOp.GetErrorCode()
559     return anObj
560
561 def MakeCylinderRH(theR, theH):
562     """
563      *  Create a cylinder with given radius and height at
564      *  the origin of coordinate system. Axis of the cylinder
565      *  will be collinear to the OZ axis of the coordinate system.
566      *  \param theR Cylinder radius.
567      *  \param theH Cylinder height.
568      *  \return New GEOM_Object, containing the created cylinder.
569
570      *  Example: see GEOM_TestAll.py
571     """
572     anObj = PrimOp.MakeCylinderRH(theR, theH)
573     if PrimOp.IsDone() == 0:
574       print "MakeCylinderRH : ", PrimOp.GetErrorCode()
575     return anObj
576
577 def MakeSpherePntR(thePnt, theR):
578     """
579      *  Create a sphere with given center and radius.
580      *  \param thePnt Sphere center.
581      *  \param theR Sphere radius.
582      *  \return New GEOM_Object, containing the created sphere.
583
584      *  Example: see GEOM_TestAll.py
585     """
586     anObj = PrimOp.MakeSpherePntR(thePnt, theR)
587     if PrimOp.IsDone() == 0:
588       print "MakeSpherePntR : ", PrimOp.GetErrorCode()
589     return anObj
590
591 def MakeSphere(x, y, z, theR):
592     """
593      *  Create a sphere with given center and radius.
594      *  \param x,y,z Coordinates of sphere center.
595      *  \param theR Sphere radius.
596      *  \return New GEOM_Object, containing the created sphere.
597
598      *  Example: see GEOM_TestAll.py
599     """
600     point = MakeVertex(x, y, z)
601     anObj = MakeSpherePntR(point, theR)
602     return anObj
603
604 def MakeSphereR(theR):
605     """
606      *  Create a sphere with given radius at the origin of coordinate system.
607      *  \param theR Sphere radius.
608      *  \return New GEOM_Object, containing the created sphere.
609
610      *  Example: see GEOM_TestAll.py
611     """
612     anObj = PrimOp.MakeSphereR(theR)
613     if PrimOp.IsDone() == 0:
614       print "MakeSphereR : ", PrimOp.GetErrorCode()
615     return anObj
616
617 def MakeCone(thePnt, theAxis, theR1, theR2, theH):
618     """
619      *  Create a cone with given base point, axis, height and radiuses.
620      *  \param thePnt Central point of the first cone base.
621      *  \param theAxis Cone axis.
622      *  \param theR1 Radius of the first cone base.
623      *  \param theR2 Radius of the second cone base.
624      *    \note If both radiuses are non-zero, the cone will be truncated.
625      *    \note If the radiuses are equal, a cylinder will be created instead.
626      *  \param theH Cone height.
627      *  \return New GEOM_Object, containing the created cone.
628
629      *  Example: see GEOM_TestAll.py
630     """
631     anObj = PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
632     if PrimOp.IsDone() == 0:
633       print "MakeConePntVecR1R2H : ", PrimOp.GetErrorCode()
634     return anObj
635
636 def MakeConeR1R2H(theR1, theR2, theH):
637     """
638      *  Create a cone with given height and radiuses at
639      *  the origin of coordinate system. Axis of the cone will
640      *  be collinear to the OZ axis of the coordinate system.
641      *  \param theR1 Radius of the first cone base.
642      *  \param theR2 Radius of the second cone base.
643      *    \note If both radiuses are non-zero, the cone will be truncated.
644      *    \note If the radiuses are equal, a cylinder will be created instead.
645      *  \param theH Cone height.
646      *  \return New GEOM_Object, containing the created cone.
647
648      *  Example: see GEOM_TestAll.py
649     """
650     anObj = PrimOp.MakeConeR1R2H(theR1, theR2, theH)
651     if PrimOp.IsDone() == 0:
652       print "MakeConeR1R2H : ", PrimOp.GetErrorCode()
653     return anObj
654
655 def MakeTorus(thePnt, theVec, theRMajor, theRMinor):
656     """
657      *  Create a torus with given center, normal vector and radiuses.
658      *  \param thePnt Torus central point.
659      *  \param theVec Torus axis of symmetry.
660      *  \param theRMajor Torus major radius.
661      *  \param theRMinor Torus minor radius.
662      *  \return New GEOM_Object, containing the created torus.
663
664      *  Example: see GEOM_TestAll.py
665     """
666     anObj = PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
667     if PrimOp.IsDone() == 0:
668       print "MakeTorusPntVecRR : ", PrimOp.GetErrorCode()
669     return anObj
670
671 def MakeTorusRR(theRMajor, theRMinor):
672     """
673      *  Create a torus with given radiuses at the origin of coordinate system.
674      *  \param theRMajor Torus major radius.
675      *  \param theRMinor Torus minor radius.
676      *  \return New GEOM_Object, containing the created torus.
677
678      *  Example: see GEOM_TestAll.py
679     """
680     anObj = PrimOp.MakeTorusRR(theRMajor, theRMinor)
681     if PrimOp.IsDone() == 0:
682       print "MakeTorusRR : ", PrimOp.GetErrorCode()
683     return anObj
684
685 def MakePrism(theBase, thePoint1, thePoint2):
686     """
687      *  Create a shape by extrusion of the base shape along a vector, defined by two points.
688      *  \param theBase Base shape to be extruded.
689      *  \param thePoint1 First end of extrusion vector.
690      *  \param thePoint2 Second end of extrusion vector.
691      *  \return New GEOM_Object, containing the created prism.
692
693      *  Example: see GEOM_TestAll.py
694     """
695     anObj = PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
696     if PrimOp.IsDone() == 0:
697       print "MakePrismTwoPnt : ", PrimOp.GetErrorCode()
698     return anObj
699
700 def MakePrismVecH(theBase, theVec, theH):
701     """
702      *  Create a shape by extrusion of the base shape along the vector,
703      *  i.e. all the space, transfixed by the base shape during its translation
704      *  along the vector on the given distance.
705      *  \param theBase Base shape to be extruded.
706      *  \param theVec Direction of extrusion.
707      *  \param theH Prism dimension along theVec.
708      *  \return New GEOM_Object, containing the created prism.
709
710      *  Example: see GEOM_TestAll.py
711     """
712     anObj = PrimOp.MakePrismVecH(theBase, theVec, theH)
713     if PrimOp.IsDone() == 0:
714       print "MakePrismVecH : ", PrimOp.GetErrorCode()
715     return anObj
716
717 def MakePipe(theBase, thePath):
718     """
719      *  Create a shape by extrusion of the base shape along
720      *  the path shape. The path shape can be a wire or an edge.
721      *  \param theBase Base shape to be extruded.
722      *  \param thePath Path shape to extrude the base shape along it.
723      *  \return New GEOM_Object, containing the created pipe.
724
725      *  Example: see GEOM_TestAll.py
726     """
727     anObj = PrimOp.MakePipe(theBase, thePath)
728     if PrimOp.IsDone() == 0:
729       print "MakePipe : ", PrimOp.GetErrorCode()
730     return anObj
731
732 def MakeRevolution(theBase, theAxis, theAngle):
733     """
734      *  Create a shape by revolution of the base shape around the axis
735      *  on the given angle, i.e. all the space, transfixed by the base
736      *  shape during its rotation around the axis on the given angle.
737      *  \param theBase Base shape to be rotated.
738      *  \param theAxis Rotation axis.
739      *  \param theAngle Rotation angle in radians.
740      *  \return New GEOM_Object, containing the created revolution.
741
742      *  Example: see GEOM_TestAll.py
743     """
744     anObj = PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
745     if PrimOp.IsDone() == 0:
746       print "MakeRevolutionAxisAngle : ", PrimOp.GetErrorCode()
747     return anObj
748
749 # -----------------------------------------------------------------------------
750 # Create base shapes
751 # -----------------------------------------------------------------------------
752
753 def MakeEdge(thePnt1, thePnt2):
754     """
755      *  Create a linear edge with specified ends.
756      *  \param thePnt1 Point for the first end of edge.
757      *  \param thePnt2 Point for the second end of edge.
758      *  \return New GEOM_Object, containing the created edge.
759
760      *  Example: see GEOM_TestAll.py
761     """
762     anObj = ShapesOp.MakeEdge(thePnt1, thePnt2)
763     if ShapesOp.IsDone() == 0:
764       print "MakeEdge : ", ShapesOp.GetErrorCode()
765     return anObj
766
767 def MakeWire(theEdgesAndWires):
768     """
769      *  Create a wire from the set of edges and wires.
770      *  \param theEdgesAndWires List of edges and/or wires.
771      *  \return New GEOM_Object, containing the created wire.
772
773      *  Example: see GEOM_TestAll.py
774     """
775     anObj = ShapesOp.MakeWire(theEdgesAndWires)
776     if ShapesOp.IsDone() == 0:
777       print "MakeWire : ", ShapesOp.GetErrorCode()
778     return anObj
779
780 def MakeFace(theWire, isPlanarWanted):
781     """
782      *  Create a face on the given wire.
783      *  \param theWire Wire to build the face on.
784      *  \param isPlanarWanted If TRUE, only planar face will be built.
785      *                        If impossible, NULL object will be returned.
786      *  \return New GEOM_Object, containing the created face.
787
788      *  Example: see GEOM_TestAll.py
789     """
790     anObj = ShapesOp.MakeFace(theWire, isPlanarWanted)
791     if ShapesOp.IsDone() == 0:
792       print "MakeFace : ", ShapesOp.GetErrorCode()
793     return anObj
794
795 def MakeFaceWires(theWires, isPlanarWanted):
796     """
797      *  Create a face on the given wires set.
798      *  \param theWires List of wires to build the face on.
799      *  \param isPlanarWanted If TRUE, only planar face will be built.
800      *                        If impossible, NULL object will be returned.
801      *  \return New GEOM_Object, containing the created face.
802
803      *  Example: see GEOM_TestAll.py
804     """
805     anObj = ShapesOp.MakeFaceWires(theWires, isPlanarWanted)
806     if ShapesOp.IsDone() == 0:
807       print "MakeFaceWires : ", ShapesOp.GetErrorCode()
808     return anObj
809
810 def MakeFaces(theWires, isPlanarWanted):
811     """
812      *  Shortcut to MakeFaceWires()
813
814      *  Example: see GEOM_TestOthers.py
815     """
816     anObj = MakeFaceWires(theWires, isPlanarWanted)
817     return anObj
818
819 def MakeShell(theFacesAndShells):
820     """
821      *  Create a shell from the set of faces and shells.
822      *  \param theFacesAndShells List of faces and/or shells.
823      *  \return New GEOM_Object, containing the created shell.
824
825      *  Example: see GEOM_TestAll.py
826     """
827     anObj = ShapesOp.MakeShell(theFacesAndShells)
828     if ShapesOp.IsDone() == 0:
829         print "MakeShell : ", ShapesOp.GetErrorCode()
830     return anObj
831
832 def MakeSolid(theShells):
833     """
834      *  Create a solid, bounded by the given shells.
835      *  \param theShells Sequence of bounding shells.
836      *  \return New GEOM_Object, containing the created solid.
837
838      *  Example: see GEOM_TestAll.py
839     """
840     anObj = ShapesOp.MakeSolidShells(theShells)
841     if ShapesOp.IsDone() == 0:
842         print "MakeSolid : ", ShapesOp.GetErrorCode()
843     return anObj
844
845 def MakeCompound(theShapes):
846     """
847      *  Create a compound of the given shapes.
848      *  \param theShapes List of shapes to put in compound.
849      *  \return New GEOM_Object, containing the created compound.
850
851      *  Example: see GEOM_TestAll.py
852     """
853     anObj = ShapesOp.MakeCompound(theShapes)
854     if ShapesOp.IsDone() == 0:
855       print "MakeCompound : ", ShapesOp.GetErrorCode()
856     return anObj
857
858 def NumberOfFaces(theShape):
859     """
860      *  Gives quantity of faces in the given shape.
861      *  \param theShape Shape to count faces of.
862      *  \return Quantity of faces.
863
864      *  Example: see GEOM_TestOthers.py
865     """
866     nb_faces = ShapesOp.NumberOfFaces(theShape)
867     if ShapesOp.IsDone() == 0:
868       print "NumberOfFaces : ", ShapesOp.GetErrorCode()
869     return nb_faces
870
871 def NumberOfEdges(theShape):
872     """
873      *  Gives quantity of edges in the given shape.
874      *  \param theShape Shape to count edges of.
875      *  \return Quantity of edges.
876
877      *  Example: see GEOM_TestOthers.py
878     """
879     nb_edges = ShapesOp.NumberOfEdges(theShape)
880     if ShapesOp.IsDone() == 0:
881       print "NumberOfEdges : ", ShapesOp.GetErrorCode()
882     return nb_edges
883
884 def ChangeOrientation(theShape):
885     """
886      *  Reverses an orientation the given shape.
887      *  \param theShape Shape to be reversed.
888      *  \return The reversed copy of theShape.
889
890      *  Example: see GEOM_TestAll.py
891     """
892     anObj = ShapesOp.ChangeOrientation(theShape)
893     if ShapesOp.IsDone() == 0:
894       print "ChangeOrientation : ", ShapesOp.GetErrorCode()
895     return anObj
896
897 def OrientationChange(theShape):
898     """
899      *  Shortcut to ChangeOrientation()
900
901      *  Example: see GEOM_TestOthers.py
902     """
903     anObj = ChangeOrientation(theShape)
904     return anObj
905
906 def GetFreeFacesIDs(theShape):
907     """
908      *  Retrieve all free faces from the given shape.
909      *  Free face is a face, which is not shared between two shells of the shape.
910      *  \param theShape Shape to find free faces in.
911      *  \return List of IDs of all free faces, contained in theShape.
912
913      *  Example: see GEOM_TestOthers.py
914     """
915     anIDs = ShapesOp.GetFreeFacesIDs(theShape)
916     if ShapesOp.IsDone() == 0:
917       print "GetFreeFacesIDs : ", ShapesOp.GetErrorCode()
918     return anIDs
919
920 def GetSharedShapes(theShape1, theShape2, theShapeType):
921     """
922      *  Get all sub-shapes of theShape1 of the given type, shared with theShape2.
923      *  \param theShape1 Shape to find sub-shapes in.
924      *  \param theShape2 Shape to find shared sub-shapes with.
925      *  \param theShapeType Type of sub-shapes to be retrieved.
926      *  \return List of sub-shapes of theShape1, shared with theShape2.
927
928      *  Example: see GEOM_TestOthers.py
929     """
930     aList = ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
931     if ShapesOp.IsDone() == 0:
932       print "GetSharedShapes : ", ShapesOp.GetErrorCode()
933     return aList
934
935 def GetShapesOnPlane(theShape, theShapeType, theAx1, theState):
936     """
937      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
938      *  the specified plane by the certain way, defined through \a theState parameter.
939      *  \param theShape Shape to find sub-shapes of.
940      *  \param theShapeType Type of sub-shapes to be retrieved.
941      *  \param theAx1 Vector (or line, or linear edge), specifying normal
942      *                direction and location of the plane to find shapes on.
943      *  \param theState The state of the subshapes to find. It can be one of
944      *   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
945      *  \return List of all found sub-shapes.
946
947      *  Example: see GEOM_TestOthers.py
948     """
949     aList = ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
950     if ShapesOp.IsDone() == 0:
951       print "GetShapesOnPlane : ", ShapesOp.GetErrorCode()
952     return aList
953
954 def GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState):
955     """
956      *  Works like the above method, but returns list of sub-shapes indices
957     """
958     aList = ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
959     if ShapesOp.IsDone() == 0:
960         print "GetShapesOnPlaneIDs : ", ShapesOp.GetErrorCode()
961     return aList
962
963 def GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState):
964     """
965      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
966      *  the specified cylinder by the certain way, defined through \a theState parameter.
967      *  \param theShape Shape to find sub-shapes of.
968      *  \param theShapeType Type of sub-shapes to be retrieved.
969      *  \param theAxis Vector (or line, or linear edge), specifying
970      *                 axis of the cylinder to find shapes on.
971      *  \param theRadius Radius of the cylinder to find shapes on.
972      *  \param theState The state of the subshapes to find. It can be one of
973      *   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
974      *  \return List of all found sub-shapes.
975
976      *  Example: see GEOM_TestOthers.py
977     """
978     aList = ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
979     if ShapesOp.IsDone() == 0:
980       print "GetShapesOnCylinder : ", ShapesOp.GetErrorCode()
981     return aList
982
983 def GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState):
984     """
985      *  Works like the above method, but returns list of sub-shapes indices
986     """
987     aList = ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
988     if ShapesOp.IsDone() == 0:
989         print "GetShapesOnCylinderIDs : ", ShapesOp.GetErrorCode()
990     return aList
991
992 def GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState):
993     """
994      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
995      *  the specified sphere by the certain way, defined through \a theState parameter.
996      *  \param theShape Shape to find sub-shapes of.
997      *  \param theShapeType Type of sub-shapes to be retrieved.
998      *  \param theCenter Point, specifying center of the sphere to find shapes on.
999      *  \param theRadius Radius of the sphere to find shapes on.
1000      *  \param theState The state of the subshapes to find. It can be one of
1001      *   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1002      *  \return List of all found sub-shapes.
1003
1004      *  Example: see GEOM_TestOthers.py
1005     """
1006     aList = ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
1007     if ShapesOp.IsDone() == 0:
1008       print "GetShapesOnSphere : ", ShapesOp.GetErrorCode()
1009     return aList
1010
1011 def GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState):
1012     """
1013      *  Works like the above method, but returns list of sub-shapes indices
1014     """
1015     aList = ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
1016     if ShapesOp.IsDone() == 0:
1017         print "GetShapesOnSphereIDs : ", ShapesOp.GetErrorCode()
1018     return aList
1019
1020 def GetShapesOnQuadrangle(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState):
1021     """
1022      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1023      *  the specified quadrangle by the certain way, defined through \a theState parameter.
1024      *  \param theShape Shape to find sub-shapes of.
1025      *  \param theShapeType Type of sub-shapes to be retrieved.
1026      *  \param theCenter Point, specifying center of the sphere to find shapes on.
1027      *  \param theRadius Radius of the sphere to find shapes on.
1028      *  \param theState The state of the subshapes to find. It can be one of
1029      *   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1030      *  \return List of all found sub-shapes.
1031
1032      *  Example: see GEOM_TestOthers.py
1033     """
1034     aList = ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState)
1035     if ShapesOp.IsDone() == 0:
1036       print "GetShapesOnQuadrangle : ", ShapesOp.GetErrorCode()
1037     return aList
1038
1039 def GetShapesOnQuadrangleIDs(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState):
1040     """
1041      *  Works like the above method, but returns list of sub-shapes indices
1042     """
1043     aList = ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState)
1044     if ShapesOp.IsDone() == 0:
1045         print "GetShapesOnQuadrangleIDs : ", ShapesOp.GetErrorCode()
1046     return aList
1047
1048 def GetInPlace(theShapeWhere, theShapeWhat):
1049     """
1050      *  Get sub-shape(s) of theShapeWhere, which are
1051      *  coincident with \a theShapeWhat or could be a part of it.
1052      *  \param theShapeWhere Shape to find sub-shapes of.
1053      *  \param theShapeWhat Shape, specifying what to find.
1054      *  \return Group of all found sub-shapes or a single found sub-shape.
1055
1056      *  Example: see GEOM_TestOthers.py
1057     """
1058     anObj = ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
1059     if ShapesOp.IsDone() == 0:
1060       print "GetInPlace : ", ShapesOp.GetErrorCode()
1061     return anObj
1062
1063 # -----------------------------------------------------------------------------
1064 # Access to sub-shapes by their unique IDs inside the main shape.
1065 # -----------------------------------------------------------------------------
1066
1067 def GetSubShape(aShape, ListOfID):
1068     """
1069      *  Obtain a composite sub-shape of <aShape>, composed from sub-shapes
1070      *  of <aShape>, selected by their unique IDs inside <aShape>
1071
1072      *  Example: see GEOM_TestAll.py
1073     """
1074     anObj = geom.AddSubShape(aShape,ListOfID)
1075     return anObj
1076
1077 def GetSubShapeID(aShape, aSubShape):
1078     """
1079      *  Obtain unique ID of sub-shape <aSubShape> inside <aShape>
1080
1081      *  Example: see GEOM_TestAll.py
1082     """
1083     anID = LocalOp.GetSubShapeIndex(aShape, aSubShape)
1084     if LocalOp.IsDone() == 0:
1085       print "GetSubShapeIndex : ", LocalOp.GetErrorCode()
1086     return anID
1087
1088 # -----------------------------------------------------------------------------
1089 # Decompose objects
1090 # -----------------------------------------------------------------------------
1091
1092 def SubShapeAll(aShape, aType):
1093     """
1094      *  Explode a shape on subshapes of a given type.
1095      *  \param theShape Shape to be exploded.
1096      *  \param theShapeType Type of sub-shapes to be retrieved.
1097      *  \return List of sub-shapes of type theShapeType, contained in theShape.
1098
1099      *  Example: see GEOM_TestAll.py
1100     """
1101     ListObj = ShapesOp.MakeExplode(aShape,aType,0)
1102     if ShapesOp.IsDone() == 0:
1103       print "MakeExplode : ", ShapesOp.GetErrorCode()
1104     return ListObj
1105
1106 def SubShapeAllIDs(aShape, aType):
1107     """
1108      *  Explode a shape on subshapes of a given type.
1109      *  \param theShape Shape to be exploded.
1110      *  \param theShapeType Type of sub-shapes to be retrieved.
1111      *  \return List of IDs of sub-shapes.
1112     """
1113     ListObj = ShapesOp.SubShapeAllIDs(aShape,aType,0)
1114     if ShapesOp.IsDone() == 0:
1115       print "SubShapeAllIDs : ", ShapesOp.GetErrorCode()
1116     return ListObj
1117
1118 def SubShapeAllSorted(aShape, aType):
1119     """
1120      *  Explode a shape on subshapes of a given type.
1121      *  Sub-shapes will be sorted by coordinates of their gravity centers.
1122      *  \param theShape Shape to be exploded.
1123      *  \param theShapeType Type of sub-shapes to be retrieved.
1124      *  \return List of sub-shapes of type theShapeType, contained in theShape.
1125
1126      *  Example: see GEOM_TestAll.py
1127     """
1128     ListObj = ShapesOp.MakeExplode(aShape,aType,1)
1129     if ShapesOp.IsDone() == 0:
1130       print "MakeExplode : ", ShapesOp.GetErrorCode()
1131     return ListObj
1132
1133 def SubShapeAllSortedIDs(aShape, aType):
1134     """
1135      *  Explode a shape on subshapes of a given type.
1136      *  Sub-shapes will be sorted by coordinates of their gravity centers.
1137      *  \param theShape Shape to be exploded.
1138      *  \param theShapeType Type of sub-shapes to be retrieved.
1139      *  \return List of IDs of sub-shapes.
1140     """
1141     ListIDs = ShapesOp.SubShapeAllIDs(aShape,aType,1)
1142     if ShapesOp.IsDone() == 0:
1143       print "SubShapeAllSortedIDs : ", ShapesOp.GetErrorCode()
1144     return ListObj
1145
1146 def SubShape(aShape, aType, ListOfInd):
1147     """
1148      *  Obtain a compound of sub-shapes of <aShape>,
1149      *  selected by they indices in list of all sub-shapes of type <aType>.
1150      *  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1151
1152      *  Example: see GEOM_TestAll.py
1153     """
1154     ListOfIDs = []
1155     AllShapeList = SubShapeAll(aShape, aType)
1156     for ind in ListOfInd:
1157         ListOfIDs.append(GetSubShapeID(aShape, AllShapeList[ind - 1]))
1158     anObj = GetSubShape(aShape, ListOfIDs)
1159     return anObj
1160
1161 def SubShapeSorted(aShape, aType, ListOfInd):
1162     """
1163      *  Obtain a compound of sub-shapes of <aShape>,
1164      *  selected by they indices in sorted list of all sub-shapes of type <aType>.
1165      *  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1166
1167      *  Example: see GEOM_TestAll.py
1168     """
1169     ListOfIDs = []
1170     AllShapeList = SubShapeAllSorted(aShape, aType)
1171     for ind in ListOfInd:
1172         ListOfIDs.append(GetSubShapeID(aShape, AllShapeList[ind - 1]))
1173     anObj = GetSubShape(aShape, ListOfIDs)
1174     return anObj
1175
1176 # -----------------------------------------------------------------------------
1177 # Healing operations
1178 # -----------------------------------------------------------------------------
1179
1180 def ProcessShape(theShape, theOperators, theParameters, theValues):
1181     """
1182      *  Apply a sequence of Shape Healing operators to the given object.
1183      *  \param theShape Shape to be processed.
1184      *  \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1185      *  \param theParameters List of names of parameters
1186      *                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1187      *  \param theValues List of values of parameters, in the same order
1188      *                    as parameters are listed in \a theParameters list.
1189      *  \return New GEOM_Object, containing processed shape.
1190
1191      *  Example: see GEOM_TestHealing.py
1192     """
1193     anObj = HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
1194     if HealOp.IsDone() == 0:
1195         print "ProcessShape : ", HealOp.GetErrorCode()
1196     return anObj
1197
1198 def SuppressFaces(theObject, theFaces):
1199     """
1200      *  Remove faces from the given object (shape).
1201      *  \param theObject Shape to be processed.
1202      *  \param theFaces Indices of faces to be removed, if EMPTY then the method
1203      *                  removes ALL faces of the given object.
1204      *  \return New GEOM_Object, containing processed shape.
1205
1206      *  Example: see GEOM_TestHealing.py
1207     """
1208     anObj = HealOp.SuppressFaces(theObject, theFaces)
1209     if HealOp.IsDone() == 0:
1210       print "SuppressFaces : ", HealOp.GetErrorCode()
1211     return anObj
1212
1213 def MakeSewing(ListShape, theTolerance):
1214     """
1215      *  Sewing of some shapes into single shape.
1216
1217      *  Example: see GEOM_TestHealing.py
1218     """
1219     comp = MakeCompound(ListShape)
1220     anObj = Sew(comp, theTolerance)
1221     return anObj
1222
1223 def Sew(theObject, theTolerance):
1224     """
1225      *  Sewing of the given object.
1226      *  \param theObject Shape to be processed.
1227      *  \param theTolerance Required tolerance value.
1228      *  \return New GEOM_Object, containing processed shape.
1229
1230      *  Example: see MakeSewing() above
1231     """
1232     anObj = HealOp.Sew(theObject, theTolerance)
1233     if HealOp.IsDone() == 0:
1234       print "Sew : ", HealOp.GetErrorCode()
1235     return anObj
1236
1237 def SuppressInternalWires(theObject, theWires):
1238     """
1239      *  Remove internal wires and edges from the given object (face).
1240      *  \param theObject Shape to be processed.
1241      *  \param theWires Indices of wires to be removed, if EMPTY then the method
1242      *                  removes ALL internal wires of the given object.
1243      *  \return New GEOM_Object, containing processed shape.
1244
1245      *  Example: see GEOM_TestHealing.py
1246     """
1247     anObj = HealOp.RemoveIntWires(theObject, theWires)
1248     if HealOp.IsDone() == 0:
1249       print "SuppressInternalWires : ", HealOp.GetErrorCode()
1250     return anObj
1251
1252 def SuppressHoles(theObject, theWires):
1253     """
1254      *  Remove internal closed contours (holes) from the given object.
1255      *  \param theObject Shape to be processed.
1256      *  \param theWires Indices of wires to be removed, if EMPTY then the method
1257      *                  removes ALL internal holes of the given object
1258      *  \return New GEOM_Object, containing processed shape.
1259
1260      *  Example: see GEOM_TestHealing.py
1261     """
1262     anObj = HealOp.FillHoles(theObject, theWires)
1263     if HealOp.IsDone() == 0:
1264       print "SuppressHoles : ", HealOp.GetErrorCode()
1265     return anObj
1266
1267 def CloseContour(theObject, theWires, isCommonVertex):
1268     """
1269      *  Close an open wire.
1270      *  \param theObject Shape to be processed.
1271      *  \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1272      *                  if -1, then theObject itself is a wire.
1273      *  \param isCommonVertex If TRUE : closure by creation of a common vertex,
1274      *                        If FALS : closure by creation of an edge between ends.
1275      *  \return New GEOM_Object, containing processed shape.
1276
1277      *  Example: see GEOM_TestHealing.py
1278     """
1279     anObj = HealOp.CloseContour(theObject, theWires, isCommonVertex)
1280     if HealOp.IsDone() == 0:
1281       print "CloseContour : ", HealOp.GetErrorCode()
1282     return anObj
1283
1284 def DivideEdge(theObject, theEdgeIndex, theValue, isByParameter):
1285     """
1286      *  Addition of a point to a given edge object.
1287      *  \param theObject Shape to be processed.
1288      *  \param theEdgeIndex Index of edge to be divided within theObject's shape,
1289      *                      if -1, then theObject itself is the edge.
1290      *  \param theValue Value of parameter on edge or length parameter,
1291      *                  depending on \a isByParameter.
1292      *  \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
1293      *                       if FALSE : \a theValue is treated as a length parameter [0..1]
1294      *  \return New GEOM_Object, containing processed shape.
1295
1296      *  Example: see GEOM_TestHealing.py
1297     """
1298     anObj = HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
1299     if HealOp.IsDone() == 0:
1300       print "DivideEdge : ", HealOp.GetErrorCode()
1301     return anObj
1302
1303 def GetFreeBoundary(theObject):
1304     """
1305      *  Get a list of wires (wrapped in GEOM_Object-s),
1306      *  that constitute a free boundary of the given shape.
1307      *  \param theObject Shape to get free boundary of.
1308      *  \return [status, theClosedWires, theOpenWires]
1309      *  status: FALSE, if an error(s) occured during the method execution.
1310      *  theClosedWires: Closed wires on the free boundary of the given shape.
1311      *  theOpenWires: Open wires on the free boundary of the given shape.
1312
1313      *  Example: see GEOM_TestHealing.py
1314     """
1315     anObj = HealOp.GetFreeBoundary(theObject)
1316     if HealOp.IsDone() == 0:
1317       print "GetFreeBoundaries : ", HealOp.GetErrorCode()
1318     return anObj
1319
1320 # -----------------------------------------------------------------------------
1321 # Create advanced objects
1322 # -----------------------------------------------------------------------------
1323
1324 def MakeCopy(theOriginal):
1325     """
1326      *  Create a copy of the given object
1327
1328      *  Example: see GEOM_TestAll.py
1329     """
1330     anObj = InsertOp.MakeCopy(theOriginal)
1331     if InsertOp.IsDone() == 0:
1332       print "MakeCopy : ", InsertOp.GetErrorCode()
1333     return anObj
1334
1335 def MakeFilling(theShape, theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter):
1336     """
1337      *  Create a filling from the given compound of contours.
1338      *  \param theShape the compound of contours
1339      *  \param theMinDeg a minimal degree
1340      *  \param theMaxDeg a maximal degree
1341      *  \param theTol2D a 2d tolerance
1342      *  \param theTol3D a 3d tolerance
1343      *  \param theNbIter a number of iteration
1344      *  \return New GEOM_Object, containing the created filling surface.
1345
1346      *  Example: see GEOM_TestAll.py
1347     """
1348     anObj = PrimOp.MakeFilling(theShape, theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter)
1349     if PrimOp.IsDone() == 0:
1350       print "MakeFilling : ", PrimOp.GetErrorCode()
1351     return anObj
1352
1353 def MakeGlueFaces(theShape, theTolerance):
1354     """
1355      *  Replace coincident faces in theShape by one face.
1356      *  \param theShape Initial shape.
1357      *  \param theTolerance Maximum distance between faces, which can be considered as coincident.
1358      *  \return New GEOM_Object, containing a copy of theShape without coincident faces.
1359
1360      *  Example: see GEOM_Spanner.py
1361     """
1362     anObj = ShapesOp.MakeGlueFaces(theShape, theTolerance)
1363     if ShapesOp.IsDone() == 0:
1364       print "MakeGlueFaces : ", ShapesOp.GetErrorCode()
1365     return anObj
1366
1367 # -----------------------------------------------------------------------------
1368 # Boolean (Common, Cut, Fuse, Section)
1369 # -----------------------------------------------------------------------------
1370
1371 def MakeBoolean(theShape1, theShape2, theOperation):
1372     """
1373      *  Perform one of boolean operations on two given shapes.
1374      *  \param theShape1 First argument for boolean operation.
1375      *  \param theShape2 Second argument for boolean operation.
1376      *  \param theOperation Indicates the operation to be done:
1377      *                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1378      *  \return New GEOM_Object, containing the result shape.
1379
1380      *  Example: see GEOM_TestAll.py
1381     """
1382     anObj = BoolOp.MakeBoolean(theShape1, theShape2, theOperation)
1383     if BoolOp.IsDone() == 0:
1384       print "MakeBoolean : ", BoolOp.GetErrorCode()
1385     return anObj
1386
1387 def MakeCommon(s1, s2):
1388     """
1389      *  Shortcut to MakeBoolean(s1, s2, 1)
1390
1391      *  Example: see GEOM_TestOthers.py
1392     """
1393     return MakeBoolean(s1, s2, 1)
1394
1395 def MakeCut(s1, s2):
1396     """
1397      *  Shortcut to MakeBoolean(s1, s2, 2)
1398
1399      *  Example: see GEOM_TestOthers.py
1400     """
1401     return MakeBoolean(s1, s2, 2)
1402
1403 def MakeFuse(s1, s2):
1404     """
1405      *  Shortcut to MakeBoolean(s1, s2, 3)
1406
1407      *  Example: see GEOM_TestOthers.py
1408     """
1409     return MakeBoolean(s1, s2, 3)
1410
1411 def MakeSection(s1, s2):
1412     """
1413      *  Shortcut to MakeBoolean(s1, s2, 4)
1414
1415      *  Example: see GEOM_TestOthers.py
1416     """
1417     return MakeBoolean(s1, s2, 4)
1418
1419 def MakePartition(ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1420                   Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[]):
1421     """
1422      *  Perform partition operation.
1423      *  \param ListShapes Shapes to be intersected.
1424      *  \param ListTools Shapes to intersect theShapes.
1425      *  \param ListKeepInside Shapes, outside which the results will be deleted.
1426      *         Each shape from theKeepInside must belong to theShapes also.
1427      *  \param ListRemoveInside Shapes, inside which the results will be deleted.
1428      *         Each shape from theRemoveInside must belong to theShapes also.
1429      *  \param Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1430      *  \param RemoveWebs If TRUE, perform Glue 3D algorithm.
1431      *  \param ListMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
1432      *  \return New GEOM_Object, containing the result shapes.
1433
1434      *  Example: see GEOM_TestAll.py
1435     """
1436     anObj = BoolOp.MakePartition(ListShapes, ListTools,
1437                                  ListKeepInside, ListRemoveInside,
1438                                  Limit, RemoveWebs, ListMaterials);
1439     if BoolOp.IsDone() == 0:
1440       print "MakePartition : ", BoolOp.GetErrorCode()
1441     return anObj
1442
1443 def Partition(ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1444               Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[]):
1445     """
1446      *  Shortcut to MakePartition()
1447
1448      *  Example: see GEOM_TestOthers.py
1449     """
1450     anObj = MakePartition(ListShapes, ListTools,
1451                           ListKeepInside, ListRemoveInside,
1452                           Limit, RemoveWebs, ListMaterials);
1453     return anObj
1454
1455 def MakeHalfPartition(theShape, thePlane):
1456     """
1457      *  Perform partition of the Shape with the Plane
1458      *  \param theShape Shape to be intersected.
1459      *  \param thePlane Tool shape, to intersect theShape.
1460      *  \return New GEOM_Object, containing the result shape.
1461
1462      *  Example: see GEOM_TestAll.py
1463     """
1464     anObj = BoolOp.MakeHalfPartition(theShape, thePlane)
1465     if BoolOp.IsDone() == 0:
1466       print "MakeHalfPartition : ", BoolOp.GetErrorCode()
1467     return anObj
1468
1469 # -----------------------------------------------------------------------------
1470 # Transform objects
1471 # -----------------------------------------------------------------------------
1472
1473 def MakeTranslationTwoPoints(theObject, thePoint1, thePoint2):
1474     """
1475      *  Translate the given object along the vector, specified
1476      *  by its end points, creating its copy before the translation.
1477      *  \param theObject The object to be translated.
1478      *  \param thePoint1 Start point of translation vector.
1479      *  \param thePoint2 End point of translation vector.
1480      *  \return New GEOM_Object, containing the translated object.
1481
1482      *  Example: see GEOM_TestAll.py
1483     """
1484     anObj = TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
1485     if TrsfOp.IsDone() == 0:
1486       print "TranslateTwoPointsCopy : ", TrsfOp.GetErrorCode()
1487     return anObj
1488
1489 def MakeTranslation(theObject, theDX, theDY, theDZ):
1490     """
1491      *  Translate the given object along the vector, specified
1492      *  by its components, creating its copy before the translation.
1493      *  \param theObject The object to be translated.
1494      *  \param theDX,theDY,theDZ Components of translation vector.
1495      *  \return New GEOM_Object, containing the translated object.
1496
1497      *  Example: see GEOM_TestAll.py
1498     """
1499     anObj = TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
1500     if TrsfOp.IsDone() == 0:
1501       print "TranslateDXDYDZCopy : ", TrsfOp.GetErrorCode()
1502     return anObj
1503
1504 def MakeTranslationVector(theObject, theVector):
1505     """
1506      *  Translate the given object along the given vector,
1507      *  creating its copy before the translation.
1508      *  \param theObject The object to be translated.
1509      *  \param theVector The translation vector.
1510      *  \return New GEOM_Object, containing the translated object.
1511
1512      *  Example: see GEOM_TestAll.py
1513     """
1514     anObj = TrsfOp.TranslateVectorCopy(theObject, theVector)
1515     if TrsfOp.IsDone() == 0:
1516       print "TranslateVectorCopy : ", TrsfOp.GetErrorCode()
1517     return anObj
1518
1519 def MakeRotation(theObject, theAxis, theAngle):
1520     """
1521      *  Rotate the given object around the given axis
1522      *  on the given angle, creating its copy before the rotatation.
1523      *  \param theObject The object to be rotated.
1524      *  \param theAxis Rotation axis.
1525      *  \param theAngle Rotation angle in radians.
1526      *  \return New GEOM_Object, containing the rotated object.
1527
1528      *  Example: see GEOM_TestAll.py
1529     """
1530     anObj = TrsfOp.RotateCopy(theObject, theAxis, theAngle)
1531     if TrsfOp.IsDone() == 0:
1532       print "RotateCopy : ", TrsfOp.GetErrorCode()
1533     return anObj
1534
1535 def MakeScaleTransform(theObject, thePoint, theFactor):
1536     """
1537      *  Scale the given object by the factor, creating its copy before the scaling.
1538      *  \param theObject The object to be scaled.
1539      *  \param thePoint Center point for scaling.
1540      *  \param theFactor Scaling factor value.
1541      *  \return New GEOM_Object, containing the scaled shape.
1542
1543      *  Example: see GEOM_TestAll.py
1544     """
1545     anObj = TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
1546     if TrsfOp.IsDone() == 0:
1547       print "ScaleShapeCopy : ", TrsfOp.GetErrorCode()
1548     return anObj
1549
1550 def MakeMirrorByPlane(theObject, thePlane):
1551     """
1552      *  Create an object, symmetrical
1553      *  to the given one relatively the given plane.
1554      *  \param theObject The object to be mirrored.
1555      *  \param thePlane Plane of symmetry.
1556      *  \return New GEOM_Object, containing the mirrored shape.
1557
1558      *  Example: see GEOM_TestAll.py
1559     """
1560     anObj = TrsfOp.MirrorPlaneCopy(theObject, thePlane)
1561     if TrsfOp.IsDone() == 0:
1562       print "MirrorPlaneCopy : ", TrsfOp.GetErrorCode()
1563     return anObj
1564
1565 def MakeMirrorByAxis(theObject, theAxis):
1566     """
1567      *  Create an object, symmetrical
1568      *  to the given one relatively the given axis.
1569      *  \param theObject The object to be mirrored.
1570      *  \param theAxis Axis of symmetry.
1571      *  \return New GEOM_Object, containing the mirrored shape.
1572
1573      *  Example: see GEOM_TestAll.py
1574     """
1575     anObj = TrsfOp.MirrorAxisCopy(theObject, theAxis)
1576     if TrsfOp.IsDone() == 0:
1577       print "MirrorAxisCopy : ", TrsfOp.GetErrorCode()
1578     return anObj
1579
1580 def MakeMirrorByPoint(theObject, thePoint):
1581     """
1582      *  Create an object, symmetrical
1583      *  to the given one relatively the given point.
1584      *  \param theObject The object to be mirrored.
1585      *  \param thePoint Point of symmetry.
1586      *  \return New GEOM_Object, containing the mirrored shape.
1587
1588      *  Example: see GEOM_TestAll.py
1589     """
1590     anObj = TrsfOp.MirrorPointCopy(theObject, thePoint)
1591     if TrsfOp.IsDone() == 0:
1592       print "MirrorPointCopy : ", TrsfOp.GetErrorCode()
1593     return anObj
1594
1595 def MakePosition(theObject, theStartLCS, theEndLCS):
1596     """
1597      *  Modify the Location of the given object by LCS
1598      *  creating its copy before the setting
1599
1600      *  Example: see GEOM_TestAll.py
1601     """
1602     anObj = TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
1603     if TrsfOp.IsDone() == 0:
1604       print "PositionShapeCopy : ", TrsfOp.GetErrorCode()
1605     return anObj
1606
1607 def MakeOffset(theObject, theOffset):
1608     """
1609      *  Create new object as offset of the given one.
1610      *  \param theObject The base object for the offset.
1611      *  \param theOffset Offset value.
1612      *  \return New GEOM_Object, containing the offset object.
1613
1614      *  Example: see GEOM_TestAll.py
1615     """
1616     anObj = TrsfOp.OffsetShapeCopy(theObject, theOffset)
1617     if TrsfOp.IsDone() == 0:
1618       print "OffsetShapeCopy : ", TrsfOp.GetErrorCode()
1619     return anObj
1620
1621 # -----------------------------------------------------------------------------
1622 # Patterns
1623 # -----------------------------------------------------------------------------
1624
1625 def MakeMultiTranslation1D(theObject, theVector, theStep, theNbTimes):
1626     """
1627      *  Translate the given object along the given vector a given number times
1628      *  \param theObject The object to be translated.
1629      *  \param theVector Direction of the translation.
1630      *  \param theStep Distance to translate on.
1631      *  \param theNbTimes Quantity of translations to be done.
1632      *  \return New GEOM_Object, containing compound of all
1633      *          the shapes, obtained after each translation.
1634
1635      *  Example: see GEOM_TestAll.py
1636     """
1637     anObj = TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
1638     if TrsfOp.IsDone() == 0:
1639       print "MultiTranslate1D : ", TrsfOp.GetErrorCode()
1640     return anObj
1641
1642 def MakeMultiTranslation2D(theObject, theVector1, theStep1, theNbTimes1,
1643                                       theVector2, theStep2, theNbTimes2):
1644     """
1645      *  Conseqently apply two specified translations to theObject specified number of times.
1646      *  \param theObject The object to be translated.
1647      *  \param theVector1 Direction of the first translation.
1648      *  \param theStep1 Step of the first translation.
1649      *  \param theNbTimes1 Quantity of translations to be done along theVector1.
1650      *  \param theVector2 Direction of the second translation.
1651      *  \param theStep2 Step of the second translation.
1652      *  \param theNbTimes2 Quantity of translations to be done along theVector2.
1653      *  \return New GEOM_Object, containing compound of all
1654      *          the shapes, obtained after each translation.
1655
1656      *  Example: see GEOM_TestAll.py
1657     """
1658     anObj = TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
1659                                                theVector2, theStep2, theNbTimes2)
1660     if TrsfOp.IsDone() == 0:
1661       print "MultiTranslate2D : ", TrsfOp.GetErrorCode()
1662     return anObj
1663
1664 def MultiRotate1D(theObject, theAxis, theNbTimes):
1665     """
1666      *  Rotate the given object around the given axis a given number times.
1667      *  Rotation angle will be 2*PI/theNbTimes.
1668      *  \param theObject The object to be rotated.
1669      *  \param theAxis The rotation axis.
1670      *  \param theNbTimes Quantity of rotations to be done.
1671      *  \return New GEOM_Object, containing compound of all the
1672      *          shapes, obtained after each rotation.
1673
1674      *  Example: see GEOM_TestAll.py
1675     """
1676     anObj = TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
1677     if TrsfOp.IsDone() == 0:
1678       print "MultiRotate1D : ", TrsfOp.GetErrorCode()
1679     return anObj
1680
1681 def MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2):
1682     """
1683      *  Rotate the given object around the
1684      *  given axis on the given angle a given number
1685      *  times and multi-translate each rotation result.
1686      *  Translation direction passes through center of gravity
1687      *  of rotated shape and its projection on the rotation axis.
1688      *  \param theObject The object to be rotated.
1689      *  \param theAxis Rotation axis.
1690      *  \param theAngle Rotation angle in graduces.
1691      *  \param theNbTimes1 Quantity of rotations to be done.
1692      *  \param theStep Translation distance.
1693      *  \param theNbTimes2 Quantity of translations to be done.
1694      *  \return New GEOM_Object, containing compound of all the
1695      *          shapes, obtained after each transformation.
1696
1697      *  Example: see GEOM_TestAll.py
1698     """
1699     anObj = TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
1700     if TrsfOp.IsDone() == 0:
1701       print "MultiRotate2D : ", TrsfOp.GetErrorCode()
1702     return anObj
1703
1704 def MakeMultiRotation1D(aShape,aDir,aPoint,aNbTimes):
1705     """
1706      *  The same, as MultiRotate1D(), but axis is given by direction and point
1707
1708      *  Example: see GEOM_TestOthers.py
1709     """
1710     aVec = MakeLine(aPoint,aDir)
1711     anObj = MultiRotate1D(aShape,aVec,aNbTimes)
1712     return anObj
1713
1714 def MakeMultiRotation2D(aShape,aDir,aPoint,anAngle,nbtimes1,aStep,nbtimes2):
1715     """
1716      *  The same, as MultiRotate2D(), but axis is given by direction and point
1717
1718      *  Example: see GEOM_TestOthers.py
1719     """
1720     aVec = MakeLine(aPoint,aDir)
1721     anObj = MultiRotate2D(aShape,aVec,anAngle,nbtimes1,aStep,nbtimes2)
1722     return anObj
1723
1724 # -----------------------------------------------------------------------------
1725 # Local operations
1726 # -----------------------------------------------------------------------------
1727
1728 def MakeFilletAll(theShape, theR):
1729     """
1730      *  Perform a fillet on all edges of the given shape.
1731      *  \param theShape Shape, to perform fillet on.
1732      *  \param theR Fillet radius.
1733      *  \return New GEOM_Object, containing the result shape.
1734
1735      *  Example: see GEOM_TestOthers.py
1736     """
1737     anObj = LocalOp.MakeFilletAll(theShape, theR)
1738     if LocalOp.IsDone() == 0:
1739       print "MakeFilletAll : ", LocalOp.GetErrorCode()
1740     return anObj
1741
1742 def MakeFillet(theShape, theR, theShapeType, theListShapes):
1743     """
1744      *  Perform a fillet on the specified edges/faces of the given shape
1745      *  \param theShape Shape, to perform fillet on.
1746      *  \param theR Fillet radius.
1747      *  \param theShapeType Type of shapes in <theListShapes>.
1748      *  \param theListShapes Global indices of edges/faces to perform fillet on.
1749      *    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
1750      *  \return New GEOM_Object, containing the result shape.
1751
1752      *  Example: see GEOM_TestAll.py
1753     """
1754     anObj = None
1755     if theShapeType == ShapeType["EDGE"]:
1756         anObj = LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
1757     else:
1758         anObj = LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
1759     if LocalOp.IsDone() == 0:
1760       print "MakeFillet : ", LocalOp.GetErrorCode()
1761     return anObj
1762
1763 def MakeChamferAll(theShape, theD):
1764     """
1765      *  Perform a symmetric chamfer on all edges of the given shape.
1766      *  \param theShape Shape, to perform chamfer on.
1767      *  \param theD Chamfer size along each face.
1768      *  \return New GEOM_Object, containing the result shape.
1769
1770      *  Example: see GEOM_TestOthers.py
1771     """
1772     anObj = LocalOp.MakeChamferAll(theShape, theD)
1773     if LocalOp.IsDone() == 0:
1774       print "MakeChamferAll : ", LocalOp.GetErrorCode()
1775     return anObj
1776
1777 def MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2):
1778     """
1779      *  Perform a chamfer on edges, common to the specified faces,
1780      *  with distance D1 on the Face1
1781      *  \param theShape Shape, to perform chamfer on.
1782      *  \param theD1 Chamfer size along \a theFace1.
1783      *  \param theD2 Chamfer size along \a theFace2.
1784      *  \param theFace1,theFace2 Global indices of two faces of \a theShape.
1785      *    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
1786      *  \return New GEOM_Object, containing the result shape.
1787
1788      *  Example: see GEOM_TestAll.py
1789     """
1790     anObj = LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
1791     if LocalOp.IsDone() == 0:
1792       print "MakeChamferEdge : ", LocalOp.GetErrorCode()
1793     return anObj
1794
1795 def MakeChamferFaces(theShape, theD1, theD2, theFaces):
1796     """
1797      *  Perform a chamfer on all edges of the specified faces,
1798      *  with distance D1 on the first specified face (if several for one edge)
1799      *  \param theShape Shape, to perform chamfer on.
1800      *  \param theD1 Chamfer size along face from \a theFaces. If both faces,
1801      *               connected to the edge, are in \a theFaces, \a theD1
1802      *               will be get along face, which is nearer to \a theFaces beginning.
1803      *  \param theD2 Chamfer size along another of two faces, connected to the edge.
1804      *  \param theFaces Sequence of global indices of faces of \a theShape.
1805      *    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
1806      *  \return New GEOM_Object, containing the result shape.
1807
1808      *  Example: see GEOM_TestAll.py
1809     """
1810     anObj = LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
1811     if LocalOp.IsDone() == 0:
1812       print "MakeChamferFaces : ", LocalOp.GetErrorCode()
1813     return anObj
1814
1815 def MakeChamfer(aShape,d1,d2,aShapeType,ListShape):
1816     """
1817      *  Shortcut to MakeChamferEdge() and MakeChamferFaces()
1818
1819      *  Example: see GEOM_TestOthers.py
1820     """
1821     anObj = None
1822     if aShapeType == ShapeType["EDGE"]:
1823         anObj = MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1])
1824     else:
1825         anObj = MakeChamferFaces(aShape,d1,d2,ListShape)
1826     return anObj
1827
1828 def Archimede(theShape, theWeight, theWaterDensity, theMeshDeflection):
1829     """
1830      *  Perform an Archimde operation on the given shape with given parameters.
1831      *                    The object presenting the resulting face is returned
1832      *  \param theShape Shape to be put in water.
1833      *  \param theWeight Weight og the shape.
1834      *  \param theWaterDensity Density of the water.
1835      *  \param theMeshDeflection Deflection of the mesh, using to compute the section.
1836      *  \return New GEOM_Object, containing a section of \a theShape
1837      *          by a plane, corresponding to water level.
1838
1839      *  Example: see GEOM_TestAll.py
1840     """
1841     anObj = LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
1842     if LocalOp.IsDone() == 0:
1843       print "MakeArchimede : ", LocalOp.GetErrorCode()
1844     return anObj
1845
1846 # -----------------------------------------------------------------------------
1847 # Information objects
1848 # -----------------------------------------------------------------------------
1849
1850 def PointCoordinates(Point):
1851     """
1852      *  Get point coordinates
1853      *  \return [x, y, z]
1854
1855      *  Example: see GEOM_TestMeasures.py
1856     """
1857     aTuple = MeasuOp.PointCoordinates(Point)
1858     if MeasuOp.IsDone() == 0:
1859       print "PointCoordinates : ", MeasuOp.GetErrorCode()
1860     return aTuple
1861
1862 def BasicProperties(theShape):
1863     """
1864      *  Get summarized length of all wires,
1865      *  area of surface and volume of the given shape.
1866      *  \param theShape Shape to define properties of.
1867      *  \return [theLength, theSurfArea, theVolume]
1868      *  theLength:   Summarized length of all wires of the given shape.
1869      *  theSurfArea: Area of surface of the given shape.
1870      *  theVolume:   Volume of the given shape.
1871
1872      *  Example: see GEOM_TestMeasures.py
1873     """
1874     aTuple = MeasuOp.GetBasicProperties(theShape)
1875     if MeasuOp.IsDone() == 0:
1876       print "BasicProperties : ", MeasuOp.GetErrorCode()
1877     return aTuple
1878
1879 def BoundingBox(theShape):
1880     """
1881      *  Get parameters of bounding box of the given shape
1882      *  \param theShape Shape to obtain bounding box of.
1883      *  \return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
1884      *  Xmin,Xmax: Limits of shape along OX axis.
1885      *  Ymin,Ymax: Limits of shape along OY axis.
1886      *  Zmin,Zmax: Limits of shape along OZ axis.
1887
1888      *  Example: see GEOM_TestMeasures.py
1889     """
1890     aTuple = MeasuOp.GetBoundingBox(theShape)
1891     if MeasuOp.IsDone() == 0:
1892       print "BoundingBox : ", MeasuOp.GetErrorCode()
1893     return aTuple
1894
1895 def Inertia(theShape):
1896     """
1897      *  Get inertia matrix and moments of inertia of theShape.
1898      *  \param theShape Shape to calculate inertia of.
1899      *  \return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
1900      *  I(1-3)(1-3): Components of the inertia matrix of the given shape.
1901      *  Ix,Iy,Iz:    Moments of inertia of the given shape.
1902
1903      *  Example: see GEOM_TestMeasures.py
1904     """
1905     aTuple = MeasuOp.GetInertia(theShape)
1906     if MeasuOp.IsDone() == 0:
1907       print "Inertia : ", MeasuOp.GetErrorCode()
1908     return aTuple
1909
1910 def MinDistance(theShape1, theShape2):
1911     """
1912      *  Get minimal distance between the given shapes.
1913      *  \param theShape1,theShape2 Shapes to find minimal distance between.
1914      *  \return Value of the minimal distance between the given shapes.
1915
1916      *  Example: see GEOM_TestMeasures.py
1917     """
1918     aTuple = MeasuOp.GetMinDistance(theShape1, theShape2)
1919     if MeasuOp.IsDone() == 0:
1920       print "MinDistance : ", MeasuOp.GetErrorCode()
1921     return aTuple[0]
1922
1923 def Tolerance(theShape):
1924     """
1925      *  Get min and max tolerances of sub-shapes of theShape
1926      *  \param theShape Shape, to get tolerances of.
1927      *  \return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
1928      *  FaceMin,FaceMax: Min and max tolerances of the faces.
1929      *  EdgeMin,EdgeMax: Min and max tolerances of the edges.
1930      *  VertMin,VertMax: Min and max tolerances of the vertices.
1931
1932      *  Example: see GEOM_TestMeasures.py
1933     """
1934     aTuple = MeasuOp.GetTolerance(theShape)
1935     if MeasuOp.IsDone() == 0:
1936       print "Tolerance : ", MeasuOp.GetErrorCode()
1937     return aTuple
1938
1939 def WhatIs(theShape):
1940     """
1941      *  Obtain description of the given shape (number of sub-shapes of each type)
1942      *  \param theShape Shape to be described.
1943      *  \return Description of the given shape.
1944
1945      *  Example: see GEOM_TestMeasures.py
1946     """
1947     aDescr = MeasuOp.WhatIs(theShape)
1948     if MeasuOp.IsDone() == 0:
1949       print "WhatIs : ", MeasuOp.GetErrorCode()
1950     return aDescr
1951
1952 def MakeCDG(theShape):
1953     """
1954      *  Get a point, situated at the centre of mass of theShape.
1955      *  \param theShape Shape to define centre of mass of.
1956      *  \return New GEOM_Object, containing the created point.
1957
1958      *  Example: see GEOM_TestMeasures.py
1959     """
1960     anObj = MeasuOp.GetCentreOfMass(theShape)
1961     if MeasuOp.IsDone() == 0:
1962       print "GetCentreOfMass : ", MeasuOp.GetErrorCode()
1963     return anObj
1964
1965 def CheckShape(theShape):
1966     """
1967      *  Check a topology of the given shape.
1968      *  \param theShape Shape to check validity of.
1969      *  \return TRUE, if the shape "seems to be valid" from the topological point of view.
1970      *  If theShape is invalid, prints a description of problem.
1971
1972      *  Example: see GEOM_TestMeasures.py
1973     """
1974     (IsValid, Status) = MeasuOp.CheckShape(theShape)
1975     if MeasuOp.IsDone() == 0:
1976       print "CheckShape : ", MeasuOp.GetErrorCode()
1977     else:
1978       if IsValid == 0:
1979         print Status
1980     return IsValid
1981
1982 # -----------------------------------------------------------------------------
1983 # Import/Export objects
1984 # -----------------------------------------------------------------------------
1985
1986 def Import(theFileName, theFormatName):
1987     """
1988      *  Import a shape from the BREP or IGES or STEP file
1989      *  (depends on given format) with given name.
1990      *  \param theFileName The file, containing the shape.
1991      *  \param theFormatName Specify format for the file reading.
1992      *         Available formats can be obtained with InsertOp.ImportTranslators() method.
1993      *  \return New GEOM_Object, containing the imported shape.
1994
1995      *  Example: see GEOM_TestOthers.py
1996     """
1997     anObj = InsertOp.Import(theFileName, theFormatName)
1998     if InsertOp.IsDone() == 0:
1999       print "Import : ", InsertOp.GetErrorCode()
2000     return anObj
2001
2002 def ImportBREP(theFileName):
2003     """
2004      *  Shortcut to Import() for BREP format
2005
2006      *  Example: see GEOM_TestOthers.py
2007     """
2008     return Import(theFileName, "BREP")
2009
2010 def ImportIGES(theFileName):
2011     """
2012      *  Shortcut to Import() for IGES format
2013
2014      *  Example: see GEOM_TestOthers.py
2015     """
2016     return Import(theFileName, "IGES")
2017
2018 def ImportSTEP(theFileName):
2019     """
2020      *  Shortcut to Import() for STEP format
2021
2022      *  Example: see GEOM_TestOthers.py
2023     """
2024     return Import(theFileName, "STEP")
2025
2026 def Export(theObject, theFileName, theFormatName):
2027     """
2028      *  Export the given shape into a file with given name.
2029      *  \param theObject Shape to be stored in the file.
2030      *  \param theFileName Name of the file to store the given shape in.
2031      *  \param theFormatName Specify format for the shape storage.
2032      *         Available formats can be obtained with InsertOp.ImportTranslators() method.
2033
2034      *  Example: see GEOM_TestOthers.py
2035     """
2036     InsertOp.Export(theObject, theFileName, theFormatName)
2037     if InsertOp.IsDone() == 0:
2038       print "Export : ", InsertOp.GetErrorCode()
2039
2040 def ExportBREP(theObject, theFileName):
2041     """
2042      *  Shortcut to Export() for BREP format
2043
2044      *  Example: see GEOM_TestOthers.py
2045     """
2046     return Export(theObject, theFileName, "BREP")
2047
2048 def ExportIGES(theObject, theFileName):
2049     """
2050      *  Shortcut to Export() for IGES format
2051
2052      *  Example: see GEOM_TestOthers.py
2053     """
2054     return Export(theObject, theFileName, "IGES")
2055
2056 def ExportSTEP(theObject, theFileName):
2057     """
2058      *  Shortcut to Export() for STEP format
2059
2060      *  Example: see GEOM_TestOthers.py
2061     """
2062     return Export(theObject, theFileName, "STEP")
2063
2064 # -----------------------------------------------------------------------------
2065 # Block operations
2066 # -----------------------------------------------------------------------------
2067
2068 def MakeQuad(E1, E2, E3, E4):
2069     """
2070      *  Create a quadrangle face from four edges. Order of Edges is not
2071      *  important. It is  not necessary that edges share the same vertex.
2072      *  \param E1,E2,E3,E4 Edges for the face bound.
2073      *  \return New GEOM_Object, containing the created face.
2074
2075      *  Example: see GEOM_Spanner.py
2076     """
2077     anObj = BlocksOp.MakeQuad(E1, E2, E3, E4)
2078     if BlocksOp.IsDone() == 0:
2079       print "MakeQuad : ", BlocksOp.GetErrorCode()
2080     return anObj
2081
2082 def MakeQuad2Edges(E1, E2):
2083     """
2084      *  Create a quadrangle face on two edges.
2085      *  The missing edges will be built by creating the shortest ones.
2086      *  \param E1,E2 Two opposite edges for the face.
2087      *  \return New GEOM_Object, containing the created face.
2088
2089      *  Example: see GEOM_Spanner.py
2090     """
2091     anObj = BlocksOp.MakeQuad2Edges(E1, E2)
2092     if BlocksOp.IsDone() == 0:
2093       print "MakeQuad2Edges : ", BlocksOp.GetErrorCode()
2094     return anObj
2095
2096 def MakeQuad4Vertices(V1, V2, V3, V4):
2097     """
2098      *  Create a quadrangle face with specified corners.
2099      *  The missing edges will be built by creating the shortest ones.
2100      *  \param V1,V2,V3,V4 Corner vertices for the face.
2101      *  \return New GEOM_Object, containing the created face.
2102
2103      *  Example: see GEOM_Spanner.py
2104     """
2105     anObj = BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
2106     if BlocksOp.IsDone() == 0:
2107       print "MakeQuad4Vertices : ", BlocksOp.GetErrorCode()
2108     return anObj
2109
2110 def MakeHexa(F1, F2, F3, F4, F5, F6):
2111     """
2112      *  Create a hexahedral solid, bounded by the six given faces. Order of
2113      *  faces is not important. It is  not necessary that Faces share the same edge.
2114      *  \param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
2115      *  \return New GEOM_Object, containing the created solid.
2116
2117      *  Example: see GEOM_Spanner.py
2118     """
2119     anObj = BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
2120     if BlocksOp.IsDone() == 0:
2121       print "MakeHexa : ", BlocksOp.GetErrorCode()
2122     return anObj
2123
2124 def MakeHexa2Faces(F1, F2):
2125     """
2126      *  Create a hexahedral solid between two given faces.
2127      *  The missing faces will be built by creating the smallest ones.
2128      *  \param F1,F2 Two opposite faces for the hexahedral solid.
2129      *  \return New GEOM_Object, containing the created solid.
2130
2131      *  Example: see GEOM_Spanner.py
2132     """
2133     anObj = BlocksOp.MakeHexa2Faces(F1, F2)
2134     if BlocksOp.IsDone() == 0:
2135       print "MakeHexa2Faces : ", BlocksOp.GetErrorCode()
2136     return anObj
2137
2138 def GetPoint(theShape, theX, theY, theZ, theEpsilon):
2139     """
2140      *  Get a vertex, found in the given shape by its coordinates.
2141      *  \param theShape Block or a compound of blocks.
2142      *  \param theX,theY,theZ Coordinates of the sought vertex.
2143      *  \param theEpsilon Maximum allowed distance between the resulting
2144      *                    vertex and point with the given coordinates.
2145      *  \return New GEOM_Object, containing the found vertex.
2146
2147      *  Example: see GEOM_TestOthers.py
2148     """
2149     anObj = BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
2150     if BlocksOp.IsDone() == 0:
2151       print "GetPoint : ", BlocksOp.GetErrorCode()
2152     return anObj
2153
2154 def GetEdge(theShape, thePoint1, thePoint2):
2155     """
2156      *  Get an edge, found in the given shape by two given vertices.
2157      *  \param theShape Block or a compound of blocks.
2158      *  \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2159      *  \return New GEOM_Object, containing the found edge.
2160
2161      *  Example: see GEOM_Spanner.py
2162     """
2163     anObj = BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
2164     if BlocksOp.IsDone() == 0:
2165       print "GetEdge : ", BlocksOp.GetErrorCode()
2166     return anObj
2167
2168 def GetEdgeNearPoint(theShape, thePoint):
2169     """
2170      *  Find an edge of the given shape, which has minimal distance to the given point.
2171      *  \param theShape Block or a compound of blocks.
2172      *  \param thePoint Point, close to the desired edge.
2173      *  \return New GEOM_Object, containing the found edge.
2174
2175      *  Example: see GEOM_TestOthers.py
2176     """
2177     anObj = BlocksOp.GetEdgeNearPoint(theShape, thePoint)
2178     if BlocksOp.IsDone() == 0:
2179       print "GetEdgeNearPoint : ", BlocksOp.GetErrorCode()
2180     return anObj
2181
2182 def GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4):
2183     """
2184      *  Returns a face, found in the given shape by four given corner vertices.
2185      *  \param theShape Block or a compound of blocks.
2186      *  \param thePoint1-thePoint4 Points, close to the corners of the desired face.
2187      *  \return New GEOM_Object, containing the found face.
2188
2189      *  Example: see GEOM_Spanner.py
2190     """
2191     anObj = BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
2192     if BlocksOp.IsDone() == 0:
2193       print "GetFaceByPoints : ", BlocksOp.GetErrorCode()
2194     return anObj
2195
2196 def GetFaceByEdges(theShape, theEdge1, theEdge2):
2197     """
2198      *  Get a face of block, found in the given shape by two given edges.
2199      *  \param theShape Block or a compound of blocks.
2200      *  \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2201      *  \return New GEOM_Object, containing the found face.
2202
2203      *  Example: see GEOM_Spanner.py
2204     """
2205     anObj = BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
2206     if BlocksOp.IsDone() == 0:
2207       print "GetFaceByEdges : ", BlocksOp.GetErrorCode()
2208     return anObj
2209
2210 def GetOppositeFace(theBlock, theFace):
2211     """
2212      *  Find a face, opposite to the given one in the given block.
2213      *  \param theBlock Must be a hexahedral solid.
2214      *  \param theFace Face of \a theBlock, opposite to the desired face.
2215      *  \return New GEOM_Object, containing the found face.
2216
2217      *  Example: see GEOM_Spanner.py
2218     """
2219     anObj = BlocksOp.GetOppositeFace(theBlock, theFace)
2220     if BlocksOp.IsDone() == 0:
2221       print "GetOppositeFace : ", BlocksOp.GetErrorCode()
2222     return anObj
2223
2224 def GetFaceNearPoint(theShape, thePoint):
2225     """
2226      *  Find a face of the given shape, which has minimal distance to the given point.
2227      *  \param theShape Block or a compound of blocks.
2228      *  \param thePoint Point, close to the desired face.
2229      *  \return New GEOM_Object, containing the found face.
2230
2231      *  Example: see GEOM_Spanner.py
2232     """
2233     anObj = BlocksOp.GetFaceNearPoint(theShape, thePoint)
2234     if BlocksOp.IsDone() == 0:
2235       print "GetFaceNearPoint : ", BlocksOp.GetErrorCode()
2236     return anObj
2237
2238 def GetFaceByNormale(theBlock, theVector):
2239     """
2240      *  Find a face of block, whose outside normale has minimal angle with the given vector.
2241      *  \param theShape Block or a compound of blocks.
2242      *  \param theVector Vector, close to the normale of the desired face.
2243      *  \return New GEOM_Object, containing the found face.
2244
2245      *  Example: see GEOM_Spanner.py
2246     """
2247     anObj = BlocksOp.GetFaceByNormale(theBlock, theVector)
2248     if BlocksOp.IsDone() == 0:
2249       print "GetFaceByNormale : ", BlocksOp.GetErrorCode()
2250     return anObj
2251
2252 def CheckCompoundOfBlocks(theCompound):
2253     """
2254      *  Check, if the compound of blocks is given.
2255      *  To be considered as a compound of blocks, the
2256      *  given shape must satisfy the following conditions:
2257      *  - Each element of the compound should be a Block (6 faces and 12 edges).
2258      *  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2259      *  - The compound should be connexe.
2260      *  - The glue between two quadrangle faces should be applied.
2261      *  \param theCompound The compound to check.
2262      *  \return TRUE, if the given shape is a compound of blocks.
2263      *  If theCompound is not valid, prints all discovered errors.
2264
2265      *  Example: see GEOM_Spanner.py
2266     """
2267     (IsValid, BCErrors) = BlocksOp.CheckCompoundOfBlocks(theCompound)
2268     if BlocksOp.IsDone() == 0:
2269       print "CheckCompoundOfBlocks : ", BlocksOp.GetErrorCode()
2270     else:
2271       if IsValid == 0:
2272         Descr = BlocksOp.PrintBCErrors(theCompound, BCErrors)
2273         print Descr
2274     return IsValid
2275
2276 def RemoveExtraEdges(theShape):
2277     """
2278      *  Remove all seam and degenerated edges from \a theShape.
2279      *  Unite faces and edges, sharing one surface.
2280      *  \param theShape The compound or single solid to remove irregular edges from.
2281      *  \return Improved shape.
2282
2283      *  Example: see GEOM_TestOthers.py
2284     """
2285     anObj = BlocksOp.RemoveExtraEdges(theShape)
2286     if BlocksOp.IsDone() == 0:
2287       print "RemoveExtraEdges : ", BlocksOp.GetErrorCode()
2288     return anObj
2289
2290 def CheckAndImprove(theShape):
2291     """
2292      *  Check, if the given shape is a blocks compound.
2293      *  Fix all detected errors.
2294      *    \note Single block can be also fixed by this method.
2295      *  \param theCompound The compound to check and improve.
2296      *  \return Improved compound.
2297
2298      *  Example: see GEOM_TestOthers.py
2299     """
2300     anObj = BlocksOp.CheckAndImprove(theShape)
2301     if BlocksOp.IsDone() == 0:
2302       print "CheckAndImprove : ", BlocksOp.GetErrorCode()
2303     return anObj
2304
2305 def MakeBlockExplode(theCompound, theMinNbFaces, theMaxNbFaces):
2306     """
2307      *  Get all the blocks, contained in the given compound.
2308      *  \param theCompound The compound to explode.
2309      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
2310      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2311      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2312      *  \return List of GEOM_Objects, containing the retrieved blocks.
2313
2314      *  Example: see GEOM_TestOthers.py
2315     """
2316     aList = BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
2317     if BlocksOp.IsDone() == 0:
2318       print "MakeBlockExplode : ", BlocksOp.GetErrorCode()
2319     return aList
2320
2321 def GetBlockNearPoint(theCompound, thePoint):
2322     """
2323      *  Find block, containing the given point inside its volume or on boundary.
2324      *  \param theCompound Compound, to find block in.
2325      *  \param thePoint Point, close to the desired block. If the point lays on
2326      *         boundary between some blocks, we return block with nearest center.
2327      *  \return New GEOM_Object, containing the found block.
2328
2329      *  Example: see GEOM_Spanner.py
2330     """
2331     anObj = BlocksOp.GetBlockNearPoint(theCompound, thePoint)
2332     if BlocksOp.IsDone() == 0:
2333       print "GetBlockNearPoint : ", BlocksOp.GetErrorCode()
2334     return anObj
2335
2336 def GetBlockByParts(theCompound, theParts):
2337     """
2338      *  Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2339      *  \param theCompound Compound, to find block in.
2340      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2341      *  \return New GEOM_Object, containing the found block.
2342
2343      *  Example: see GEOM_TestOthers.py
2344     """
2345     anObj = BlocksOp.GetBlockByParts(theCompound, theParts)
2346     if BlocksOp.IsDone() == 0:
2347       print "GetBlockByParts : ", BlocksOp.GetErrorCode()
2348     return anObj
2349
2350 def GetBlocksByParts(theCompound, theParts):
2351     """
2352      *  Return all blocks, containing all the elements, passed as the parts.
2353      *  \param theCompound Compound, to find blocks in.
2354      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2355      *  \return List of GEOM_Objects, containing the found blocks.
2356
2357      *  Example: see GEOM_Spanner.py
2358     """
2359     aList = BlocksOp.GetBlocksByParts(theCompound, theParts)
2360     if BlocksOp.IsDone() == 0:
2361       print "GetBlocksByParts : ", BlocksOp.GetErrorCode()
2362     return aList
2363
2364 def MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes):
2365     """
2366      *  Multi-transformate block and glue the result.
2367      *  Transformation is defined so, as to superpose direction faces.
2368      *  \param Block Hexahedral solid to be multi-transformed.
2369      *  \param DirFace1 ID of First direction face.
2370      *  \param DirFace2 ID of Second direction face.
2371      *  \param NbTimes Quantity of transformations to be done.
2372      *    \note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
2373      *  \return New GEOM_Object, containing the result shape.
2374
2375      *  Example: see GEOM_Spanner.py
2376     """
2377     anObj = BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
2378     if BlocksOp.IsDone() == 0:
2379       print "MakeMultiTransformation1D : ", BlocksOp.GetErrorCode()
2380     return anObj
2381
2382 def MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
2383                                      DirFace1V, DirFace2V, NbTimesV):
2384     """
2385      *  Multi-transformate block and glue the result.
2386      *  \param Block Hexahedral solid to be multi-transformed.
2387      *  \param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
2388      *  \param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
2389      *  \param NbTimesU,NbTimesV Quantity of transformations to be done.
2390      *  \return New GEOM_Object, containing the result shape.
2391
2392      *  Example: see GEOM_Spanner.py
2393     """
2394     anObj = BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
2395                                                       DirFace1V, DirFace2V, NbTimesV)
2396     if BlocksOp.IsDone() == 0:
2397       print "MakeMultiTransformation2D : ", BlocksOp.GetErrorCode()
2398     return anObj
2399
2400 def Propagate(theShape):
2401     """
2402      *  Build all possible propagation groups.
2403      *  Propagation group is a set of all edges, opposite to one (main)
2404      *  edge of this group directly or through other opposite edges.
2405      *  Notion of Opposite Edge make sence only on quadrangle face.
2406      *  \param theShape Shape to build propagation groups on.
2407      *  \return List of GEOM_Objects, each of them is a propagation group.
2408
2409      *  Example: see GEOM_TestOthers.py
2410     """
2411     listChains = BlocksOp.Propagate(theShape)
2412     if BlocksOp.IsDone() == 0:
2413       print "Propagate : ", BlocksOp.GetErrorCode()
2414     return listChains
2415
2416 # -----------------------------------------------------------------------------
2417 # Group operations
2418 # -----------------------------------------------------------------------------
2419
2420 def CreateGroup(theMainShape, theShapeType):
2421     """
2422      *  Creates a new group which will store sub shapes of theMainShape
2423      *  \param theMainShape is a GEOM object on which the group is selected
2424      *  \param theShapeType defines a shape type of the group
2425      *  \return a newly created GEOM group
2426
2427      *  Example: see GEOM_TestOthers.py
2428     """
2429     anObj = GroupOp.CreateGroup(theMainShape, theShapeType)
2430     if GroupOp.IsDone() == 0:
2431        print "CreateGroup : ", GroupOp.GetErrorCode()
2432     return anObj
2433
2434 def AddObject(theGroup, theSubShapeID):
2435     """
2436      *  Adds a sub object with ID theSubShapeId to the group
2437      *  \param theGroup is a GEOM group to which the new sub shape is added
2438      *  \param theSubShapeID is a sub shape ID in the main object.
2439      *  \note Use method GetSubShapeID() to get an unique ID of the sub shape
2440
2441      *  Example: see GEOM_TestOthers.py
2442     """
2443     GroupOp.AddObject(theGroup, theSubShapeID)
2444     if GroupOp.IsDone() == 0:
2445       print "AddObject : ", GroupOp.GetErrorCode()
2446
2447 def RemoveObject(theGroup, theSubShapeID):
2448     """
2449      *  Removes a sub object with ID \a theSubShapeId from the group
2450      *  \param theGroup is a GEOM group from which the new sub shape is removed
2451      *  \param theSubShapeID is a sub shape ID in the main object.
2452      *  \note Use method GetSubShapeID() to get an unique ID of the sub shape
2453
2454      *  Example: see GEOM_TestOthers.py
2455     """
2456     GroupOp.RemoveObject(theGroup, theSubShapeID)
2457     if GroupOp.IsDone() == 0:
2458       print "RemoveObject : ", GroupOp.GetErrorCode()
2459
2460 def UnionList (theGroup, theSubShapes):
2461     """
2462      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2463      *  \param theGroup is a GEOM group to which the new sub shapes are added.
2464      *  \param theSubShapes is a list of sub shapes to be added.
2465
2466      *  Example: see GEOM_TestOthers.py
2467     """
2468     GroupOp.UnionList(theGroup, theSubShapes)
2469     if GroupOp.IsDone() == 0:
2470       print "UnionList : ", GroupOp.GetErrorCode()
2471
2472 def UnionIDs(theGroup, theSubShapes):
2473     """
2474      *  Works like the above method, but argument
2475      *  theSubShapes here is a list of sub-shapes indices
2476     """
2477     GroupOp.UnionIDs(theGroup, theSubShapes)
2478     if GroupOp.IsDone() == 0:
2479         print "UnionIDs : ", GroupOp.GetErrorCode()
2480
2481 def DifferenceList (theGroup, theSubShapes):
2482     """
2483      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
2484      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
2485      *  \param theSubShapes is a list of sub-shapes to be removed.
2486
2487      *  Example: see GEOM_TestOthers.py
2488     """
2489     GroupOp.DifferenceList(theGroup, theSubShapes)
2490     if GroupOp.IsDone() == 0:
2491       print "DifferenceList : ", GroupOp.GetErrorCode()
2492
2493 def DifferenceIDs(theGroup, theSubShapes):
2494     """
2495      *  Works like the above method, but argument
2496      *  theSubShapes here is a list of sub-shapes indices
2497     """
2498     GroupOp.DifferenceIDs(theGroup, theSubShapes)
2499     if GroupOp.IsDone() == 0:
2500         print "DifferenceIDs : ", GroupOp.GetErrorCode()
2501
2502 def GetObjectIDs(theGroup):
2503     """
2504      *  Returns a list of sub objects ID stored in the group
2505      *  \param theGroup is a GEOM group for which a list of IDs is requested
2506
2507      *  Example: see GEOM_TestOthers.py
2508     """
2509     ListIDs = GroupOp.GetObjects(theGroup)
2510     if GroupOp.IsDone() == 0:
2511       print "GetObjectIDs : ", GroupOp.GetErrorCode()
2512     return ListIDs
2513
2514 def GetType(theGroup):
2515     """
2516      *  Returns a type of sub objects stored in the group
2517      *  \param theGroup is a GEOM group which type is returned.
2518
2519      *  Example: see GEOM_TestOthers.py
2520     """
2521     aType = GroupOp.GetType(theGroup)
2522     if GroupOp.IsDone() == 0:
2523       print "GetType : ", GroupOp.GetErrorCode()
2524     return aType
2525
2526 def GetMainShape(theGroup):
2527     """
2528      *  Returns a main shape associated with the group
2529      *  \param theGroup is a GEOM group for which a main shape object is requested
2530      *  \return a GEOM object which is a main shape for theGroup
2531
2532      *  Example: see GEOM_TestOthers.py
2533     """
2534     anObj = GroupOp.GetMainShape(theGroup)
2535     if GroupOp.IsDone() == 0:
2536       print "GetMainShape : ", GroupOp.GetErrorCode()
2537     return anObj
2538
2539 def GetEdgesByLength (theShape, min_length, max_length, include_min = 1, include_max = 1):
2540     """
2541     Create group of edges of theShape, whose length is in range [min_length, max_length].
2542     If include_min/max == 0, edges with length == min/max_length will not be included in result.
2543     """
2544
2545     edges = SubShapeAll(theShape, ShapeType["EDGE"])
2546     edges_in_range = []
2547     for edge in edges:
2548         Props = BasicProperties(edge)
2549         if min_length <= Props[0] and Props[0] <= max_length:
2550             if (not include_min) and (min_length == Props[0]):
2551                 skip = 1
2552             else:
2553                 if (not include_max) and (Props[0] == max_length):
2554                     skip = 1
2555                 else:
2556                     edges_in_range.append(edge)
2557
2558     if len(edges_in_range) <= 0:
2559         print "No edges found by given criteria"
2560         return 0
2561
2562     group_edges = CreateGroup(theShape, ShapeType["EDGE"])
2563     UnionList(group_edges, edges_in_range)
2564
2565     return group_edges
2566
2567 def SelectEdges (min_length, max_length, include_min = 1, include_max = 1):
2568     """
2569     Create group of edges of selected shape, whose length is in range [min_length, max_length].
2570     If include_min/max == 0, edges with length == min/max_length will not be included in result.
2571     """
2572
2573     nb_selected = sg.SelectedCount()
2574     if nb_selected < 1:
2575         print "Select a shape before calling this function, please."
2576         return 0
2577     if nb_selected > 1:
2578         print "Only one shape must be selected"
2579         return 0
2580
2581     id_shape = sg.getSelected(0)
2582     shape = IDToObject( id_shape )
2583
2584     group_edges = GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
2585
2586     left_str  = " < "
2587     right_str = " < "
2588     if include_min: left_str  = " <= "
2589     if include_max: right_str  = " <= "
2590
2591     addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
2592                        + left_str + "length" + right_str + `max_length`)
2593
2594     sg.updateObjBrowser(1)
2595
2596     return group_edges
2597
2598 def addPath(Path):
2599     """
2600      * Add Path to load python scripts from
2601     """
2602     if (sys.path.count(Path) < 1):
2603         sys.path.append(Path)