1 # GEOM GEOM_SWIG : binding of C++ omplementaion with Python
3 # Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 # Author : Paul RASCLE, EDF
40 g = lcc.FindOrLoadComponent("FactoryServer", "GEOM")
41 geom = g._narrow( GEOM.GEOM_Gen )
42 #gg = ImportComponentGUI("GEOM")
45 #SRN: modified on Mar 18, 2005
64 def init_geom(theStudy):
66 global myStudy, myBuilder, myStudyId, BasicOp, CurvesOp, PrimOp, ShapesOp, HealOp
67 global InsertOp, BoolOp, TrsfOp, LocalOp, MeasuOp, BlocksOp, GroupOp, father
70 myStudyId = myStudy._get_StudyId()
71 myBuilder = myStudy.NewBuilder()
72 father = myStudy.FindComponent("GEOM")
74 father = myBuilder.NewComponent("GEOM")
75 A1 = myBuilder.FindOrCreateAttribute(father, "AttributeName")
76 FName = A1._narrow(SALOMEDS.AttributeName)
77 FName.SetValue("Geometry")
78 A2 = myBuilder.FindOrCreateAttribute(father, "AttributePixMap")
79 aPixmap = A2._narrow(SALOMEDS.AttributePixMap)
80 aPixmap.SetPixMap("ICON_OBJBROWSER_Geometry")
81 myBuilder.DefineComponentInstance(father,geom)
84 # -----------------------------------------------------------------------------
85 # Assign Operations Interfaces
86 # -----------------------------------------------------------------------------
88 BasicOp = geom.GetIBasicOperations (myStudyId)
89 CurvesOp = geom.GetICurvesOperations (myStudyId)
90 PrimOp = geom.GetI3DPrimOperations (myStudyId)
91 ShapesOp = geom.GetIShapesOperations (myStudyId)
92 HealOp = geom.GetIHealingOperations (myStudyId)
93 InsertOp = geom.GetIInsertOperations (myStudyId)
94 BoolOp = geom.GetIBooleanOperations (myStudyId)
95 TrsfOp = geom.GetITransformOperations(myStudyId)
96 LocalOp = geom.GetILocalOperations (myStudyId)
97 MeasuOp = geom.GetIMeasureOperations (myStudyId)
98 BlocksOp = geom.GetIBlocksOperations (myStudyId)
99 GroupOp = geom.GetIGroupOperations (myStudyId)
104 #SRN: end of modifications
106 ## Get name for sub-shape aSubObj of shape aMainObj
108 # Example: see GEOM_TestAll.py
109 def SubShapeName(aSubObj, aMainObj):
110 #aSubId = orb.object_to_string(aSubObj)
111 #aMainId = orb.object_to_string(aMainObj)
112 #index = gg.getIndexTopology(aSubId, aMainId)
113 #name = gg.getShapeTypeString(aSubId) + "_%d"%(index)
114 index = ShapesOp.GetTopologyIndex(aMainObj, aSubObj)
115 name = ShapesOp.GetShapeTypeString(aSubObj) + "_%d"%(index)
118 ## Publish in study aShape with name aName
120 # Example: see GEOM_TestAll.py
121 def addToStudy(aShape, aName):
123 aSObject = geom.AddInStudy(myStudy, aShape, aName, None)
125 print "addToStudy() failed"
127 return aShape.GetStudyEntry()
129 ## Publish in study aShape with name aName as sub-object of previously published aFather
131 # Example: see GEOM_TestAll.py
132 def addToStudyInFather(aFather, aShape, aName):
134 aSObject = geom.AddInStudy(myStudy, aShape, aName, aFather)
136 print "addToStudyInFather() failed"
138 return aShape.GetStudyEntry()
140 # -----------------------------------------------------------------------------
141 # enumeration ShapeType as a dictionary
142 # -----------------------------------------------------------------------------
144 ShapeType = {"COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8}
146 # -----------------------------------------------------------------------------
148 # -----------------------------------------------------------------------------
150 ## Create point by three coordinates.
151 # @param theX The X coordinate of the point.
152 # @param theY The Y coordinate of the point.
153 # @param theZ The Z coordinate of the point.
154 # @return New GEOM_Object, containing the created point.
156 # Example: see GEOM_TestAll.py
157 def MakeVertex(theX, theY, theZ):
158 anObj = BasicOp.MakePointXYZ(theX, theY, theZ)
159 if BasicOp.IsDone() == 0:
160 print "MakePointXYZ : ", BasicOp.GetErrorCode()
163 ## Create a point, distant from the referenced point
164 # on the given distances along the coordinate axes.
165 # @param theReference The referenced point.
166 # @param theX Displacement from the referenced point along OX axis.
167 # @param theY Displacement from the referenced point along OY axis.
168 # @param theZ Displacement from the referenced point along OZ axis.
169 # @return New GEOM_Object, containing the created point.
171 # Example: see GEOM_TestAll.py
172 def MakeVertexWithRef(theReference, theX, theY, theZ):
173 anObj = BasicOp.MakePointWithReference(theReference, theX, theY, theZ)
174 if BasicOp.IsDone() == 0:
175 print "MakePointWithReference : ", BasicOp.GetErrorCode()
178 ## Create a point, corresponding to the given parameter on the given curve.
179 # @param theRefCurve The referenced curve.
180 # @param theParameter Value of parameter on the referenced curve.
181 # @return New GEOM_Object, containing the created point.
183 # Example: see GEOM_TestAll.py
184 def MakeVertexOnCurve(theRefCurve, theParameter):
185 anObj = BasicOp.MakePointOnCurve(theRefCurve, theParameter)
186 if BasicOp.IsDone() == 0:
187 print "MakePointOnCurve : ", BasicOp.GetErrorCode()
190 ## Create a tangent, corresponding to the given parameter on the given curve.
191 # @param theRefCurve The referenced curve.
192 # @param theParameter Value of parameter on the referenced curve.
193 # @return New GEOM_Object, containing the created tangent.
194 def MakeTangentOnCurve(theRefCurve, theParameter):
195 anObj = BasicOp.MakeTangentOnCurve(theRefCurve, theParameter)
196 if BasicOp.IsDone() == 0:
197 print "MakeTangentOnCurve : ", BasicOp.GetErrorCode()
200 ## Create a vector with the given components.
201 # @param theDX X component of the vector.
202 # @param theDY Y component of the vector.
203 # @param theDZ Z component of the vector.
204 # @return New GEOM_Object, containing the created vector.
206 # Example: see GEOM_TestAll.py
207 def MakeVectorDXDYDZ(theDX, theDY, theDZ):
208 anObj = BasicOp.MakeVectorDXDYDZ(theDX, theDY, theDZ)
209 if BasicOp.IsDone() == 0:
210 print "MakeVectorDXDYDZ : ", BasicOp.GetErrorCode()
213 ## Create a vector between two points.
214 # @param thePnt1 Start point for the vector.
215 # @param thePnt2 End point for the vector.
216 # @return New GEOM_Object, containing the created vector.
218 # Example: see GEOM_TestAll.py
219 def MakeVector(thePnt1, thePnt2):
220 anObj = BasicOp.MakeVectorTwoPnt(thePnt1, thePnt2)
221 if BasicOp.IsDone() == 0:
222 print "MakeVectorTwoPnt : ", BasicOp.GetErrorCode()
225 ## Create a line, passing through the given point
226 # and parrallel to the given direction
227 # @param thePnt Point. The resulting line will pass through it.
228 # @param theDir Direction. The resulting line will be parallel to it.
229 # @return New GEOM_Object, containing the created line.
231 # Example: see GEOM_TestAll.py
232 def MakeLine(thePnt, theDir):
233 anObj = BasicOp.MakeLine(thePnt, theDir)
234 if BasicOp.IsDone() == 0:
235 print "MakeLine : ", BasicOp.GetErrorCode()
238 ## Create a line, passing through the given points
239 # @param thePnt1 First of two points, defining the line.
240 # @param thePnt2 Second of two points, defining the line.
241 # @return New GEOM_Object, containing the created line.
243 # Example: see GEOM_TestAll.py
244 def MakeLineTwoPnt(thePnt1, thePnt2):
245 anObj = BasicOp.MakeLineTwoPnt(thePnt1, thePnt2)
246 if BasicOp.IsDone() == 0:
247 print "MakeLineTwoPnt : ", BasicOp.GetErrorCode()
250 ## Create a plane, passing through the given point
251 # and normal to the given vector.
252 # @param thePnt Point, the plane has to pass through.
253 # @param theVec Vector, defining the plane normal direction.
254 # @param theTrimSize Half size of a side of quadrangle face, representing the plane.
255 # @return New GEOM_Object, containing the created plane.
257 # Example: see GEOM_TestAll.py
258 def MakePlane(thePnt, theVec, theTrimSize):
259 anObj = BasicOp.MakePlanePntVec(thePnt, theVec, theTrimSize)
260 if BasicOp.IsDone() == 0:
261 print "MakePlanePntVec : ", BasicOp.GetErrorCode()
264 ## Create a plane, passing through the three given points
265 # @param thePnt1 First of three points, defining the plane.
266 # @param thePnt2 Second of three points, defining the plane.
267 # @param thePnt3 Fird of three points, defining the plane.
268 # @param theTrimSize Half size of a side of quadrangle face, representing the plane.
269 # @return New GEOM_Object, containing the created plane.
271 # Example: see GEOM_TestAll.py
272 def MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize):
273 anObj = BasicOp.MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize)
274 if BasicOp.IsDone() == 0:
275 print "MakePlaneThreePnt : ", BasicOp.GetErrorCode()
278 ## Create a plane, similar to the existing one, but with another size of representing face.
279 # @param theFace Referenced plane or LCS(Marker).
280 # @param theTrimSize New half size of a side of quadrangle face, representing the plane.
281 # @return New GEOM_Object, containing the created plane.
283 # Example: see GEOM_TestAll.py
284 def MakePlaneFace(theFace, theTrimSize):
285 anObj = BasicOp.MakePlaneFace(theFace, theTrimSize)
286 if BasicOp.IsDone() == 0:
287 print "MakePlaneFace : ", BasicOp.GetErrorCode()
290 ## Create a local coordinate system.
291 # @param OX,OY,OZ Three coordinates of coordinate system origin.
292 # @param XDX,XDY,XDZ Three components of OX direction
293 # @param YDX,YDY,YDZ Three components of OY direction
294 # @return New GEOM_Object, containing the created coordinate system.
296 # Example: see GEOM_TestAll.py
297 def MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ):
298 anObj = BasicOp.MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ)
299 if BasicOp.IsDone() == 0:
300 print "MakeMarker : ", BasicOp.GetErrorCode()
303 ## Create a local coordinate system.
304 # @param theOrigin Point of coordinate system origin.
305 # @param theXVec Vector of X direction
306 # @param theYVec Vector of Y direction
307 # @return New GEOM_Object, containing the created coordinate system.
308 def MakeMarkerPntTwoVec(theOrigin, theXVec, theYVec):
309 O = PointCoordinates( theOrigin )
311 for vec in [ theXVec, theYVec ]:
312 v1, v2 = SubShapeAll( vec, ShapeType["VERTEX"] )
313 p1 = PointCoordinates( v1 )
314 p2 = PointCoordinates( v2 )
315 for i in range( 0, 3 ):
316 OXOY.append( p2[i] - p1[i] )
318 anObj = BasicOp.MakeMarker( O[0], O[1], O[2],
319 OXOY[0], OXOY[1], OXOY[2],
320 OXOY[3], OXOY[4], OXOY[5], )
321 if BasicOp.IsDone() == 0:
322 print "MakeMarker : ", BasicOp.GetErrorCode()
325 # -----------------------------------------------------------------------------
327 # -----------------------------------------------------------------------------
329 ## Create an arc of circle, passing through three given points.
330 # @param thePnt1 Start point of the arc.
331 # @param thePnt2 Middle point of the arc.
332 # @param thePnt3 End point of the arc.
333 # @return New GEOM_Object, containing the created arc.
335 # Example: see GEOM_TestAll.py
336 def MakeArc(thePnt1, thePnt2, thePnt3):
337 anObj = CurvesOp.MakeArc(thePnt1, thePnt2, thePnt3)
338 if CurvesOp.IsDone() == 0:
339 print "MakeArc : ", CurvesOp.GetErrorCode()
342 ## Create a circle with given center, normal vector and radius.
343 # @param thePnt Circle center.
344 # @param theVec Vector, normal to the plane of the circle.
345 # @param theR Circle radius.
346 # @return New GEOM_Object, containing the created circle.
348 # Example: see GEOM_TestAll.py
349 def MakeCircle(thePnt, theVec, theR):
350 anObj = CurvesOp.MakeCirclePntVecR(thePnt, theVec, theR)
351 if CurvesOp.IsDone() == 0:
352 print "MakeCirclePntVecR : ", CurvesOp.GetErrorCode()
355 ## Create a circle, passing through three given points
356 # @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
357 # @return New GEOM_Object, containing the created circle.
359 # Example: see GEOM_TestAll.py
360 def MakeCircleThreePnt(thePnt1, thePnt2, thePnt3):
361 anObj = CurvesOp.MakeCircleThreePnt(thePnt1, thePnt2, thePnt3)
362 if CurvesOp.IsDone() == 0:
363 print "MakeCircleThreePnt : ", CurvesOp.GetErrorCode()
366 ## Create an ellipse with given center, normal vector and radiuses.
367 # @param thePnt Ellipse center.
368 # @param theVec Vector, normal to the plane of the ellipse.
369 # @param theRMajor Major ellipse radius.
370 # @param theRMinor Minor ellipse radius.
371 # @return New GEOM_Object, containing the created ellipse.
373 # Example: see GEOM_TestAll.py
374 def MakeEllipse(thePnt, theVec, theRMajor, theRMinor):
375 anObj = CurvesOp.MakeEllipse(thePnt, theVec, theRMajor, theRMinor)
376 if CurvesOp.IsDone() == 0:
377 print "MakeEllipse : ", CurvesOp.GetErrorCode()
380 ## Create a polyline on the set of points.
381 # @param thePoints Sequence of points for the polyline.
382 # @return New GEOM_Object, containing the created polyline.
384 # Example: see GEOM_TestAll.py
385 def MakePolyline(thePoints):
386 anObj = CurvesOp.MakePolyline(thePoints)
387 if CurvesOp.IsDone() == 0:
388 print "MakePolyline : ", CurvesOp.GetErrorCode()
391 ## Create bezier curve on the set of points.
392 # @param thePoints Sequence of points for the bezier curve.
393 # @return New GEOM_Object, containing the created bezier curve.
395 # Example: see GEOM_TestAll.py
396 def MakeBezier(thePoints):
397 anObj = CurvesOp.MakeSplineBezier(thePoints)
398 if CurvesOp.IsDone() == 0:
399 print "MakeSplineBezier : ", CurvesOp.GetErrorCode()
402 ## Create B-Spline curve on the set of points.
403 # @param thePoints Sequence of points for the B-Spline curve.
404 # @return New GEOM_Object, containing the created B-Spline curve.
406 # Example: see GEOM_TestAll.py
407 def MakeInterpol(thePoints):
408 anObj = CurvesOp.MakeSplineInterpolation(thePoints)
409 if CurvesOp.IsDone() == 0:
410 print "MakeSplineInterpolation : ", CurvesOp.GetErrorCode()
413 ## Create a sketcher (wire or face), following the textual description,
414 # passed through \a theCommand argument. \n
415 # Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
416 # Format of the description string have to be the following:
418 # "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
421 # - x1, y1 are coordinates of the first sketcher point (zero by default),
423 # - "R angle" : Set the direction by angle
424 # - "D dx dy" : Set the direction by DX & DY
427 # - "TT x y" : Create segment by point at X & Y
428 # - "T dx dy" : Create segment by point with DX & DY
429 # - "L length" : Create segment by direction & Length
430 # - "IX x" : Create segment by direction & Intersect. X
431 # - "IY y" : Create segment by direction & Intersect. Y
434 # - "C radius length" : Create arc by direction, radius and length(in degree)
437 # - "WW" : Close Wire (to finish)
438 # - "WF" : Close Wire and build face (to finish)
440 # @param theCommand String, defining the sketcher in local
441 # coordinates of the working plane.
442 # @param theWorkingPlane Nine double values, defining origin,
443 # OZ and OX directions of the working plane.
444 # @return New GEOM_Object, containing the created wire.
446 # Example: see GEOM_TestAll.py
447 def MakeSketcher(theCommand, theWorkingPlane = [0,0,0, 0,0,1, 1,0,0]):
448 anObj = CurvesOp.MakeSketcher(theCommand, theWorkingPlane)
449 if CurvesOp.IsDone() == 0:
450 print "MakeSketcher : ", CurvesOp.GetErrorCode()
453 ## Create a sketcher (wire or face), following the textual description,
454 # passed through \a theCommand argument. \n
455 # For format of the description string see the previous method.\n
456 # @param theCommand String, defining the sketcher in local
457 # coordinates of the working plane.
458 # @param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
459 # @return New GEOM_Object, containing the created wire.
460 def MakeSketcherOnPlane(theCommand, theWorkingPlane):
461 anObj = CurvesOp.MakeSketcherOnPlane(theCommand, theWorkingPlane)
462 if CurvesOp.IsDone() == 0:
463 print "MakeSketcher : ", CurvesOp.GetErrorCode()
466 # -----------------------------------------------------------------------------
467 # Create 3D Primitives
468 # -----------------------------------------------------------------------------
470 ## Create a box by coordinates of two opposite vertices.
472 # Example: see GEOM_TestAll.py
473 def MakeBox(x1,y1,z1,x2,y2,z2):
474 pnt1 = MakeVertex(x1,y1,z1)
475 pnt2 = MakeVertex(x2,y2,z2)
476 return MakeBoxTwoPnt(pnt1,pnt2)
478 ## Create a box with specified dimensions along the coordinate axes
479 # and with edges, parallel to the coordinate axes.
480 # Center of the box will be at point (DX/2, DY/2, DZ/2).
481 # @param theDX Length of Box edges, parallel to OX axis.
482 # @param theDY Length of Box edges, parallel to OY axis.
483 # @param theDZ Length of Box edges, parallel to OZ axis.
484 # @return New GEOM_Object, containing the created box.
486 # Example: see GEOM_TestAll.py
487 def MakeBoxDXDYDZ(theDX, theDY, theDZ):
488 anObj = PrimOp.MakeBoxDXDYDZ(theDX, theDY, theDZ)
489 if PrimOp.IsDone() == 0:
490 print "MakeBoxDXDYDZ : ", PrimOp.GetErrorCode()
493 ## Create a box with two specified opposite vertices,
494 # and with edges, parallel to the coordinate axes
495 # @param thePnt1 First of two opposite vertices.
496 # @param thePnt2 Second of two opposite vertices.
497 # @return New GEOM_Object, containing the created box.
499 # Example: see GEOM_TestAll.py
500 def MakeBoxTwoPnt(thePnt1, thePnt2):
501 anObj = PrimOp.MakeBoxTwoPnt(thePnt1, thePnt2)
502 if PrimOp.IsDone() == 0:
503 print "MakeBoxTwoPnt : ", PrimOp.GetErrorCode()
506 ## Create a cylinder with given base point, axis, radius and height.
507 # @param thePnt Central point of cylinder base.
508 # @param theAxis Cylinder axis.
509 # @param theR Cylinder radius.
510 # @param theH Cylinder height.
511 # @return New GEOM_Object, containing the created cylinder.
513 # Example: see GEOM_TestAll.py
514 def MakeCylinder(thePnt, theAxis, theR, theH):
515 anObj = PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
516 if PrimOp.IsDone() == 0:
517 print "MakeCylinderPntVecRH : ", PrimOp.GetErrorCode()
520 ## Create a cylinder with given radius and height at
521 # the origin of coordinate system. Axis of the cylinder
522 # will be collinear to the OZ axis of the coordinate system.
523 # @param theR Cylinder radius.
524 # @param theH Cylinder height.
525 # @return New GEOM_Object, containing the created cylinder.
527 # Example: see GEOM_TestAll.py
528 def MakeCylinderRH(theR, theH):
529 anObj = PrimOp.MakeCylinderRH(theR, theH)
530 if PrimOp.IsDone() == 0:
531 print "MakeCylinderRH : ", PrimOp.GetErrorCode()
534 ## Create a sphere with given center and radius.
535 # @param thePnt Sphere center.
536 # @param theR Sphere radius.
537 # @return New GEOM_Object, containing the created sphere.
539 # Example: see GEOM_TestAll.py
540 def MakeSpherePntR(thePnt, theR):
541 anObj = PrimOp.MakeSpherePntR(thePnt, theR)
542 if PrimOp.IsDone() == 0:
543 print "MakeSpherePntR : ", PrimOp.GetErrorCode()
546 ## Create a sphere with given center and radius.
547 # @param x,y,z Coordinates of sphere center.
548 # @param theR Sphere radius.
549 # @return New GEOM_Object, containing the created sphere.
551 # Example: see GEOM_TestAll.py
552 def MakeSphere(x, y, z, theR):
553 point = MakeVertex(x, y, z)
554 anObj = MakeSpherePntR(point, theR)
557 ## Create a sphere with given radius at the origin of coordinate system.
558 # @param theR Sphere radius.
559 # @return New GEOM_Object, containing the created sphere.
561 # Example: see GEOM_TestAll.py
562 def MakeSphereR(theR):
563 anObj = PrimOp.MakeSphereR(theR)
564 if PrimOp.IsDone() == 0:
565 print "MakeSphereR : ", PrimOp.GetErrorCode()
568 ## Create a cone with given base point, axis, height and radiuses.
569 # @param thePnt Central point of the first cone base.
570 # @param theAxis Cone axis.
571 # @param theR1 Radius of the first cone base.
572 # @param theR2 Radius of the second cone base.
573 # \note If both radiuses are non-zero, the cone will be truncated.
574 # \note If the radiuses are equal, a cylinder will be created instead.
575 # @param theH Cone height.
576 # @return New GEOM_Object, containing the created cone.
578 # Example: see GEOM_TestAll.py
579 def MakeCone(thePnt, theAxis, theR1, theR2, theH):
580 anObj = PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
581 if PrimOp.IsDone() == 0:
582 print "MakeConePntVecR1R2H : ", PrimOp.GetErrorCode()
585 ## Create a cone with given height and radiuses at
586 # the origin of coordinate system. Axis of the cone will
587 # be collinear to the OZ axis of the coordinate system.
588 # @param theR1 Radius of the first cone base.
589 # @param theR2 Radius of the second cone base.
590 # \note If both radiuses are non-zero, the cone will be truncated.
591 # \note If the radiuses are equal, a cylinder will be created instead.
592 # @param theH Cone height.
593 # @return New GEOM_Object, containing the created cone.
595 # Example: see GEOM_TestAll.py
596 def MakeConeR1R2H(theR1, theR2, theH):
597 anObj = PrimOp.MakeConeR1R2H(theR1, theR2, theH)
598 if PrimOp.IsDone() == 0:
599 print "MakeConeR1R2H : ", PrimOp.GetErrorCode()
602 ## Create a torus with given center, normal vector and radiuses.
603 # @param thePnt Torus central point.
604 # @param theVec Torus axis of symmetry.
605 # @param theRMajor Torus major radius.
606 # @param theRMinor Torus minor radius.
607 # @return New GEOM_Object, containing the created torus.
609 # Example: see GEOM_TestAll.py
610 def MakeTorus(thePnt, theVec, theRMajor, theRMinor):
611 anObj = PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
612 if PrimOp.IsDone() == 0:
613 print "MakeTorusPntVecRR : ", PrimOp.GetErrorCode()
616 ## Create a torus with given radiuses at the origin of coordinate system.
617 # @param theRMajor Torus major radius.
618 # @param theRMinor Torus minor radius.
619 # @return New GEOM_Object, containing the created torus.
621 # Example: see GEOM_TestAll.py
622 def MakeTorusRR(theRMajor, theRMinor):
623 anObj = PrimOp.MakeTorusRR(theRMajor, theRMinor)
624 if PrimOp.IsDone() == 0:
625 print "MakeTorusRR : ", PrimOp.GetErrorCode()
628 ## Create a shape by extrusion of the base shape along a vector, defined by two points.
629 # @param theBase Base shape to be extruded.
630 # @param thePoint1 First end of extrusion vector.
631 # @param thePoint2 Second end of extrusion vector.
632 # @return New GEOM_Object, containing the created prism.
634 # Example: see GEOM_TestAll.py
635 def MakePrism(theBase, thePoint1, thePoint2):
636 anObj = PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
637 if PrimOp.IsDone() == 0:
638 print "MakePrismTwoPnt : ", PrimOp.GetErrorCode()
641 ## Create a shape by extrusion of the base shape along the vector,
642 # i.e. all the space, transfixed by the base shape during its translation
643 # along the vector on the given distance.
644 # @param theBase Base shape to be extruded.
645 # @param theVec Direction of extrusion.
646 # @param theH Prism dimension along theVec.
647 # @return New GEOM_Object, containing the created prism.
649 # Example: see GEOM_TestAll.py
650 def MakePrismVecH(theBase, theVec, theH):
651 anObj = PrimOp.MakePrismVecH(theBase, theVec, theH)
652 if PrimOp.IsDone() == 0:
653 print "MakePrismVecH : ", PrimOp.GetErrorCode()
656 ## Create a shape by extrusion of the base shape along
657 # the path shape. The path shape can be a wire or an edge.
658 # @param theBase Base shape to be extruded.
659 # @param thePath Path shape to extrude the base shape along it.
660 # @return New GEOM_Object, containing the created pipe.
662 # Example: see GEOM_TestAll.py
663 def MakePipe(theBase, thePath):
664 anObj = PrimOp.MakePipe(theBase, thePath)
665 if PrimOp.IsDone() == 0:
666 print "MakePipe : ", PrimOp.GetErrorCode()
669 ## Create a shape by revolution of the base shape around the axis
670 # on the given angle, i.e. all the space, transfixed by the base
671 # shape during its rotation around the axis on the given angle.
672 # @param theBase Base shape to be rotated.
673 # @param theAxis Rotation axis.
674 # @param theAngle Rotation angle in radians.
675 # @return New GEOM_Object, containing the created revolution.
677 # Example: see GEOM_TestAll.py
678 def MakeRevolution(theBase, theAxis, theAngle):
679 anObj = PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
680 if PrimOp.IsDone() == 0:
681 print "MakeRevolutionAxisAngle : ", PrimOp.GetErrorCode()
684 ## Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
685 # @param theSeqSections - set of specified sections.
686 # @param theModeSolid - mode defining building solid or shell
687 # @param thePreci - precision 3D used for smoothing by default 1.e-6
688 # @param theRuled - mode defining type of the result surfaces (ruled or smoothed).
689 # @return New GEOM_Object, containing the created shell or solid.
691 # Example: see GEOM_TestAll.py
692 def MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled):
693 anObj = PrimOp.MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled)
694 if PrimOp.IsDone() == 0:
695 print "MakeThruSections : ", PrimOp.GetErrorCode()
698 ## Create a shape by extrusion of the profile shape along
699 # the path shape. The path shape can be a wire or an edge.
700 # the several profiles can be specified in the several locations of path.
701 # @param theSeqBases - list of Bases shape to be extruded.
702 # @param theLocations - list of locations on the path corresponding
703 # specified list of the Bases shapes. Number of locations
704 # should be equal to number of bases or list of locations can be empty.
705 # @param thePath - Path shape to extrude the base shape along it.
706 # @param theWithContact - the mode defining that the section is translated to be in
707 # contact with the spine.
708 # @param - WithCorrection - defining that the section is rotated to be
709 # orthogonal to the spine tangent in the correspondent point
710 # @return New GEOM_Object, containing the created pipe.
712 # Example: see GEOM_TestAll.py
713 def MakePipeWithDifferentSections(theSeqBases, theLocations,thePath,theWithContact,theWithCorrection):
714 anObj = PrimOp.MakePipeWithDifferentSections(theSeqBases, theLocations,thePath,theWithContact,theWithCorrection)
715 if PrimOp.IsDone() == 0:
716 print "MakePipeWithDifferentSections : ", PrimOp.GetErrorCode()
719 # -----------------------------------------------------------------------------
721 # -----------------------------------------------------------------------------
723 ## Create a linear edge with specified ends.
724 # @param thePnt1 Point for the first end of edge.
725 # @param thePnt2 Point for the second end of edge.
726 # @return New GEOM_Object, containing the created edge.
728 # Example: see GEOM_TestAll.py
729 def MakeEdge(thePnt1, thePnt2):
730 anObj = ShapesOp.MakeEdge(thePnt1, thePnt2)
731 if ShapesOp.IsDone() == 0:
732 print "MakeEdge : ", ShapesOp.GetErrorCode()
735 ## Create a wire from the set of edges and wires.
736 # @param theEdgesAndWires List of edges and/or wires.
737 # @return New GEOM_Object, containing the created wire.
739 # Example: see GEOM_TestAll.py
740 def MakeWire(theEdgesAndWires):
741 anObj = ShapesOp.MakeWire(theEdgesAndWires)
742 if ShapesOp.IsDone() == 0:
743 print "MakeWire : ", ShapesOp.GetErrorCode()
746 ## Create a face on the given wire.
747 # @param theWire closed Wire or Edge to build the face on.
748 # @param isPlanarWanted If TRUE, only planar face will be built.
749 # If impossible, NULL object will be returned.
750 # @return New GEOM_Object, containing the created face.
752 # Example: see GEOM_TestAll.py
753 def MakeFace(theWire, isPlanarWanted):
754 anObj = ShapesOp.MakeFace(theWire, isPlanarWanted)
755 if ShapesOp.IsDone() == 0:
756 print "MakeFace : ", ShapesOp.GetErrorCode()
759 ## Create a face on the given wires set.
760 # @param theWires List of closed wires or edges to build the face on.
761 # @param isPlanarWanted If TRUE, only planar face will be built.
762 # If impossible, NULL object will be returned.
763 # @return New GEOM_Object, containing the created face.
765 # Example: see GEOM_TestAll.py
766 def MakeFaceWires(theWires, isPlanarWanted):
767 anObj = ShapesOp.MakeFaceWires(theWires, isPlanarWanted)
768 if ShapesOp.IsDone() == 0:
769 print "MakeFaceWires : ", ShapesOp.GetErrorCode()
772 ## Shortcut to MakeFaceWires()
774 # Example: see GEOM_TestOthers.py
775 def MakeFaces(theWires, isPlanarWanted):
776 anObj = MakeFaceWires(theWires, isPlanarWanted)
779 ## Create a shell from the set of faces and shells.
780 # @param theFacesAndShells List of faces and/or shells.
781 # @return New GEOM_Object, containing the created shell.
783 # Example: see GEOM_TestAll.py
784 def MakeShell(theFacesAndShells):
785 anObj = ShapesOp.MakeShell(theFacesAndShells)
786 if ShapesOp.IsDone() == 0:
787 print "MakeShell : ", ShapesOp.GetErrorCode()
790 ## Create a solid, bounded by the given shells.
791 # @param theShells Sequence of bounding shells.
792 # @return New GEOM_Object, containing the created solid.
794 # Example: see GEOM_TestAll.py
795 def MakeSolid(theShells):
796 anObj = ShapesOp.MakeSolidShells(theShells)
797 if ShapesOp.IsDone() == 0:
798 print "MakeSolid : ", ShapesOp.GetErrorCode()
801 ## Create a compound of the given shapes.
802 # @param theShapes List of shapes to put in compound.
803 # @return New GEOM_Object, containing the created compound.
805 # Example: see GEOM_TestAll.py
806 def MakeCompound(theShapes):
807 anObj = ShapesOp.MakeCompound(theShapes)
808 if ShapesOp.IsDone() == 0:
809 print "MakeCompound : ", ShapesOp.GetErrorCode()
812 ## Gives quantity of faces in the given shape.
813 # @param theShape Shape to count faces of.
814 # @return Quantity of faces.
816 # Example: see GEOM_TestOthers.py
817 def NumberOfFaces(theShape):
818 nb_faces = ShapesOp.NumberOfFaces(theShape)
819 if ShapesOp.IsDone() == 0:
820 print "NumberOfFaces : ", ShapesOp.GetErrorCode()
823 ## Gives quantity of edges in the given shape.
824 # @param theShape Shape to count edges of.
825 # @return Quantity of edges.
827 # Example: see GEOM_TestOthers.py
828 def NumberOfEdges(theShape):
829 nb_edges = ShapesOp.NumberOfEdges(theShape)
830 if ShapesOp.IsDone() == 0:
831 print "NumberOfEdges : ", ShapesOp.GetErrorCode()
834 ## Reverses an orientation the given shape.
835 # @param theShape Shape to be reversed.
836 # @return The reversed copy of theShape.
838 # Example: see GEOM_TestAll.py
839 def ChangeOrientation(theShape):
840 anObj = ShapesOp.ChangeOrientation(theShape)
841 if ShapesOp.IsDone() == 0:
842 print "ChangeOrientation : ", ShapesOp.GetErrorCode()
845 ## Shortcut to ChangeOrientation()
847 # Example: see GEOM_TestOthers.py
848 def OrientationChange(theShape):
849 anObj = ChangeOrientation(theShape)
852 ## Retrieve all free faces from the given shape.
853 # Free face is a face, which is not shared between two shells of the shape.
854 # @param theShape Shape to find free faces in.
855 # @return List of IDs of all free faces, contained in theShape.
857 # Example: see GEOM_TestOthers.py
858 def GetFreeFacesIDs(theShape):
859 anIDs = ShapesOp.GetFreeFacesIDs(theShape)
860 if ShapesOp.IsDone() == 0:
861 print "GetFreeFacesIDs : ", ShapesOp.GetErrorCode()
864 ## Get all sub-shapes of theShape1 of the given type, shared with theShape2.
865 # @param theShape1 Shape to find sub-shapes in.
866 # @param theShape2 Shape to find shared sub-shapes with.
867 # @param theShapeType Type of sub-shapes to be retrieved.
868 # @return List of sub-shapes of theShape1, shared with theShape2.
870 # Example: see GEOM_TestOthers.py
871 def GetSharedShapes(theShape1, theShape2, theShapeType):
872 aList = ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
873 if ShapesOp.IsDone() == 0:
874 print "GetSharedShapes : ", ShapesOp.GetErrorCode()
877 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
878 # the specified plane by the certain way, defined through \a theState parameter.
879 # @param theShape Shape to find sub-shapes of.
880 # @param theShapeType Type of sub-shapes to be retrieved.
881 # @param theAx1 Vector (or line, or linear edge), specifying normal
882 # direction and location of the plane to find shapes on.
883 # @param theState The state of the subshapes to find. It can be one of
884 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
885 # @return List of all found sub-shapes.
887 # Example: see GEOM_TestOthers.py
888 def GetShapesOnPlane(theShape, theShapeType, theAx1, theState):
889 aList = ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
890 if ShapesOp.IsDone() == 0:
891 print "GetShapesOnPlane : ", ShapesOp.GetErrorCode()
894 ## Works like the above method, but returns list of sub-shapes indices
896 # Example: see GEOM_TestOthers.py
897 def GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState):
898 aList = ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
899 if ShapesOp.IsDone() == 0:
900 print "GetShapesOnPlaneIDs : ", ShapesOp.GetErrorCode()
903 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
904 # the specified plane by the certain way, defined through \a theState parameter.
905 # @param theShape Shape to find sub-shapes of.
906 # @param theShapeType Type of sub-shapes to be retrieved.
907 # @param theAx1 Vector (or line, or linear edge), specifying normal
908 # direction of the plane to find shapes on.
909 # @param thePnt Point specifying location of the plane to find shapes on.
910 # @param theState The state of the subshapes to find. It can be one of
911 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
912 # @return List of all found sub-shapes.
914 # Example: see GEOM_TestOthers.py
915 def GetShapesOnPlaneWithLocation(theShape, theShapeType, theAx1, thePnt, theState):
916 aList = ShapesOp.GetShapesOnPlaneWithLocation(theShape, theShapeType, theAx1, thePnt, theState)
917 if ShapesOp.IsDone() == 0:
918 print "GetShapesOnPlaneWithLocation : ", ShapesOp.GetErrorCode()
921 ## Works like the above method, but returns list of sub-shapes indices
923 # Example: see GEOM_TestOthers.py
924 def GetShapesOnPlaneWithLocationIDs(theShape, theShapeType, theAx1, thePnt, theState):
925 aList = ShapesOp.GetShapesOnPlaneWithLocationIDs(theShape, theShapeType, theAx1, thePnt, theState)
926 if ShapesOp.IsDone() == 0:
927 print "GetShapesOnPlaneWithLocationIDs : ", ShapesOp.GetErrorCode()
930 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
931 # the specified cylinder by the certain way, defined through \a theState parameter.
932 # @param theShape Shape to find sub-shapes of.
933 # @param theShapeType Type of sub-shapes to be retrieved.
934 # @param theAxis Vector (or line, or linear edge), specifying
935 # axis of the cylinder to find shapes on.
936 # @param theRadius Radius of the cylinder to find shapes on.
937 # @param theState The state of the subshapes to find. It can be one of
938 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
939 # @return List of all found sub-shapes.
941 # Example: see GEOM_TestOthers.py
942 def GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState):
943 aList = ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
944 if ShapesOp.IsDone() == 0:
945 print "GetShapesOnCylinder : ", ShapesOp.GetErrorCode()
948 ## Works like the above method, but returns list of sub-shapes indices
950 # Example: see GEOM_TestOthers.py
951 def GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState):
952 aList = ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
953 if ShapesOp.IsDone() == 0:
954 print "GetShapesOnCylinderIDs : ", ShapesOp.GetErrorCode()
957 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
958 # the specified sphere by the certain way, defined through \a theState parameter.
959 # @param theShape Shape to find sub-shapes of.
960 # @param theShapeType Type of sub-shapes to be retrieved.
961 # @param theCenter Point, specifying center of the sphere to find shapes on.
962 # @param theRadius Radius of the sphere to find shapes on.
963 # @param theState The state of the subshapes to find. It can be one of
964 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
965 # @return List of all found sub-shapes.
967 # Example: see GEOM_TestOthers.py
968 def GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState):
969 aList = ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
970 if ShapesOp.IsDone() == 0:
971 print "GetShapesOnSphere : ", ShapesOp.GetErrorCode()
974 ## Works like the above method, but returns list of sub-shapes indices
976 # Example: see GEOM_TestOthers.py
977 def GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState):
978 aList = ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
979 if ShapesOp.IsDone() == 0:
980 print "GetShapesOnSphereIDs : ", ShapesOp.GetErrorCode()
983 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
984 # the specified quadrangle by the certain way, defined through \a theState parameter.
985 # @param theShape Shape to find sub-shapes of.
986 # @param theShapeType Type of sub-shapes to be retrieved.
987 # @param theTopLeftPoint Point, specifying top left corner of a quadrangle
988 # @param theTopRigthPoint Point, specifying top right corner of a quadrangle
989 # @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
990 # @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
991 # @param theState The state of the subshapes to find. It can be one of
992 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
993 # @return List of all found sub-shapes.
995 # Example: see GEOM_TestOthers.py
996 def GetShapesOnQuadrangle(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState):
997 aList = ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState)
998 if ShapesOp.IsDone() == 0:
999 print "GetShapesOnQuadrangle : ", ShapesOp.GetErrorCode()
1002 ## Works like the above method, but returns list of sub-shapes indices
1004 # Example: see GEOM_TestOthers.py
1005 def GetShapesOnQuadrangleIDs(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState):
1006 aList = ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType, theTopLeftPoint, theTopRigthPoint, theBottomLeftPoint, theBottomRigthPoint, theState)
1007 if ShapesOp.IsDone() == 0:
1008 print "GetShapesOnQuadrangleIDs : ", ShapesOp.GetErrorCode()
1011 ## Get sub-shape(s) of theShapeWhere, which are
1012 # coincident with \a theShapeWhat or could be a part of it.
1013 # @param theShapeWhere Shape to find sub-shapes of.
1014 # @param theShapeWhat Shape, specifying what to find.
1015 # @return Group of all found sub-shapes or a single found sub-shape.
1017 # Example: see GEOM_TestOthers.py
1018 def GetInPlace(theShapeWhere, theShapeWhat):
1019 anObj = ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
1020 if ShapesOp.IsDone() == 0:
1021 print "GetInPlace : ", ShapesOp.GetErrorCode()
1024 # -----------------------------------------------------------------------------
1025 # Access to sub-shapes by their unique IDs inside the main shape.
1026 # -----------------------------------------------------------------------------
1028 ## Obtain a composite sub-shape of <aShape>, composed from sub-shapes
1029 # of <aShape>, selected by their unique IDs inside <aShape>
1031 # Example: see GEOM_TestAll.py
1032 def GetSubShape(aShape, ListOfID):
1033 anObj = geom.AddSubShape(aShape,ListOfID)
1036 ## Obtain unique ID of sub-shape <aSubShape> inside <aShape>
1038 # Example: see GEOM_TestAll.py
1039 def GetSubShapeID(aShape, aSubShape):
1040 anID = LocalOp.GetSubShapeIndex(aShape, aSubShape)
1041 if LocalOp.IsDone() == 0:
1042 print "GetSubShapeIndex : ", LocalOp.GetErrorCode()
1045 # -----------------------------------------------------------------------------
1047 # -----------------------------------------------------------------------------
1049 ## Explode a shape on subshapes of a given type.
1050 # @param theShape Shape to be exploded.
1051 # @param theShapeType Type of sub-shapes to be retrieved.
1052 # @return List of sub-shapes of type theShapeType, contained in theShape.
1054 # Example: see GEOM_TestAll.py
1055 def SubShapeAll(aShape, aType):
1056 ListObj = ShapesOp.MakeExplode(aShape,aType,0)
1057 if ShapesOp.IsDone() == 0:
1058 print "MakeExplode : ", ShapesOp.GetErrorCode()
1061 ## Explode a shape on subshapes of a given type.
1062 # @param theShape Shape to be exploded.
1063 # @param theShapeType Type of sub-shapes to be retrieved.
1064 # @return List of IDs of sub-shapes.
1065 def SubShapeAllIDs(aShape, aType):
1066 ListObj = ShapesOp.SubShapeAllIDs(aShape,aType,0)
1067 if ShapesOp.IsDone() == 0:
1068 print "SubShapeAllIDs : ", ShapesOp.GetErrorCode()
1071 ## Explode a shape on subshapes of a given type.
1072 # Sub-shapes will be sorted by coordinates of their gravity centers.
1073 # @param theShape Shape to be exploded.
1074 # @param theShapeType Type of sub-shapes to be retrieved.
1075 # @return List of sub-shapes of type theShapeType, contained in theShape.
1077 # Example: see GEOM_TestAll.py
1078 def SubShapeAllSorted(aShape, aType):
1079 ListObj = ShapesOp.MakeExplode(aShape,aType,1)
1080 if ShapesOp.IsDone() == 0:
1081 print "MakeExplode : ", ShapesOp.GetErrorCode()
1084 ## Explode a shape on subshapes of a given type.
1085 # Sub-shapes will be sorted by coordinates of their gravity centers.
1086 # @param theShape Shape to be exploded.
1087 # @param theShapeType Type of sub-shapes to be retrieved.
1088 # @return List of IDs of sub-shapes.
1089 def SubShapeAllSortedIDs(aShape, aType):
1090 ListIDs = ShapesOp.SubShapeAllIDs(aShape,aType,1)
1091 if ShapesOp.IsDone() == 0:
1092 print "SubShapeAllSortedIDs : ", ShapesOp.GetErrorCode()
1095 ## Obtain a compound of sub-shapes of <aShape>,
1096 # selected by they indices in list of all sub-shapes of type <aType>.
1097 # Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1099 # Example: see GEOM_TestAll.py
1100 def SubShape(aShape, aType, ListOfInd):
1102 AllShapeList = SubShapeAll(aShape, aType)
1103 for ind in ListOfInd:
1104 ListOfIDs.append(GetSubShapeID(aShape, AllShapeList[ind - 1]))
1105 anObj = GetSubShape(aShape, ListOfIDs)
1108 ## Obtain a compound of sub-shapes of <aShape>,
1109 # selected by they indices in sorted list of all sub-shapes of type <aType>.
1110 # Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1112 # Example: see GEOM_TestAll.py
1113 def SubShapeSorted(aShape, aType, ListOfInd):
1115 AllShapeList = SubShapeAllSorted(aShape, aType)
1116 for ind in ListOfInd:
1117 ListOfIDs.append(GetSubShapeID(aShape, AllShapeList[ind - 1]))
1118 anObj = GetSubShape(aShape, ListOfIDs)
1121 # -----------------------------------------------------------------------------
1122 # Healing operations
1123 # -----------------------------------------------------------------------------
1125 ## Apply a sequence of Shape Healing operators to the given object.
1126 # @param theShape Shape to be processed.
1127 # @param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1128 # @param theParameters List of names of parameters
1129 # ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1130 # @param theValues List of values of parameters, in the same order
1131 # as parameters are listed in \a theParameters list.
1132 # @return New GEOM_Object, containing processed shape.
1134 # Example: see GEOM_TestHealing.py
1135 def ProcessShape(theShape, theOperators, theParameters, theValues):
1136 anObj = HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
1137 if HealOp.IsDone() == 0:
1138 print "ProcessShape : ", HealOp.GetErrorCode()
1141 ## Remove faces from the given object (shape).
1142 # @param theObject Shape to be processed.
1143 # @param theFaces Indices of faces to be removed, if EMPTY then the method
1144 # removes ALL faces of the given object.
1145 # @return New GEOM_Object, containing processed shape.
1147 # Example: see GEOM_TestHealing.py
1148 def SuppressFaces(theObject, theFaces):
1149 anObj = HealOp.SuppressFaces(theObject, theFaces)
1150 if HealOp.IsDone() == 0:
1151 print "SuppressFaces : ", HealOp.GetErrorCode()
1154 ## Sewing of some shapes into single shape.
1156 # Example: see GEOM_TestHealing.py
1157 def MakeSewing(ListShape, theTolerance):
1158 comp = MakeCompound(ListShape)
1159 anObj = Sew(comp, theTolerance)
1162 ## Sewing of the given object.
1163 # @param theObject Shape to be processed.
1164 # @param theTolerance Required tolerance value.
1165 # @return New GEOM_Object, containing processed shape.
1167 # Example: see MakeSewing() above
1168 def Sew(theObject, theTolerance):
1169 anObj = HealOp.Sew(theObject, theTolerance)
1170 if HealOp.IsDone() == 0:
1171 print "Sew : ", HealOp.GetErrorCode()
1174 ## Remove internal wires and edges from the given object (face).
1175 # @param theObject Shape to be processed.
1176 # @param theWires Indices of wires to be removed, if EMPTY then the method
1177 # removes ALL internal wires of the given object.
1178 # @return New GEOM_Object, containing processed shape.
1180 # Example: see GEOM_TestHealing.py
1181 def SuppressInternalWires(theObject, theWires):
1182 anObj = HealOp.RemoveIntWires(theObject, theWires)
1183 if HealOp.IsDone() == 0:
1184 print "SuppressInternalWires : ", HealOp.GetErrorCode()
1187 ## Remove internal closed contours (holes) from the given object.
1188 # @param theObject Shape to be processed.
1189 # @param theWires Indices of wires to be removed, if EMPTY then the method
1190 # removes ALL internal holes of the given object
1191 # @return New GEOM_Object, containing processed shape.
1193 # Example: see GEOM_TestHealing.py
1194 def SuppressHoles(theObject, theWires):
1195 anObj = HealOp.FillHoles(theObject, theWires)
1196 if HealOp.IsDone() == 0:
1197 print "SuppressHoles : ", HealOp.GetErrorCode()
1200 ## Close an open wire.
1201 # @param theObject Shape to be processed.
1202 # @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1203 # if -1, then theObject itself is a wire.
1204 # @param isCommonVertex If TRUE : closure by creation of a common vertex,
1205 # If FALS : closure by creation of an edge between ends.
1206 # @return New GEOM_Object, containing processed shape.
1208 # Example: see GEOM_TestHealing.py
1209 def CloseContour(theObject, theWires, isCommonVertex):
1210 anObj = HealOp.CloseContour(theObject, theWires, isCommonVertex)
1211 if HealOp.IsDone() == 0:
1212 print "CloseContour : ", HealOp.GetErrorCode()
1215 ## Addition of a point to a given edge object.
1216 # @param theObject Shape to be processed.
1217 # @param theEdgeIndex Index of edge to be divided within theObject's shape,
1218 # if -1, then theObject itself is the edge.
1219 # @param theValue Value of parameter on edge or length parameter,
1220 # depending on \a isByParameter.
1221 # @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
1222 # if FALSE : \a theValue is treated as a length parameter [0..1]
1223 # @return New GEOM_Object, containing processed shape.
1225 # Example: see GEOM_TestHealing.py
1226 def DivideEdge(theObject, theEdgeIndex, theValue, isByParameter):
1227 anObj = HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
1228 if HealOp.IsDone() == 0:
1229 print "DivideEdge : ", HealOp.GetErrorCode()
1232 ## Change orientation of the given object.
1233 # @param theObject Shape to be processed.
1234 # @update given shape
1235 def ChangeOrientationShell(theObject):
1236 theObject = HealOp.ChangeOrientation(theObject)
1237 if HealOp.IsDone() == 0:
1238 print "ChangeOrientation : ", HealOp.GetErrorCode()
1240 ## Change orientation of the given object.
1241 # @param theObject Shape to be processed.
1242 # @return New GEOM_Object, containing processed shape.
1243 def ChangeOrientationShellCopy(theObject):
1244 anObj = HealOp.ChangeOrientationCopy(theObject)
1245 if HealOp.IsDone() == 0:
1246 print "ChangeOrientation : ", HealOp.GetErrorCode()
1249 ## Get a list of wires (wrapped in GEOM_Object-s),
1250 # that constitute a free boundary of the given shape.
1251 # @param theObject Shape to get free boundary of.
1252 # @return [status, theClosedWires, theOpenWires]
1253 # status: FALSE, if an error(s) occured during the method execution.
1254 # theClosedWires: Closed wires on the free boundary of the given shape.
1255 # theOpenWires: Open wires on the free boundary of the given shape.
1257 # Example: see GEOM_TestHealing.py
1258 def GetFreeBoundary(theObject):
1259 anObj = HealOp.GetFreeBoundary(theObject)
1260 if HealOp.IsDone() == 0:
1261 print "GetFreeBoundaries : ", HealOp.GetErrorCode()
1264 # -----------------------------------------------------------------------------
1265 # Create advanced objects
1266 # -----------------------------------------------------------------------------
1268 ## Create a copy of the given object
1270 # Example: see GEOM_TestAll.py
1271 def MakeCopy(theOriginal):
1272 anObj = InsertOp.MakeCopy(theOriginal)
1273 if InsertOp.IsDone() == 0:
1274 print "MakeCopy : ", InsertOp.GetErrorCode()
1277 ## Create a filling from the given compound of contours.
1278 # @param theShape the compound of contours
1279 # @param theMinDeg a minimal degree
1280 # @param theMaxDeg a maximal degree
1281 # @param theTol2D a 2d tolerance
1282 # @param theTol3D a 3d tolerance
1283 # @param theNbIter a number of iteration
1284 # @return New GEOM_Object, containing the created filling surface.
1286 # Example: see GEOM_TestAll.py
1287 def MakeFilling(theShape, theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter):
1288 anObj = PrimOp.MakeFilling(theShape, theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter)
1289 if PrimOp.IsDone() == 0:
1290 print "MakeFilling : ", PrimOp.GetErrorCode()
1293 ## Replace coincident faces in theShape by one face.
1294 # @param theShape Initial shape.
1295 # @param theTolerance Maximum distance between faces, which can be considered as coincident.
1296 # @return New GEOM_Object, containing a copy of theShape without coincident faces.
1298 # Example: see GEOM_Spanner.py
1299 def MakeGlueFaces(theShape, theTolerance):
1300 anObj = ShapesOp.MakeGlueFaces(theShape, theTolerance)
1301 if ShapesOp.IsDone() == 0:
1302 print "MakeGlueFaces : ", ShapesOp.GetErrorCode()
1305 # -----------------------------------------------------------------------------
1306 # Boolean (Common, Cut, Fuse, Section)
1307 # -----------------------------------------------------------------------------
1309 ## Perform one of boolean operations on two given shapes.
1310 # @param theShape1 First argument for boolean operation.
1311 # @param theShape2 Second argument for boolean operation.
1312 # @param theOperation Indicates the operation to be done:
1313 # 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1314 # @return New GEOM_Object, containing the result shape.
1316 # Example: see GEOM_TestAll.py
1317 def MakeBoolean(theShape1, theShape2, theOperation):
1318 anObj = BoolOp.MakeBoolean(theShape1, theShape2, theOperation)
1319 if BoolOp.IsDone() == 0:
1320 print "MakeBoolean : ", BoolOp.GetErrorCode()
1323 ## Shortcut to MakeBoolean(s1, s2, 1)
1325 # Example: see GEOM_TestOthers.py
1326 def MakeCommon(s1, s2):
1327 return MakeBoolean(s1, s2, 1)
1329 ## Shortcut to MakeBoolean(s1, s2, 2)
1331 # Example: see GEOM_TestOthers.py
1332 def MakeCut(s1, s2):
1333 return MakeBoolean(s1, s2, 2)
1335 ## Shortcut to MakeBoolean(s1, s2, 3)
1337 # Example: see GEOM_TestOthers.py
1338 def MakeFuse(s1, s2):
1339 return MakeBoolean(s1, s2, 3)
1341 ## Shortcut to MakeBoolean(s1, s2, 4)
1343 # Example: see GEOM_TestOthers.py
1344 def MakeSection(s1, s2):
1345 return MakeBoolean(s1, s2, 4)
1347 ## Perform partition operation.
1348 # @param ListShapes Shapes to be intersected.
1349 # @param ListTools Shapes to intersect theShapes.
1350 # !!!NOTE: shapes from this lists (for each separately) can not have
1351 # intersections with each other.
1353 # After implementation new version of PartitionAlgo (October 2006)
1354 # other parameters are ignored by current functionality. They are kept
1355 # in this function only for support old versions.
1356 # Ignored parameters:
1357 # @param ListKeepInside Shapes, outside which the results will be deleted.
1358 # Each shape from theKeepInside must belong to theShapes also.
1359 # @param ListRemoveInside Shapes, inside which the results will be deleted.
1360 # Each shape from theRemoveInside must belong to theShapes also.
1361 # @param Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1362 # @param RemoveWebs If TRUE, perform Glue 3D algorithm.
1363 # @param ListMaterials Material indices for each shape. Make sence,
1364 # only if theRemoveWebs is TRUE.
1366 # @return New GEOM_Object, containing the result shapes.
1368 # Example: see GEOM_TestAll.py
1369 def MakePartition(ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1370 Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[]):
1371 anObj = BoolOp.MakePartition(ListShapes, ListTools,
1372 ListKeepInside, ListRemoveInside,
1373 Limit, RemoveWebs, ListMaterials);
1374 if BoolOp.IsDone() == 0:
1375 print "MakePartition : ", BoolOp.GetErrorCode()
1378 ## Shortcut to MakePartition()
1380 # Example: see GEOM_TestOthers.py
1381 def Partition(ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1382 Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[]):
1383 anObj = MakePartition(ListShapes, ListTools,
1384 ListKeepInside, ListRemoveInside,
1385 Limit, RemoveWebs, ListMaterials);
1388 ## Perform partition of the Shape with the Plane
1389 # @param theShape Shape to be intersected.
1390 # @param thePlane Tool shape, to intersect theShape.
1391 # @return New GEOM_Object, containing the result shape.
1393 # Example: see GEOM_TestAll.py
1394 def MakeHalfPartition(theShape, thePlane):
1395 anObj = BoolOp.MakeHalfPartition(theShape, thePlane)
1396 if BoolOp.IsDone() == 0:
1397 print "MakeHalfPartition : ", BoolOp.GetErrorCode()
1400 # -----------------------------------------------------------------------------
1402 # -----------------------------------------------------------------------------
1404 ## Translate the given object along the vector, specified
1405 # by its end points, creating its copy before the translation.
1406 # @param theObject The object to be translated.
1407 # @param thePoint1 Start point of translation vector.
1408 # @param thePoint2 End point of translation vector.
1409 # @return New GEOM_Object, containing the translated object.
1411 # Example: see GEOM_TestAll.py
1412 def MakeTranslationTwoPoints(theObject, thePoint1, thePoint2):
1413 anObj = TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
1414 if TrsfOp.IsDone() == 0:
1415 print "TranslateTwoPointsCopy : ", TrsfOp.GetErrorCode()
1418 ## Translate the given object along the vector, specified
1419 # by its components, creating its copy before the translation.
1420 # @param theObject The object to be translated.
1421 # @param theDX,theDY,theDZ Components of translation vector.
1422 # @return New GEOM_Object, containing the translated object.
1424 # Example: see GEOM_TestAll.py
1425 def MakeTranslation(theObject, theDX, theDY, theDZ):
1426 anObj = TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
1427 if TrsfOp.IsDone() == 0:
1428 print "TranslateDXDYDZCopy : ", TrsfOp.GetErrorCode()
1431 ## Translate the given object along the given vector,
1432 # creating its copy before the translation.
1433 # @param theObject The object to be translated.
1434 # @param theVector The translation vector.
1435 # @return New GEOM_Object, containing the translated object.
1437 # Example: see GEOM_TestAll.py
1438 def MakeTranslationVector(theObject, theVector):
1439 anObj = TrsfOp.TranslateVectorCopy(theObject, theVector)
1440 if TrsfOp.IsDone() == 0:
1441 print "TranslateVectorCopy : ", TrsfOp.GetErrorCode()
1444 ## Rotate the given object around the given axis
1445 # on the given angle, creating its copy before the rotatation.
1446 # @param theObject The object to be rotated.
1447 # @param theAxis Rotation axis.
1448 # @param theAngle Rotation angle in radians.
1449 # @return New GEOM_Object, containing the rotated object.
1451 # Example: see GEOM_TestAll.py
1452 def MakeRotation(theObject, theAxis, theAngle):
1453 anObj = TrsfOp.RotateCopy(theObject, theAxis, theAngle)
1454 if TrsfOp.IsDone() == 0:
1455 print "RotateCopy : ", TrsfOp.GetErrorCode()
1458 ## Rotate given object around vector perpendicular to plane
1459 # containing three points, creating its copy before the rotatation.
1460 # @param theObject The object to be rotated.
1461 # @param theCentPoint central point - the axis is the vector perpendicular to the plane
1462 # containing the three points.
1463 # @param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
1464 # @return New GEOM_Object, containing the rotated object.
1466 # Example: see GEOM_TestAll.py
1467 def MakeRotationThreePoints(theObject, theCentPoint, thePoint1, thePoint2):
1468 anObj = TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
1469 if TrsfOp.IsDone() == 0:
1470 print "RotateThreePointsCopy : ", TrsfOp.GetErrorCode()
1473 ## Scale the given object by the factor, creating its copy before the scaling.
1474 # @param theObject The object to be scaled.
1475 # @param thePoint Center point for scaling.
1476 # @param theFactor Scaling factor value.
1477 # @return New GEOM_Object, containing the scaled shape.
1479 # Example: see GEOM_TestAll.py
1480 def MakeScaleTransform(theObject, thePoint, theFactor):
1481 anObj = TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
1482 if TrsfOp.IsDone() == 0:
1483 print "ScaleShapeCopy : ", TrsfOp.GetErrorCode()
1486 ## Create an object, symmetrical
1487 # to the given one relatively the given plane.
1488 # @param theObject The object to be mirrored.
1489 # @param thePlane Plane of symmetry.
1490 # @return New GEOM_Object, containing the mirrored shape.
1492 # Example: see GEOM_TestAll.py
1493 def MakeMirrorByPlane(theObject, thePlane):
1494 anObj = TrsfOp.MirrorPlaneCopy(theObject, thePlane)
1495 if TrsfOp.IsDone() == 0:
1496 print "MirrorPlaneCopy : ", TrsfOp.GetErrorCode()
1499 ## Create an object, symmetrical
1500 # to the given one relatively the given axis.
1501 # @param theObject The object to be mirrored.
1502 # @param theAxis Axis of symmetry.
1503 # @return New GEOM_Object, containing the mirrored shape.
1505 # Example: see GEOM_TestAll.py
1506 def MakeMirrorByAxis(theObject, theAxis):
1507 anObj = TrsfOp.MirrorAxisCopy(theObject, theAxis)
1508 if TrsfOp.IsDone() == 0:
1509 print "MirrorAxisCopy : ", TrsfOp.GetErrorCode()
1512 ## Create an object, symmetrical
1513 # to the given one relatively the given point.
1514 # @param theObject The object to be mirrored.
1515 # @param thePoint Point of symmetry.
1516 # @return New GEOM_Object, containing the mirrored shape.
1518 # Example: see GEOM_TestAll.py
1519 def MakeMirrorByPoint(theObject, thePoint):
1520 anObj = TrsfOp.MirrorPointCopy(theObject, thePoint)
1521 if TrsfOp.IsDone() == 0:
1522 print "MirrorPointCopy : ", TrsfOp.GetErrorCode()
1525 ## Modify the Location of the given object by LCS,
1526 # creating its copy before the setting.
1527 # @param theObject The object to be displaced.
1528 # @param theStartLCS Coordinate system to perform displacement from it.
1529 # If \a theStartLCS is NULL, displacement
1530 # will be performed from global CS.
1531 # If \a theObject itself is used as \a theStartLCS,
1532 # its location will be changed to \a theEndLCS.
1533 # @param theEndLCS Coordinate system to perform displacement to it.
1534 # @return New GEOM_Object, containing the displaced shape.
1536 # Example: see GEOM_TestAll.py
1537 def MakePosition(theObject, theStartLCS, theEndLCS):
1538 anObj = TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
1539 if TrsfOp.IsDone() == 0:
1540 print "PositionShapeCopy : ", TrsfOp.GetErrorCode()
1543 ## Create new object as offset of the given one.
1544 # @param theObject The base object for the offset.
1545 # @param theOffset Offset value.
1546 # @return New GEOM_Object, containing the offset object.
1548 # Example: see GEOM_TestAll.py
1549 def MakeOffset(theObject, theOffset):
1550 anObj = TrsfOp.OffsetShapeCopy(theObject, theOffset)
1551 if TrsfOp.IsDone() == 0:
1552 print "OffsetShapeCopy : ", TrsfOp.GetErrorCode()
1555 # -----------------------------------------------------------------------------
1557 # -----------------------------------------------------------------------------
1559 ## Translate the given object along the given vector a given number times
1560 # @param theObject The object to be translated.
1561 # @param theVector Direction of the translation.
1562 # @param theStep Distance to translate on.
1563 # @param theNbTimes Quantity of translations to be done.
1564 # @return New GEOM_Object, containing compound of all
1565 # the shapes, obtained after each translation.
1567 # Example: see GEOM_TestAll.py
1568 def MakeMultiTranslation1D(theObject, theVector, theStep, theNbTimes):
1569 anObj = TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
1570 if TrsfOp.IsDone() == 0:
1571 print "MultiTranslate1D : ", TrsfOp.GetErrorCode()
1574 ## Conseqently apply two specified translations to theObject specified number of times.
1575 # @param theObject The object to be translated.
1576 # @param theVector1 Direction of the first translation.
1577 # @param theStep1 Step of the first translation.
1578 # @param theNbTimes1 Quantity of translations to be done along theVector1.
1579 # @param theVector2 Direction of the second translation.
1580 # @param theStep2 Step of the second translation.
1581 # @param theNbTimes2 Quantity of translations to be done along theVector2.
1582 # @return New GEOM_Object, containing compound of all
1583 # the shapes, obtained after each translation.
1585 # Example: see GEOM_TestAll.py
1586 def MakeMultiTranslation2D(theObject, theVector1, theStep1, theNbTimes1,
1587 theVector2, theStep2, theNbTimes2):
1588 anObj = TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
1589 theVector2, theStep2, theNbTimes2)
1590 if TrsfOp.IsDone() == 0:
1591 print "MultiTranslate2D : ", TrsfOp.GetErrorCode()
1594 ## Rotate the given object around the given axis a given number times.
1595 # Rotation angle will be 2*PI/theNbTimes.
1596 # @param theObject The object to be rotated.
1597 # @param theAxis The rotation axis.
1598 # @param theNbTimes Quantity of rotations to be done.
1599 # @return New GEOM_Object, containing compound of all the
1600 # shapes, obtained after each rotation.
1602 # Example: see GEOM_TestAll.py
1603 def MultiRotate1D(theObject, theAxis, theNbTimes):
1604 anObj = TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
1605 if TrsfOp.IsDone() == 0:
1606 print "MultiRotate1D : ", TrsfOp.GetErrorCode()
1609 ## Rotate the given object around the
1610 # given axis on the given angle a given number
1611 # times and multi-translate each rotation result.
1612 # Translation direction passes through center of gravity
1613 # of rotated shape and its projection on the rotation axis.
1614 # @param theObject The object to be rotated.
1615 # @param theAxis Rotation axis.
1616 # @param theAngle Rotation angle in graduces.
1617 # @param theNbTimes1 Quantity of rotations to be done.
1618 # @param theStep Translation distance.
1619 # @param theNbTimes2 Quantity of translations to be done.
1620 # @return New GEOM_Object, containing compound of all the
1621 # shapes, obtained after each transformation.
1623 # Example: see GEOM_TestAll.py
1624 def MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2):
1625 anObj = TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
1626 if TrsfOp.IsDone() == 0:
1627 print "MultiRotate2D : ", TrsfOp.GetErrorCode()
1630 ## The same, as MultiRotate1D(), but axis is given by direction and point
1632 # Example: see GEOM_TestOthers.py
1633 def MakeMultiRotation1D(aShape,aDir,aPoint,aNbTimes):
1634 aVec = MakeLine(aPoint,aDir)
1635 anObj = MultiRotate1D(aShape,aVec,aNbTimes)
1638 ## The same, as MultiRotate2D(), but axis is given by direction and point
1640 # Example: see GEOM_TestOthers.py
1641 def MakeMultiRotation2D(aShape,aDir,aPoint,anAngle,nbtimes1,aStep,nbtimes2):
1642 aVec = MakeLine(aPoint,aDir)
1643 anObj = MultiRotate2D(aShape,aVec,anAngle,nbtimes1,aStep,nbtimes2)
1646 # -----------------------------------------------------------------------------
1648 # -----------------------------------------------------------------------------
1650 ## Perform a fillet on all edges of the given shape.
1651 # @param theShape Shape, to perform fillet on.
1652 # @param theR Fillet radius.
1653 # @return New GEOM_Object, containing the result shape.
1655 # Example: see GEOM_TestOthers.py
1656 def MakeFilletAll(theShape, theR):
1657 anObj = LocalOp.MakeFilletAll(theShape, theR)
1658 if LocalOp.IsDone() == 0:
1659 print "MakeFilletAll : ", LocalOp.GetErrorCode()
1662 ## Perform a fillet on the specified edges/faces of the given shape
1663 # @param theShape Shape, to perform fillet on.
1664 # @param theR Fillet radius.
1665 # @param theShapeType Type of shapes in <theListShapes>.
1666 # @param theListShapes Global indices of edges/faces to perform fillet on.
1667 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
1668 # @return New GEOM_Object, containing the result shape.
1670 # Example: see GEOM_TestAll.py
1671 def MakeFillet(theShape, theR, theShapeType, theListShapes):
1673 if theShapeType == ShapeType["EDGE"]:
1674 anObj = LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
1676 anObj = LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
1677 if LocalOp.IsDone() == 0:
1678 print "MakeFillet : ", LocalOp.GetErrorCode()
1681 ## Perform a symmetric chamfer on all edges of the given shape.
1682 # @param theShape Shape, to perform chamfer on.
1683 # @param theD Chamfer size along each face.
1684 # @return New GEOM_Object, containing the result shape.
1686 # Example: see GEOM_TestOthers.py
1687 def MakeChamferAll(theShape, theD):
1688 anObj = LocalOp.MakeChamferAll(theShape, theD)
1689 if LocalOp.IsDone() == 0:
1690 print "MakeChamferAll : ", LocalOp.GetErrorCode()
1693 ## Perform a chamfer on edges, common to the specified faces,
1694 # with distance D1 on the Face1
1695 # @param theShape Shape, to perform chamfer on.
1696 # @param theD1 Chamfer size along \a theFace1.
1697 # @param theD2 Chamfer size along \a theFace2.
1698 # @param theFace1,theFace2 Global indices of two faces of \a theShape.
1699 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
1700 # @return New GEOM_Object, containing the result shape.
1702 # Example: see GEOM_TestAll.py
1703 def MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2):
1704 anObj = LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
1705 if LocalOp.IsDone() == 0:
1706 print "MakeChamferEdge : ", LocalOp.GetErrorCode()
1709 ## Perform a chamfer on all edges of the specified faces,
1710 # with distance D1 on the first specified face (if several for one edge)
1711 # @param theShape Shape, to perform chamfer on.
1712 # @param theD1 Chamfer size along face from \a theFaces. If both faces,
1713 # connected to the edge, are in \a theFaces, \a theD1
1714 # will be get along face, which is nearer to \a theFaces beginning.
1715 # @param theD2 Chamfer size along another of two faces, connected to the edge.
1716 # @param theFaces Sequence of global indices of faces of \a theShape.
1717 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
1718 # @return New GEOM_Object, containing the result shape.
1720 # Example: see GEOM_TestAll.py
1721 def MakeChamferFaces(theShape, theD1, theD2, theFaces):
1722 anObj = LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
1723 if LocalOp.IsDone() == 0:
1724 print "MakeChamferFaces : ", LocalOp.GetErrorCode()
1727 ## Shortcut to MakeChamferEdge() and MakeChamferFaces()
1729 # Example: see GEOM_TestOthers.py
1730 def MakeChamfer(aShape,d1,d2,aShapeType,ListShape):
1732 if aShapeType == ShapeType["EDGE"]:
1733 anObj = MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1])
1735 anObj = MakeChamferFaces(aShape,d1,d2,ListShape)
1738 ## Perform an Archimde operation on the given shape with given parameters.
1739 # The object presenting the resulting face is returned.
1740 # @param theShape Shape to be put in water.
1741 # @param theWeight Weight og the shape.
1742 # @param theWaterDensity Density of the water.
1743 # @param theMeshDeflection Deflection of the mesh, using to compute the section.
1744 # @return New GEOM_Object, containing a section of \a theShape
1745 # by a plane, corresponding to water level.
1747 # Example: see GEOM_TestAll.py
1748 def Archimede(theShape, theWeight, theWaterDensity, theMeshDeflection):
1749 anObj = LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
1750 if LocalOp.IsDone() == 0:
1751 print "MakeArchimede : ", LocalOp.GetErrorCode()
1754 # -----------------------------------------------------------------------------
1755 # Information objects
1756 # -----------------------------------------------------------------------------
1758 ## Get point coordinates
1761 # Example: see GEOM_TestMeasures.py
1762 def PointCoordinates(Point):
1763 aTuple = MeasuOp.PointCoordinates(Point)
1764 if MeasuOp.IsDone() == 0:
1765 print "PointCoordinates : ", MeasuOp.GetErrorCode()
1768 ## Get summarized length of all wires,
1769 # area of surface and volume of the given shape.
1770 # @param theShape Shape to define properties of.
1771 # @return [theLength, theSurfArea, theVolume]
1772 # theLength: Summarized length of all wires of the given shape.
1773 # theSurfArea: Area of surface of the given shape.
1774 # theVolume: Volume of the given shape.
1776 # Example: see GEOM_TestMeasures.py
1777 def BasicProperties(theShape):
1778 aTuple = MeasuOp.GetBasicProperties(theShape)
1779 if MeasuOp.IsDone() == 0:
1780 print "BasicProperties : ", MeasuOp.GetErrorCode()
1783 ## Get parameters of bounding box of the given shape
1784 # @param theShape Shape to obtain bounding box of.
1785 # @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
1786 # Xmin,Xmax: Limits of shape along OX axis.
1787 # Ymin,Ymax: Limits of shape along OY axis.
1788 # Zmin,Zmax: Limits of shape along OZ axis.
1790 # Example: see GEOM_TestMeasures.py
1791 def BoundingBox(theShape):
1792 aTuple = MeasuOp.GetBoundingBox(theShape)
1793 if MeasuOp.IsDone() == 0:
1794 print "BoundingBox : ", MeasuOp.GetErrorCode()
1797 ## Get inertia matrix and moments of inertia of theShape.
1798 # @param theShape Shape to calculate inertia of.
1799 # @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
1800 # I(1-3)(1-3): Components of the inertia matrix of the given shape.
1801 # Ix,Iy,Iz: Moments of inertia of the given shape.
1803 # Example: see GEOM_TestMeasures.py
1804 def Inertia(theShape):
1805 aTuple = MeasuOp.GetInertia(theShape)
1806 if MeasuOp.IsDone() == 0:
1807 print "Inertia : ", MeasuOp.GetErrorCode()
1810 ## Get minimal distance between the given shapes.
1811 # @param theShape1,theShape2 Shapes to find minimal distance between.
1812 # @return Value of the minimal distance between the given shapes.
1814 # Example: see GEOM_TestMeasures.py
1815 def MinDistance(theShape1, theShape2):
1816 aTuple = MeasuOp.GetMinDistance(theShape1, theShape2)
1817 if MeasuOp.IsDone() == 0:
1818 print "MinDistance : ", MeasuOp.GetErrorCode()
1821 ## Get min and max tolerances of sub-shapes of theShape
1822 # @param theShape Shape, to get tolerances of.
1823 # @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
1824 # FaceMin,FaceMax: Min and max tolerances of the faces.
1825 # EdgeMin,EdgeMax: Min and max tolerances of the edges.
1826 # VertMin,VertMax: Min and max tolerances of the vertices.
1828 # Example: see GEOM_TestMeasures.py
1829 def Tolerance(theShape):
1830 aTuple = MeasuOp.GetTolerance(theShape)
1831 if MeasuOp.IsDone() == 0:
1832 print "Tolerance : ", MeasuOp.GetErrorCode()
1835 ## Obtain description of the given shape (number of sub-shapes of each type)
1836 # @param theShape Shape to be described.
1837 # @return Description of the given shape.
1839 # Example: see GEOM_TestMeasures.py
1840 def WhatIs(theShape):
1841 aDescr = MeasuOp.WhatIs(theShape)
1842 if MeasuOp.IsDone() == 0:
1843 print "WhatIs : ", MeasuOp.GetErrorCode()
1846 ## Get a point, situated at the centre of mass of theShape.
1847 # @param theShape Shape to define centre of mass of.
1848 # @return New GEOM_Object, containing the created point.
1850 # Example: see GEOM_TestMeasures.py
1851 def MakeCDG(theShape):
1852 anObj = MeasuOp.GetCentreOfMass(theShape)
1853 if MeasuOp.IsDone() == 0:
1854 print "GetCentreOfMass : ", MeasuOp.GetErrorCode()
1857 ## Check a topology of the given shape.
1858 # @param theShape Shape to check validity of.
1859 # @param theIsCheckGeom If FALSE, only the shape's topology will be checked,
1860 # if TRUE, the shape's geometry will be checked also.
1861 # @return TRUE, if the shape "seems to be valid".
1862 # If theShape is invalid, prints a description of problem.
1864 # Example: see GEOM_TestMeasures.py
1865 def CheckShape(theShape, theIsCheckGeom = 0):
1867 (IsValid, Status) = MeasuOp.CheckShapeWithGeometry(theShape)
1869 (IsValid, Status) = MeasuOp.CheckShape(theShape)
1871 if MeasuOp.IsDone() == 0:
1872 print "CheckShape : ", MeasuOp.GetErrorCode()
1878 ## Get position (LCS) of theShape.
1880 # Origin of the LCS is situated at the shape's center of mass.
1881 # Axes of the LCS are obtained from shape's location or,
1882 # if the shape is a planar face, from position of its plane.
1884 # @param theShape Shape to calculate position of.
1885 # @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
1886 # Ox,Oy,Oz: Coordinates of shape's LCS origin.
1887 # Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
1888 # Xx,Xy,Xz: Coordinates of shape's LCS X direction.
1890 # Example: see GEOM_TestMeasures.py
1891 def GetPosition(theShape):
1892 aTuple = MeasuOp.GetPosition(theShape)
1893 if MeasuOp.IsDone() == 0:
1894 print "GetPosition : ", MeasuOp.GetErrorCode()
1897 # -----------------------------------------------------------------------------
1898 # Import/Export objects
1899 # -----------------------------------------------------------------------------
1901 ## Import a shape from the BREP or IGES or STEP file
1902 # (depends on given format) with given name.
1903 # @param theFileName The file, containing the shape.
1904 # @param theFormatName Specify format for the file reading.
1905 # Available formats can be obtained with InsertOp.ImportTranslators() method.
1906 # @return New GEOM_Object, containing the imported shape.
1908 # Example: see GEOM_TestOthers.py
1909 def Import(theFileName, theFormatName):
1910 anObj = InsertOp.Import(theFileName, theFormatName)
1911 if InsertOp.IsDone() == 0:
1912 print "Import : ", InsertOp.GetErrorCode()
1915 ## Shortcut to Import() for BREP format
1917 # Example: see GEOM_TestOthers.py
1918 def ImportBREP(theFileName):
1919 return Import(theFileName, "BREP")
1921 ## Shortcut to Import() for IGES format
1923 # Example: see GEOM_TestOthers.py
1924 def ImportIGES(theFileName):
1925 return Import(theFileName, "IGES")
1927 ## Shortcut to Import() for STEP format
1929 # Example: see GEOM_TestOthers.py
1930 def ImportSTEP(theFileName):
1931 return Import(theFileName, "STEP")
1933 ## Export the given shape into a file with given name.
1934 # @param theObject Shape to be stored in the file.
1935 # @param theFileName Name of the file to store the given shape in.
1936 # @param theFormatName Specify format for the shape storage.
1937 # Available formats can be obtained with InsertOp.ImportTranslators() method.
1939 # Example: see GEOM_TestOthers.py
1940 def Export(theObject, theFileName, theFormatName):
1941 InsertOp.Export(theObject, theFileName, theFormatName)
1942 if InsertOp.IsDone() == 0:
1943 print "Export : ", InsertOp.GetErrorCode()
1945 ## Shortcut to Export() for BREP format
1947 # Example: see GEOM_TestOthers.py
1948 def ExportBREP(theObject, theFileName):
1949 return Export(theObject, theFileName, "BREP")
1951 ## Shortcut to Export() for IGES format
1953 # Example: see GEOM_TestOthers.py
1954 def ExportIGES(theObject, theFileName):
1955 return Export(theObject, theFileName, "IGES")
1957 ## Shortcut to Export() for STEP format
1959 # Example: see GEOM_TestOthers.py
1960 def ExportSTEP(theObject, theFileName):
1961 return Export(theObject, theFileName, "STEP")
1963 # -----------------------------------------------------------------------------
1965 # -----------------------------------------------------------------------------
1967 ## Create a quadrangle face from four edges. Order of Edges is not
1968 # important. It is not necessary that edges share the same vertex.
1969 # @param E1,E2,E3,E4 Edges for the face bound.
1970 # @return New GEOM_Object, containing the created face.
1972 # Example: see GEOM_Spanner.py
1973 def MakeQuad(E1, E2, E3, E4):
1974 anObj = BlocksOp.MakeQuad(E1, E2, E3, E4)
1975 if BlocksOp.IsDone() == 0:
1976 print "MakeQuad : ", BlocksOp.GetErrorCode()
1979 ## Create a quadrangle face on two edges.
1980 # The missing edges will be built by creating the shortest ones.
1981 # @param E1,E2 Two opposite edges for the face.
1982 # @return New GEOM_Object, containing the created face.
1984 # Example: see GEOM_Spanner.py
1985 def MakeQuad2Edges(E1, E2):
1986 anObj = BlocksOp.MakeQuad2Edges(E1, E2)
1987 if BlocksOp.IsDone() == 0:
1988 print "MakeQuad2Edges : ", BlocksOp.GetErrorCode()
1991 ## Create a quadrangle face with specified corners.
1992 # The missing edges will be built by creating the shortest ones.
1993 # @param V1,V2,V3,V4 Corner vertices for the face.
1994 # @return New GEOM_Object, containing the created face.
1996 # Example: see GEOM_Spanner.py
1997 def MakeQuad4Vertices(V1, V2, V3, V4):
1998 anObj = BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
1999 if BlocksOp.IsDone() == 0:
2000 print "MakeQuad4Vertices : ", BlocksOp.GetErrorCode()
2003 ## Create a hexahedral solid, bounded by the six given faces. Order of
2004 # faces is not important. It is not necessary that Faces share the same edge.
2005 # @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
2006 # @return New GEOM_Object, containing the created solid.
2008 # Example: see GEOM_Spanner.py
2009 def MakeHexa(F1, F2, F3, F4, F5, F6):
2010 anObj = BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
2011 if BlocksOp.IsDone() == 0:
2012 print "MakeHexa : ", BlocksOp.GetErrorCode()
2015 ## Create a hexahedral solid between two given faces.
2016 # The missing faces will be built by creating the smallest ones.
2017 # @param F1,F2 Two opposite faces for the hexahedral solid.
2018 # @return New GEOM_Object, containing the created solid.
2020 # Example: see GEOM_Spanner.py
2021 def MakeHexa2Faces(F1, F2):
2022 anObj = BlocksOp.MakeHexa2Faces(F1, F2)
2023 if BlocksOp.IsDone() == 0:
2024 print "MakeHexa2Faces : ", BlocksOp.GetErrorCode()
2027 ## Get a vertex, found in the given shape by its coordinates.
2028 # @param theShape Block or a compound of blocks.
2029 # @param theX,theY,theZ Coordinates of the sought vertex.
2030 # @param theEpsilon Maximum allowed distance between the resulting
2031 # vertex and point with the given coordinates.
2032 # @return New GEOM_Object, containing the found vertex.
2034 # Example: see GEOM_TestOthers.py
2035 def GetPoint(theShape, theX, theY, theZ, theEpsilon):
2036 anObj = BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
2037 if BlocksOp.IsDone() == 0:
2038 print "GetPoint : ", BlocksOp.GetErrorCode()
2041 ## Get an edge, found in the given shape by two given vertices.
2042 # @param theShape Block or a compound of blocks.
2043 # @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2044 # @return New GEOM_Object, containing the found edge.
2046 # Example: see GEOM_Spanner.py
2047 def GetEdge(theShape, thePoint1, thePoint2):
2048 anObj = BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
2049 if BlocksOp.IsDone() == 0:
2050 print "GetEdge : ", BlocksOp.GetErrorCode()
2053 ## Find an edge of the given shape, which has minimal distance to the given point.
2054 # @param theShape Block or a compound of blocks.
2055 # @param thePoint Point, close to the desired edge.
2056 # @return New GEOM_Object, containing the found edge.
2058 # Example: see GEOM_TestOthers.py
2059 def GetEdgeNearPoint(theShape, thePoint):
2060 anObj = BlocksOp.GetEdgeNearPoint(theShape, thePoint)
2061 if BlocksOp.IsDone() == 0:
2062 print "GetEdgeNearPoint : ", BlocksOp.GetErrorCode()
2065 ## Returns a face, found in the given shape by four given corner vertices.
2066 # @param theShape Block or a compound of blocks.
2067 # @param thePoint1-thePoint4 Points, close to the corners of the desired face.
2068 # @return New GEOM_Object, containing the found face.
2070 # Example: see GEOM_Spanner.py
2071 def GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4):
2072 anObj = BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
2073 if BlocksOp.IsDone() == 0:
2074 print "GetFaceByPoints : ", BlocksOp.GetErrorCode()
2077 ## Get a face of block, found in the given shape by two given edges.
2078 # @param theShape Block or a compound of blocks.
2079 # @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2080 # @return New GEOM_Object, containing the found face.
2082 # Example: see GEOM_Spanner.py
2083 def GetFaceByEdges(theShape, theEdge1, theEdge2):
2084 anObj = BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
2085 if BlocksOp.IsDone() == 0:
2086 print "GetFaceByEdges : ", BlocksOp.GetErrorCode()
2089 ## Find a face, opposite to the given one in the given block.
2090 # @param theBlock Must be a hexahedral solid.
2091 # @param theFace Face of \a theBlock, opposite to the desired face.
2092 # @return New GEOM_Object, containing the found face.
2094 # Example: see GEOM_Spanner.py
2095 def GetOppositeFace(theBlock, theFace):
2096 anObj = BlocksOp.GetOppositeFace(theBlock, theFace)
2097 if BlocksOp.IsDone() == 0:
2098 print "GetOppositeFace : ", BlocksOp.GetErrorCode()
2101 ## Find a face of the given shape, which has minimal distance to the given point.
2102 # @param theShape Block or a compound of blocks.
2103 # @param thePoint Point, close to the desired face.
2104 # @return New GEOM_Object, containing the found face.
2106 # Example: see GEOM_Spanner.py
2107 def GetFaceNearPoint(theShape, thePoint):
2108 anObj = BlocksOp.GetFaceNearPoint(theShape, thePoint)
2109 if BlocksOp.IsDone() == 0:
2110 print "GetFaceNearPoint : ", BlocksOp.GetErrorCode()
2113 ## Find a face of block, whose outside normale has minimal angle with the given vector.
2114 # @param theShape Block or a compound of blocks.
2115 # @param theVector Vector, close to the normale of the desired face.
2116 # @return New GEOM_Object, containing the found face.
2118 # Example: see GEOM_Spanner.py
2119 def GetFaceByNormale(theBlock, theVector):
2120 anObj = BlocksOp.GetFaceByNormale(theBlock, theVector)
2121 if BlocksOp.IsDone() == 0:
2122 print "GetFaceByNormale : ", BlocksOp.GetErrorCode()
2125 ## Check, if the compound of blocks is given.
2126 # To be considered as a compound of blocks, the
2127 # given shape must satisfy the following conditions:
2128 # - Each element of the compound should be a Block (6 faces and 12 edges).
2129 # - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2130 # - The compound should be connexe.
2131 # - The glue between two quadrangle faces should be applied.
2132 # @param theCompound The compound to check.
2133 # @return TRUE, if the given shape is a compound of blocks.
2134 # If theCompound is not valid, prints all discovered errors.
2136 # Example: see GEOM_Spanner.py
2137 def CheckCompoundOfBlocks(theCompound):
2138 (IsValid, BCErrors) = BlocksOp.CheckCompoundOfBlocks(theCompound)
2139 if BlocksOp.IsDone() == 0:
2140 print "CheckCompoundOfBlocks : ", BlocksOp.GetErrorCode()
2143 Descr = BlocksOp.PrintBCErrors(theCompound, BCErrors)
2147 ## Remove all seam and degenerated edges from \a theShape.
2148 # Unite faces and edges, sharing one surface. It means that
2149 # this faces must have references to one C++ surface object (handle).
2150 # @param theShape The compound or single solid to remove irregular edges from.
2151 # @return Improved shape.
2153 # Example: see GEOM_TestOthers.py
2154 def RemoveExtraEdges(theShape):
2155 anObj = BlocksOp.RemoveExtraEdges(theShape)
2156 if BlocksOp.IsDone() == 0:
2157 print "RemoveExtraEdges : ", BlocksOp.GetErrorCode()
2160 ## Check, if the given shape is a blocks compound.
2161 # Fix all detected errors.
2162 # \note Single block can be also fixed by this method.
2163 # @param theCompound The compound to check and improve.
2164 # @return Improved compound.
2166 # Example: see GEOM_TestOthers.py
2167 def CheckAndImprove(theShape):
2168 anObj = BlocksOp.CheckAndImprove(theShape)
2169 if BlocksOp.IsDone() == 0:
2170 print "CheckAndImprove : ", BlocksOp.GetErrorCode()
2173 ## Get all the blocks, contained in the given compound.
2174 # @param theCompound The compound to explode.
2175 # @param theMinNbFaces If solid has lower number of faces, it is not a block.
2176 # @param theMaxNbFaces If solid has higher number of faces, it is not a block.
2177 # \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2178 # @return List of GEOM_Objects, containing the retrieved blocks.
2180 # Example: see GEOM_TestOthers.py
2181 def MakeBlockExplode(theCompound, theMinNbFaces, theMaxNbFaces):
2182 aList = BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
2183 if BlocksOp.IsDone() == 0:
2184 print "MakeBlockExplode : ", BlocksOp.GetErrorCode()
2187 ## Find block, containing the given point inside its volume or on boundary.
2188 # @param theCompound Compound, to find block in.
2189 # @param thePoint Point, close to the desired block. If the point lays on
2190 # boundary between some blocks, we return block with nearest center.
2191 # @return New GEOM_Object, containing the found block.
2193 # Example: see GEOM_Spanner.py
2194 def GetBlockNearPoint(theCompound, thePoint):
2195 anObj = BlocksOp.GetBlockNearPoint(theCompound, thePoint)
2196 if BlocksOp.IsDone() == 0:
2197 print "GetBlockNearPoint : ", BlocksOp.GetErrorCode()
2200 ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2201 # @param theCompound Compound, to find block in.
2202 # @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2203 # @return New GEOM_Object, containing the found block.
2205 # Example: see GEOM_TestOthers.py
2206 def GetBlockByParts(theCompound, theParts):
2207 anObj = BlocksOp.GetBlockByParts(theCompound, theParts)
2208 if BlocksOp.IsDone() == 0:
2209 print "GetBlockByParts : ", BlocksOp.GetErrorCode()
2212 ## Return all blocks, containing all the elements, passed as the parts.
2213 # @param theCompound Compound, to find blocks in.
2214 # @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2215 # @return List of GEOM_Objects, containing the found blocks.
2217 # Example: see GEOM_Spanner.py
2218 def GetBlocksByParts(theCompound, theParts):
2219 aList = BlocksOp.GetBlocksByParts(theCompound, theParts)
2220 if BlocksOp.IsDone() == 0:
2221 print "GetBlocksByParts : ", BlocksOp.GetErrorCode()
2224 ## Multi-transformate block and glue the result.
2225 # Transformation is defined so, as to superpose direction faces.
2226 # @param Block Hexahedral solid to be multi-transformed.
2227 # @param DirFace1 ID of First direction face.
2228 # @param DirFace2 ID of Second direction face.
2229 # @param NbTimes Quantity of transformations to be done.
2230 # \note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
2231 # @return New GEOM_Object, containing the result shape.
2233 # Example: see GEOM_Spanner.py
2234 def MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes):
2235 anObj = BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
2236 if BlocksOp.IsDone() == 0:
2237 print "MakeMultiTransformation1D : ", BlocksOp.GetErrorCode()
2240 ## Multi-transformate block and glue the result.
2241 # @param Block Hexahedral solid to be multi-transformed.
2242 # @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
2243 # @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
2244 # @param NbTimesU,NbTimesV Quantity of transformations to be done.
2245 # @return New GEOM_Object, containing the result shape.
2247 # Example: see GEOM_Spanner.py
2248 def MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
2249 DirFace1V, DirFace2V, NbTimesV):
2250 anObj = BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
2251 DirFace1V, DirFace2V, NbTimesV)
2252 if BlocksOp.IsDone() == 0:
2253 print "MakeMultiTransformation2D : ", BlocksOp.GetErrorCode()
2256 ## Build all possible propagation groups.
2257 # Propagation group is a set of all edges, opposite to one (main)
2258 # edge of this group directly or through other opposite edges.
2259 # Notion of Opposite Edge make sence only on quadrangle face.
2260 # @param theShape Shape to build propagation groups on.
2261 # @return List of GEOM_Objects, each of them is a propagation group.
2263 # Example: see GEOM_TestOthers.py
2264 def Propagate(theShape):
2265 listChains = BlocksOp.Propagate(theShape)
2266 if BlocksOp.IsDone() == 0:
2267 print "Propagate : ", BlocksOp.GetErrorCode()
2270 # -----------------------------------------------------------------------------
2272 # -----------------------------------------------------------------------------
2274 ## Creates a new group which will store sub shapes of theMainShape
2275 # @param theMainShape is a GEOM object on which the group is selected
2276 # @param theShapeType defines a shape type of the group
2277 # @return a newly created GEOM group
2279 # Example: see GEOM_TestOthers.py
2280 def CreateGroup(theMainShape, theShapeType):
2281 anObj = GroupOp.CreateGroup(theMainShape, theShapeType)
2282 if GroupOp.IsDone() == 0:
2283 print "CreateGroup : ", GroupOp.GetErrorCode()
2286 ## Adds a sub object with ID theSubShapeId to the group
2287 # @param theGroup is a GEOM group to which the new sub shape is added
2288 # @param theSubShapeID is a sub shape ID in the main object.
2289 # \note Use method GetSubShapeID() to get an unique ID of the sub shape
2291 # Example: see GEOM_TestOthers.py
2292 def AddObject(theGroup, theSubShapeID):
2293 GroupOp.AddObject(theGroup, theSubShapeID)
2294 if GroupOp.IsDone() == 0:
2295 print "AddObject : ", GroupOp.GetErrorCode()
2297 ## Removes a sub object with ID \a theSubShapeId from the group
2298 # @param theGroup is a GEOM group from which the new sub shape is removed
2299 # @param theSubShapeID is a sub shape ID in the main object.
2300 # \note Use method GetSubShapeID() to get an unique ID of the sub shape
2302 # Example: see GEOM_TestOthers.py
2303 def RemoveObject(theGroup, theSubShapeID):
2304 GroupOp.RemoveObject(theGroup, theSubShapeID)
2305 if GroupOp.IsDone() == 0:
2306 print "RemoveObject : ", GroupOp.GetErrorCode()
2308 ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2309 # @param theGroup is a GEOM group to which the new sub shapes are added.
2310 # @param theSubShapes is a list of sub shapes to be added.
2312 # Example: see GEOM_TestOthers.py
2313 def UnionList (theGroup, theSubShapes):
2314 GroupOp.UnionList(theGroup, theSubShapes)
2315 if GroupOp.IsDone() == 0:
2316 print "UnionList : ", GroupOp.GetErrorCode()
2318 ## Works like the above method, but argument
2319 # theSubShapes here is a list of sub-shapes indices
2321 # Example: see GEOM_TestOthers.py
2322 def UnionIDs(theGroup, theSubShapes):
2323 GroupOp.UnionIDs(theGroup, theSubShapes)
2324 if GroupOp.IsDone() == 0:
2325 print "UnionIDs : ", GroupOp.GetErrorCode()
2327 ## Removes from the group all the given shapes. No errors, if some shapes are not included.
2328 # @param theGroup is a GEOM group from which the sub-shapes are removed.
2329 # @param theSubShapes is a list of sub-shapes to be removed.
2331 # Example: see GEOM_TestOthers.py
2332 def DifferenceList (theGroup, theSubShapes):
2333 GroupOp.DifferenceList(theGroup, theSubShapes)
2334 if GroupOp.IsDone() == 0:
2335 print "DifferenceList : ", GroupOp.GetErrorCode()
2337 ## Works like the above method, but argument
2338 # theSubShapes here is a list of sub-shapes indices
2340 # Example: see GEOM_TestOthers.py
2341 def DifferenceIDs(theGroup, theSubShapes):
2342 GroupOp.DifferenceIDs(theGroup, theSubShapes)
2343 if GroupOp.IsDone() == 0:
2344 print "DifferenceIDs : ", GroupOp.GetErrorCode()
2346 ## Returns a list of sub objects ID stored in the group
2347 # @param theGroup is a GEOM group for which a list of IDs is requested
2349 # Example: see GEOM_TestOthers.py
2350 def GetObjectIDs(theGroup):
2351 ListIDs = GroupOp.GetObjects(theGroup)
2352 if GroupOp.IsDone() == 0:
2353 print "GetObjectIDs : ", GroupOp.GetErrorCode()
2356 ## Returns a type of sub objects stored in the group
2357 # @param theGroup is a GEOM group which type is returned.
2359 # Example: see GEOM_TestOthers.py
2360 def GetType(theGroup):
2361 aType = GroupOp.GetType(theGroup)
2362 if GroupOp.IsDone() == 0:
2363 print "GetType : ", GroupOp.GetErrorCode()
2366 ## Returns a main shape associated with the group
2367 # @param theGroup is a GEOM group for which a main shape object is requested
2368 # @return a GEOM object which is a main shape for theGroup
2370 # Example: see GEOM_TestOthers.py
2371 def GetMainShape(theGroup):
2372 anObj = GroupOp.GetMainShape(theGroup)
2373 if GroupOp.IsDone() == 0:
2374 print "GetMainShape : ", GroupOp.GetErrorCode()
2377 ## Create group of edges of theShape, whose length is in range [min_length, max_length].
2378 # If include_min/max == 0, edges with length == min/max_length will not be included in result.
2379 def GetEdgesByLength (theShape, min_length, max_length, include_min = 1, include_max = 1):
2380 edges = SubShapeAll(theShape, ShapeType["EDGE"])
2383 Props = BasicProperties(edge)
2384 if min_length <= Props[0] and Props[0] <= max_length:
2385 if (not include_min) and (min_length == Props[0]):
2388 if (not include_max) and (Props[0] == max_length):
2391 edges_in_range.append(edge)
2393 if len(edges_in_range) <= 0:
2394 print "No edges found by given criteria"
2397 group_edges = CreateGroup(theShape, ShapeType["EDGE"])
2398 UnionList(group_edges, edges_in_range)
2402 ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
2403 # If include_min/max == 0, edges with length == min/max_length will not be included in result.
2404 def SelectEdges (min_length, max_length, include_min = 1, include_max = 1):
2405 nb_selected = sg.SelectedCount()
2407 print "Select a shape before calling this function, please."
2410 print "Only one shape must be selected"
2413 id_shape = sg.getSelected(0)
2414 shape = IDToObject( id_shape )
2416 group_edges = GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
2420 if include_min: left_str = " <= "
2421 if include_max: right_str = " <= "
2423 addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
2424 + left_str + "length" + right_str + `max_length`)
2426 sg.updateObjBrowser(1)
2430 ## Add Path to load python scripts from
2432 if (sys.path.count(Path) < 1):
2433 sys.path.append(Path)