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
34 ## @defgroup l1_geompy_auxiliary Auxiliary data structures and methods
36 ## @defgroup l1_geompy_purpose All package methods, grouped by their purpose
38 ## @defgroup l2_import_export Importing/exporting geometrical objects
39 ## @defgroup l2_creating Creating geometrical objects
41 ## @defgroup l3_basic_go Creating Basic Geometric Objects
43 ## @defgroup l4_curves Creating Curves
46 ## @defgroup l3_3d_primitives Creating 3D Primitives
47 ## @defgroup l3_complex Creating Complex Objects
48 ## @defgroup l3_groups Working with groups
49 ## @defgroup l3_blocks Building by blocks
51 ## @defgroup l4_blocks_measure Check and Improve
54 ## @defgroup l3_sketcher Sketcher
55 ## @defgroup l3_advanced Creating Advanced Geometrical Objects
57 ## @defgroup l4_decompose Decompose objects
58 ## @defgroup l4_access Access to sub-shapes by their unique IDs inside the main shape
59 ## @defgroup l4_obtain Access to subshapes by a criteria
64 ## @defgroup l2_transforming Transforming geometrical objects
66 ## @defgroup l3_basic_op Basic Operations
67 ## @defgroup l3_boolean Boolean Operations
68 ## @defgroup l3_transform Transformation Operations
69 ## @defgroup l3_local Local Operations (Fillet and Chamfer)
70 ## @defgroup l3_blocks_op Blocks Operations
71 ## @defgroup l3_healing Repairing Operations
72 ## @defgroup l3_restore_ss Restore presentation parameters and a tree of subshapes
75 ## @defgroup l2_measure Using measurement tools
86 ## Enumeration ShapeType as a dictionary
87 # @ingroup l1_geompy_auxiliary
88 ShapeType = {"COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8}
90 ## Raise an Error, containing the Method_name, if Operation is Failed
91 ## @ingroup l1_geompy_auxiliary
92 def RaiseIfFailed (Method_name, Operation):
93 if Operation.IsDone() == 0 and Operation.GetErrorCode() != "NOT_FOUND_ANY":
94 raise RuntimeError, Method_name + " : " + Operation.GetErrorCode()
96 ## Kinds of shape enumeration
97 # @ingroup l1_geompy_auxiliary
98 kind = GEOM.GEOM_IKindOfShape
100 ## Information about closed/unclosed state of shell or wire
101 # @ingroup l1_geompy_auxiliary
108 class geompyDC(GEOM._objref_GEOM_Gen):
110 ## @addtogroup l1_geompy_auxiliary
113 GEOM._objref_GEOM_Gen.__init__(self)
114 self.myBuilder = None
132 def init_geom(self,theStudy):
133 self.myStudy = theStudy
134 self.myStudyId = self.myStudy._get_StudyId()
135 self.myBuilder = self.myStudy.NewBuilder()
136 self.father = self.myStudy.FindComponent("GEOM")
137 if self.father is None:
138 self.father = self.myBuilder.NewComponent("GEOM")
139 A1 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributeName")
140 FName = A1._narrow(SALOMEDS.AttributeName)
141 FName.SetValue("Geometry")
142 A2 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributePixMap")
143 aPixmap = A2._narrow(SALOMEDS.AttributePixMap)
144 aPixmap.SetPixMap("ICON_OBJBROWSER_Geometry")
145 self.myBuilder.DefineComponentInstance(self.father,self)
147 self.BasicOp = self.GetIBasicOperations (self.myStudyId)
148 self.CurvesOp = self.GetICurvesOperations (self.myStudyId)
149 self.PrimOp = self.GetI3DPrimOperations (self.myStudyId)
150 self.ShapesOp = self.GetIShapesOperations (self.myStudyId)
151 self.HealOp = self.GetIHealingOperations (self.myStudyId)
152 self.InsertOp = self.GetIInsertOperations (self.myStudyId)
153 self.BoolOp = self.GetIBooleanOperations (self.myStudyId)
154 self.TrsfOp = self.GetITransformOperations(self.myStudyId)
155 self.LocalOp = self.GetILocalOperations (self.myStudyId)
156 self.MeasuOp = self.GetIMeasureOperations (self.myStudyId)
157 self.BlocksOp = self.GetIBlocksOperations (self.myStudyId)
158 self.GroupOp = self.GetIGroupOperations (self.myStudyId)
161 ## Get name for sub-shape aSubObj of shape aMainObj
163 # @ref swig_SubShapeAllSorted "Example"
164 def SubShapeName(self,aSubObj, aMainObj):
165 # Example: see GEOM_TestAll.py
167 #aSubId = orb.object_to_string(aSubObj)
168 #aMainId = orb.object_to_string(aMainObj)
169 #index = gg.getIndexTopology(aSubId, aMainId)
170 #name = gg.getShapeTypeString(aSubId) + "_%d"%(index)
171 index = self.ShapesOp.GetTopologyIndex(aMainObj, aSubObj)
172 name = self.ShapesOp.GetShapeTypeString(aSubObj) + "_%d"%(index)
175 ## Publish in study aShape with name aName
177 # \param aShape the shape to be published
178 # \param aName the name for the shape
179 # \param doRestoreSubShapes if True, finds and publishes also
180 # sub-shapes of <VAR>aShape</VAR>, corresponding to its arguments
181 # and published sub-shapes of arguments
182 # \param theArgs,theFindMethod,theInheritFirstArg see geompy.RestoreSubShapes for
183 # these arguments description
184 # \return study entry of the published shape in form of string
186 # @ref swig_MakeQuad4Vertices "Example"
187 def addToStudy(self, aShape, aName, doRestoreSubShapes=False,
188 theArgs=[], theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False):
189 # Example: see GEOM_TestAll.py
191 aSObject = self.AddInStudy(self.myStudy, aShape, aName, None)
192 if doRestoreSubShapes:
193 self.RestoreSubShapesSO(self.myStudy, aSObject, theArgs,
194 theFindMethod, theInheritFirstArg)
196 print "addToStudy() failed"
198 return aShape.GetStudyEntry()
200 ## Publish in study aShape with name aName as sub-object of previously published aFather
202 # @ref swig_SubShapeAllSorted "Example"
203 def addToStudyInFather(self, aFather, aShape, aName):
204 # Example: see GEOM_TestAll.py
206 aSObject = self.AddInStudy(myStudy, aShape, aName, aFather)
208 print "addToStudyInFather() failed"
210 return aShape.GetStudyEntry()
212 # end of l1_geompy_auxiliary
215 ## @addtogroup l3_restore_ss
218 ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
219 # To be used from python scripts out of geompy.addToStudy (non-default usage)
220 # \param theObject published GEOM object, arguments of which will be published
221 # \param theArgs list of GEOM_Object, operation arguments to be published.
222 # If this list is empty, all operation arguments will be published
223 # \param theFindMethod method to search subshapes, corresponding to arguments and
224 # their subshapes. Value from enumeration GEOM::find_shape_method.
225 # \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
226 # Do not publish subshapes in place of arguments, but only
227 # in place of subshapes of the first argument,
228 # because the whole shape corresponds to the first argument.
229 # Mainly to be used after transformations, but it also can be
230 # usefull after partition with one object shape, and some other
231 # operations, where only the first argument has to be considered.
232 # If theObject has only one argument shape, this flag is automatically
233 # considered as True, not regarding really passed value.
234 # \return True in case of success, False otherwise.
236 # @ref tui_restore_prs_params "Example"
237 def RestoreSubShapes (self, theObject, theArgs=[],
238 theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False):
239 # Example: see GEOM_TestAll.py
240 return self.RestoreSubShapesO(self.myStudy, theObject, theArgs,
241 theFindMethod, theInheritFirstArg)
243 # end of l3_restore_ss
246 ## @addtogroup l3_basic_go
249 ## Create point by three coordinates.
250 # @param theX The X coordinate of the point.
251 # @param theY The Y coordinate of the point.
252 # @param theZ The Z coordinate of the point.
253 # @return New GEOM_Object, containing the created point.
255 # @ref tui_creation_point "Example"
256 def MakeVertex(self,theX, theY, theZ):
257 # Example: see GEOM_TestAll.py
258 anObj = self.BasicOp.MakePointXYZ(theX, theY, theZ)
259 RaiseIfFailed("MakePointXYZ", self.BasicOp)
262 ## Create a point, distant from the referenced point
263 # on the given distances along the coordinate axes.
264 # @param theReference The referenced point.
265 # @param theX Displacement from the referenced point along OX axis.
266 # @param theY Displacement from the referenced point along OY axis.
267 # @param theZ Displacement from the referenced point along OZ axis.
268 # @return New GEOM_Object, containing the created point.
270 # @ref tui_creation_point "Example"
271 def MakeVertexWithRef(self,theReference, theX, theY, theZ):
272 # Example: see GEOM_TestAll.py
273 anObj = self.BasicOp.MakePointWithReference(theReference, theX, theY, theZ)
274 RaiseIfFailed("MakePointWithReference", self.BasicOp)
277 ## Create a point, corresponding to the given parameter on the given curve.
278 # @param theRefCurve The referenced curve.
279 # @param theParameter Value of parameter on the referenced curve.
280 # @return New GEOM_Object, containing the created point.
282 # @ref tui_creation_point "Example"
283 def MakeVertexOnCurve(self,theRefCurve, theParameter):
284 # Example: see GEOM_TestAll.py
285 anObj = self.BasicOp.MakePointOnCurve(theRefCurve, theParameter)
286 RaiseIfFailed("MakePointOnCurve", self.BasicOp)
289 ## Create a point, corresponding to the given parameters on the
291 # @param theRefSurf The referenced surface.
292 # @param theUParameter Value of U-parameter on the referenced surface.
293 # @param theVParameter Value of V-parameter on the referenced surface.
294 # @return New GEOM_Object, containing the created point.
296 # @ref swig_MakeVertexOnSurface "Example"
297 def MakeVertexOnSurface(self, theRefSurf, theUParameter, theVParameter):
298 # Example: see GEOM_TestAll.py
299 anObj = self.BasicOp.MakePointOnSurface(theRefSurf, theUParameter, theVParameter)
300 RaiseIfFailed("MakePointOnSurface", self.BasicOp)
303 ## Create a point on intersection of two lines.
304 # @param theRefLine1, theRefLine2 The referenced lines.
305 # @return New GEOM_Object, containing the created point.
307 # @ref swig_MakeVertexOnLinesIntersection "Example"
308 def MakeVertexOnLinesIntersection(self, theRefLine1, theRefLine2):
309 # Example: see GEOM_TestAll.py
310 anObj = self.BasicOp.MakePointOnLinesIntersection(theRefLine1, theRefLine2)
311 RaiseIfFailed("MakePointOnLinesIntersection", self.BasicOp)
314 ## Create a tangent, corresponding to the given parameter on the given curve.
315 # @param theRefCurve The referenced curve.
316 # @param theParameter Value of parameter on the referenced curve.
317 # @return New GEOM_Object, containing the created tangent.
319 # @ref swig_MakeTangentOnCurve "Example"
320 def MakeTangentOnCurve(self, theRefCurve, theParameter):
321 anObj = self.BasicOp.MakeTangentOnCurve(theRefCurve, theParameter)
322 RaiseIfFailed("MakeTangentOnCurve", self.BasicOp)
325 ## Create a vector with the given components.
326 # @param theDX X component of the vector.
327 # @param theDY Y component of the vector.
328 # @param theDZ Z component of the vector.
329 # @return New GEOM_Object, containing the created vector.
331 # @ref tui_creation_vector "Example"
332 def MakeVectorDXDYDZ(self,theDX, theDY, theDZ):
333 # Example: see GEOM_TestAll.py
334 anObj = self.BasicOp.MakeVectorDXDYDZ(theDX, theDY, theDZ)
335 RaiseIfFailed("MakeVectorDXDYDZ", self.BasicOp)
338 ## Create a vector between two points.
339 # @param thePnt1 Start point for the vector.
340 # @param thePnt2 End point for the vector.
341 # @return New GEOM_Object, containing the created vector.
343 # @ref tui_creation_vector "Example"
344 def MakeVector(self,thePnt1, thePnt2):
345 # Example: see GEOM_TestAll.py
346 anObj = self.BasicOp.MakeVectorTwoPnt(thePnt1, thePnt2)
347 RaiseIfFailed("MakeVectorTwoPnt", self.BasicOp)
350 ## Create a line, passing through the given point
351 # and parrallel to the given direction
352 # @param thePnt Point. The resulting line will pass through it.
353 # @param theDir Direction. The resulting line will be parallel to it.
354 # @return New GEOM_Object, containing the created line.
356 # @ref tui_creation_line "Example"
357 def MakeLine(self,thePnt, theDir):
358 # Example: see GEOM_TestAll.py
359 anObj = self.BasicOp.MakeLine(thePnt, theDir)
360 RaiseIfFailed("MakeLine", self.BasicOp)
363 ## Create a line, passing through the given points
364 # @param thePnt1 First of two points, defining the line.
365 # @param thePnt2 Second of two points, defining the line.
366 # @return New GEOM_Object, containing the created line.
368 # @ref tui_creation_line "Example"
369 def MakeLineTwoPnt(self,thePnt1, thePnt2):
370 # Example: see GEOM_TestAll.py
371 anObj = self.BasicOp.MakeLineTwoPnt(thePnt1, thePnt2)
372 RaiseIfFailed("MakeLineTwoPnt", self.BasicOp)
375 ## Create a line on two faces intersection.
376 # @param theFace1 First of two faces, defining the line.
377 # @param theFace2 Second of two faces, defining the line.
378 # @return New GEOM_Object, containing the created line.
380 # @ref swig_MakeLineTwoFaces "Example"
381 def MakeLineTwoFaces(self, theFace1, theFace2):
382 # Example: see GEOM_TestAll.py
383 anObj = self.BasicOp.MakeLineTwoFaces(theFace1, theFace2)
384 RaiseIfFailed("MakeLineTwoFaces", self.BasicOp)
387 ## Create a plane, passing through the given point
388 # and normal to the given vector.
389 # @param thePnt Point, the plane has to pass through.
390 # @param theVec Vector, defining the plane normal direction.
391 # @param theTrimSize Half size of a side of quadrangle face, representing the plane.
392 # @return New GEOM_Object, containing the created plane.
394 # @ref tui_creation_plane "Example"
395 def MakePlane(self,thePnt, theVec, theTrimSize):
396 # Example: see GEOM_TestAll.py
397 anObj = self.BasicOp.MakePlanePntVec(thePnt, theVec, theTrimSize)
398 RaiseIfFailed("MakePlanePntVec", self.BasicOp)
401 ## Create a plane, passing through the three given points
402 # @param thePnt1 First of three points, defining the plane.
403 # @param thePnt2 Second of three points, defining the plane.
404 # @param thePnt3 Fird of three points, defining the plane.
405 # @param theTrimSize Half size of a side of quadrangle face, representing the plane.
406 # @return New GEOM_Object, containing the created plane.
408 # @ref tui_creation_plane "Example"
409 def MakePlaneThreePnt(self,thePnt1, thePnt2, thePnt3, theTrimSize):
410 # Example: see GEOM_TestAll.py
411 anObj = self.BasicOp.MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize)
412 RaiseIfFailed("MakePlaneThreePnt", self.BasicOp)
415 ## Create a plane, similar to the existing one, but with another size of representing face.
416 # @param theFace Referenced plane or LCS(Marker).
417 # @param theTrimSize New half size of a side of quadrangle face, representing the plane.
418 # @return New GEOM_Object, containing the created plane.
420 # @ref tui_creation_plane "Example"
421 def MakePlaneFace(self,theFace, theTrimSize):
422 # Example: see GEOM_TestAll.py
423 anObj = self.BasicOp.MakePlaneFace(theFace, theTrimSize)
424 RaiseIfFailed("MakePlaneFace", self.BasicOp)
427 ## Create a local coordinate system.
428 # @param OX,OY,OZ Three coordinates of coordinate system origin.
429 # @param XDX,XDY,XDZ Three components of OX direction
430 # @param YDX,YDY,YDZ Three components of OY direction
431 # @return New GEOM_Object, containing the created coordinate system.
433 # @ref swig_MakeMarker "Example"
434 def MakeMarker(self, OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ):
435 # Example: see GEOM_TestAll.py
436 anObj = self.BasicOp.MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ)
437 RaiseIfFailed("MakeMarker", self.BasicOp)
440 ## Create a local coordinate system.
441 # @param theOrigin Point of coordinate system origin.
442 # @param theXVec Vector of X direction
443 # @param theYVec Vector of Y direction
444 # @return New GEOM_Object, containing the created coordinate system.
446 # @ref swig_MakeMarker "Example"
447 def MakeMarkerPntTwoVec(self, theOrigin, theXVec, theYVec):
448 O = self.PointCoordinates( theOrigin )
450 for vec in [ theXVec, theYVec ]:
451 v1, v2 = self.SubShapeAll( vec, ShapeType["VERTEX"] )
452 p1 = self.PointCoordinates( v1 )
453 p2 = self.PointCoordinates( v2 )
454 for i in range( 0, 3 ):
455 OXOY.append( p2[i] - p1[i] )
457 anObj = self.BasicOp.MakeMarker( O[0], O[1], O[2],
458 OXOY[0], OXOY[1], OXOY[2],
459 OXOY[3], OXOY[4], OXOY[5], )
460 RaiseIfFailed("MakeMarker", self.BasicOp)
466 ## @addtogroup l4_curves
469 ## Create an arc of circle, passing through three given points.
470 # @param thePnt1 Start point of the arc.
471 # @param thePnt2 Middle point of the arc.
472 # @param thePnt3 End point of the arc.
473 # @return New GEOM_Object, containing the created arc.
475 # @ref swig_MakeArc "Example"
476 def MakeArc(self,thePnt1, thePnt2, thePnt3):
477 # Example: see GEOM_TestAll.py
478 anObj = self.CurvesOp.MakeArc(thePnt1, thePnt2, thePnt3)
479 RaiseIfFailed("MakeArc", self.CurvesOp)
482 ## Create an arc of circle from a center and 2 points.
483 # @param thePnt1 Center of the arc
484 # @param thePnt2 Start point of the arc. (Gives also the radius of the arc)
485 # @param thePnt3 End point of the arc (Gives also a direction)
486 # @param theSense Orientation of the arc
487 # @return New GEOM_Object, containing the created arc.
489 # @ref swig_MakeArc "Example"
490 def MakeArcCenter(self, thePnt1, thePnt2, thePnt3, theSense=False):
491 # Example: see GEOM_TestAll.py
492 anObj = self.CurvesOp.MakeArcCenter(thePnt1, thePnt2, thePnt3, theSense)
493 RaiseIfFailed("MakeArcCenter", self.CurvesOp)
496 ## Create a circle with given center, normal vector and radius.
497 # @param thePnt Circle center.
498 # @param theVec Vector, normal to the plane of the circle.
499 # @param theR Circle radius.
500 # @return New GEOM_Object, containing the created circle.
502 # @ref tui_creation_circle "Example"
503 def MakeCircle(self,thePnt, theVec, theR):
504 # Example: see GEOM_TestAll.py
505 anObj = self.CurvesOp.MakeCirclePntVecR(thePnt, theVec, theR)
506 RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
509 ## Create a circle, passing through three given points
510 # @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
511 # @return New GEOM_Object, containing the created circle.
513 # @ref tui_creation_circle "Example"
514 def MakeCircleThreePnt(self,thePnt1, thePnt2, thePnt3):
515 # Example: see GEOM_TestAll.py
516 anObj = self.CurvesOp.MakeCircleThreePnt(thePnt1, thePnt2, thePnt3)
517 RaiseIfFailed("MakeCircleThreePnt", self.CurvesOp)
520 ## Create a circle, with given point1 as center,
521 # passing through the point2 as radius and laying in the plane,
522 # defined by all three given points.
523 # @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
524 # @return New GEOM_Object, containing the created circle.
526 # @ref swig_MakeCircle "Example"
527 def MakeCircleCenter2Pnt(self,thePnt1, thePnt2, thePnt3):
528 # Example: see GEOM_example6.py
529 anObj = self.CurvesOp.MakeCircleCenter2Pnt(thePnt1, thePnt2, thePnt3)
530 RaiseIfFailed("MakeCircleCenter2Pnt", self.CurvesOp)
533 ## Create an ellipse with given center, normal vector and radiuses.
534 # @param thePnt Ellipse center.
535 # @param theVec Vector, normal to the plane of the ellipse.
536 # @param theRMajor Major ellipse radius.
537 # @param theRMinor Minor ellipse radius.
538 # @return New GEOM_Object, containing the created ellipse.
540 # @ref tui_creation_ellipse "Example"
541 def MakeEllipse(self,thePnt, theVec, theRMajor, theRMinor):
542 # Example: see GEOM_TestAll.py
543 anObj = self.CurvesOp.MakeEllipse(thePnt, theVec, theRMajor, theRMinor)
544 RaiseIfFailed("MakeEllipse", self.CurvesOp)
547 ## Create a polyline on the set of points.
548 # @param thePoints Sequence of points for the polyline.
549 # @return New GEOM_Object, containing the created polyline.
551 # @ref tui_creation_curve "Example"
552 def MakePolyline(self,thePoints):
553 # Example: see GEOM_TestAll.py
554 anObj = self.CurvesOp.MakePolyline(thePoints)
555 RaiseIfFailed("MakePolyline", self.CurvesOp)
558 ## Create bezier curve on the set of points.
559 # @param thePoints Sequence of points for the bezier curve.
560 # @return New GEOM_Object, containing the created bezier curve.
562 # @ref tui_creation_curve "Example"
563 def MakeBezier(self,thePoints):
564 # Example: see GEOM_TestAll.py
565 anObj = self.CurvesOp.MakeSplineBezier(thePoints)
566 RaiseIfFailed("MakeSplineBezier", self.CurvesOp)
569 ## Create B-Spline curve on the set of points.
570 # @param thePoints Sequence of points for the B-Spline curve.
571 # @return New GEOM_Object, containing the created B-Spline curve.
573 # @ref tui_creation_curve "Example"
574 def MakeInterpol(self,thePoints):
575 # Example: see GEOM_TestAll.py
576 anObj = self.CurvesOp.MakeSplineInterpolation(thePoints)
577 RaiseIfFailed("MakeSplineInterpolation", self.CurvesOp)
583 ## @addtogroup l3_sketcher
586 ## Create a sketcher (wire or face), following the textual description,
587 # passed through <VAR>theCommand</VAR> argument. \n
588 # Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
589 # Format of the description string have to be the following:
591 # "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
594 # - x1, y1 are coordinates of the first sketcher point (zero by default),
596 # - "R angle" : Set the direction by angle
597 # - "D dx dy" : Set the direction by DX & DY
600 # - "TT x y" : Create segment by point at X & Y
601 # - "T dx dy" : Create segment by point with DX & DY
602 # - "L length" : Create segment by direction & Length
603 # - "IX x" : Create segment by direction & Intersect. X
604 # - "IY y" : Create segment by direction & Intersect. Y
607 # - "C radius length" : Create arc by direction, radius and length(in degree)
610 # - "WW" : Close Wire (to finish)
611 # - "WF" : Close Wire and build face (to finish)
613 # @param theCommand String, defining the sketcher in local
614 # coordinates of the working plane.
615 # @param theWorkingPlane Nine double values, defining origin,
616 # OZ and OX directions of the working plane.
617 # @return New GEOM_Object, containing the created wire.
619 # @ref tui_sketcher_page "Example"
620 def MakeSketcher(self, theCommand, theWorkingPlane = [0,0,0, 0,0,1, 1,0,0]):
621 # Example: see GEOM_TestAll.py
622 anObj = self.CurvesOp.MakeSketcher(theCommand, theWorkingPlane)
623 RaiseIfFailed("MakeSketcher", self.CurvesOp)
626 ## Create a sketcher (wire or face), following the textual description,
627 # passed through <VAR>theCommand</VAR> argument. \n
628 # For format of the description string see the previous method.\n
629 # @param theCommand String, defining the sketcher in local
630 # coordinates of the working plane.
631 # @param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
632 # @return New GEOM_Object, containing the created wire.
634 # @ref tui_sketcher_page "Example"
635 def MakeSketcherOnPlane(self, theCommand, theWorkingPlane):
636 anObj = self.CurvesOp.MakeSketcherOnPlane(theCommand, theWorkingPlane)
637 RaiseIfFailed("MakeSketcherOnPlane", self.CurvesOp)
643 ## @addtogroup l3_3d_primitives
646 ## Create a box by coordinates of two opposite vertices.
648 # @ref tui_creation_box "Example"
649 def MakeBox(self,x1,y1,z1,x2,y2,z2):
650 # Example: see GEOM_TestAll.py
651 pnt1 = self.MakeVertex(x1,y1,z1)
652 pnt2 = self.MakeVertex(x2,y2,z2)
653 return self.MakeBoxTwoPnt(pnt1,pnt2)
655 ## Create a box with specified dimensions along the coordinate axes
656 # and with edges, parallel to the coordinate axes.
657 # Center of the box will be at point (DX/2, DY/2, DZ/2).
658 # @param theDX Length of Box edges, parallel to OX axis.
659 # @param theDY Length of Box edges, parallel to OY axis.
660 # @param theDZ Length of Box edges, parallel to OZ axis.
661 # @return New GEOM_Object, containing the created box.
663 # @ref tui_creation_box "Example"
664 def MakeBoxDXDYDZ(self,theDX, theDY, theDZ):
665 # Example: see GEOM_TestAll.py
666 anObj = self.PrimOp.MakeBoxDXDYDZ(theDX, theDY, theDZ)
667 RaiseIfFailed("MakeBoxDXDYDZ", self.PrimOp)
670 ## Create a box with two specified opposite vertices,
671 # and with edges, parallel to the coordinate axes
672 # @param thePnt1 First of two opposite vertices.
673 # @param thePnt2 Second of two opposite vertices.
674 # @return New GEOM_Object, containing the created box.
676 # @ref tui_creation_box "Example"
677 def MakeBoxTwoPnt(self,thePnt1, thePnt2):
678 # Example: see GEOM_TestAll.py
679 anObj = self.PrimOp.MakeBoxTwoPnt(thePnt1, thePnt2)
680 RaiseIfFailed("MakeBoxTwoPnt", self.PrimOp)
683 ## Create a face with specified dimensions along OX-OY coordinate axes,
684 # with edges, parallel to this coordinate axes.
685 # @param theH length of Face edge, parallel to OX axis.
686 # @param theW length of Face edge, parallel to OY axis.
687 # @return New GEOM_Object, containing the created face.
689 # @ref tui_creation_face "Example"
690 def MakeFaceHW(self,theH, theW):
691 # Example: see GEOM_TestAll.py
692 anObj = self.PrimOp.MakeFaceHW(theH, theW)
693 RaiseIfFailed("MakeFaceHW", self.PrimOp)
696 ## Create a face from another plane and two sizes,
697 # vertical size and horisontal size.
698 # @param thePlane Plane in that axis will be create new face.
699 # @param theH Height (vertical size).
700 # @param theW Width (horisontal size).
701 # @return New GEOM_Object, containing the created face.
703 # @ref tui_creation_face "Example"
704 def MakeFacePlaneHW(self, theFace, theH, theW):
705 # Example: see GEOM_TestAll.py
706 anObj = self.PrimOp.MakeFacePlaneHW(theFace, theH, theW)
707 RaiseIfFailed("MakeFacePlaneHW", self.PrimOp)
710 ## Create a disk with given center, normal vector and radius.
711 # @param thePnt Disk center.
712 # @param theVec Vector, normal to the plane of the disk.
713 # @param theR Disk radius.
714 # @return New GEOM_Object, containing the created disk.
716 # @ref tui_creation_disk "Example"
717 def MakeDiskPntVecR(self,thePnt, theVec, theR):
718 # Example: see GEOM_TestAll.py
719 anObj = self.PrimOp.MakeDiskPntVecR(thePnt, theVec, theR)
720 RaiseIfFailed("MakeDiskPntVecR", self.PrimOp)
723 ## Create a disk, passing through three given points
724 # @param thePnt1,thePnt2,thePnt3 Points, defining the disk.
725 # @return New GEOM_Object, containing the created disk.
727 # @ref tui_creation_disk "Example"
728 def MakeDiskThreePnt(self,thePnt1, thePnt2, thePnt3):
729 # Example: see GEOM_TestAll.py
730 anObj = self.PrimOp.MakeDiskThreePnt(thePnt1, thePnt2, thePnt3)
731 RaiseIfFailed("MakeDiskThreePnt", self.PrimOp)
734 ## Create a cylinder with given base point, axis, radius and height.
735 # @param thePnt Central point of cylinder base.
736 # @param theAxis Cylinder axis.
737 # @param theR Cylinder radius.
738 # @param theH Cylinder height.
739 # @return New GEOM_Object, containing the created cylinder.
741 # @ref tui_creation_cylinder "Example"
742 def MakeCylinder(self,thePnt, theAxis, theR, theH):
743 # Example: see GEOM_TestAll.py
744 anObj = self.PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
745 RaiseIfFailed("MakeCylinderPntVecRH", self.PrimOp)
748 ## Create a cylinder with given radius and height at
749 # the origin of coordinate system. Axis of the cylinder
750 # will be collinear to the OZ axis of the coordinate system.
751 # @param theR Cylinder radius.
752 # @param theH Cylinder height.
753 # @return New GEOM_Object, containing the created cylinder.
755 # @ref tui_creation_cylinder "Example"
756 def MakeCylinderRH(self,theR, theH):
757 # Example: see GEOM_TestAll.py
758 anObj = self.PrimOp.MakeCylinderRH(theR, theH)
759 RaiseIfFailed("MakeCylinderRH", self.PrimOp)
762 ## Create a sphere with given center and radius.
763 # @param thePnt Sphere center.
764 # @param theR Sphere radius.
765 # @return New GEOM_Object, containing the created sphere.
767 # @ref tui_creation_sphere "Example"
768 def MakeSpherePntR(self, thePnt, theR):
769 # Example: see GEOM_TestAll.py
770 anObj = self.PrimOp.MakeSpherePntR(thePnt, theR)
771 RaiseIfFailed("MakeSpherePntR", self.PrimOp)
774 ## Create a sphere with given center and radius.
775 # @param x,y,z Coordinates of sphere center.
776 # @param theR Sphere radius.
777 # @return New GEOM_Object, containing the created sphere.
779 # @ref tui_creation_sphere "Example"
780 def MakeSphere(self, x, y, z, theR):
781 # Example: see GEOM_TestAll.py
782 point = self.MakeVertex(x, y, z)
783 anObj = self.MakeSpherePntR(point, theR)
786 ## Create a sphere with given radius at the origin of coordinate system.
787 # @param theR Sphere radius.
788 # @return New GEOM_Object, containing the created sphere.
790 # @ref tui_creation_sphere "Example"
791 def MakeSphereR(self, theR):
792 # Example: see GEOM_TestAll.py
793 anObj = self.PrimOp.MakeSphereR(theR)
794 RaiseIfFailed("MakeSphereR", self.PrimOp)
797 ## Create a cone with given base point, axis, height and radiuses.
798 # @param thePnt Central point of the first cone base.
799 # @param theAxis Cone axis.
800 # @param theR1 Radius of the first cone base.
801 # @param theR2 Radius of the second cone base.
802 # \note If both radiuses are non-zero, the cone will be truncated.
803 # \note If the radiuses are equal, a cylinder will be created instead.
804 # @param theH Cone height.
805 # @return New GEOM_Object, containing the created cone.
807 # @ref tui_creation_cone "Example"
808 def MakeCone(self,thePnt, theAxis, theR1, theR2, theH):
809 # Example: see GEOM_TestAll.py
810 anObj = self.PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
811 RaiseIfFailed("MakeConePntVecR1R2H", self.PrimOp)
814 ## Create a cone with given height and radiuses at
815 # the origin of coordinate system. Axis of the cone will
816 # be collinear to the OZ axis of the coordinate system.
817 # @param theR1 Radius of the first cone base.
818 # @param theR2 Radius of the second cone base.
819 # \note If both radiuses are non-zero, the cone will be truncated.
820 # \note If the radiuses are equal, a cylinder will be created instead.
821 # @param theH Cone height.
822 # @return New GEOM_Object, containing the created cone.
824 # @ref tui_creation_cone "Example"
825 def MakeConeR1R2H(self,theR1, theR2, theH):
826 # Example: see GEOM_TestAll.py
827 anObj = self.PrimOp.MakeConeR1R2H(theR1, theR2, theH)
828 RaiseIfFailed("MakeConeR1R2H", self.PrimOp)
831 ## Create a torus with given center, normal vector and radiuses.
832 # @param thePnt Torus central point.
833 # @param theVec Torus axis of symmetry.
834 # @param theRMajor Torus major radius.
835 # @param theRMinor Torus minor radius.
836 # @return New GEOM_Object, containing the created torus.
838 # @ref tui_creation_torus "Example"
839 def MakeTorus(self, thePnt, theVec, theRMajor, theRMinor):
840 # Example: see GEOM_TestAll.py
841 anObj = self.PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
842 RaiseIfFailed("MakeTorusPntVecRR", self.PrimOp)
845 ## Create a torus with given radiuses at the origin of coordinate system.
846 # @param theRMajor Torus major radius.
847 # @param theRMinor Torus minor radius.
848 # @return New GEOM_Object, containing the created torus.
850 # @ref tui_creation_torus "Example"
851 def MakeTorusRR(self, theRMajor, theRMinor):
852 # Example: see GEOM_TestAll.py
853 anObj = self.PrimOp.MakeTorusRR(theRMajor, theRMinor)
854 RaiseIfFailed("MakeTorusRR", self.PrimOp)
857 # end of l3_3d_primitives
860 ## @addtogroup l3_complex
863 ## Create a shape by extrusion of the base shape along a vector, defined by two points.
864 # @param theBase Base shape to be extruded.
865 # @param thePoint1 First end of extrusion vector.
866 # @param thePoint2 Second end of extrusion vector.
867 # @return New GEOM_Object, containing the created prism.
869 # @ref tui_creation_prism "Example"
870 def MakePrism(self, theBase, thePoint1, thePoint2):
871 # Example: see GEOM_TestAll.py
872 anObj = self.PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
873 RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
876 ## Create a shape by extrusion of the base shape along the vector,
877 # i.e. all the space, transfixed by the base shape during its translation
878 # along the vector on the given distance.
879 # @param theBase Base shape to be extruded.
880 # @param theVec Direction of extrusion.
881 # @param theH Prism dimension along theVec.
882 # @return New GEOM_Object, containing the created prism.
884 # @ref tui_creation_prism "Example"
885 def MakePrismVecH(self, theBase, theVec, theH):
886 # Example: see GEOM_TestAll.py
887 anObj = self.PrimOp.MakePrismVecH(theBase, theVec, theH)
888 RaiseIfFailed("MakePrismVecH", self.PrimOp)
891 ## Create a shape by extrusion of the base shape along the vector,
892 # i.e. all the space, transfixed by the base shape during its translation
893 # along the vector on the given distance in 2 Ways (forward/backward) .
894 # @param theBase Base shape to be extruded.
895 # @param theVec Direction of extrusion.
896 # @param theH Prism dimension along theVec in forward direction.
897 # @return New GEOM_Object, containing the created prism.
899 # @ref tui_creation_prism "Example"
900 def MakePrismVecH2Ways(self, theBase, theVec, theH):
901 # Example: see GEOM_TestAll.py
902 anObj = self.PrimOp.MakePrismVecH2Ways(theBase, theVec, theH)
903 RaiseIfFailed("MakePrismVecH2Ways", self.PrimOp)
906 ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
907 # @param theBase Base shape to be extruded.
908 # @param theDX, theDY, theDZ Directions of extrusion.
909 # @return New GEOM_Object, containing the created prism.
911 # @ref tui_creation_prism "Example"
912 def MakePrismDXDYDZ(self, theBase, theDX, theDY, theDZ):
913 # Example: see GEOM_TestAll.py
914 anObj = self.PrimOp.MakePrismDXDYDZ(theBase, theDX, theDY, theDZ)
915 RaiseIfFailed("MakePrismDXDYDZ", self.PrimOp)
918 ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
919 # i.e. all the space, transfixed by the base shape during its translation
920 # along the vector on the given distance in 2 Ways (forward/backward) .
921 # @param theBase Base shape to be extruded.
922 # @param theDX, theDY, theDZ Directions of extrusion.
923 # @return New GEOM_Object, containing the created prism.
925 # @ref tui_creation_prism "Example"
926 def MakePrismDXDYDZ2Ways(self, theBase, theDX, theDY, theDZ):
927 # Example: see GEOM_TestAll.py
928 anObj = self.PrimOp.MakePrismDXDYDZ2Ways(theBase, theDX, theDY, theDZ)
929 RaiseIfFailed("MakePrismDXDYDZ2Ways", self.PrimOp)
932 ## Create a shape by revolution of the base shape around the axis
933 # on the given angle, i.e. all the space, transfixed by the base
934 # shape during its rotation around the axis on the given angle.
935 # @param theBase Base shape to be rotated.
936 # @param theAxis Rotation axis.
937 # @param theAngle Rotation angle in radians.
938 # @return New GEOM_Object, containing the created revolution.
940 # @ref tui_creation_revolution "Example"
941 def MakeRevolution(self, theBase, theAxis, theAngle):
942 # Example: see GEOM_TestAll.py
943 anObj = self.PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
944 RaiseIfFailed("MakeRevolutionAxisAngle", self.PrimOp)
947 ## The Same Revolution but in both ways forward&backward.
948 def MakeRevolution2Ways(self, theBase, theAxis, theAngle):
949 anObj = self.PrimOp.MakeRevolutionAxisAngle2Ways(theBase, theAxis, theAngle)
950 RaiseIfFailed("MakeRevolutionAxisAngle2Ways", self.PrimOp)
953 ## Create a filling from the given compound of contours.
954 # @param theShape the compound of contours
955 # @param theMinDeg a minimal degree of BSpline surface to create
956 # @param theMaxDeg a maximal degree of BSpline surface to create
957 # @param theTol2D a 2d tolerance to be reached
958 # @param theTol3D a 3d tolerance to be reached
959 # @param theNbIter a number of iteration of approximation algorithm
960 # @param isApprox if True, BSpline curves are generated in the process
961 # of surface construction. By default it is False, that means
962 # the surface is created using Besier curves. The usage of
963 # Approximation makes the algorithm work slower, but allows
964 # building the surface for rather complex cases
965 # @return New GEOM_Object, containing the created filling surface.
967 # @ref tui_creation_filling "Example"
968 def MakeFilling(self, theShape, theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter, isApprox=0):
969 # Example: see GEOM_TestAll.py
970 anObj = self.PrimOp.MakeFilling(theShape, theMinDeg, theMaxDeg,
971 theTol2D, theTol3D, theNbIter, isApprox)
972 RaiseIfFailed("MakeFilling", self.PrimOp)
975 ## Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
976 # @param theSeqSections - set of specified sections.
977 # @param theModeSolid - mode defining building solid or shell
978 # @param thePreci - precision 3D used for smoothing by default 1.e-6
979 # @param theRuled - mode defining type of the result surfaces (ruled or smoothed).
980 # @return New GEOM_Object, containing the created shell or solid.
982 # @ref swig_todo "Example"
983 def MakeThruSections(self,theSeqSections,theModeSolid,thePreci,theRuled):
984 # Example: see GEOM_TestAll.py
985 anObj = self.PrimOp.MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled)
986 RaiseIfFailed("MakeThruSections", self.PrimOp)
989 ## Create a shape by extrusion of the base shape along
990 # the path shape. The path shape can be a wire or an edge.
991 # @param theBase Base shape to be extruded.
992 # @param thePath Path shape to extrude the base shape along it.
993 # @return New GEOM_Object, containing the created pipe.
995 # @ref tui_creation_pipe "Example"
996 def MakePipe(self,theBase, thePath):
997 # Example: see GEOM_TestAll.py
998 anObj = self.PrimOp.MakePipe(theBase, thePath)
999 RaiseIfFailed("MakePipe", self.PrimOp)
1002 ## Create a shape by extrusion of the profile shape along
1003 # the path shape. The path shape can be a wire or an edge.
1004 # the several profiles can be specified in the several locations of path.
1005 # @param theSeqBases - list of Bases shape to be extruded.
1006 # @param theLocations - list of locations on the path corresponding
1007 # specified list of the Bases shapes. Number of locations
1008 # should be equal to number of bases or list of locations can be empty.
1009 # @param thePath - Path shape to extrude the base shape along it.
1010 # @param theWithContact - the mode defining that the section is translated to be in
1011 # contact with the spine.
1012 # @param theWithCorrection - defining that the section is rotated to be
1013 # orthogonal to the spine tangent in the correspondent point
1014 # @return New GEOM_Object, containing the created pipe.
1016 # @ref tui_creation_pipe_with_diff_sec "Example"
1017 def MakePipeWithDifferentSections(self, theSeqBases,
1018 theLocations, thePath,
1019 theWithContact, theWithCorrection):
1020 anObj = self.PrimOp.MakePipeWithDifferentSections(theSeqBases,
1021 theLocations, thePath,
1022 theWithContact, theWithCorrection)
1023 RaiseIfFailed("MakePipeWithDifferentSections", self.PrimOp)
1026 ## Create a shape by extrusion of the profile shape along
1027 # the path shape. The path shape can be a wire or a edge.
1028 # the several profiles can be specified in the several locations of path.
1029 # @param theSeqBases - list of Bases shape to be extruded. Base shape must be
1030 # shell or face. If number of faces in neighbour sections
1031 # aren't coincided result solid between such sections will
1032 # be created using external boundaries of this shells.
1033 # @param theSeqSubBases - list of corresponding subshapes of section shapes.
1034 # This list is used for searching correspondences between
1035 # faces in the sections. Size of this list must be equal
1036 # to size of list of base shapes.
1037 # @param theLocations - list of locations on the path corresponding
1038 # specified list of the Bases shapes. Number of locations
1039 # should be equal to number of bases. First and last
1040 # locations must be coincided with first and last vertexes
1041 # of path correspondingly.
1042 # @param thePath - Path shape to extrude the base shape along it.
1043 # @param theWithContact - the mode defining that the section is translated to be in
1044 # contact with the spine.
1045 # @param theWithCorrection - defining that the section is rotated to be
1046 # orthogonal to the spine tangent in the correspondent point
1047 # @return New GEOM_Object, containing the created solids.
1049 # @ref tui_creation_pipe_with_shell_sec "Example"
1050 def MakePipeWithShellSections(self,theSeqBases, theSeqSubBases,
1051 theLocations, thePath,
1052 theWithContact, theWithCorrection):
1053 anObj = self.PrimOp.MakePipeWithShellSections(theSeqBases, theSeqSubBases,
1054 theLocations, thePath,
1055 theWithContact, theWithCorrection)
1056 RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
1059 ## Create a shape by extrusion of the profile shape along
1060 # the path shape. This function is used only for debug pipe
1061 # functionality - it is a version of previous function
1062 # (MakePipeWithShellSections(...)) which give a possibility to
1063 # recieve information about creating pipe between each pair of
1064 # sections step by step.
1065 def MakePipeWithShellSectionsBySteps(self, theSeqBases, theSeqSubBases,
1066 theLocations, thePath,
1067 theWithContact, theWithCorrection):
1069 nbsect = len(theSeqBases)
1070 nbsubsect = len(theSeqSubBases)
1071 #print "nbsect = ",nbsect
1072 for i in range(1,nbsect):
1074 tmpSeqBases = [ theSeqBases[i-1], theSeqBases[i] ]
1075 tmpLocations = [ theLocations[i-1], theLocations[i] ]
1077 if nbsubsect>0: tmpSeqSubBases = [ theSeqSubBases[i-1], theSeqSubBases[i] ]
1078 anObj = self.PrimOp.MakePipeWithShellSections(tmpSeqBases, tmpSeqSubBases,
1079 tmpLocations, thePath,
1080 theWithContact, theWithCorrection)
1081 if self.PrimOp.IsDone() == 0:
1082 print "Problems with pipe creation between ",i," and ",i+1," sections"
1083 RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
1086 print "Pipe between ",i," and ",i+1," sections is OK"
1091 resc = self.MakeCompound(res)
1092 #resc = self.MakeSewing(res, 0.001)
1093 #print "resc: ",resc
1096 ## Create solids between given sections
1097 # @param theSeqBases - list of sections (shell or face).
1098 # @param theLocations - list of corresponding vertexes
1099 # @return New GEOM_Object, containing the created solids.
1101 # @ref tui_creation_pipe_without_path "Example"
1102 def MakePipeShellsWithoutPath(self, theSeqBases, theLocations):
1103 anObj = self.PrimOp.MakePipeShellsWithoutPath(theSeqBases, theLocations)
1104 RaiseIfFailed("MakePipeShellsWithoutPath", self.PrimOp)
1110 ## @addtogroup l3_advanced
1113 ## Create a linear edge with specified ends.
1114 # @param thePnt1 Point for the first end of edge.
1115 # @param thePnt2 Point for the second end of edge.
1116 # @return New GEOM_Object, containing the created edge.
1118 # @ref tui_creation_edge "Example"
1119 def MakeEdge(self,thePnt1, thePnt2):
1120 # Example: see GEOM_TestAll.py
1121 anObj = self.ShapesOp.MakeEdge(thePnt1, thePnt2)
1122 RaiseIfFailed("MakeEdge", self.ShapesOp)
1125 ## Create a wire from the set of edges and wires.
1126 # @param theEdgesAndWires List of edges and/or wires.
1127 # @return New GEOM_Object, containing the created wire.
1129 # @ref tui_creation_wire "Example"
1130 def MakeWire(self,theEdgesAndWires):
1131 # Example: see GEOM_TestAll.py
1132 anObj = self.ShapesOp.MakeWire(theEdgesAndWires)
1133 RaiseIfFailed("MakeWire", self.ShapesOp)
1136 ## Create a face on the given wire.
1137 # @param theWire closed Wire or Edge to build the face on.
1138 # @param isPlanarWanted If TRUE, only planar face will be built.
1139 # If impossible, NULL object will be returned.
1140 # @return New GEOM_Object, containing the created face.
1142 # @ref tui_creation_face "Example"
1143 def MakeFace(self,theWire, isPlanarWanted):
1144 # Example: see GEOM_TestAll.py
1145 anObj = self.ShapesOp.MakeFace(theWire, isPlanarWanted)
1146 RaiseIfFailed("MakeFace", self.ShapesOp)
1149 ## Create a face on the given wires set.
1150 # @param theWires List of closed wires or edges to build the face on.
1151 # @param isPlanarWanted If TRUE, only planar face will be built.
1152 # If impossible, NULL object will be returned.
1153 # @return New GEOM_Object, containing the created face.
1155 # @ref tui_creation_face "Example"
1156 def MakeFaceWires(self,theWires, isPlanarWanted):
1157 # Example: see GEOM_TestAll.py
1158 anObj = self.ShapesOp.MakeFaceWires(theWires, isPlanarWanted)
1159 RaiseIfFailed("MakeFaceWires", self.ShapesOp)
1162 ## Shortcut to MakeFaceWires()
1164 # @ref tui_creation_face "Example 1"
1165 # \n @ref swig_MakeFaces "Example 2"
1166 def MakeFaces(self,theWires, isPlanarWanted):
1167 # Example: see GEOM_TestOthers.py
1168 anObj = self.MakeFaceWires(theWires, isPlanarWanted)
1171 ## Create a shell from the set of faces and shells.
1172 # @param theFacesAndShells List of faces and/or shells.
1173 # @return New GEOM_Object, containing the created shell.
1175 # @ref tui_creation_shell "Example"
1176 def MakeShell(self,theFacesAndShells):
1177 # Example: see GEOM_TestAll.py
1178 anObj = self.ShapesOp.MakeShell(theFacesAndShells)
1179 RaiseIfFailed("MakeShell", self.ShapesOp)
1182 ## Create a solid, bounded by the given shells.
1183 # @param theShells Sequence of bounding shells.
1184 # @return New GEOM_Object, containing the created solid.
1186 # @ref tui_creation_solid "Example"
1187 def MakeSolid(self,theShells):
1188 # Example: see GEOM_TestAll.py
1189 anObj = self.ShapesOp.MakeSolidShells(theShells)
1190 RaiseIfFailed("MakeSolidShells", self.ShapesOp)
1193 ## Create a compound of the given shapes.
1194 # @param theShapes List of shapes to put in compound.
1195 # @return New GEOM_Object, containing the created compound.
1197 # @ref tui_creation_compound "Example"
1198 def MakeCompound(self,theShapes):
1199 # Example: see GEOM_TestAll.py
1200 anObj = self.ShapesOp.MakeCompound(theShapes)
1201 RaiseIfFailed("MakeCompound", self.ShapesOp)
1204 # end of l3_advanced
1207 ## @addtogroup l2_measure
1210 ## Gives quantity of faces in the given shape.
1211 # @param theShape Shape to count faces of.
1212 # @return Quantity of faces.
1214 # @ref swig_NumberOfFaces "Example"
1215 def NumberOfFaces(self,theShape):
1216 # Example: see GEOM_TestOthers.py
1217 nb_faces = self.ShapesOp.NumberOfFaces(theShape)
1218 RaiseIfFailed("NumberOfFaces", self.ShapesOp)
1221 ## Gives quantity of edges in the given shape.
1222 # @param theShape Shape to count edges of.
1223 # @return Quantity of edges.
1225 # @ref swig_NumberOfEdges "Example"
1226 def NumberOfEdges(self,theShape):
1227 # Example: see GEOM_TestOthers.py
1228 nb_edges = self.ShapesOp.NumberOfEdges(theShape)
1229 RaiseIfFailed("NumberOfEdges", self.ShapesOp)
1235 ## @addtogroup l3_healing
1238 ## Reverses an orientation the given shape.
1239 # @param theShape Shape to be reversed.
1240 # @return The reversed copy of theShape.
1242 # @ref swig_ChangeOrientation "Example"
1243 def ChangeOrientation(self,theShape):
1244 # Example: see GEOM_TestAll.py
1245 anObj = self.ShapesOp.ChangeOrientation(theShape)
1246 RaiseIfFailed("ChangeOrientation", self.ShapesOp)
1249 ## Shortcut to ChangeOrientation()
1251 # @ref swig_OrientationChange "Example"
1252 def OrientationChange(self,theShape):
1253 # Example: see GEOM_TestOthers.py
1254 anObj = self.ChangeOrientation(theShape)
1260 ## @addtogroup l4_obtain
1263 ## Retrieve all free faces from the given shape.
1264 # Free face is a face, which is not shared between two shells of the shape.
1265 # @param theShape Shape to find free faces in.
1266 # @return List of IDs of all free faces, contained in theShape.
1268 # @ref tui_measurement_tools_page "Example"
1269 def GetFreeFacesIDs(self,theShape):
1270 # Example: see GEOM_TestOthers.py
1271 anIDs = self.ShapesOp.GetFreeFacesIDs(theShape)
1272 RaiseIfFailed("GetFreeFacesIDs", self.ShapesOp)
1275 ## Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1276 # @param theShape1 Shape to find sub-shapes in.
1277 # @param theShape2 Shape to find shared sub-shapes with.
1278 # @param theShapeType Type of sub-shapes to be retrieved.
1279 # @return List of sub-shapes of theShape1, shared with theShape2.
1281 # @ref swig_GetSharedShapes "Example"
1282 def GetSharedShapes(self,theShape1, theShape2, theShapeType):
1283 # Example: see GEOM_TestOthers.py
1284 aList = self.ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
1285 RaiseIfFailed("GetSharedShapes", self.ShapesOp)
1288 ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
1289 # situated relatively the specified plane by the certain way,
1290 # defined through <VAR>theState</VAR> parameter.
1291 # @param theShape Shape to find sub-shapes of.
1292 # @param theShapeType Type of sub-shapes to be retrieved.
1293 # @param theAx1 Vector (or line, or linear edge), specifying normal
1294 # direction and location of the plane to find shapes on.
1295 # @param theState The state of the subshapes to find. It can be one of
1296 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1297 # @return List of all found sub-shapes.
1299 # @ref swig_GetShapesOnPlane "Example"
1300 def GetShapesOnPlane(self,theShape, theShapeType, theAx1, theState):
1301 # Example: see GEOM_TestOthers.py
1302 aList = self.ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
1303 RaiseIfFailed("GetShapesOnPlane", self.ShapesOp)
1306 ## Works like the above method, but returns list of sub-shapes indices
1308 # @ref swig_GetShapesOnPlaneIDs "Example"
1309 def GetShapesOnPlaneIDs(self,theShape, theShapeType, theAx1, theState):
1310 # Example: see GEOM_TestOthers.py
1311 aList = self.ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
1312 RaiseIfFailed("GetShapesOnPlaneIDs", self.ShapesOp)
1315 ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
1316 # situated relatively the specified plane by the certain way,
1317 # defined through <VAR>theState</VAR> parameter.
1318 # @param theShape Shape to find sub-shapes of.
1319 # @param theShapeType Type of sub-shapes to be retrieved.
1320 # @param theAx1 Vector (or line, or linear edge), specifying normal
1321 # direction of the plane to find shapes on.
1322 # @param thePnt Point specifying location of the plane to find shapes on.
1323 # @param theState The state of the subshapes to find. It can be one of
1324 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1325 # @return List of all found sub-shapes.
1327 # @ref swig_GetShapesOnPlaneWithLocation "Example"
1328 def GetShapesOnPlaneWithLocation(self, theShape, theShapeType, theAx1, thePnt, theState):
1329 # Example: see GEOM_TestOthers.py
1330 aList = self.ShapesOp.GetShapesOnPlaneWithLocation(theShape, theShapeType,
1331 theAx1, thePnt, theState)
1332 RaiseIfFailed("GetShapesOnPlaneWithLocation", self.ShapesOp)
1335 ## Works like the above method, but returns list of sub-shapes indices
1337 # @ref swig_GetShapesOnPlaneWithLocationIDs "Example"
1338 def GetShapesOnPlaneWithLocationIDs(self, theShape, theShapeType, theAx1, thePnt, theState):
1339 # Example: see GEOM_TestOthers.py
1340 aList = self.ShapesOp.GetShapesOnPlaneWithLocationIDs(theShape, theShapeType,
1341 theAx1, thePnt, theState)
1342 RaiseIfFailed("GetShapesOnPlaneWithLocationIDs", self.ShapesOp)
1345 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1346 # the specified cylinder by the certain way, defined through \a theState parameter.
1347 # @param theShape Shape to find sub-shapes of.
1348 # @param theShapeType Type of sub-shapes to be retrieved.
1349 # @param theAxis Vector (or line, or linear edge), specifying
1350 # axis of the cylinder to find shapes on.
1351 # @param theRadius Radius of the cylinder to find shapes on.
1352 # @param theState The state of the subshapes to find. It can be one of
1353 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1354 # @return List of all found sub-shapes.
1356 # @ref swig_GetShapesOnCylinder "Example"
1357 def GetShapesOnCylinder(self, theShape, theShapeType, theAxis, theRadius, theState):
1358 # Example: see GEOM_TestOthers.py
1359 aList = self.ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
1360 RaiseIfFailed("GetShapesOnCylinder", self.ShapesOp)
1363 ## Works like the above method, but returns list of sub-shapes indices
1365 # @ref swig_GetShapesOnCylinderIDs "Example"
1366 def GetShapesOnCylinderIDs(self, theShape, theShapeType, theAxis, theRadius, theState):
1367 # Example: see GEOM_TestOthers.py
1368 aList = self.ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
1369 RaiseIfFailed("GetShapesOnCylinderIDs", self.ShapesOp)
1372 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1373 # the specified sphere by the certain way, defined through \a theState parameter.
1374 # @param theShape Shape to find sub-shapes of.
1375 # @param theShapeType Type of sub-shapes to be retrieved.
1376 # @param theCenter Point, specifying center of the sphere to find shapes on.
1377 # @param theRadius Radius of the sphere to find shapes on.
1378 # @param theState The state of the subshapes to find. It can be one of
1379 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1380 # @return List of all found sub-shapes.
1382 # @ref swig_GetShapesOnSphere "Example"
1383 def GetShapesOnSphere(self,theShape, theShapeType, theCenter, theRadius, theState):
1384 # Example: see GEOM_TestOthers.py
1385 aList = self.ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
1386 RaiseIfFailed("GetShapesOnSphere", self.ShapesOp)
1389 ## Works like the above method, but returns list of sub-shapes indices
1391 # @ref swig_GetShapesOnSphereIDs "Example"
1392 def GetShapesOnSphereIDs(self,theShape, theShapeType, theCenter, theRadius, theState):
1393 # Example: see GEOM_TestOthers.py
1394 aList = self.ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
1395 RaiseIfFailed("GetShapesOnSphereIDs", self.ShapesOp)
1398 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1399 # the specified quadrangle by the certain way, defined through \a theState parameter.
1400 # @param theShape Shape to find sub-shapes of.
1401 # @param theShapeType Type of sub-shapes to be retrieved.
1402 # @param theTopLeftPoint Point, specifying top left corner of a quadrangle
1403 # @param theTopRigthPoint Point, specifying top right corner of a quadrangle
1404 # @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
1405 # @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
1406 # @param theState The state of the subshapes to find. It can be one of
1407 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1408 # @return List of all found sub-shapes.
1410 # @ref swig_GetShapesOnQuadrangle "Example"
1411 def GetShapesOnQuadrangle(self, theShape, theShapeType,
1412 theTopLeftPoint, theTopRigthPoint,
1413 theBottomLeftPoint, theBottomRigthPoint, theState):
1414 # Example: see GEOM_TestOthers.py
1415 aList = self.ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType,
1416 theTopLeftPoint, theTopRigthPoint,
1417 theBottomLeftPoint, theBottomRigthPoint, theState)
1418 RaiseIfFailed("GetShapesOnQuadrangle", self.ShapesOp)
1421 ## Works like the above method, but returns list of sub-shapes indices
1423 # @ref swig_GetShapesOnQuadrangleIDs "Example"
1424 def GetShapesOnQuadrangleIDs(self, theShape, theShapeType,
1425 theTopLeftPoint, theTopRigthPoint,
1426 theBottomLeftPoint, theBottomRigthPoint, theState):
1427 # Example: see GEOM_TestOthers.py
1428 aList = self.ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType,
1429 theTopLeftPoint, theTopRigthPoint,
1430 theBottomLeftPoint, theBottomRigthPoint, theState)
1431 RaiseIfFailed("GetShapesOnQuadrangleIDs", self.ShapesOp)
1434 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1435 # the specified \a theBox by the certain way, defined through \a theState parameter.
1436 # @param theBox Shape for relative comparing.
1437 # @param theShape Shape to find sub-shapes of.
1438 # @param theShapeType Type of sub-shapes to be retrieved.
1439 # @param theState The state of the subshapes to find. It can be one of
1440 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1441 # @return List of all found sub-shapes.
1443 # @ref swig_GetShapesOnBox "Example"
1444 def GetShapesOnBox(self, theBox, theShape, theShapeType, theState):
1445 # Example: see GEOM_TestOthers.py
1446 aList = self.ShapesOp.GetShapesOnBox(theBox, theShape, theShapeType, theState)
1447 RaiseIfFailed("GetShapesOnBox", self.ShapesOp)
1450 ## Works like the above method, but returns list of sub-shapes indices
1452 # @ref swig_GetShapesOnBoxIDs "Example"
1453 def GetShapesOnBoxIDs(self, theBox, theShape, theShapeType, theState):
1454 # Example: see GEOM_TestOthers.py
1455 aList = self.ShapesOp.GetShapesOnBoxIDs(theBox, theShape, theShapeType, theState)
1456 RaiseIfFailed("GetShapesOnBoxIDs", self.ShapesOp)
1459 ## Find in \a theShape all sub-shapes of type \a theShapeType,
1460 # situated relatively the specified \a theCheckShape by the
1461 # certain way, defined through \a theState parameter.
1462 # @param theCheckShape Shape for relative comparing.
1463 # @param theShape Shape to find sub-shapes of.
1464 # @param theShapeType Type of sub-shapes to be retrieved.
1465 # @param theState The state of the subshapes to find. It can be one of
1466 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1467 # @return List of all found sub-shapes.
1469 # @ref swig_GetShapesOnShape "Example"
1470 def GetShapesOnShape(self, theCheckShape, theShape, theShapeType, theState):
1471 # Example: see GEOM_TestOthers.py
1472 aList = self.ShapesOp.GetShapesOnShape(theCheckShape, theShape,
1473 theShapeType, theState)
1474 RaiseIfFailed("GetShapesOnShape", self.ShapesOp)
1477 ## Works like the above method, but returns result as compound
1479 # @ref swig_GetShapesOnShapeAsCompound "Example"
1480 def GetShapesOnShapeAsCompound(self, theCheckShape, theShape, theShapeType, theState):
1481 # Example: see GEOM_TestOthers.py
1482 anObj = self.ShapesOp.GetShapesOnShapeAsCompound(theCheckShape, theShape,
1483 theShapeType, theState)
1484 RaiseIfFailed("GetShapesOnShapeAsCompound", self.ShapesOp)
1487 ## Works like the above method, but returns list of sub-shapes indices
1489 # @ref swig_GetShapesOnShapeIDs "Example"
1490 def GetShapesOnShapeIDs(self, theCheckShape, theShape, theShapeType, theState):
1491 # Example: see GEOM_TestOthers.py
1492 aList = self.ShapesOp.GetShapesOnShapeIDs(theCheckShape, theShape,
1493 theShapeType, theState)
1494 RaiseIfFailed("GetShapesOnShapeIDs", self.ShapesOp)
1497 ## Get sub-shape(s) of theShapeWhere, which are
1498 # coincident with \a theShapeWhat or could be a part of it.
1499 # @param theShapeWhere Shape to find sub-shapes of.
1500 # @param theShapeWhat Shape, specifying what to find.
1501 # @return Group of all found sub-shapes or a single found sub-shape.
1503 # @ref swig_GetInPlace "Example"
1504 def GetInPlace(self,theShapeWhere, theShapeWhat):
1505 # Example: see GEOM_TestOthers.py
1506 anObj = self.ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
1507 RaiseIfFailed("GetInPlace", self.ShapesOp)
1510 ## Get sub-shape(s) of \a theShapeWhere, which are
1511 # coincident with \a theShapeWhat or could be a part of it.
1513 # Implementation of this method is based on a saved history of an operation,
1514 # produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1515 # arguments (an argument shape or a sub-shape of an argument shape).
1516 # The operation could be the Partition or one of boolean operations,
1517 # performed on simple shapes (not on compounds).
1519 # @param theShapeWhere Shape to find sub-shapes of.
1520 # @param theShapeWhat Shape, specifying what to find (must be in the
1521 # building history of the ShapeWhere).
1522 # @return Group of all found sub-shapes or a single found sub-shape.
1524 # @ref swig_GetInPlace "Example"
1525 def GetInPlaceByHistory(self, theShapeWhere, theShapeWhat):
1526 # Example: see GEOM_TestOthers.py
1527 anObj = self.ShapesOp.GetInPlaceByHistory(theShapeWhere, theShapeWhat)
1528 RaiseIfFailed("GetInPlaceByHistory", self.ShapesOp)
1531 ## Get sub-shape of theShapeWhere, which is
1532 # equal to \a theShapeWhat.
1533 # @param theShapeWhere Shape to find sub-shape of.
1534 # @param theShapeWhat Shape, specifying what to find.
1535 # @return New GEOM_Object for found sub-shape.
1537 # @ref swig_GetSame "Example"
1538 def GetSame(self,theShapeWhere, theShapeWhat):
1539 anObj = self.ShapesOp.GetSame(theShapeWhere, theShapeWhat)
1540 RaiseIfFailed("GetSame", self.ShapesOp)
1546 ## @addtogroup l4_access
1549 ## Obtain a composite sub-shape of <VAR>aShape</VAR>, composed from sub-shapes
1550 # of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
1552 # @ref swig_all_decompose "Example"
1553 def GetSubShape(self, aShape, ListOfID):
1554 # Example: see GEOM_TestAll.py
1555 anObj = self.AddSubShape(aShape,ListOfID)
1558 ## Obtain unique ID of sub-shape <VAR>aSubShape</VAR> inside <VAR>aShape</VAR>
1560 # @ref swig_all_decompose "Example"
1561 def GetSubShapeID(self, aShape, aSubShape):
1562 # Example: see GEOM_TestAll.py
1563 anID = self.LocalOp.GetSubShapeIndex(aShape, aSubShape)
1564 RaiseIfFailed("GetSubShapeIndex", self.LocalOp)
1570 ## @addtogroup l4_decompose
1573 ## Explode a shape on subshapes of a given type.
1574 # @param aShape Shape to be exploded.
1575 # @param aType Type of sub-shapes to be retrieved.
1576 # @return List of sub-shapes of type theShapeType, contained in theShape.
1578 # @ref swig_all_decompose "Example"
1579 def SubShapeAll(self, aShape, aType):
1580 # Example: see GEOM_TestAll.py
1581 ListObj = self.ShapesOp.MakeExplode(aShape,aType,0)
1582 RaiseIfFailed("MakeExplode", self.ShapesOp)
1585 ## Explode a shape on subshapes of a given type.
1586 # @param aShape Shape to be exploded.
1587 # @param aType Type of sub-shapes to be retrieved.
1588 # @return List of IDs of sub-shapes.
1590 # @ref swig_all_decompose "Example"
1591 def SubShapeAllIDs(self, aShape, aType):
1592 ListObj = self.ShapesOp.SubShapeAllIDs(aShape,aType,0)
1593 RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
1596 ## Explode a shape on subshapes of a given type.
1597 # Sub-shapes will be sorted by coordinates of their gravity centers.
1598 # @param aShape Shape to be exploded.
1599 # @param aType Type of sub-shapes to be retrieved.
1600 # @return List of sub-shapes of type theShapeType, contained in theShape.
1602 # @ref swig_SubShapeAllSorted "Example"
1603 def SubShapeAllSorted(self, aShape, aType):
1604 # Example: see GEOM_TestAll.py
1605 ListObj = self.ShapesOp.MakeExplode(aShape,aType,1)
1606 RaiseIfFailed("MakeExplode", self.ShapesOp)
1609 ## Explode a shape on subshapes of a given type.
1610 # Sub-shapes will be sorted by coordinates of their gravity centers.
1611 # @param aShape Shape to be exploded.
1612 # @param aType Type of sub-shapes to be retrieved.
1613 # @return List of IDs of sub-shapes.
1615 # @ref swig_all_decompose "Example"
1616 def SubShapeAllSortedIDs(self, aShape, aType):
1617 ListIDs = self.ShapesOp.SubShapeAllIDs(aShape,aType,1)
1618 RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
1621 ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
1622 # selected by they indices in list of all sub-shapes of type <VAR>aType</VAR>.
1623 # Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1625 # @ref swig_all_decompose "Example"
1626 def SubShape(self, aShape, aType, ListOfInd):
1627 # Example: see GEOM_TestAll.py
1629 AllShapeList = self.SubShapeAll(aShape, aType)
1630 for ind in ListOfInd:
1631 ListOfIDs.append(self.GetSubShapeID(aShape, AllShapeList[ind - 1]))
1632 anObj = self.GetSubShape(aShape, ListOfIDs)
1635 ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
1636 # selected by they indices in sorted list of all sub-shapes of type <VAR>aType</VAR>.
1637 # Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1639 # @ref swig_all_decompose "Example"
1640 def SubShapeSorted(self,aShape, aType, ListOfInd):
1641 # Example: see GEOM_TestAll.py
1643 AllShapeList = self.SubShapeAllSorted(aShape, aType)
1644 for ind in ListOfInd:
1645 ListOfIDs.append(self.GetSubShapeID(aShape, AllShapeList[ind - 1]))
1646 anObj = self.GetSubShape(aShape, ListOfIDs)
1649 # end of l4_decompose
1652 ## @addtogroup l3_healing
1655 ## Apply a sequence of Shape Healing operators to the given object.
1656 # @param theShape Shape to be processed.
1657 # @param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1658 # @param theParameters List of names of parameters
1659 # ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1660 # @param theValues List of values of parameters, in the same order
1661 # as parameters are listed in <VAR>theParameters</VAR> list.
1662 # @return New GEOM_Object, containing processed shape.
1664 # @ref tui_shape_processing "Example"
1665 def ProcessShape(self,theShape, theOperators, theParameters, theValues):
1666 # Example: see GEOM_TestHealing.py
1667 anObj = self.HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
1668 RaiseIfFailed("ProcessShape", self.HealOp)
1671 ## Remove faces from the given object (shape).
1672 # @param theObject Shape to be processed.
1673 # @param theFaces Indices of faces to be removed, if EMPTY then the method
1674 # removes ALL faces of the given object.
1675 # @return New GEOM_Object, containing processed shape.
1677 # @ref tui_suppress_faces "Example"
1678 def SuppressFaces(self,theObject, theFaces):
1679 # Example: see GEOM_TestHealing.py
1680 anObj = self.HealOp.SuppressFaces(theObject, theFaces)
1681 RaiseIfFailed("SuppressFaces", self.HealOp)
1684 ## Sewing of some shapes into single shape.
1686 # @ref tui_sewing "Example"
1687 def MakeSewing(self, ListShape, theTolerance):
1688 # Example: see GEOM_TestHealing.py
1689 comp = self.MakeCompound(ListShape)
1690 anObj = self.Sew(comp, theTolerance)
1693 ## Sewing of the given object.
1694 # @param theObject Shape to be processed.
1695 # @param theTolerance Required tolerance value.
1696 # @return New GEOM_Object, containing processed shape.
1697 def Sew(self, theObject, theTolerance):
1698 # Example: see MakeSewing() above
1699 anObj = self.HealOp.Sew(theObject, theTolerance)
1700 RaiseIfFailed("Sew", self.HealOp)
1703 ## Remove internal wires and edges from the given object (face).
1704 # @param theObject Shape to be processed.
1705 # @param theWires Indices of wires to be removed, if EMPTY then the method
1706 # removes ALL internal wires of the given object.
1707 # @return New GEOM_Object, containing processed shape.
1709 # @ref tui_suppress_internal_wires "Example"
1710 def SuppressInternalWires(self,theObject, theWires):
1711 # Example: see GEOM_TestHealing.py
1712 anObj = self.HealOp.RemoveIntWires(theObject, theWires)
1713 RaiseIfFailed("RemoveIntWires", self.HealOp)
1716 ## Remove internal closed contours (holes) from the given object.
1717 # @param theObject Shape to be processed.
1718 # @param theWires Indices of wires to be removed, if EMPTY then the method
1719 # removes ALL internal holes of the given object
1720 # @return New GEOM_Object, containing processed shape.
1722 # @ref tui_suppress_holes "Example"
1723 def SuppressHoles(self,theObject, theWires):
1724 # Example: see GEOM_TestHealing.py
1725 anObj = self.HealOp.FillHoles(theObject, theWires)
1726 RaiseIfFailed("FillHoles", self.HealOp)
1729 ## Close an open wire.
1730 # @param theObject Shape to be processed.
1731 # @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1732 # if -1, then <VAR>theObject</VAR> itself is a wire.
1733 # @param isCommonVertex If TRUE : closure by creation of a common vertex,
1734 # If FALS : closure by creation of an edge between ends.
1735 # @return New GEOM_Object, containing processed shape.
1737 # @ref tui_close_contour "Example"
1738 def CloseContour(self,theObject, theWires, isCommonVertex):
1739 # Example: see GEOM_TestHealing.py
1740 anObj = self.HealOp.CloseContour(theObject, theWires, isCommonVertex)
1741 RaiseIfFailed("CloseContour", self.HealOp)
1744 ## Addition of a point to a given edge object.
1745 # @param theObject Shape to be processed.
1746 # @param theEdgeIndex Index of edge to be divided within theObject's shape,
1747 # if -1, then theObject itself is the edge.
1748 # @param theValue Value of parameter on edge or length parameter,
1749 # depending on \a isByParameter.
1750 # @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
1751 # if FALSE : \a theValue is treated as a length parameter [0..1]
1752 # @return New GEOM_Object, containing processed shape.
1754 # @ref tui_add_point_on_edge "Example"
1755 def DivideEdge(self,theObject, theEdgeIndex, theValue, isByParameter):
1756 # Example: see GEOM_TestHealing.py
1757 anObj = self.HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
1758 RaiseIfFailed("DivideEdge", self.HealOp)
1761 ## Change orientation of the given object. Updates given shape.
1762 # @param theObject Shape to be processed.
1764 # @ref swig_todo "Example"
1765 def ChangeOrientationShell(self,theObject):
1766 theObject = self.HealOp.ChangeOrientation(theObject)
1767 RaiseIfFailed("ChangeOrientation", self.HealOp)
1770 ## Change orientation of the given object.
1771 # @param theObject Shape to be processed.
1772 # @return New GEOM_Object, containing processed shape.
1774 # @ref swig_todo "Example"
1775 def ChangeOrientationShellCopy(self,theObject):
1776 anObj = self.HealOp.ChangeOrientationCopy(theObject)
1777 RaiseIfFailed("ChangeOrientationCopy", self.HealOp)
1780 ## Get a list of wires (wrapped in GEOM_Object-s),
1781 # that constitute a free boundary of the given shape.
1782 # @param theObject Shape to get free boundary of.
1783 # @return [status, theClosedWires, theOpenWires]
1784 # status: FALSE, if an error(s) occured during the method execution.
1785 # theClosedWires: Closed wires on the free boundary of the given shape.
1786 # theOpenWires: Open wires on the free boundary of the given shape.
1788 # @ref tui_measurement_tools_page "Example"
1789 def GetFreeBoundary(self,theObject):
1790 # Example: see GEOM_TestHealing.py
1791 anObj = self.HealOp.GetFreeBoundary(theObject)
1792 RaiseIfFailed("GetFreeBoundary", self.HealOp)
1795 ## Replace coincident faces in theShape by one face.
1796 # @param theShape Initial shape.
1797 # @param theTolerance Maximum distance between faces, which can be considered as coincident.
1798 # @param doKeepNonSolids If FALSE, only solids will present in the result,
1799 # otherwise all initial shapes.
1800 # @return New GEOM_Object, containing a copy of theShape without coincident faces.
1802 # @ref tui_glue_faces "Example"
1803 def MakeGlueFaces(self, theShape, theTolerance, doKeepNonSolids=True):
1804 # Example: see GEOM_Spanner.py
1805 anObj = self.ShapesOp.MakeGlueFaces(theShape, theTolerance, doKeepNonSolids)
1807 raise RuntimeError, "MakeGlueFaces : " + self.ShapesOp.GetErrorCode()
1810 ## Find coincident faces in theShape for possible gluing.
1811 # @param theShape Initial shape.
1812 # @param theTolerance Maximum distance between faces,
1813 # which can be considered as coincident.
1816 # @ref swig_todo "Example"
1817 def GetGlueFaces(self, theShape, theTolerance):
1818 # Example: see GEOM_Spanner.py
1819 anObj = self.ShapesOp.GetGlueFaces(theShape, theTolerance)
1820 RaiseIfFailed("GetGlueFaces", self.ShapesOp)
1823 ## Replace coincident faces in theShape by one face
1824 # in compliance with given list of faces
1825 # @param theShape Initial shape.
1826 # @param theTolerance Maximum distance between faces,
1827 # which can be considered as coincident.
1828 # @param theFaces List of faces for gluing.
1829 # @param doKeepNonSolids If FALSE, only solids will present in the result,
1830 # otherwise all initial shapes.
1831 # @return New GEOM_Object, containing a copy of theShape
1832 # without some faces.
1834 # @ref swig_todo "Example"
1835 def MakeGlueFacesByList(self, theShape, theTolerance, theFaces, doKeepNonSolids=True):
1836 # Example: see GEOM_Spanner.py
1837 anObj = self.ShapesOp.MakeGlueFacesByList(theShape, theTolerance, theFaces, doKeepNonSolids)
1839 raise RuntimeError, "MakeGlueFacesByList : " + self.ShapesOp.GetErrorCode()
1845 ## @addtogroup l3_boolean Boolean Operations
1848 # -----------------------------------------------------------------------------
1849 # Boolean (Common, Cut, Fuse, Section)
1850 # -----------------------------------------------------------------------------
1852 ## Perform one of boolean operations on two given shapes.
1853 # @param theShape1 First argument for boolean operation.
1854 # @param theShape2 Second argument for boolean operation.
1855 # @param theOperation Indicates the operation to be done:
1856 # 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1857 # @return New GEOM_Object, containing the result shape.
1859 # @ref tui_fuse "Example"
1860 def MakeBoolean(self,theShape1, theShape2, theOperation):
1861 # Example: see GEOM_TestAll.py
1862 anObj = self.BoolOp.MakeBoolean(theShape1, theShape2, theOperation)
1863 RaiseIfFailed("MakeBoolean", self.BoolOp)
1866 ## Shortcut to MakeBoolean(s1, s2, 1)
1868 # @ref tui_common "Example 1"
1869 # \n @ref swig_MakeCommon "Example 2"
1870 def MakeCommon(self, s1, s2):
1871 # Example: see GEOM_TestOthers.py
1872 return self.MakeBoolean(s1, s2, 1)
1874 ## Shortcut to MakeBoolean(s1, s2, 2)
1876 # @ref tui_cut "Example 1"
1877 # \n @ref swig_MakeCommon "Example 2"
1878 def MakeCut(self, s1, s2):
1879 # Example: see GEOM_TestOthers.py
1880 return self.MakeBoolean(s1, s2, 2)
1882 ## Shortcut to MakeBoolean(s1, s2, 3)
1884 # @ref tui_fuse "Example 1"
1885 # \n @ref swig_MakeCommon "Example 2"
1886 def MakeFuse(self, s1, s2):
1887 # Example: see GEOM_TestOthers.py
1888 return self.MakeBoolean(s1, s2, 3)
1890 ## Shortcut to MakeBoolean(s1, s2, 4)
1892 # @ref tui_section "Example 1"
1893 # \n @ref swig_MakeCommon "Example 2"
1894 def MakeSection(self, s1, s2):
1895 # Example: see GEOM_TestOthers.py
1896 return self.MakeBoolean(s1, s2, 4)
1901 ## @addtogroup l3_basic_op
1904 ## Perform partition operation.
1905 # @param ListShapes Shapes to be intersected.
1906 # @param ListTools Shapes to intersect theShapes.
1907 # !!!NOTE: Each compound from ListShapes and ListTools will be exploded
1908 # in order to avoid possible intersection between shapes from
1910 # @param Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1911 # @param KeepNonlimitShapes: if this parameter == 0 - only shapes with
1912 # type <= Limit are kept in the result,
1913 # else - shapes with type > Limit are kept
1914 # also (if they exist)
1916 # After implementation new version of PartitionAlgo (October 2006)
1917 # other parameters are ignored by current functionality. They are kept
1918 # in this function only for support old versions.
1919 # Ignored parameters:
1920 # @param ListKeepInside Shapes, outside which the results will be deleted.
1921 # Each shape from theKeepInside must belong to theShapes also.
1922 # @param ListRemoveInside Shapes, inside which the results will be deleted.
1923 # Each shape from theRemoveInside must belong to theShapes also.
1924 # @param RemoveWebs If TRUE, perform Glue 3D algorithm.
1925 # @param ListMaterials Material indices for each shape. Make sence,
1926 # only if theRemoveWebs is TRUE.
1928 # @return New GEOM_Object, containing the result shapes.
1930 # @ref tui_partition "Example"
1931 def MakePartition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1932 Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[],
1933 KeepNonlimitShapes=0):
1934 # Example: see GEOM_TestAll.py
1935 anObj = self.BoolOp.MakePartition(ListShapes, ListTools,
1936 ListKeepInside, ListRemoveInside,
1937 Limit, RemoveWebs, ListMaterials,
1938 KeepNonlimitShapes);
1939 RaiseIfFailed("MakePartition", self.BoolOp)
1942 ## Perform partition operation.
1943 # This method may be useful if it is needed to make a partition for
1944 # compound contains nonintersected shapes. Performance will be better
1945 # since intersection between shapes from compound is not performed.
1947 # Description of all parameters as in previous method MakePartition()
1949 # !!!NOTE: Passed compounds (via ListShapes or via ListTools)
1950 # have to consist of nonintersecting shapes.
1952 # @return New GEOM_Object, containing the result shapes.
1954 # @ref swig_todo "Example"
1955 def MakePartitionNonSelfIntersectedShape(self, ListShapes, ListTools=[],
1956 ListKeepInside=[], ListRemoveInside=[],
1957 Limit=ShapeType["SHAPE"], RemoveWebs=0,
1958 ListMaterials=[], KeepNonlimitShapes=0):
1959 anObj = self.BoolOp.MakePartitionNonSelfIntersectedShape(ListShapes, ListTools,
1960 ListKeepInside, ListRemoveInside,
1961 Limit, RemoveWebs, ListMaterials,
1962 KeepNonlimitShapes);
1963 RaiseIfFailed("MakePartitionNonSelfIntersectedShape", self.BoolOp)
1966 ## Shortcut to MakePartition()
1968 # @ref tui_partition "Example 1"
1969 # \n @ref swig_Partition "Example 2"
1970 def Partition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1971 Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[],
1972 KeepNonlimitShapes=0):
1973 # Example: see GEOM_TestOthers.py
1974 anObj = self.MakePartition(ListShapes, ListTools,
1975 ListKeepInside, ListRemoveInside,
1976 Limit, RemoveWebs, ListMaterials,
1977 KeepNonlimitShapes);
1980 ## Perform partition of the Shape with the Plane
1981 # @param theShape Shape to be intersected.
1982 # @param thePlane Tool shape, to intersect theShape.
1983 # @return New GEOM_Object, containing the result shape.
1985 # @ref tui_partition "Example"
1986 def MakeHalfPartition(self,theShape, thePlane):
1987 # Example: see GEOM_TestAll.py
1988 anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)
1989 RaiseIfFailed("MakeHalfPartition", self.BoolOp)
1992 # end of l3_basic_op
1995 ## @addtogroup l3_transform
1998 ## Translate the given object along the vector, specified
1999 # by its end points, creating its copy before the translation.
2000 # @param theObject The object to be translated.
2001 # @param thePoint1 Start point of translation vector.
2002 # @param thePoint2 End point of translation vector.
2003 # @return New GEOM_Object, containing the translated object.
2005 # @ref tui_translation "Example 1"
2006 # \n @ref swig_MakeTranslationTwoPoints "Example 2"
2007 def MakeTranslationTwoPoints(self,theObject, thePoint1, thePoint2):
2008 # Example: see GEOM_TestAll.py
2009 anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
2010 RaiseIfFailed("TranslateTwoPointsCopy", self.TrsfOp)
2013 ## Translate the given object along the vector, specified
2014 # by its components, creating its copy before the translation.
2015 # @param theObject The object to be translated.
2016 # @param theDX,theDY,theDZ Components of translation vector.
2017 # @return New GEOM_Object, containing the translated object.
2019 # @ref tui_translation "Example"
2020 def MakeTranslation(self,theObject, theDX, theDY, theDZ):
2021 # Example: see GEOM_TestAll.py
2022 anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
2023 RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
2026 ## Translate the given object along the given vector,
2027 # creating its copy before the translation.
2028 # @param theObject The object to be translated.
2029 # @param theVector The translation vector.
2030 # @return New GEOM_Object, containing the translated object.
2032 # @ref tui_translation "Example"
2033 def MakeTranslationVector(self,theObject, theVector):
2034 # Example: see GEOM_TestAll.py
2035 anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
2036 RaiseIfFailed("TranslateVectorCopy", self.TrsfOp)
2039 ## Translate the given object along the given vector on given distance,
2040 # creating its copy before the translation.
2041 # @param theObject The object to be translated.
2042 # @param theVector The translation vector.
2043 # @param theDistance The translation distance.
2044 # @return New GEOM_Object, containing the translated object.
2046 # @ref tui_translation "Example"
2047 def MakeTranslationVectorDistance(self, theObject, theVector, theDistance):
2048 # Example: see GEOM_TestAll.py
2049 anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, 1)
2050 RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
2053 ## Rotate the given object around the given axis
2054 # on the given angle, creating its copy before the rotatation.
2055 # @param theObject The object to be rotated.
2056 # @param theAxis Rotation axis.
2057 # @param theAngle Rotation angle in radians.
2058 # @return New GEOM_Object, containing the rotated object.
2060 # @ref tui_rotation "Example"
2061 def MakeRotation(self,theObject, theAxis, theAngle):
2062 # Example: see GEOM_TestAll.py
2063 anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
2064 RaiseIfFailed("RotateCopy", self.TrsfOp)
2067 ## Rotate given object around vector perpendicular to plane
2068 # containing three points, creating its copy before the rotatation.
2069 # @param theObject The object to be rotated.
2070 # @param theCentPoint central point - the axis is the vector perpendicular to the plane
2071 # containing the three points.
2072 # @param thePoint1,thePoint2 - in a perpendicular plane of the axis.
2073 # @return New GEOM_Object, containing the rotated object.
2075 # @ref tui_rotation "Example"
2076 def MakeRotationThreePoints(self,theObject, theCentPoint, thePoint1, thePoint2):
2077 # Example: see GEOM_TestAll.py
2078 anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
2079 RaiseIfFailed("RotateThreePointsCopy", self.TrsfOp)
2082 ## Scale the given object by the factor, creating its copy before the scaling.
2083 # @param theObject The object to be scaled.
2084 # @param thePoint Center point for scaling.
2085 # Passing None for it means scaling relatively the origin of global CS.
2086 # @param theFactor Scaling factor value.
2087 # @return New GEOM_Object, containing the scaled shape.
2089 # @ref tui_scale "Example"
2090 def MakeScaleTransform(self, theObject, thePoint, theFactor):
2091 # Example: see GEOM_TestAll.py
2092 anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
2093 RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
2096 ## Scale the given object by different factors along coordinate axes,
2097 # creating its copy before the scaling.
2098 # @param theObject The object to be scaled.
2099 # @param thePoint Center point for scaling.
2100 # Passing None for it means scaling relatively the origin of global CS.
2101 # @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
2102 # @return New GEOM_Object, containing the scaled shape.
2104 # @ref swig_scale "Example"
2105 def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ):
2106 # Example: see GEOM_TestAll.py
2107 anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
2108 theFactorX, theFactorY, theFactorZ)
2109 RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
2112 ## Create an object, symmetrical
2113 # to the given one relatively the given plane.
2114 # @param theObject The object to be mirrored.
2115 # @param thePlane Plane of symmetry.
2116 # @return New GEOM_Object, containing the mirrored shape.
2118 # @ref tui_mirror "Example"
2119 def MakeMirrorByPlane(self,theObject, thePlane):
2120 # Example: see GEOM_TestAll.py
2121 anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
2122 RaiseIfFailed("MirrorPlaneCopy", self.TrsfOp)
2125 ## Create an object, symmetrical
2126 # to the given one relatively the given axis.
2127 # @param theObject The object to be mirrored.
2128 # @param theAxis Axis of symmetry.
2129 # @return New GEOM_Object, containing the mirrored shape.
2131 # @ref tui_mirror "Example"
2132 def MakeMirrorByAxis(self,theObject, theAxis):
2133 # Example: see GEOM_TestAll.py
2134 anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
2135 RaiseIfFailed("MirrorAxisCopy", self.TrsfOp)
2138 ## Create an object, symmetrical
2139 # to the given one relatively the given point.
2140 # @param theObject The object to be mirrored.
2141 # @param thePoint Point of symmetry.
2142 # @return New GEOM_Object, containing the mirrored shape.
2144 # @ref tui_mirror "Example"
2145 def MakeMirrorByPoint(self,theObject, thePoint):
2146 # Example: see GEOM_TestAll.py
2147 anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
2148 RaiseIfFailed("MirrorPointCopy", self.TrsfOp)
2151 ## Modify the Location of the given object by LCS,
2152 # creating its copy before the setting.
2153 # @param theObject The object to be displaced.
2154 # @param theStartLCS Coordinate system to perform displacement from it.
2155 # If \a theStartLCS is NULL, displacement
2156 # will be performed from global CS.
2157 # If \a theObject itself is used as \a theStartLCS,
2158 # its location will be changed to \a theEndLCS.
2159 # @param theEndLCS Coordinate system to perform displacement to it.
2160 # @return New GEOM_Object, containing the displaced shape.
2162 # @ref tui_modify_location "Example"
2163 def MakePosition(self,theObject, theStartLCS, theEndLCS):
2164 # Example: see GEOM_TestAll.py
2165 anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
2166 RaiseIfFailed("PositionShapeCopy", self.TrsfOp)
2169 ## Create new object as offset of the given one.
2170 # @param theObject The base object for the offset.
2171 # @param theOffset Offset value.
2172 # @return New GEOM_Object, containing the offset object.
2174 # @ref tui_offset "Example"
2175 def MakeOffset(self,theObject, theOffset):
2176 # Example: see GEOM_TestAll.py
2177 anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
2178 RaiseIfFailed("OffsetShapeCopy", self.TrsfOp)
2181 # -----------------------------------------------------------------------------
2183 # -----------------------------------------------------------------------------
2185 ## Translate the given object along the given vector a given number times
2186 # @param theObject The object to be translated.
2187 # @param theVector Direction of the translation.
2188 # @param theStep Distance to translate on.
2189 # @param theNbTimes Quantity of translations to be done.
2190 # @return New GEOM_Object, containing compound of all
2191 # the shapes, obtained after each translation.
2193 # @ref tui_multi_translation "Example"
2194 def MakeMultiTranslation1D(self,theObject, theVector, theStep, theNbTimes):
2195 # Example: see GEOM_TestAll.py
2196 anObj = self.TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
2197 RaiseIfFailed("MultiTranslate1D", self.TrsfOp)
2200 ## Conseqently apply two specified translations to theObject specified number of times.
2201 # @param theObject The object to be translated.
2202 # @param theVector1 Direction of the first translation.
2203 # @param theStep1 Step of the first translation.
2204 # @param theNbTimes1 Quantity of translations to be done along theVector1.
2205 # @param theVector2 Direction of the second translation.
2206 # @param theStep2 Step of the second translation.
2207 # @param theNbTimes2 Quantity of translations to be done along theVector2.
2208 # @return New GEOM_Object, containing compound of all
2209 # the shapes, obtained after each translation.
2211 # @ref tui_multi_translation "Example"
2212 def MakeMultiTranslation2D(self,theObject, theVector1, theStep1, theNbTimes1,
2213 theVector2, theStep2, theNbTimes2):
2214 # Example: see GEOM_TestAll.py
2215 anObj = self.TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
2216 theVector2, theStep2, theNbTimes2)
2217 RaiseIfFailed("MultiTranslate2D", self.TrsfOp)
2220 ## Rotate the given object around the given axis a given number times.
2221 # Rotation angle will be 2*PI/theNbTimes.
2222 # @param theObject The object to be rotated.
2223 # @param theAxis The rotation axis.
2224 # @param theNbTimes Quantity of rotations to be done.
2225 # @return New GEOM_Object, containing compound of all the
2226 # shapes, obtained after each rotation.
2228 # @ref tui_multi_rotation "Example"
2229 def MultiRotate1D(self,theObject, theAxis, theNbTimes):
2230 # Example: see GEOM_TestAll.py
2231 anObj = self.TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
2232 RaiseIfFailed("MultiRotate1D", self.TrsfOp)
2235 ## Rotate the given object around the
2236 # given axis on the given angle a given number
2237 # times and multi-translate each rotation result.
2238 # Translation direction passes through center of gravity
2239 # of rotated shape and its projection on the rotation axis.
2240 # @param theObject The object to be rotated.
2241 # @param theAxis Rotation axis.
2242 # @param theAngle Rotation angle in graduces.
2243 # @param theNbTimes1 Quantity of rotations to be done.
2244 # @param theStep Translation distance.
2245 # @param theNbTimes2 Quantity of translations to be done.
2246 # @return New GEOM_Object, containing compound of all the
2247 # shapes, obtained after each transformation.
2249 # @ref tui_multi_rotation "Example"
2250 def MultiRotate2D(self,theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2):
2251 # Example: see GEOM_TestAll.py
2252 anObj = self.TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
2253 RaiseIfFailed("MultiRotate2D", self.TrsfOp)
2256 ## The same, as MultiRotate1D(), but axis is given by direction and point
2257 # @ref swig_MakeMultiRotation "Example"
2258 def MakeMultiRotation1D(self,aShape,aDir,aPoint,aNbTimes):
2259 # Example: see GEOM_TestOthers.py
2260 aVec = self.MakeLine(aPoint,aDir)
2261 anObj = self.MultiRotate1D(aShape,aVec,aNbTimes)
2264 ## The same, as MultiRotate2D(), but axis is given by direction and point
2265 # @ref swig_MakeMultiRotation "Example"
2266 def MakeMultiRotation2D(self,aShape,aDir,aPoint,anAngle,nbtimes1,aStep,nbtimes2):
2267 # Example: see GEOM_TestOthers.py
2268 aVec = self.MakeLine(aPoint,aDir)
2269 anObj = self.MultiRotate2D(aShape,aVec,anAngle,nbtimes1,aStep,nbtimes2)
2272 # end of l3_transform
2275 ## @addtogroup l3_local
2278 ## Perform a fillet on all edges of the given shape.
2279 # @param theShape Shape, to perform fillet on.
2280 # @param theR Fillet radius.
2281 # @return New GEOM_Object, containing the result shape.
2283 # @ref tui_fillet "Example 1"
2284 # \n @ref swig_MakeFilletAll "Example 2"
2285 def MakeFilletAll(self,theShape, theR):
2286 # Example: see GEOM_TestOthers.py
2287 anObj = self.LocalOp.MakeFilletAll(theShape, theR)
2288 RaiseIfFailed("MakeFilletAll", self.LocalOp)
2291 ## Perform a fillet on the specified edges/faces of the given shape
2292 # @param theShape Shape, to perform fillet on.
2293 # @param theR Fillet radius.
2294 # @param theShapeType Type of shapes in <VAR>theListShapes</VAR>.
2295 # @param theListShapes Global indices of edges/faces to perform fillet on.
2296 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
2297 # @return New GEOM_Object, containing the result shape.
2299 # @ref tui_fillet "Example"
2300 def MakeFillet(self,theShape, theR, theShapeType, theListShapes):
2301 # Example: see GEOM_TestAll.py
2303 if theShapeType == ShapeType["EDGE"]:
2304 anObj = self.LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
2305 RaiseIfFailed("MakeFilletEdges", self.LocalOp)
2307 anObj = self.LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
2308 RaiseIfFailed("MakeFilletFaces", self.LocalOp)
2311 ## The same that MakeFillet but with two Fillet Radius R1 and R2
2312 def MakeFilletR1R2(self, theShape, theR1, theR2, theShapeType, theListShapes):
2314 if theShapeType == ShapeType["EDGE"]:
2315 anObj = self.LocalOp.MakeFilletEdgesR1R2(theShape, theR1, theR2, theListShapes)
2316 RaiseIfFailed("MakeFilletEdgesR1R2", self.LocalOp)
2318 anObj = self.LocalOp.MakeFilletFacesR1R2(theShape, theR1, theR2, theListShapes)
2319 RaiseIfFailed("MakeFilletFacesR1R2", self.LocalOp)
2322 ## Perform a symmetric chamfer on all edges of the given shape.
2323 # @param theShape Shape, to perform chamfer on.
2324 # @param theD Chamfer size along each face.
2325 # @return New GEOM_Object, containing the result shape.
2327 # @ref tui_chamfer "Example 1"
2328 # \n @ref swig_MakeChamferAll "Example 2"
2329 def MakeChamferAll(self,theShape, theD):
2330 # Example: see GEOM_TestOthers.py
2331 anObj = self.LocalOp.MakeChamferAll(theShape, theD)
2332 RaiseIfFailed("MakeChamferAll", self.LocalOp)
2335 ## Perform a chamfer on edges, common to the specified faces,
2336 # with distance D1 on the Face1
2337 # @param theShape Shape, to perform chamfer on.
2338 # @param theD1 Chamfer size along \a theFace1.
2339 # @param theD2 Chamfer size along \a theFace2.
2340 # @param theFace1,theFace2 Global indices of two faces of \a theShape.
2341 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
2342 # @return New GEOM_Object, containing the result shape.
2344 # @ref tui_chamfer "Example"
2345 def MakeChamferEdge(self,theShape, theD1, theD2, theFace1, theFace2):
2346 # Example: see GEOM_TestAll.py
2347 anObj = self.LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
2348 RaiseIfFailed("MakeChamferEdge", self.LocalOp)
2351 ## The Same that MakeChamferEdge but with params theD is chamfer length and
2352 # theAngle is Angle of chamfer (angle in radians)
2353 def MakeChamferEdgeAD(self, theShape, theD, theAngle, theFace1, theFace2):
2354 anObj = self.LocalOp.MakeChamferEdgeAD(theShape, theD, theAngle, theFace1, theFace2)
2355 RaiseIfFailed("MakeChamferEdgeAD", self.LocalOp)
2358 ## Perform a chamfer on all edges of the specified faces,
2359 # with distance D1 on the first specified face (if several for one edge)
2360 # @param theShape Shape, to perform chamfer on.
2361 # @param theD1 Chamfer size along face from \a theFaces. If both faces,
2362 # connected to the edge, are in \a theFaces, \a theD1
2363 # will be get along face, which is nearer to \a theFaces beginning.
2364 # @param theD2 Chamfer size along another of two faces, connected to the edge.
2365 # @param theFaces Sequence of global indices of faces of \a theShape.
2366 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
2367 # @return New GEOM_Object, containing the result shape.
2369 # @ref tui_chamfer "Example"
2370 def MakeChamferFaces(self,theShape, theD1, theD2, theFaces):
2371 # Example: see GEOM_TestAll.py
2372 anObj = self.LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
2373 RaiseIfFailed("MakeChamferFaces", self.LocalOp)
2376 ## The Same that MakeChamferFaces but with params theD is chamfer lenght and
2377 # theAngle is Angle of chamfer (angle in radians)
2379 # @ref swig_FilletChamfer "Example"
2380 def MakeChamferFacesAD(self, theShape, theD, theAngle, theFaces):
2381 anObj = self.LocalOp.MakeChamferFacesAD(theShape, theD, theAngle, theFaces)
2382 RaiseIfFailed("MakeChamferFacesAD", self.LocalOp)
2385 ## Perform a chamfer on edges,
2386 # with distance D1 on the first specified face (if several for one edge)
2387 # @param theShape Shape, to perform chamfer on.
2388 # @param theD1,theD2 Chamfer size
2389 # @param theEdges Sequence of edges of \a theShape.
2390 # @return New GEOM_Object, containing the result shape.
2392 # @ref swig_FilletChamfer "Example"
2393 def MakeChamferEdges(self, theShape, theD1, theD2, theEdges):
2394 anObj = self.LocalOp.MakeChamferEdges(theShape, theD1, theD2, theEdges)
2395 RaiseIfFailed("MakeChamferEdges", self.LocalOp)
2398 ## The Same that MakeChamferEdges but with params theD is chamfer lenght and
2399 # theAngle is Angle of chamfer (angle in radians)
2400 def MakeChamferEdgesAD(self, theShape, theD, theAngle, theEdges):
2401 anObj = self.LocalOp.MakeChamferEdgesAD(theShape, theD, theAngle, theEdges)
2402 RaiseIfFailed("MakeChamferEdgesAD", self.LocalOp)
2405 ## Shortcut to MakeChamferEdge() and MakeChamferFaces()
2407 # @ref swig_MakeChamfer "Example"
2408 def MakeChamfer(self,aShape,d1,d2,aShapeType,ListShape):
2409 # Example: see GEOM_TestOthers.py
2411 if aShapeType == ShapeType["EDGE"]:
2412 anObj = self.MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1])
2414 anObj = self.MakeChamferFaces(aShape,d1,d2,ListShape)
2420 ## @addtogroup l3_basic_op
2423 ## Perform an Archimde operation on the given shape with given parameters.
2424 # The object presenting the resulting face is returned.
2425 # @param theShape Shape to be put in water.
2426 # @param theWeight Weight og the shape.
2427 # @param theWaterDensity Density of the water.
2428 # @param theMeshDeflection Deflection of the mesh, using to compute the section.
2429 # @return New GEOM_Object, containing a section of \a theShape
2430 # by a plane, corresponding to water level.
2432 # @ref tui_archimede "Example"
2433 def Archimede(self,theShape, theWeight, theWaterDensity, theMeshDeflection):
2434 # Example: see GEOM_TestAll.py
2435 anObj = self.LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
2436 RaiseIfFailed("MakeArchimede", self.LocalOp)
2439 # end of l3_basic_op
2442 ## @addtogroup l2_measure
2445 ## Get point coordinates
2448 # @ref tui_measurement_tools_page "Example"
2449 def PointCoordinates(self,Point):
2450 # Example: see GEOM_TestMeasures.py
2451 aTuple = self.MeasuOp.PointCoordinates(Point)
2452 RaiseIfFailed("PointCoordinates", self.MeasuOp)
2455 ## Get summarized length of all wires,
2456 # area of surface and volume of the given shape.
2457 # @param theShape Shape to define properties of.
2458 # @return [theLength, theSurfArea, theVolume]
2459 # theLength: Summarized length of all wires of the given shape.
2460 # theSurfArea: Area of surface of the given shape.
2461 # theVolume: Volume of the given shape.
2463 # @ref tui_measurement_tools_page "Example"
2464 def BasicProperties(self,theShape):
2465 # Example: see GEOM_TestMeasures.py
2466 aTuple = self.MeasuOp.GetBasicProperties(theShape)
2467 RaiseIfFailed("GetBasicProperties", self.MeasuOp)
2470 ## Get parameters of bounding box of the given shape
2471 # @param theShape Shape to obtain bounding box of.
2472 # @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
2473 # Xmin,Xmax: Limits of shape along OX axis.
2474 # Ymin,Ymax: Limits of shape along OY axis.
2475 # Zmin,Zmax: Limits of shape along OZ axis.
2477 # @ref tui_measurement_tools_page "Example"
2478 def BoundingBox(self,theShape):
2479 # Example: see GEOM_TestMeasures.py
2480 aTuple = self.MeasuOp.GetBoundingBox(theShape)
2481 RaiseIfFailed("GetBoundingBox", self.MeasuOp)
2484 ## Get inertia matrix and moments of inertia of theShape.
2485 # @param theShape Shape to calculate inertia of.
2486 # @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
2487 # I(1-3)(1-3): Components of the inertia matrix of the given shape.
2488 # Ix,Iy,Iz: Moments of inertia of the given shape.
2490 # @ref tui_measurement_tools_page "Example"
2491 def Inertia(self,theShape):
2492 # Example: see GEOM_TestMeasures.py
2493 aTuple = self.MeasuOp.GetInertia(theShape)
2494 RaiseIfFailed("GetInertia", self.MeasuOp)
2497 ## Get minimal distance between the given shapes.
2498 # @param theShape1,theShape2 Shapes to find minimal distance between.
2499 # @return Value of the minimal distance between the given shapes.
2501 # @ref tui_measurement_tools_page "Example"
2502 def MinDistance(self, theShape1, theShape2):
2503 # Example: see GEOM_TestMeasures.py
2504 aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
2505 RaiseIfFailed("GetMinDistance", self.MeasuOp)
2508 ## Get minimal distance between the given shapes.
2509 # @param theShape1,theShape2 Shapes to find minimal distance between.
2510 # @return Value of the minimal distance between the given shapes.
2512 # @ref swig_all_measure "Example"
2513 def MinDistanceComponents(self, theShape1, theShape2):
2514 # Example: see GEOM_TestMeasures.py
2515 aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
2516 RaiseIfFailed("GetMinDistance", self.MeasuOp)
2517 aRes = [aTuple[0], aTuple[4] - aTuple[1], aTuple[5] - aTuple[2], aTuple[6] - aTuple[3]]
2520 ## Get angle between the given shapes in degrees.
2521 # @param theShape1,theShape2 Lines or linear edges to find angle between.
2522 # @return Value of the angle between the given shapes in degrees.
2524 # @ref tui_measurement_tools_page "Example"
2525 def GetAngle(self, theShape1, theShape2):
2526 # Example: see GEOM_TestMeasures.py
2527 anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
2528 RaiseIfFailed("GetAngle", self.MeasuOp)
2530 ## Get angle between the given shapes in radians.
2531 # @param theShape1,theShape2 Lines or linear edges to find angle between.
2532 # @return Value of the angle between the given shapes in radians.
2534 # @ref tui_measurement_tools_page "Example"
2535 def GetAngleRadians(self, theShape1, theShape2):
2536 # Example: see GEOM_TestMeasures.py
2537 anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)*math.pi/180.
2538 RaiseIfFailed("GetAngle", self.MeasuOp)
2541 ## @name Curve Curvature Measurement
2542 # Methods for receiving radius of curvature of curves
2543 # in the given point
2546 ## Measure curvature of a curve at a point, set by parameter.
2547 # @ref swig_todo "Example"
2548 def CurveCurvatureByParam(self, theCurve, theParam):
2549 # Example: see GEOM_TestMeasures.py
2550 aCurv = self.MeasuOp.CurveCurvatureByParam(theCurve,theParam)
2551 RaiseIfFailed("CurveCurvatureByParam", self.MeasuOp)
2555 # @ref swig_todo "Example"
2556 def CurveCurvatureByPoint(self, theCurve, thePoint):
2557 aCurv = self.MeasuOp.CurveCurvatureByPoint(theCurve,thePoint)
2558 RaiseIfFailed("CurveCurvatureByPoint", self.MeasuOp)
2562 ## @name Surface Curvature Measurement
2563 # Methods for receiving max and min radius of curvature of surfaces
2564 # in the given point
2568 ## @ref swig_todo "Example"
2569 def MaxSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
2570 # Example: see GEOM_TestMeasures.py
2571 aSurf = self.MeasuOp.MaxSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
2572 RaiseIfFailed("MaxSurfaceCurvatureByParam", self.MeasuOp)
2576 ## @ref swig_todo "Example"
2577 def MaxSurfaceCurvatureByPoint(self, theSurf, thePoint):
2578 aSurf = self.MeasuOp.MaxSurfaceCurvatureByPoint(theSurf,thePoint)
2579 RaiseIfFailed("MaxSurfaceCurvatureByPoint", self.MeasuOp)
2583 ## @ref swig_todo "Example"
2584 def MinSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
2585 aSurf = self.MeasuOp.MinSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
2586 RaiseIfFailed("MinSurfaceCurvatureByParam", self.MeasuOp)
2590 ## @ref swig_todo "Example"
2591 def MinSurfaceCurvatureByPoint(self, theSurf, thePoint):
2592 aSurf = self.MeasuOp.MinSurfaceCurvatureByPoint(theSurf,thePoint)
2593 RaiseIfFailed("MinSurfaceCurvatureByPoint", self.MeasuOp)
2597 ## Get min and max tolerances of sub-shapes of theShape
2598 # @param theShape Shape, to get tolerances of.
2599 # @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
2600 # FaceMin,FaceMax: Min and max tolerances of the faces.
2601 # EdgeMin,EdgeMax: Min and max tolerances of the edges.
2602 # VertMin,VertMax: Min and max tolerances of the vertices.
2604 # @ref tui_measurement_tools_page "Example"
2605 def Tolerance(self,theShape):
2606 # Example: see GEOM_TestMeasures.py
2607 aTuple = self.MeasuOp.GetTolerance(theShape)
2608 RaiseIfFailed("GetTolerance", self.MeasuOp)
2611 ## Obtain description of the given shape (number of sub-shapes of each type)
2612 # @param theShape Shape to be described.
2613 # @return Description of the given shape.
2615 # @ref tui_measurement_tools_page "Example"
2616 def WhatIs(self,theShape):
2617 # Example: see GEOM_TestMeasures.py
2618 aDescr = self.MeasuOp.WhatIs(theShape)
2619 RaiseIfFailed("WhatIs", self.MeasuOp)
2622 ## Get a point, situated at the centre of mass of theShape.
2623 # @param theShape Shape to define centre of mass of.
2624 # @return New GEOM_Object, containing the created point.
2626 # @ref tui_measurement_tools_page "Example"
2627 def MakeCDG(self,theShape):
2628 # Example: see GEOM_TestMeasures.py
2629 anObj = self.MeasuOp.GetCentreOfMass(theShape)
2630 RaiseIfFailed("GetCentreOfMass", self.MeasuOp)
2633 ## Get a normale to the given face. If the point is not given,
2634 # the normale is calculated at the center of mass.
2635 # @param theFace Face to define normale of.
2636 # @param theOptionalPoint Point to compute the normale at.
2637 # @return New GEOM_Object, containing the created vector.
2639 # @ref swig_todo "Example"
2640 def GetNormal(self, theFace, theOptionalPoint = None):
2641 # Example: see GEOM_TestMeasures.py
2642 anObj = self.MeasuOp.GetNormal(theFace, theOptionalPoint)
2643 RaiseIfFailed("GetNormal", self.MeasuOp)
2646 ## Check a topology of the given shape.
2647 # @param theShape Shape to check validity of.
2648 # @param theIsCheckGeom If FALSE, only the shape's topology will be checked,
2649 # if TRUE, the shape's geometry will be checked also.
2650 # @return TRUE, if the shape "seems to be valid".
2651 # If theShape is invalid, prints a description of problem.
2653 # @ref tui_measurement_tools_page "Example"
2654 def CheckShape(self,theShape, theIsCheckGeom = 0):
2655 # Example: see GEOM_TestMeasures.py
2657 (IsValid, Status) = self.MeasuOp.CheckShapeWithGeometry(theShape)
2658 RaiseIfFailed("CheckShapeWithGeometry", self.MeasuOp)
2660 (IsValid, Status) = self.MeasuOp.CheckShape(theShape)
2661 RaiseIfFailed("CheckShape", self.MeasuOp)
2666 ## Get position (LCS) of theShape.
2668 # Origin of the LCS is situated at the shape's center of mass.
2669 # Axes of the LCS are obtained from shape's location or,
2670 # if the shape is a planar face, from position of its plane.
2672 # @param theShape Shape to calculate position of.
2673 # @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
2674 # Ox,Oy,Oz: Coordinates of shape's LCS origin.
2675 # Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
2676 # Xx,Xy,Xz: Coordinates of shape's LCS X direction.
2678 # @ref swig_todo "Example"
2679 def GetPosition(self,theShape):
2680 # Example: see GEOM_TestMeasures.py
2681 aTuple = self.MeasuOp.GetPosition(theShape)
2682 RaiseIfFailed("GetPosition", self.MeasuOp)
2685 ## Get kind of theShape.
2687 # @param theShape Shape to get a kind of.
2688 # @return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration
2689 # and a list of parameters, describing the shape.
2690 # @note Concrete meaning of each value, returned via \a theIntegers
2691 # or \a theDoubles list depends on the kind of the shape.
2692 # The full list of possible outputs is:
2694 # - geompy.kind.COMPOUND nb_solids nb_faces nb_edges nb_vertices
2695 # - geompy.kind.COMPSOLID nb_solids nb_faces nb_edges nb_vertices
2697 # - geompy.kind.SHELL geompy.info.CLOSED nb_faces nb_edges nb_vertices
2698 # - geompy.kind.SHELL geompy.info.UNCLOSED nb_faces nb_edges nb_vertices
2700 # - geompy.kind.WIRE geompy.info.CLOSED nb_edges nb_vertices
2701 # - geompy.kind.WIRE geompy.info.UNCLOSED nb_edges nb_vertices
2703 # - geompy.kind.SPHERE xc yc zc R
2704 # - geompy.kind.CYLINDER xb yb zb dx dy dz R H
2705 # - geompy.kind.BOX xc yc zc ax ay az
2706 # - geompy.kind.ROTATED_BOX xc yc zc zx zy zz xx xy xz ax ay az
2707 # - geompy.kind.TORUS xc yc zc dx dy dz R_1 R_2
2708 # - geompy.kind.CONE xb yb zb dx dy dz R_1 R_2 H
2709 # - geompy.kind.POLYHEDRON nb_faces nb_edges nb_vertices
2710 # - geompy.kind.SOLID nb_faces nb_edges nb_vertices
2712 # - geompy.kind.SPHERE2D xc yc zc R
2713 # - geompy.kind.CYLINDER2D xb yb zb dx dy dz R H
2714 # - geompy.kind.TORUS2D xc yc zc dx dy dz R_1 R_2
2715 # - geompy.kind.CONE2D xc yc zc dx dy dz R_1 R_2 H
2716 # - geompy.kind.DISK_CIRCLE xc yc zc dx dy dz R
2717 # - geompy.kind.DISK_ELLIPSE xc yc zc dx dy dz R_1 R_2
2718 # - geompy.kind.POLYGON xo yo zo dx dy dz nb_edges nb_vertices
2719 # - geompy.kind.PLANE xo yo zo dx dy dz
2720 # - geompy.kind.PLANAR xo yo zo dx dy dz nb_edges nb_vertices
2721 # - geompy.kind.FACE nb_edges nb_vertices
2723 # - geompy.kind.CIRCLE xc yc zc dx dy dz R
2724 # - geompy.kind.ARC_CIRCLE xc yc zc dx dy dz R x1 y1 z1 x2 y2 z2
2725 # - geompy.kind.ELLIPSE xc yc zc dx dy dz R_1 R_2
2726 # - geompy.kind.ARC_ELLIPSE xc yc zc dx dy dz R_1 R_2 x1 y1 z1 x2 y2 z2
2727 # - geompy.kind.LINE xo yo zo dx dy dz
2728 # - geompy.kind.SEGMENT x1 y1 z1 x2 y2 z2
2729 # - geompy.kind.EDGE nb_vertices
2731 # - geompy.kind.VERTEX x y z
2733 # @ref swig_todo "Example"
2734 def KindOfShape(self,theShape):
2735 # Example: see GEOM_TestMeasures.py
2736 aRoughTuple = self.MeasuOp.KindOfShape(theShape)
2737 RaiseIfFailed("KindOfShape", self.MeasuOp)
2739 aKind = aRoughTuple[0]
2740 anInts = aRoughTuple[1]
2741 aDbls = aRoughTuple[2]
2743 # Now there is no exception from this rule:
2744 aKindTuple = [aKind] + aDbls + anInts
2746 # If they are we will regroup parameters for such kind of shape.
2748 #if aKind == kind.SOME_KIND:
2749 # # SOME_KIND int int double int double double
2750 # aKindTuple = [aKind, anInts[0], anInts[1], aDbls[0], anInts[2], aDbls[1], aDbls[2]]
2757 ## @addtogroup l2_import_export
2760 ## Import a shape from the BREP or IGES or STEP file
2761 # (depends on given format) with given name.
2762 # @param theFileName The file, containing the shape.
2763 # @param theFormatName Specify format for the file reading.
2764 # Available formats can be obtained with InsertOp.ImportTranslators() method.
2765 # @return New GEOM_Object, containing the imported shape.
2767 # @ref swig_Import_Export "Example"
2768 def Import(self,theFileName, theFormatName):
2769 # Example: see GEOM_TestOthers.py
2770 anObj = self.InsertOp.Import(theFileName, theFormatName)
2771 RaiseIfFailed("Import", self.InsertOp)
2774 ## Shortcut to Import() for BREP format
2776 # @ref swig_Import_Export "Example"
2777 def ImportBREP(self,theFileName):
2778 # Example: see GEOM_TestOthers.py
2779 return self.Import(theFileName, "BREP")
2781 ## Shortcut to Import() for IGES format
2783 # @ref swig_Import_Export "Example"
2784 def ImportIGES(self,theFileName):
2785 # Example: see GEOM_TestOthers.py
2786 return self.Import(theFileName, "IGES")
2788 ## Shortcut to Import() for STEP format
2790 # @ref swig_Import_Export "Example"
2791 def ImportSTEP(self,theFileName):
2792 # Example: see GEOM_TestOthers.py
2793 return self.Import(theFileName, "STEP")
2795 ## Export the given shape into a file with given name.
2796 # @param theObject Shape to be stored in the file.
2797 # @param theFileName Name of the file to store the given shape in.
2798 # @param theFormatName Specify format for the shape storage.
2799 # Available formats can be obtained with InsertOp.ImportTranslators() method.
2801 # @ref swig_Import_Export "Example"
2802 def Export(self,theObject, theFileName, theFormatName):
2803 # Example: see GEOM_TestOthers.py
2804 self.InsertOp.Export(theObject, theFileName, theFormatName)
2805 if self.InsertOp.IsDone() == 0:
2806 raise RuntimeError, "Export : " + self.InsertOp.GetErrorCode()
2810 ## Shortcut to Export() for BREP format
2812 # @ref swig_Import_Export "Example"
2813 def ExportBREP(self,theObject, theFileName):
2814 # Example: see GEOM_TestOthers.py
2815 return self.Export(theObject, theFileName, "BREP")
2817 ## Shortcut to Export() for IGES format
2819 # @ref swig_Import_Export "Example"
2820 def ExportIGES(self,theObject, theFileName):
2821 # Example: see GEOM_TestOthers.py
2822 return self.Export(theObject, theFileName, "IGES")
2824 ## Shortcut to Export() for STEP format
2826 # @ref swig_Import_Export "Example"
2827 def ExportSTEP(self,theObject, theFileName):
2828 # Example: see GEOM_TestOthers.py
2829 return self.Export(theObject, theFileName, "STEP")
2831 # end of l2_import_export
2834 ## @addtogroup l3_blocks
2837 ## Create a quadrangle face from four edges. Order of Edges is not
2838 # important. It is not necessary that edges share the same vertex.
2839 # @param E1,E2,E3,E4 Edges for the face bound.
2840 # @return New GEOM_Object, containing the created face.
2842 # @ref tui_building_by_blocks_page "Example"
2843 def MakeQuad(self,E1, E2, E3, E4):
2844 # Example: see GEOM_Spanner.py
2845 anObj = self.BlocksOp.MakeQuad(E1, E2, E3, E4)
2846 RaiseIfFailed("MakeQuad", self.BlocksOp)
2849 ## Create a quadrangle face on two edges.
2850 # The missing edges will be built by creating the shortest ones.
2851 # @param E1,E2 Two opposite edges for the face.
2852 # @return New GEOM_Object, containing the created face.
2854 # @ref tui_building_by_blocks_page "Example"
2855 def MakeQuad2Edges(self,E1, E2):
2856 # Example: see GEOM_Spanner.py
2857 anObj = self.BlocksOp.MakeQuad2Edges(E1, E2)
2858 RaiseIfFailed("MakeQuad2Edges", self.BlocksOp)
2861 ## Create a quadrangle face with specified corners.
2862 # The missing edges will be built by creating the shortest ones.
2863 # @param V1,V2,V3,V4 Corner vertices for the face.
2864 # @return New GEOM_Object, containing the created face.
2866 # @ref tui_building_by_blocks_page "Example 1"
2867 # \n @ref swig_MakeQuad4Vertices "Example 2"
2868 def MakeQuad4Vertices(self,V1, V2, V3, V4):
2869 # Example: see GEOM_Spanner.py
2870 anObj = self.BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
2871 RaiseIfFailed("MakeQuad4Vertices", self.BlocksOp)
2874 ## Create a hexahedral solid, bounded by the six given faces. Order of
2875 # faces is not important. It is not necessary that Faces share the same edge.
2876 # @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
2877 # @return New GEOM_Object, containing the created solid.
2879 # @ref tui_building_by_blocks_page "Example 1"
2880 # \n @ref swig_MakeHexa "Example 2"
2881 def MakeHexa(self,F1, F2, F3, F4, F5, F6):
2882 # Example: see GEOM_Spanner.py
2883 anObj = self.BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
2884 RaiseIfFailed("MakeHexa", self.BlocksOp)
2887 ## Create a hexahedral solid between two given faces.
2888 # The missing faces will be built by creating the smallest ones.
2889 # @param F1,F2 Two opposite faces for the hexahedral solid.
2890 # @return New GEOM_Object, containing the created solid.
2892 # @ref tui_building_by_blocks_page "Example 1"
2893 # \n @ref swig_MakeHexa2Faces "Example 2"
2894 def MakeHexa2Faces(self,F1, F2):
2895 # Example: see GEOM_Spanner.py
2896 anObj = self.BlocksOp.MakeHexa2Faces(F1, F2)
2897 RaiseIfFailed("MakeHexa2Faces", self.BlocksOp)
2903 ## @addtogroup l3_blocks_op
2906 ## Get a vertex, found in the given shape by its coordinates.
2907 # @param theShape Block or a compound of blocks.
2908 # @param theX,theY,theZ Coordinates of the sought vertex.
2909 # @param theEpsilon Maximum allowed distance between the resulting
2910 # vertex and point with the given coordinates.
2911 # @return New GEOM_Object, containing the found vertex.
2913 # @ref swig_GetPoint "Example"
2914 def GetPoint(self,theShape, theX, theY, theZ, theEpsilon):
2915 # Example: see GEOM_TestOthers.py
2916 anObj = self.BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
2917 RaiseIfFailed("GetPoint", self.BlocksOp)
2920 ## Get an edge, found in the given shape by two given vertices.
2921 # @param theShape Block or a compound of blocks.
2922 # @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2923 # @return New GEOM_Object, containing the found edge.
2925 # @ref swig_todo "Example"
2926 def GetEdge(self,theShape, thePoint1, thePoint2):
2927 # Example: see GEOM_Spanner.py
2928 anObj = self.BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
2929 RaiseIfFailed("GetEdge", self.BlocksOp)
2932 ## Find an edge of the given shape, which has minimal distance to the given point.
2933 # @param theShape Block or a compound of blocks.
2934 # @param thePoint Point, close to the desired edge.
2935 # @return New GEOM_Object, containing the found edge.
2937 # @ref swig_GetEdgeNearPoint "Example"
2938 def GetEdgeNearPoint(self,theShape, thePoint):
2939 # Example: see GEOM_TestOthers.py
2940 anObj = self.BlocksOp.GetEdgeNearPoint(theShape, thePoint)
2941 RaiseIfFailed("GetEdgeNearPoint", self.BlocksOp)
2944 ## Returns a face, found in the given shape by four given corner vertices.
2945 # @param theShape Block or a compound of blocks.
2946 # @param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2947 # @return New GEOM_Object, containing the found face.
2949 # @ref swig_todo "Example"
2950 def GetFaceByPoints(self,theShape, thePoint1, thePoint2, thePoint3, thePoint4):
2951 # Example: see GEOM_Spanner.py
2952 anObj = self.BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
2953 RaiseIfFailed("GetFaceByPoints", self.BlocksOp)
2956 ## Get a face of block, found in the given shape by two given edges.
2957 # @param theShape Block or a compound of blocks.
2958 # @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2959 # @return New GEOM_Object, containing the found face.
2961 # @ref swig_todo "Example"
2962 def GetFaceByEdges(self,theShape, theEdge1, theEdge2):
2963 # Example: see GEOM_Spanner.py
2964 anObj = self.BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
2965 RaiseIfFailed("GetFaceByEdges", self.BlocksOp)
2968 ## Find a face, opposite to the given one in the given block.
2969 # @param theBlock Must be a hexahedral solid.
2970 # @param theFace Face of \a theBlock, opposite to the desired face.
2971 # @return New GEOM_Object, containing the found face.
2973 # @ref swig_GetOppositeFace "Example"
2974 def GetOppositeFace(self,theBlock, theFace):
2975 # Example: see GEOM_Spanner.py
2976 anObj = self.BlocksOp.GetOppositeFace(theBlock, theFace)
2977 RaiseIfFailed("GetOppositeFace", self.BlocksOp)
2980 ## Find a face of the given shape, which has minimal distance to the given point.
2981 # @param theShape Block or a compound of blocks.
2982 # @param thePoint Point, close to the desired face.
2983 # @return New GEOM_Object, containing the found face.
2985 # @ref swig_GetFaceNearPoint "Example"
2986 def GetFaceNearPoint(self,theShape, thePoint):
2987 # Example: see GEOM_Spanner.py
2988 anObj = self.BlocksOp.GetFaceNearPoint(theShape, thePoint)
2989 RaiseIfFailed("GetFaceNearPoint", self.BlocksOp)
2992 ## Find a face of block, whose outside normale has minimal angle with the given vector.
2993 # @param theBlock Block or a compound of blocks.
2994 # @param theVector Vector, close to the normale of the desired face.
2995 # @return New GEOM_Object, containing the found face.
2997 # @ref swig_todo "Example"
2998 def GetFaceByNormale(self, theBlock, theVector):
2999 # Example: see GEOM_Spanner.py
3000 anObj = self.BlocksOp.GetFaceByNormale(theBlock, theVector)
3001 RaiseIfFailed("GetFaceByNormale", self.BlocksOp)
3004 # end of l3_blocks_op
3007 ## @addtogroup l4_blocks_measure
3010 ## Check, if the compound of blocks is given.
3011 # To be considered as a compound of blocks, the
3012 # given shape must satisfy the following conditions:
3013 # - Each element of the compound should be a Block (6 faces and 12 edges).
3014 # - A connection between two Blocks should be an entire quadrangle face or an entire edge.
3015 # - The compound should be connexe.
3016 # - The glue between two quadrangle faces should be applied.
3017 # @param theCompound The compound to check.
3018 # @return TRUE, if the given shape is a compound of blocks.
3019 # If theCompound is not valid, prints all discovered errors.
3021 # @ref tui_measurement_tools_page "Example 1"
3022 # \n @ref swig_CheckCompoundOfBlocks "Example 2"
3023 def CheckCompoundOfBlocks(self,theCompound):
3024 # Example: see GEOM_Spanner.py
3025 (IsValid, BCErrors) = self.BlocksOp.CheckCompoundOfBlocks(theCompound)
3026 RaiseIfFailed("CheckCompoundOfBlocks", self.BlocksOp)
3028 Descr = self.BlocksOp.PrintBCErrors(theCompound, BCErrors)
3032 ## Remove all seam and degenerated edges from \a theShape.
3033 # Unite faces and edges, sharing one surface. It means that
3034 # this faces must have references to one C++ surface object (handle).
3035 # @param theShape The compound or single solid to remove irregular edges from.
3036 # @return Improved shape.
3038 # @ref swig_RemoveExtraEdges "Example"
3039 def RemoveExtraEdges(self,theShape):
3040 # Example: see GEOM_TestOthers.py
3041 anObj = self.BlocksOp.RemoveExtraEdges(theShape)
3042 RaiseIfFailed("RemoveExtraEdges", self.BlocksOp)
3045 ## Check, if the given shape is a blocks compound.
3046 # Fix all detected errors.
3047 # \note Single block can be also fixed by this method.
3048 # @param theShape The compound to check and improve.
3049 # @return Improved compound.
3051 # @ref swig_CheckAndImprove "Example"
3052 def CheckAndImprove(self,theShape):
3053 # Example: see GEOM_TestOthers.py
3054 anObj = self.BlocksOp.CheckAndImprove(theShape)
3055 RaiseIfFailed("CheckAndImprove", self.BlocksOp)
3058 # end of l4_blocks_measure
3061 ## @addtogroup l3_blocks_op
3064 ## Get all the blocks, contained in the given compound.
3065 # @param theCompound The compound to explode.
3066 # @param theMinNbFaces If solid has lower number of faces, it is not a block.
3067 # @param theMaxNbFaces If solid has higher number of faces, it is not a block.
3068 # \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
3069 # @return List of GEOM_Objects, containing the retrieved blocks.
3071 # @ref tui_explode_on_blocks "Example 1"
3072 # \n @ref swig_MakeBlockExplode "Example 2"
3073 def MakeBlockExplode(self,theCompound, theMinNbFaces, theMaxNbFaces):
3074 # Example: see GEOM_TestOthers.py
3075 aList = self.BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
3076 RaiseIfFailed("ExplodeCompoundOfBlocks", self.BlocksOp)
3079 ## Find block, containing the given point inside its volume or on boundary.
3080 # @param theCompound Compound, to find block in.
3081 # @param thePoint Point, close to the desired block. If the point lays on
3082 # boundary between some blocks, we return block with nearest center.
3083 # @return New GEOM_Object, containing the found block.
3085 # @ref swig_todo "Example"
3086 def GetBlockNearPoint(self,theCompound, thePoint):
3087 # Example: see GEOM_Spanner.py
3088 anObj = self.BlocksOp.GetBlockNearPoint(theCompound, thePoint)
3089 RaiseIfFailed("GetBlockNearPoint", self.BlocksOp)
3092 ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
3093 # @param theCompound Compound, to find block in.
3094 # @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
3095 # @return New GEOM_Object, containing the found block.
3097 # @ref swig_GetBlockByParts "Example"
3098 def GetBlockByParts(self,theCompound, theParts):
3099 # Example: see GEOM_TestOthers.py
3100 anObj = self.BlocksOp.GetBlockByParts(theCompound, theParts)
3101 RaiseIfFailed("GetBlockByParts", self.BlocksOp)
3104 ## Return all blocks, containing all the elements, passed as the parts.
3105 # @param theCompound Compound, to find blocks in.
3106 # @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
3107 # @return List of GEOM_Objects, containing the found blocks.
3109 # @ref swig_todo "Example"
3110 def GetBlocksByParts(self,theCompound, theParts):
3111 # Example: see GEOM_Spanner.py
3112 aList = self.BlocksOp.GetBlocksByParts(theCompound, theParts)
3113 RaiseIfFailed("GetBlocksByParts", self.BlocksOp)
3116 ## Multi-transformate block and glue the result.
3117 # Transformation is defined so, as to superpose direction faces.
3118 # @param Block Hexahedral solid to be multi-transformed.
3119 # @param DirFace1 ID of First direction face.
3120 # @param DirFace2 ID of Second direction face.
3121 # @param NbTimes Quantity of transformations to be done.
3122 # \note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
3123 # @return New GEOM_Object, containing the result shape.
3125 # @ref tui_multi_transformation "Example"
3126 def MakeMultiTransformation1D(self,Block, DirFace1, DirFace2, NbTimes):
3127 # Example: see GEOM_Spanner.py
3128 anObj = self.BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
3129 RaiseIfFailed("MakeMultiTransformation1D", self.BlocksOp)
3132 ## Multi-transformate block and glue the result.
3133 # @param Block Hexahedral solid to be multi-transformed.
3134 # @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
3135 # @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
3136 # @param NbTimesU,NbTimesV Quantity of transformations to be done.
3137 # @return New GEOM_Object, containing the result shape.
3139 # @ref tui_multi_transformation "Example"
3140 def MakeMultiTransformation2D(self,Block, DirFace1U, DirFace2U, NbTimesU,
3141 DirFace1V, DirFace2V, NbTimesV):
3142 # Example: see GEOM_Spanner.py
3143 anObj = self.BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
3144 DirFace1V, DirFace2V, NbTimesV)
3145 RaiseIfFailed("MakeMultiTransformation2D", self.BlocksOp)
3148 ## Build all possible propagation groups.
3149 # Propagation group is a set of all edges, opposite to one (main)
3150 # edge of this group directly or through other opposite edges.
3151 # Notion of Opposite Edge make sence only on quadrangle face.
3152 # @param theShape Shape to build propagation groups on.
3153 # @return List of GEOM_Objects, each of them is a propagation group.
3155 # @ref swig_Propagate "Example"
3156 def Propagate(self,theShape):
3157 # Example: see GEOM_TestOthers.py
3158 listChains = self.BlocksOp.Propagate(theShape)
3159 RaiseIfFailed("Propagate", self.BlocksOp)
3162 # end of l3_blocks_op
3165 ## @addtogroup l3_groups
3168 ## Creates a new group which will store sub shapes of theMainShape
3169 # @param theMainShape is a GEOM object on which the group is selected
3170 # @param theShapeType defines a shape type of the group
3171 # @return a newly created GEOM group
3173 # @ref tui_working_with_groups_page "Example 1"
3174 # \n @ref swig_CreateGroup "Example 2"
3175 def CreateGroup(self,theMainShape, theShapeType):
3176 # Example: see GEOM_TestOthers.py
3177 anObj = self.GroupOp.CreateGroup(theMainShape, theShapeType)
3178 RaiseIfFailed("CreateGroup", self.GroupOp)
3181 ## Adds a sub object with ID theSubShapeId to the group
3182 # @param theGroup is a GEOM group to which the new sub shape is added
3183 # @param theSubShapeID is a sub shape ID in the main object.
3184 # \note Use method GetSubShapeID() to get an unique ID of the sub shape
3186 # @ref tui_working_with_groups_page "Example"
3187 def AddObject(self,theGroup, theSubShapeID):
3188 # Example: see GEOM_TestOthers.py
3189 self.GroupOp.AddObject(theGroup, theSubShapeID)
3190 RaiseIfFailed("AddObject", self.GroupOp)
3193 ## Removes a sub object with ID \a theSubShapeId from the group
3194 # @param theGroup is a GEOM group from which the new sub shape is removed
3195 # @param theSubShapeID is a sub shape ID in the main object.
3196 # \note Use method GetSubShapeID() to get an unique ID of the sub shape
3198 # @ref tui_working_with_groups_page "Example"
3199 def RemoveObject(self,theGroup, theSubShapeID):
3200 # Example: see GEOM_TestOthers.py
3201 self.GroupOp.RemoveObject(theGroup, theSubShapeID)
3202 RaiseIfFailed("RemoveObject", self.GroupOp)
3205 ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3206 # @param theGroup is a GEOM group to which the new sub shapes are added.
3207 # @param theSubShapes is a list of sub shapes to be added.
3209 # @ref tui_working_with_groups_page "Example"
3210 def UnionList (self,theGroup, theSubShapes):
3211 # Example: see GEOM_TestOthers.py
3212 self.GroupOp.UnionList(theGroup, theSubShapes)
3213 RaiseIfFailed("UnionList", self.GroupOp)
3216 ## Works like the above method, but argument
3217 # theSubShapes here is a list of sub-shapes indices
3219 # @ref swig_UnionIDs "Example"
3220 def UnionIDs(self,theGroup, theSubShapes):
3221 # Example: see GEOM_TestOthers.py
3222 self.GroupOp.UnionIDs(theGroup, theSubShapes)
3223 RaiseIfFailed("UnionIDs", self.GroupOp)
3226 ## Removes from the group all the given shapes. No errors, if some shapes are not included.
3227 # @param theGroup is a GEOM group from which the sub-shapes are removed.
3228 # @param theSubShapes is a list of sub-shapes to be removed.
3230 # @ref tui_working_with_groups_page "Example"
3231 def DifferenceList (self,theGroup, theSubShapes):
3232 # Example: see GEOM_TestOthers.py
3233 self.GroupOp.DifferenceList(theGroup, theSubShapes)
3234 RaiseIfFailed("DifferenceList", self.GroupOp)
3237 ## Works like the above method, but argument
3238 # theSubShapes here is a list of sub-shapes indices
3240 # @ref swig_DifferenceIDs "Example"
3241 def DifferenceIDs(self,theGroup, theSubShapes):
3242 # Example: see GEOM_TestOthers.py
3243 self.GroupOp.DifferenceIDs(theGroup, theSubShapes)
3244 RaiseIfFailed("DifferenceIDs", self.GroupOp)
3247 ## Returns a list of sub objects ID stored in the group
3248 # @param theGroup is a GEOM group for which a list of IDs is requested
3250 # @ref swig_GetObjectIDs "Example"
3251 def GetObjectIDs(self,theGroup):
3252 # Example: see GEOM_TestOthers.py
3253 ListIDs = self.GroupOp.GetObjects(theGroup)
3254 RaiseIfFailed("GetObjects", self.GroupOp)
3257 ## Returns a type of sub objects stored in the group
3258 # @param theGroup is a GEOM group which type is returned.
3260 # @ref swig_GetType "Example"
3261 def GetType(self,theGroup):
3262 # Example: see GEOM_TestOthers.py
3263 aType = self.GroupOp.GetType(theGroup)
3264 RaiseIfFailed("GetType", self.GroupOp)
3267 ## Returns a main shape associated with the group
3268 # @param theGroup is a GEOM group for which a main shape object is requested
3269 # @return a GEOM object which is a main shape for theGroup
3271 # @ref swig_GetMainShape "Example"
3272 def GetMainShape(self,theGroup):
3273 # Example: see GEOM_TestOthers.py
3274 anObj = self.GroupOp.GetMainShape(theGroup)
3275 RaiseIfFailed("GetMainShape", self.GroupOp)
3278 ## Create group of edges of theShape, whose length is in range [min_length, max_length].
3279 # If include_min/max == 0, edges with length == min/max_length will not be included in result.
3281 # @ref swig_todo "Example"
3282 def GetEdgesByLength (self, theShape, min_length, max_length, include_min = 1, include_max = 1):
3283 edges = self.SubShapeAll(theShape, ShapeType["EDGE"])
3286 Props = self.BasicProperties(edge)
3287 if min_length <= Props[0] and Props[0] <= max_length:
3288 if (not include_min) and (min_length == Props[0]):
3291 if (not include_max) and (Props[0] == max_length):
3294 edges_in_range.append(edge)
3296 if len(edges_in_range) <= 0:
3297 print "No edges found by given criteria"
3300 group_edges = self.CreateGroup(theShape, ShapeType["EDGE"])
3301 self.UnionList(group_edges, edges_in_range)
3305 ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
3306 # If include_min/max == 0, edges with length == min/max_length will not be included in result.
3308 # @ref swig_todo "Example"
3309 def SelectEdges (self, min_length, max_length, include_min = 1, include_max = 1):
3310 nb_selected = sg.SelectedCount()
3312 print "Select a shape before calling this function, please."
3315 print "Only one shape must be selected"
3318 id_shape = sg.getSelected(0)
3319 shape = IDToObject( id_shape )
3321 group_edges = self.GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
3325 if include_min: left_str = " <= "
3326 if include_max: right_str = " <= "
3328 self.addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
3329 + left_str + "length" + right_str + `max_length`)
3331 sg.updateObjBrowser(1)
3338 ## Create a copy of the given object
3339 # @ingroup l1_geompy_auxiliary
3341 # @ref swig_all_advanced "Example"
3342 def MakeCopy(self,theOriginal):
3343 # Example: see GEOM_TestAll.py
3344 anObj = self.InsertOp.MakeCopy(theOriginal)
3345 RaiseIfFailed("MakeCopy", self.InsertOp)
3348 ## Add Path to load python scripts from
3349 # @ingroup l1_geompy_auxiliary
3350 def addPath(self,Path):
3351 if (sys.path.count(Path) < 1):
3352 sys.path.append(Path)
3355 #Register the new proxy for GEOM_Gen
3356 omniORB.registerObjref(GEOM._objref_GEOM_Gen._NP_RepositoryId, geompyDC)