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 cylinder with given base point, axis, radius and height.
684 # @param thePnt Central point of cylinder base.
685 # @param theAxis Cylinder axis.
686 # @param theR Cylinder radius.
687 # @param theH Cylinder height.
688 # @return New GEOM_Object, containing the created cylinder.
690 # @ref tui_creation_cylinder "Example"
691 def MakeCylinder(self,thePnt, theAxis, theR, theH):
692 # Example: see GEOM_TestAll.py
693 anObj = self.PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
694 RaiseIfFailed("MakeCylinderPntVecRH", self.PrimOp)
697 ## Create a cylinder with given radius and height at
698 # the origin of coordinate system. Axis of the cylinder
699 # will be collinear to the OZ axis of the coordinate system.
700 # @param theR Cylinder radius.
701 # @param theH Cylinder height.
702 # @return New GEOM_Object, containing the created cylinder.
704 # @ref tui_creation_cylinder "Example"
705 def MakeCylinderRH(self,theR, theH):
706 # Example: see GEOM_TestAll.py
707 anObj = self.PrimOp.MakeCylinderRH(theR, theH)
708 RaiseIfFailed("MakeCylinderRH", self.PrimOp)
711 ## Create a sphere with given center and radius.
712 # @param thePnt Sphere center.
713 # @param theR Sphere radius.
714 # @return New GEOM_Object, containing the created sphere.
716 # @ref tui_creation_sphere "Example"
717 def MakeSpherePntR(self, thePnt, theR):
718 # Example: see GEOM_TestAll.py
719 anObj = self.PrimOp.MakeSpherePntR(thePnt, theR)
720 RaiseIfFailed("MakeSpherePntR", self.PrimOp)
723 ## Create a sphere with given center and radius.
724 # @param x,y,z Coordinates of sphere center.
725 # @param theR Sphere radius.
726 # @return New GEOM_Object, containing the created sphere.
728 # @ref tui_creation_sphere "Example"
729 def MakeSphere(self, x, y, z, theR):
730 # Example: see GEOM_TestAll.py
731 point = self.MakeVertex(x, y, z)
732 anObj = self.MakeSpherePntR(point, theR)
735 ## Create a sphere with given radius at the origin of coordinate system.
736 # @param theR Sphere radius.
737 # @return New GEOM_Object, containing the created sphere.
739 # @ref tui_creation_sphere "Example"
740 def MakeSphereR(self, theR):
741 # Example: see GEOM_TestAll.py
742 anObj = self.PrimOp.MakeSphereR(theR)
743 RaiseIfFailed("MakeSphereR", self.PrimOp)
746 ## Create a cone with given base point, axis, height and radiuses.
747 # @param thePnt Central point of the first cone base.
748 # @param theAxis Cone axis.
749 # @param theR1 Radius of the first cone base.
750 # @param theR2 Radius of the second cone base.
751 # \note If both radiuses are non-zero, the cone will be truncated.
752 # \note If the radiuses are equal, a cylinder will be created instead.
753 # @param theH Cone height.
754 # @return New GEOM_Object, containing the created cone.
756 # @ref tui_creation_cone "Example"
757 def MakeCone(self,thePnt, theAxis, theR1, theR2, theH):
758 # Example: see GEOM_TestAll.py
759 anObj = self.PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
760 RaiseIfFailed("MakeConePntVecR1R2H", self.PrimOp)
763 ## Create a cone with given height and radiuses at
764 # the origin of coordinate system. Axis of the cone will
765 # be collinear to the OZ axis of the coordinate system.
766 # @param theR1 Radius of the first cone base.
767 # @param theR2 Radius of the second cone base.
768 # \note If both radiuses are non-zero, the cone will be truncated.
769 # \note If the radiuses are equal, a cylinder will be created instead.
770 # @param theH Cone height.
771 # @return New GEOM_Object, containing the created cone.
773 # @ref tui_creation_cone "Example"
774 def MakeConeR1R2H(self,theR1, theR2, theH):
775 # Example: see GEOM_TestAll.py
776 anObj = self.PrimOp.MakeConeR1R2H(theR1, theR2, theH)
777 RaiseIfFailed("MakeConeR1R2H", self.PrimOp)
780 ## Create a torus with given center, normal vector and radiuses.
781 # @param thePnt Torus central point.
782 # @param theVec Torus axis of symmetry.
783 # @param theRMajor Torus major radius.
784 # @param theRMinor Torus minor radius.
785 # @return New GEOM_Object, containing the created torus.
787 # @ref tui_creation_torus "Example"
788 def MakeTorus(self, thePnt, theVec, theRMajor, theRMinor):
789 # Example: see GEOM_TestAll.py
790 anObj = self.PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
791 RaiseIfFailed("MakeTorusPntVecRR", self.PrimOp)
794 ## Create a torus with given radiuses at the origin of coordinate system.
795 # @param theRMajor Torus major radius.
796 # @param theRMinor Torus minor radius.
797 # @return New GEOM_Object, containing the created torus.
799 # @ref tui_creation_torus "Example"
800 def MakeTorusRR(self, theRMajor, theRMinor):
801 # Example: see GEOM_TestAll.py
802 anObj = self.PrimOp.MakeTorusRR(theRMajor, theRMinor)
803 RaiseIfFailed("MakeTorusRR", self.PrimOp)
806 # end of l3_3d_primitives
809 ## @addtogroup l3_complex
812 ## Create a shape by extrusion of the base shape along a vector, defined by two points.
813 # @param theBase Base shape to be extruded.
814 # @param thePoint1 First end of extrusion vector.
815 # @param thePoint2 Second end of extrusion vector.
816 # @return New GEOM_Object, containing the created prism.
818 # @ref tui_creation_prism "Example"
819 def MakePrism(self, theBase, thePoint1, thePoint2):
820 # Example: see GEOM_TestAll.py
821 anObj = self.PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
822 RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
825 ## Create a shape by extrusion of the base shape along the vector,
826 # i.e. all the space, transfixed by the base shape during its translation
827 # along the vector on the given distance.
828 # @param theBase Base shape to be extruded.
829 # @param theVec Direction of extrusion.
830 # @param theH Prism dimension along theVec.
831 # @return New GEOM_Object, containing the created prism.
833 # @ref tui_creation_prism "Example"
834 def MakePrismVecH(self, theBase, theVec, theH):
835 # Example: see GEOM_TestAll.py
836 anObj = self.PrimOp.MakePrismVecH(theBase, theVec, theH)
837 RaiseIfFailed("MakePrismVecH", self.PrimOp)
840 ## Create a shape by extrusion of the base shape along the vector,
841 # i.e. all the space, transfixed by the base shape during its translation
842 # along the vector on the given distance in 2 Ways (forward/backward) .
843 # @param theBase Base shape to be extruded.
844 # @param theVec Direction of extrusion.
845 # @param theH Prism dimension along theVec in forward direction.
846 # @return New GEOM_Object, containing the created prism.
848 # @ref tui_creation_prism "Example"
849 def MakePrismVecH2Ways(self, theBase, theVec, theH):
850 # Example: see GEOM_TestAll.py
851 anObj = self.PrimOp.MakePrismVecH2Ways(theBase, theVec, theH)
852 RaiseIfFailed("MakePrismVecH2Ways", self.PrimOp)
855 ## Create a shape by revolution of the base shape around the axis
856 # on the given angle, i.e. all the space, transfixed by the base
857 # shape during its rotation around the axis on the given angle.
858 # @param theBase Base shape to be rotated.
859 # @param theAxis Rotation axis.
860 # @param theAngle Rotation angle in radians.
861 # @return New GEOM_Object, containing the created revolution.
863 # @ref tui_creation_revolution "Example"
864 def MakeRevolution(self, theBase, theAxis, theAngle):
865 # Example: see GEOM_TestAll.py
866 anObj = self.PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
867 RaiseIfFailed("MakeRevolutionAxisAngle", self.PrimOp)
870 ## The Same Revolution but in both ways forward&backward.
871 def MakeRevolution2Ways(self, theBase, theAxis, theAngle):
872 anObj = self.PrimOp.MakeRevolutionAxisAngle2Ways(theBase, theAxis, theAngle)
873 RaiseIfFailed("MakeRevolutionAxisAngle2Ways", self.PrimOp)
876 ## Create a filling from the given compound of contours.
877 # @param theShape the compound of contours
878 # @param theMinDeg a minimal degree of BSpline surface to create
879 # @param theMaxDeg a maximal degree of BSpline surface to create
880 # @param theTol2D a 2d tolerance to be reached
881 # @param theTol3D a 3d tolerance to be reached
882 # @param theNbIter a number of iteration of approximation algorithm
883 # @param isApprox if True, BSpline curves are generated in the process
884 # of surface construction. By default it is False, that means
885 # the surface is created using Besier curves. The usage of
886 # Approximation makes the algorithm work slower, but allows
887 # building the surface for rather complex cases
888 # @return New GEOM_Object, containing the created filling surface.
890 # @ref tui_creation_filling "Example"
891 def MakeFilling(self, theShape, theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter, isApprox=0):
892 # Example: see GEOM_TestAll.py
893 anObj = self.PrimOp.MakeFilling(theShape, theMinDeg, theMaxDeg,
894 theTol2D, theTol3D, theNbIter, isApprox)
895 RaiseIfFailed("MakeFilling", self.PrimOp)
898 ## Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
899 # @param theSeqSections - set of specified sections.
900 # @param theModeSolid - mode defining building solid or shell
901 # @param thePreci - precision 3D used for smoothing by default 1.e-6
902 # @param theRuled - mode defining type of the result surfaces (ruled or smoothed).
903 # @return New GEOM_Object, containing the created shell or solid.
905 # @ref swig_todo "Example"
906 def MakeThruSections(self,theSeqSections,theModeSolid,thePreci,theRuled):
907 # Example: see GEOM_TestAll.py
908 anObj = self.PrimOp.MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled)
909 RaiseIfFailed("MakeThruSections", self.PrimOp)
912 ## Create a shape by extrusion of the base shape along
913 # the path shape. The path shape can be a wire or an edge.
914 # @param theBase Base shape to be extruded.
915 # @param thePath Path shape to extrude the base shape along it.
916 # @return New GEOM_Object, containing the created pipe.
918 # @ref tui_creation_pipe "Example"
919 def MakePipe(self,theBase, thePath):
920 # Example: see GEOM_TestAll.py
921 anObj = self.PrimOp.MakePipe(theBase, thePath)
922 RaiseIfFailed("MakePipe", self.PrimOp)
925 ## Create a shape by extrusion of the profile shape along
926 # the path shape. The path shape can be a wire or an edge.
927 # the several profiles can be specified in the several locations of path.
928 # @param theSeqBases - list of Bases shape to be extruded.
929 # @param theLocations - list of locations on the path corresponding
930 # specified list of the Bases shapes. Number of locations
931 # should be equal to number of bases or list of locations can be empty.
932 # @param thePath - Path shape to extrude the base shape along it.
933 # @param theWithContact - the mode defining that the section is translated to be in
934 # contact with the spine.
935 # @param theWithCorrection - defining that the section is rotated to be
936 # orthogonal to the spine tangent in the correspondent point
937 # @return New GEOM_Object, containing the created pipe.
939 # @ref tui_creation_pipe_with_diff_sec "Example"
940 def MakePipeWithDifferentSections(self, theSeqBases,
941 theLocations, thePath,
942 theWithContact, theWithCorrection):
943 anObj = self.PrimOp.MakePipeWithDifferentSections(theSeqBases,
944 theLocations, thePath,
945 theWithContact, theWithCorrection)
946 RaiseIfFailed("MakePipeWithDifferentSections", self.PrimOp)
949 ## Create a shape by extrusion of the profile shape along
950 # the path shape. The path shape can be a wire or a edge.
951 # the several profiles can be specified in the several locations of path.
952 # @param theSeqBases - list of Bases shape to be extruded. Base shape must be
953 # shell or face. If number of faces in neighbour sections
954 # aren't coincided result solid between such sections will
955 # be created using external boundaries of this shells.
956 # @param theSeqSubBases - list of corresponding subshapes of section shapes.
957 # This list is used for searching correspondences between
958 # faces in the sections. Size of this list must be equal
959 # to size of list of base shapes.
960 # @param theLocations - list of locations on the path corresponding
961 # specified list of the Bases shapes. Number of locations
962 # should be equal to number of bases. First and last
963 # locations must be coincided with first and last vertexes
964 # of path correspondingly.
965 # @param thePath - Path shape to extrude the base shape along it.
966 # @param theWithContact - the mode defining that the section is translated to be in
967 # contact with the spine.
968 # @param theWithCorrection - defining that the section is rotated to be
969 # orthogonal to the spine tangent in the correspondent point
970 # @return New GEOM_Object, containing the created solids.
972 # @ref tui_creation_pipe_with_shell_sec "Example"
973 def MakePipeWithShellSections(self,theSeqBases, theSeqSubBases,
974 theLocations, thePath,
975 theWithContact, theWithCorrection):
976 anObj = self.PrimOp.MakePipeWithShellSections(theSeqBases, theSeqSubBases,
977 theLocations, thePath,
978 theWithContact, theWithCorrection)
979 RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
982 ## Create a shape by extrusion of the profile shape along
983 # the path shape. This function is used only for debug pipe
984 # functionality - it is a version of previous function
985 # (MakePipeWithShellSections(...)) which give a possibility to
986 # recieve information about creating pipe between each pair of
987 # sections step by step.
988 def MakePipeWithShellSectionsBySteps(self, theSeqBases, theSeqSubBases,
989 theLocations, thePath,
990 theWithContact, theWithCorrection):
992 nbsect = len(theSeqBases)
993 nbsubsect = len(theSeqSubBases)
994 #print "nbsect = ",nbsect
995 for i in range(1,nbsect):
997 tmpSeqBases = [ theSeqBases[i-1], theSeqBases[i] ]
998 tmpLocations = [ theLocations[i-1], theLocations[i] ]
1000 if nbsubsect>0: tmpSeqSubBases = [ theSeqSubBases[i-1], theSeqSubBases[i] ]
1001 anObj = self.PrimOp.MakePipeWithShellSections(tmpSeqBases, tmpSeqSubBases,
1002 tmpLocations, thePath,
1003 theWithContact, theWithCorrection)
1004 if self.PrimOp.IsDone() == 0:
1005 print "Problems with pipe creation between ",i," and ",i+1," sections"
1006 RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
1009 print "Pipe between ",i," and ",i+1," sections is OK"
1014 resc = self.MakeCompound(res)
1015 #resc = self.MakeSewing(res, 0.001)
1016 #print "resc: ",resc
1019 ## Create solids between given sections
1020 # @param theSeqBases - list of sections (shell or face).
1021 # @param theLocations - list of corresponding vertexes
1022 # @return New GEOM_Object, containing the created solids.
1024 # @ref tui_creation_pipe_without_path "Example"
1025 def MakePipeShellsWithoutPath(self, theSeqBases, theLocations):
1026 anObj = self.PrimOp.MakePipeShellsWithoutPath(theSeqBases, theLocations)
1027 RaiseIfFailed("MakePipeShellsWithoutPath", self.PrimOp)
1033 ## @addtogroup l3_advanced
1036 ## Create a linear edge with specified ends.
1037 # @param thePnt1 Point for the first end of edge.
1038 # @param thePnt2 Point for the second end of edge.
1039 # @return New GEOM_Object, containing the created edge.
1041 # @ref tui_creation_edge "Example"
1042 def MakeEdge(self,thePnt1, thePnt2):
1043 # Example: see GEOM_TestAll.py
1044 anObj = self.ShapesOp.MakeEdge(thePnt1, thePnt2)
1045 RaiseIfFailed("MakeEdge", self.ShapesOp)
1048 ## Create a wire from the set of edges and wires.
1049 # @param theEdgesAndWires List of edges and/or wires.
1050 # @return New GEOM_Object, containing the created wire.
1052 # @ref tui_creation_wire "Example"
1053 def MakeWire(self,theEdgesAndWires):
1054 # Example: see GEOM_TestAll.py
1055 anObj = self.ShapesOp.MakeWire(theEdgesAndWires)
1056 RaiseIfFailed("MakeWire", self.ShapesOp)
1059 ## Create a face on the given wire.
1060 # @param theWire closed Wire or Edge to build the face on.
1061 # @param isPlanarWanted If TRUE, only planar face will be built.
1062 # If impossible, NULL object will be returned.
1063 # @return New GEOM_Object, containing the created face.
1065 # @ref tui_creation_face "Example"
1066 def MakeFace(self,theWire, isPlanarWanted):
1067 # Example: see GEOM_TestAll.py
1068 anObj = self.ShapesOp.MakeFace(theWire, isPlanarWanted)
1069 RaiseIfFailed("MakeFace", self.ShapesOp)
1072 ## Create a face on the given wires set.
1073 # @param theWires List of closed wires or edges to build the face on.
1074 # @param isPlanarWanted If TRUE, only planar face will be built.
1075 # If impossible, NULL object will be returned.
1076 # @return New GEOM_Object, containing the created face.
1078 # @ref tui_creation_face "Example"
1079 def MakeFaceWires(self,theWires, isPlanarWanted):
1080 # Example: see GEOM_TestAll.py
1081 anObj = self.ShapesOp.MakeFaceWires(theWires, isPlanarWanted)
1082 RaiseIfFailed("MakeFaceWires", self.ShapesOp)
1085 ## Shortcut to MakeFaceWires()
1087 # @ref tui_creation_face "Example 1"
1088 # \n @ref swig_MakeFaces "Example 2"
1089 def MakeFaces(self,theWires, isPlanarWanted):
1090 # Example: see GEOM_TestOthers.py
1091 anObj = self.MakeFaceWires(theWires, isPlanarWanted)
1094 ## Create a shell from the set of faces and shells.
1095 # @param theFacesAndShells List of faces and/or shells.
1096 # @return New GEOM_Object, containing the created shell.
1098 # @ref tui_creation_shell "Example"
1099 def MakeShell(self,theFacesAndShells):
1100 # Example: see GEOM_TestAll.py
1101 anObj = self.ShapesOp.MakeShell(theFacesAndShells)
1102 RaiseIfFailed("MakeShell", self.ShapesOp)
1105 ## Create a solid, bounded by the given shells.
1106 # @param theShells Sequence of bounding shells.
1107 # @return New GEOM_Object, containing the created solid.
1109 # @ref tui_creation_solid "Example"
1110 def MakeSolid(self,theShells):
1111 # Example: see GEOM_TestAll.py
1112 anObj = self.ShapesOp.MakeSolidShells(theShells)
1113 RaiseIfFailed("MakeSolidShells", self.ShapesOp)
1116 ## Create a compound of the given shapes.
1117 # @param theShapes List of shapes to put in compound.
1118 # @return New GEOM_Object, containing the created compound.
1120 # @ref tui_creation_compound "Example"
1121 def MakeCompound(self,theShapes):
1122 # Example: see GEOM_TestAll.py
1123 anObj = self.ShapesOp.MakeCompound(theShapes)
1124 RaiseIfFailed("MakeCompound", self.ShapesOp)
1127 # end of l3_advanced
1130 ## @addtogroup l2_measure
1133 ## Gives quantity of faces in the given shape.
1134 # @param theShape Shape to count faces of.
1135 # @return Quantity of faces.
1137 # @ref swig_NumberOfFaces "Example"
1138 def NumberOfFaces(self,theShape):
1139 # Example: see GEOM_TestOthers.py
1140 nb_faces = self.ShapesOp.NumberOfFaces(theShape)
1141 RaiseIfFailed("NumberOfFaces", self.ShapesOp)
1144 ## Gives quantity of edges in the given shape.
1145 # @param theShape Shape to count edges of.
1146 # @return Quantity of edges.
1148 # @ref swig_NumberOfEdges "Example"
1149 def NumberOfEdges(self,theShape):
1150 # Example: see GEOM_TestOthers.py
1151 nb_edges = self.ShapesOp.NumberOfEdges(theShape)
1152 RaiseIfFailed("NumberOfEdges", self.ShapesOp)
1158 ## @addtogroup l3_healing
1161 ## Reverses an orientation the given shape.
1162 # @param theShape Shape to be reversed.
1163 # @return The reversed copy of theShape.
1165 # @ref swig_ChangeOrientation "Example"
1166 def ChangeOrientation(self,theShape):
1167 # Example: see GEOM_TestAll.py
1168 anObj = self.ShapesOp.ChangeOrientation(theShape)
1169 RaiseIfFailed("ChangeOrientation", self.ShapesOp)
1172 ## Shortcut to ChangeOrientation()
1174 # @ref swig_OrientationChange "Example"
1175 def OrientationChange(self,theShape):
1176 # Example: see GEOM_TestOthers.py
1177 anObj = self.ChangeOrientation(theShape)
1183 ## @addtogroup l4_obtain
1186 ## Retrieve all free faces from the given shape.
1187 # Free face is a face, which is not shared between two shells of the shape.
1188 # @param theShape Shape to find free faces in.
1189 # @return List of IDs of all free faces, contained in theShape.
1191 # @ref tui_measurement_tools_page "Example"
1192 def GetFreeFacesIDs(self,theShape):
1193 # Example: see GEOM_TestOthers.py
1194 anIDs = self.ShapesOp.GetFreeFacesIDs(theShape)
1195 RaiseIfFailed("GetFreeFacesIDs", self.ShapesOp)
1198 ## Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1199 # @param theShape1 Shape to find sub-shapes in.
1200 # @param theShape2 Shape to find shared sub-shapes with.
1201 # @param theShapeType Type of sub-shapes to be retrieved.
1202 # @return List of sub-shapes of theShape1, shared with theShape2.
1204 # @ref swig_GetSharedShapes "Example"
1205 def GetSharedShapes(self,theShape1, theShape2, theShapeType):
1206 # Example: see GEOM_TestOthers.py
1207 aList = self.ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
1208 RaiseIfFailed("GetSharedShapes", self.ShapesOp)
1211 ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
1212 # situated relatively the specified plane by the certain way,
1213 # defined through <VAR>theState</VAR> parameter.
1214 # @param theShape Shape to find sub-shapes of.
1215 # @param theShapeType Type of sub-shapes to be retrieved.
1216 # @param theAx1 Vector (or line, or linear edge), specifying normal
1217 # direction and location of the plane to find shapes on.
1218 # @param theState The state of the subshapes to find. It can be one of
1219 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1220 # @return List of all found sub-shapes.
1222 # @ref swig_GetShapesOnPlane "Example"
1223 def GetShapesOnPlane(self,theShape, theShapeType, theAx1, theState):
1224 # Example: see GEOM_TestOthers.py
1225 aList = self.ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
1226 RaiseIfFailed("GetShapesOnPlane", self.ShapesOp)
1229 ## Works like the above method, but returns list of sub-shapes indices
1231 # @ref swig_GetShapesOnPlaneIDs "Example"
1232 def GetShapesOnPlaneIDs(self,theShape, theShapeType, theAx1, theState):
1233 # Example: see GEOM_TestOthers.py
1234 aList = self.ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
1235 RaiseIfFailed("GetShapesOnPlaneIDs", self.ShapesOp)
1238 ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
1239 # situated relatively the specified plane by the certain way,
1240 # defined through <VAR>theState</VAR> parameter.
1241 # @param theShape Shape to find sub-shapes of.
1242 # @param theShapeType Type of sub-shapes to be retrieved.
1243 # @param theAx1 Vector (or line, or linear edge), specifying normal
1244 # direction of the plane to find shapes on.
1245 # @param thePnt Point specifying location of the plane to find shapes on.
1246 # @param theState The state of the subshapes to find. It can be one of
1247 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1248 # @return List of all found sub-shapes.
1250 # @ref swig_GetShapesOnPlaneWithLocation "Example"
1251 def GetShapesOnPlaneWithLocation(self, theShape, theShapeType, theAx1, thePnt, theState):
1252 # Example: see GEOM_TestOthers.py
1253 aList = self.ShapesOp.GetShapesOnPlaneWithLocation(theShape, theShapeType,
1254 theAx1, thePnt, theState)
1255 RaiseIfFailed("GetShapesOnPlaneWithLocation", self.ShapesOp)
1258 ## Works like the above method, but returns list of sub-shapes indices
1260 # @ref swig_GetShapesOnPlaneWithLocationIDs "Example"
1261 def GetShapesOnPlaneWithLocationIDs(self, theShape, theShapeType, theAx1, thePnt, theState):
1262 # Example: see GEOM_TestOthers.py
1263 aList = self.ShapesOp.GetShapesOnPlaneWithLocationIDs(theShape, theShapeType,
1264 theAx1, thePnt, theState)
1265 RaiseIfFailed("GetShapesOnPlaneWithLocationIDs", self.ShapesOp)
1268 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1269 # the specified cylinder by the certain way, defined through \a theState parameter.
1270 # @param theShape Shape to find sub-shapes of.
1271 # @param theShapeType Type of sub-shapes to be retrieved.
1272 # @param theAxis Vector (or line, or linear edge), specifying
1273 # axis of the cylinder to find shapes on.
1274 # @param theRadius Radius of the cylinder to find shapes on.
1275 # @param theState The state of the subshapes to find. It can be one of
1276 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1277 # @return List of all found sub-shapes.
1279 # @ref swig_GetShapesOnCylinder "Example"
1280 def GetShapesOnCylinder(self, theShape, theShapeType, theAxis, theRadius, theState):
1281 # Example: see GEOM_TestOthers.py
1282 aList = self.ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
1283 RaiseIfFailed("GetShapesOnCylinder", self.ShapesOp)
1286 ## Works like the above method, but returns list of sub-shapes indices
1288 # @ref swig_GetShapesOnCylinderIDs "Example"
1289 def GetShapesOnCylinderIDs(self, theShape, theShapeType, theAxis, theRadius, theState):
1290 # Example: see GEOM_TestOthers.py
1291 aList = self.ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
1292 RaiseIfFailed("GetShapesOnCylinderIDs", self.ShapesOp)
1295 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1296 # the specified sphere by the certain way, defined through \a theState parameter.
1297 # @param theShape Shape to find sub-shapes of.
1298 # @param theShapeType Type of sub-shapes to be retrieved.
1299 # @param theCenter Point, specifying center of the sphere to find shapes on.
1300 # @param theRadius Radius of the sphere to find shapes on.
1301 # @param theState The state of the subshapes to find. It can be one of
1302 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1303 # @return List of all found sub-shapes.
1305 # @ref swig_GetShapesOnSphere "Example"
1306 def GetShapesOnSphere(self,theShape, theShapeType, theCenter, theRadius, theState):
1307 # Example: see GEOM_TestOthers.py
1308 aList = self.ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
1309 RaiseIfFailed("GetShapesOnSphere", self.ShapesOp)
1312 ## Works like the above method, but returns list of sub-shapes indices
1314 # @ref swig_GetShapesOnSphereIDs "Example"
1315 def GetShapesOnSphereIDs(self,theShape, theShapeType, theCenter, theRadius, theState):
1316 # Example: see GEOM_TestOthers.py
1317 aList = self.ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
1318 RaiseIfFailed("GetShapesOnSphereIDs", self.ShapesOp)
1321 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1322 # the specified quadrangle by the certain way, defined through \a theState parameter.
1323 # @param theShape Shape to find sub-shapes of.
1324 # @param theShapeType Type of sub-shapes to be retrieved.
1325 # @param theTopLeftPoint Point, specifying top left corner of a quadrangle
1326 # @param theTopRigthPoint Point, specifying top right corner of a quadrangle
1327 # @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
1328 # @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
1329 # @param theState The state of the subshapes to find. It can be one of
1330 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1331 # @return List of all found sub-shapes.
1333 # @ref swig_GetShapesOnQuadrangle "Example"
1334 def GetShapesOnQuadrangle(self, theShape, theShapeType,
1335 theTopLeftPoint, theTopRigthPoint,
1336 theBottomLeftPoint, theBottomRigthPoint, theState):
1337 # Example: see GEOM_TestOthers.py
1338 aList = self.ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType,
1339 theTopLeftPoint, theTopRigthPoint,
1340 theBottomLeftPoint, theBottomRigthPoint, theState)
1341 RaiseIfFailed("GetShapesOnQuadrangle", self.ShapesOp)
1344 ## Works like the above method, but returns list of sub-shapes indices
1346 # @ref swig_GetShapesOnQuadrangleIDs "Example"
1347 def GetShapesOnQuadrangleIDs(self, theShape, theShapeType,
1348 theTopLeftPoint, theTopRigthPoint,
1349 theBottomLeftPoint, theBottomRigthPoint, theState):
1350 # Example: see GEOM_TestOthers.py
1351 aList = self.ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType,
1352 theTopLeftPoint, theTopRigthPoint,
1353 theBottomLeftPoint, theBottomRigthPoint, theState)
1354 RaiseIfFailed("GetShapesOnQuadrangleIDs", self.ShapesOp)
1357 ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1358 # the specified \a theBox by the certain way, defined through \a theState parameter.
1359 # @param theBox Shape for relative comparing.
1360 # @param theShape Shape to find sub-shapes of.
1361 # @param theShapeType Type of sub-shapes to be retrieved.
1362 # @param theState The state of the subshapes to find. It can be one of
1363 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1364 # @return List of all found sub-shapes.
1366 # @ref swig_GetShapesOnBox "Example"
1367 def GetShapesOnBox(self, theBox, theShape, theShapeType, theState):
1368 # Example: see GEOM_TestOthers.py
1369 aList = self.ShapesOp.GetShapesOnBox(theBox, theShape, theShapeType, theState)
1370 RaiseIfFailed("GetShapesOnBox", self.ShapesOp)
1373 ## Works like the above method, but returns list of sub-shapes indices
1375 # @ref swig_GetShapesOnBoxIDs "Example"
1376 def GetShapesOnBoxIDs(self, theBox, theShape, theShapeType, theState):
1377 # Example: see GEOM_TestOthers.py
1378 aList = self.ShapesOp.GetShapesOnBoxIDs(theBox, theShape, theShapeType, theState)
1379 RaiseIfFailed("GetShapesOnBoxIDs", self.ShapesOp)
1382 ## Find in \a theShape all sub-shapes of type \a theShapeType,
1383 # situated relatively the specified \a theCheckShape by the
1384 # certain way, defined through \a theState parameter.
1385 # @param theCheckShape Shape for relative comparing.
1386 # @param theShape Shape to find sub-shapes of.
1387 # @param theShapeType Type of sub-shapes to be retrieved.
1388 # @param theState The state of the subshapes to find. It can be one of
1389 # ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1390 # @return List of all found sub-shapes.
1392 # @ref swig_GetShapesOnShape "Example"
1393 def GetShapesOnShape(self, theCheckShape, theShape, theShapeType, theState):
1394 # Example: see GEOM_TestOthers.py
1395 aList = self.ShapesOp.GetShapesOnShape(theCheckShape, theShape,
1396 theShapeType, theState)
1397 RaiseIfFailed("GetShapesOnShape", self.ShapesOp)
1400 ## Works like the above method, but returns result as compound
1402 # @ref swig_GetShapesOnShapeAsCompound "Example"
1403 def GetShapesOnShapeAsCompound(self, theCheckShape, theShape, theShapeType, theState):
1404 # Example: see GEOM_TestOthers.py
1405 anObj = self.ShapesOp.GetShapesOnShapeAsCompound(theCheckShape, theShape,
1406 theShapeType, theState)
1407 RaiseIfFailed("GetShapesOnShapeAsCompound", self.ShapesOp)
1410 ## Works like the above method, but returns list of sub-shapes indices
1412 # @ref swig_GetShapesOnShapeIDs "Example"
1413 def GetShapesOnShapeIDs(self, theCheckShape, theShape, theShapeType, theState):
1414 # Example: see GEOM_TestOthers.py
1415 aList = self.ShapesOp.GetShapesOnShapeIDs(theCheckShape, theShape,
1416 theShapeType, theState)
1417 RaiseIfFailed("GetShapesOnShapeIDs", self.ShapesOp)
1420 ## Get sub-shape(s) of theShapeWhere, which are
1421 # coincident with \a theShapeWhat or could be a part of it.
1422 # @param theShapeWhere Shape to find sub-shapes of.
1423 # @param theShapeWhat Shape, specifying what to find.
1424 # @return Group of all found sub-shapes or a single found sub-shape.
1426 # @ref swig_GetInPlace "Example"
1427 def GetInPlace(self,theShapeWhere, theShapeWhat):
1428 # Example: see GEOM_TestOthers.py
1429 anObj = self.ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
1430 RaiseIfFailed("GetInPlace", self.ShapesOp)
1433 ## Get sub-shape(s) of \a theShapeWhere, which are
1434 # coincident with \a theShapeWhat or could be a part of it.
1436 # Implementation of this method is based on a saved history of an operation,
1437 # produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1438 # arguments (an argument shape or a sub-shape of an argument shape).
1439 # The operation could be the Partition or one of boolean operations,
1440 # performed on simple shapes (not on compounds).
1442 # @param theShapeWhere Shape to find sub-shapes of.
1443 # @param theShapeWhat Shape, specifying what to find (must be in the
1444 # building history of the ShapeWhere).
1445 # @return Group of all found sub-shapes or a single found sub-shape.
1447 # @ref swig_GetInPlace "Example"
1448 def GetInPlaceByHistory(self, theShapeWhere, theShapeWhat):
1449 # Example: see GEOM_TestOthers.py
1450 anObj = self.ShapesOp.GetInPlaceByHistory(theShapeWhere, theShapeWhat)
1451 RaiseIfFailed("GetInPlaceByHistory", self.ShapesOp)
1454 ## Get sub-shape of theShapeWhere, which is
1455 # equal to \a theShapeWhat.
1456 # @param theShapeWhere Shape to find sub-shape of.
1457 # @param theShapeWhat Shape, specifying what to find.
1458 # @return New GEOM_Object for found sub-shape.
1460 # @ref swig_GetSame "Example"
1461 def GetSame(self,theShapeWhere, theShapeWhat):
1462 anObj = self.ShapesOp.GetSame(theShapeWhere, theShapeWhat)
1463 RaiseIfFailed("GetSame", self.ShapesOp)
1469 ## @addtogroup l4_access
1472 ## Obtain a composite sub-shape of <VAR>aShape</VAR>, composed from sub-shapes
1473 # of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
1475 # @ref swig_all_decompose "Example"
1476 def GetSubShape(self, aShape, ListOfID):
1477 # Example: see GEOM_TestAll.py
1478 anObj = self.AddSubShape(aShape,ListOfID)
1481 ## Obtain unique ID of sub-shape <VAR>aSubShape</VAR> inside <VAR>aShape</VAR>
1483 # @ref swig_all_decompose "Example"
1484 def GetSubShapeID(self, aShape, aSubShape):
1485 # Example: see GEOM_TestAll.py
1486 anID = self.LocalOp.GetSubShapeIndex(aShape, aSubShape)
1487 RaiseIfFailed("GetSubShapeIndex", self.LocalOp)
1493 ## @addtogroup l4_decompose
1496 ## Explode a shape on subshapes of a given type.
1497 # @param aShape Shape to be exploded.
1498 # @param aType Type of sub-shapes to be retrieved.
1499 # @return List of sub-shapes of type theShapeType, contained in theShape.
1501 # @ref swig_all_decompose "Example"
1502 def SubShapeAll(self, aShape, aType):
1503 # Example: see GEOM_TestAll.py
1504 ListObj = self.ShapesOp.MakeExplode(aShape,aType,0)
1505 RaiseIfFailed("MakeExplode", self.ShapesOp)
1508 ## Explode a shape on subshapes of a given type.
1509 # @param aShape Shape to be exploded.
1510 # @param aType Type of sub-shapes to be retrieved.
1511 # @return List of IDs of sub-shapes.
1513 # @ref swig_all_decompose "Example"
1514 def SubShapeAllIDs(self, aShape, aType):
1515 ListObj = self.ShapesOp.SubShapeAllIDs(aShape,aType,0)
1516 RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
1519 ## Explode a shape on subshapes of a given type.
1520 # Sub-shapes will be sorted by coordinates of their gravity centers.
1521 # @param aShape Shape to be exploded.
1522 # @param aType Type of sub-shapes to be retrieved.
1523 # @return List of sub-shapes of type theShapeType, contained in theShape.
1525 # @ref swig_SubShapeAllSorted "Example"
1526 def SubShapeAllSorted(self, aShape, aType):
1527 # Example: see GEOM_TestAll.py
1528 ListObj = self.ShapesOp.MakeExplode(aShape,aType,1)
1529 RaiseIfFailed("MakeExplode", self.ShapesOp)
1532 ## Explode a shape on subshapes of a given type.
1533 # Sub-shapes will be sorted by coordinates of their gravity centers.
1534 # @param aShape Shape to be exploded.
1535 # @param aType Type of sub-shapes to be retrieved.
1536 # @return List of IDs of sub-shapes.
1538 # @ref swig_all_decompose "Example"
1539 def SubShapeAllSortedIDs(self, aShape, aType):
1540 ListIDs = self.ShapesOp.SubShapeAllIDs(aShape,aType,1)
1541 RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
1544 ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
1545 # selected by they indices in list of all sub-shapes of type <VAR>aType</VAR>.
1546 # Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1548 # @ref swig_all_decompose "Example"
1549 def SubShape(self, aShape, aType, ListOfInd):
1550 # Example: see GEOM_TestAll.py
1552 AllShapeList = self.SubShapeAll(aShape, aType)
1553 for ind in ListOfInd:
1554 ListOfIDs.append(self.GetSubShapeID(aShape, AllShapeList[ind - 1]))
1555 anObj = self.GetSubShape(aShape, ListOfIDs)
1558 ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
1559 # selected by they indices in sorted list of all sub-shapes of type <VAR>aType</VAR>.
1560 # Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
1562 # @ref swig_all_decompose "Example"
1563 def SubShapeSorted(self,aShape, aType, ListOfInd):
1564 # Example: see GEOM_TestAll.py
1566 AllShapeList = self.SubShapeAllSorted(aShape, aType)
1567 for ind in ListOfInd:
1568 ListOfIDs.append(self.GetSubShapeID(aShape, AllShapeList[ind - 1]))
1569 anObj = self.GetSubShape(aShape, ListOfIDs)
1572 # end of l4_decompose
1575 ## @addtogroup l3_healing
1578 ## Apply a sequence of Shape Healing operators to the given object.
1579 # @param theShape Shape to be processed.
1580 # @param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1581 # @param theParameters List of names of parameters
1582 # ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1583 # @param theValues List of values of parameters, in the same order
1584 # as parameters are listed in <VAR>theParameters</VAR> list.
1585 # @return New GEOM_Object, containing processed shape.
1587 # @ref tui_shape_processing "Example"
1588 def ProcessShape(self,theShape, theOperators, theParameters, theValues):
1589 # Example: see GEOM_TestHealing.py
1590 anObj = self.HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
1591 RaiseIfFailed("ProcessShape", self.HealOp)
1594 ## Remove faces from the given object (shape).
1595 # @param theObject Shape to be processed.
1596 # @param theFaces Indices of faces to be removed, if EMPTY then the method
1597 # removes ALL faces of the given object.
1598 # @return New GEOM_Object, containing processed shape.
1600 # @ref tui_suppress_faces "Example"
1601 def SuppressFaces(self,theObject, theFaces):
1602 # Example: see GEOM_TestHealing.py
1603 anObj = self.HealOp.SuppressFaces(theObject, theFaces)
1604 RaiseIfFailed("SuppressFaces", self.HealOp)
1607 ## Sewing of some shapes into single shape.
1609 # @ref tui_sewing "Example"
1610 def MakeSewing(self, ListShape, theTolerance):
1611 # Example: see GEOM_TestHealing.py
1612 comp = self.MakeCompound(ListShape)
1613 anObj = self.Sew(comp, theTolerance)
1616 ## Sewing of the given object.
1617 # @param theObject Shape to be processed.
1618 # @param theTolerance Required tolerance value.
1619 # @return New GEOM_Object, containing processed shape.
1620 def Sew(self, theObject, theTolerance):
1621 # Example: see MakeSewing() above
1622 anObj = self.HealOp.Sew(theObject, theTolerance)
1623 RaiseIfFailed("Sew", self.HealOp)
1626 ## Remove internal wires and edges from the given object (face).
1627 # @param theObject Shape to be processed.
1628 # @param theWires Indices of wires to be removed, if EMPTY then the method
1629 # removes ALL internal wires of the given object.
1630 # @return New GEOM_Object, containing processed shape.
1632 # @ref tui_suppress_internal_wires "Example"
1633 def SuppressInternalWires(self,theObject, theWires):
1634 # Example: see GEOM_TestHealing.py
1635 anObj = self.HealOp.RemoveIntWires(theObject, theWires)
1636 RaiseIfFailed("RemoveIntWires", self.HealOp)
1639 ## Remove internal closed contours (holes) from the given object.
1640 # @param theObject Shape to be processed.
1641 # @param theWires Indices of wires to be removed, if EMPTY then the method
1642 # removes ALL internal holes of the given object
1643 # @return New GEOM_Object, containing processed shape.
1645 # @ref tui_suppress_holes "Example"
1646 def SuppressHoles(self,theObject, theWires):
1647 # Example: see GEOM_TestHealing.py
1648 anObj = self.HealOp.FillHoles(theObject, theWires)
1649 RaiseIfFailed("FillHoles", self.HealOp)
1652 ## Close an open wire.
1653 # @param theObject Shape to be processed.
1654 # @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1655 # if -1, then <VAR>theObject</VAR> itself is a wire.
1656 # @param isCommonVertex If TRUE : closure by creation of a common vertex,
1657 # If FALS : closure by creation of an edge between ends.
1658 # @return New GEOM_Object, containing processed shape.
1660 # @ref tui_close_contour "Example"
1661 def CloseContour(self,theObject, theWires, isCommonVertex):
1662 # Example: see GEOM_TestHealing.py
1663 anObj = self.HealOp.CloseContour(theObject, theWires, isCommonVertex)
1664 RaiseIfFailed("CloseContour", self.HealOp)
1667 ## Addition of a point to a given edge object.
1668 # @param theObject Shape to be processed.
1669 # @param theEdgeIndex Index of edge to be divided within theObject's shape,
1670 # if -1, then theObject itself is the edge.
1671 # @param theValue Value of parameter on edge or length parameter,
1672 # depending on \a isByParameter.
1673 # @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
1674 # if FALSE : \a theValue is treated as a length parameter [0..1]
1675 # @return New GEOM_Object, containing processed shape.
1677 # @ref tui_add_point_on_edge "Example"
1678 def DivideEdge(self,theObject, theEdgeIndex, theValue, isByParameter):
1679 # Example: see GEOM_TestHealing.py
1680 anObj = self.HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
1681 RaiseIfFailed("DivideEdge", self.HealOp)
1684 ## Change orientation of the given object. Updates given shape.
1685 # @param theObject Shape to be processed.
1687 # @ref swig_todo "Example"
1688 def ChangeOrientationShell(self,theObject):
1689 theObject = self.HealOp.ChangeOrientation(theObject)
1690 RaiseIfFailed("ChangeOrientation", self.HealOp)
1693 ## Change orientation of the given object.
1694 # @param theObject Shape to be processed.
1695 # @return New GEOM_Object, containing processed shape.
1697 # @ref swig_todo "Example"
1698 def ChangeOrientationShellCopy(self,theObject):
1699 anObj = self.HealOp.ChangeOrientationCopy(theObject)
1700 RaiseIfFailed("ChangeOrientationCopy", self.HealOp)
1703 ## Get a list of wires (wrapped in GEOM_Object-s),
1704 # that constitute a free boundary of the given shape.
1705 # @param theObject Shape to get free boundary of.
1706 # @return [status, theClosedWires, theOpenWires]
1707 # status: FALSE, if an error(s) occured during the method execution.
1708 # theClosedWires: Closed wires on the free boundary of the given shape.
1709 # theOpenWires: Open wires on the free boundary of the given shape.
1711 # @ref tui_measurement_tools_page "Example"
1712 def GetFreeBoundary(self,theObject):
1713 # Example: see GEOM_TestHealing.py
1714 anObj = self.HealOp.GetFreeBoundary(theObject)
1715 RaiseIfFailed("GetFreeBoundary", self.HealOp)
1718 ## Replace coincident faces in theShape by one face.
1719 # @param theShape Initial shape.
1720 # @param theTolerance Maximum distance between faces, which can be considered as coincident.
1721 # @param doKeepNonSolids If FALSE, only solids will present in the result,
1722 # otherwise all initial shapes.
1723 # @return New GEOM_Object, containing a copy of theShape without coincident faces.
1725 # @ref tui_glue_faces "Example"
1726 def MakeGlueFaces(self, theShape, theTolerance, doKeepNonSolids=True):
1727 # Example: see GEOM_Spanner.py
1728 anObj = self.ShapesOp.MakeGlueFaces(theShape, theTolerance, doKeepNonSolids)
1730 raise RuntimeError, "MakeGlueFaces : " + self.ShapesOp.GetErrorCode()
1733 ## Find coincident faces in theShape for possible gluing.
1734 # @param theShape Initial shape.
1735 # @param theTolerance Maximum distance between faces,
1736 # which can be considered as coincident.
1739 # @ref swig_todo "Example"
1740 def GetGlueFaces(self, theShape, theTolerance):
1741 # Example: see GEOM_Spanner.py
1742 anObj = self.ShapesOp.GetGlueFaces(theShape, theTolerance)
1743 RaiseIfFailed("GetGlueFaces", self.ShapesOp)
1746 ## Replace coincident faces in theShape by one face
1747 # in compliance with given list of faces
1748 # @param theShape Initial shape.
1749 # @param theTolerance Maximum distance between faces,
1750 # which can be considered as coincident.
1751 # @param theFaces List of faces for gluing.
1752 # @param doKeepNonSolids If FALSE, only solids will present in the result,
1753 # otherwise all initial shapes.
1754 # @return New GEOM_Object, containing a copy of theShape
1755 # without some faces.
1757 # @ref swig_todo "Example"
1758 def MakeGlueFacesByList(self, theShape, theTolerance, theFaces, doKeepNonSolids=True):
1759 # Example: see GEOM_Spanner.py
1760 anObj = self.ShapesOp.MakeGlueFacesByList(theShape, theTolerance, theFaces, doKeepNonSolids)
1762 raise RuntimeError, "MakeGlueFacesByList : " + self.ShapesOp.GetErrorCode()
1768 ## @addtogroup l3_boolean Boolean Operations
1771 # -----------------------------------------------------------------------------
1772 # Boolean (Common, Cut, Fuse, Section)
1773 # -----------------------------------------------------------------------------
1775 ## Perform one of boolean operations on two given shapes.
1776 # @param theShape1 First argument for boolean operation.
1777 # @param theShape2 Second argument for boolean operation.
1778 # @param theOperation Indicates the operation to be done:
1779 # 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1780 # @return New GEOM_Object, containing the result shape.
1782 # @ref tui_fuse "Example"
1783 def MakeBoolean(self,theShape1, theShape2, theOperation):
1784 # Example: see GEOM_TestAll.py
1785 anObj = self.BoolOp.MakeBoolean(theShape1, theShape2, theOperation)
1786 RaiseIfFailed("MakeBoolean", self.BoolOp)
1789 ## Shortcut to MakeBoolean(s1, s2, 1)
1791 # @ref tui_common "Example 1"
1792 # \n @ref swig_MakeCommon "Example 2"
1793 def MakeCommon(self, s1, s2):
1794 # Example: see GEOM_TestOthers.py
1795 return self.MakeBoolean(s1, s2, 1)
1797 ## Shortcut to MakeBoolean(s1, s2, 2)
1799 # @ref tui_cut "Example 1"
1800 # \n @ref swig_MakeCommon "Example 2"
1801 def MakeCut(self, s1, s2):
1802 # Example: see GEOM_TestOthers.py
1803 return self.MakeBoolean(s1, s2, 2)
1805 ## Shortcut to MakeBoolean(s1, s2, 3)
1807 # @ref tui_fuse "Example 1"
1808 # \n @ref swig_MakeCommon "Example 2"
1809 def MakeFuse(self, s1, s2):
1810 # Example: see GEOM_TestOthers.py
1811 return self.MakeBoolean(s1, s2, 3)
1813 ## Shortcut to MakeBoolean(s1, s2, 4)
1815 # @ref tui_section "Example 1"
1816 # \n @ref swig_MakeCommon "Example 2"
1817 def MakeSection(self, s1, s2):
1818 # Example: see GEOM_TestOthers.py
1819 return self.MakeBoolean(s1, s2, 4)
1824 ## @addtogroup l3_basic_op
1827 ## Perform partition operation.
1828 # @param ListShapes Shapes to be intersected.
1829 # @param ListTools Shapes to intersect theShapes.
1830 # !!!NOTE: Each compound from ListShapes and ListTools will be exploded
1831 # in order to avoid possible intersection between shapes from
1833 # @param Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1834 # @param KeepNonlimitShapes: if this parameter == 0 - only shapes with
1835 # type <= Limit are kept in the result,
1836 # else - shapes with type > Limit are kept
1837 # also (if they exist)
1839 # After implementation new version of PartitionAlgo (October 2006)
1840 # other parameters are ignored by current functionality. They are kept
1841 # in this function only for support old versions.
1842 # Ignored parameters:
1843 # @param ListKeepInside Shapes, outside which the results will be deleted.
1844 # Each shape from theKeepInside must belong to theShapes also.
1845 # @param ListRemoveInside Shapes, inside which the results will be deleted.
1846 # Each shape from theRemoveInside must belong to theShapes also.
1847 # @param RemoveWebs If TRUE, perform Glue 3D algorithm.
1848 # @param ListMaterials Material indices for each shape. Make sence,
1849 # only if theRemoveWebs is TRUE.
1851 # @return New GEOM_Object, containing the result shapes.
1853 # @ref tui_partition "Example"
1854 def MakePartition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1855 Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[],
1856 KeepNonlimitShapes=0):
1857 # Example: see GEOM_TestAll.py
1858 anObj = self.BoolOp.MakePartition(ListShapes, ListTools,
1859 ListKeepInside, ListRemoveInside,
1860 Limit, RemoveWebs, ListMaterials,
1861 KeepNonlimitShapes);
1862 RaiseIfFailed("MakePartition", self.BoolOp)
1865 ## Perform partition operation.
1866 # This method may be useful if it is needed to make a partition for
1867 # compound contains nonintersected shapes. Performance will be better
1868 # since intersection between shapes from compound is not performed.
1870 # Description of all parameters as in previous method MakePartition()
1872 # !!!NOTE: Passed compounds (via ListShapes or via ListTools)
1873 # have to consist of nonintersecting shapes.
1875 # @return New GEOM_Object, containing the result shapes.
1877 # @ref swig_todo "Example"
1878 def MakePartitionNonSelfIntersectedShape(self, ListShapes, ListTools=[],
1879 ListKeepInside=[], ListRemoveInside=[],
1880 Limit=ShapeType["SHAPE"], RemoveWebs=0,
1881 ListMaterials=[], KeepNonlimitShapes=0):
1882 anObj = self.BoolOp.MakePartitionNonSelfIntersectedShape(ListShapes, ListTools,
1883 ListKeepInside, ListRemoveInside,
1884 Limit, RemoveWebs, ListMaterials,
1885 KeepNonlimitShapes);
1886 RaiseIfFailed("MakePartitionNonSelfIntersectedShape", self.BoolOp)
1889 ## Shortcut to MakePartition()
1891 # @ref tui_partition "Example 1"
1892 # \n @ref swig_Partition "Example 2"
1893 def Partition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
1894 Limit=ShapeType["SHAPE"], RemoveWebs=0, ListMaterials=[],
1895 KeepNonlimitShapes=0):
1896 # Example: see GEOM_TestOthers.py
1897 anObj = self.MakePartition(ListShapes, ListTools,
1898 ListKeepInside, ListRemoveInside,
1899 Limit, RemoveWebs, ListMaterials,
1900 KeepNonlimitShapes);
1903 ## Perform partition of the Shape with the Plane
1904 # @param theShape Shape to be intersected.
1905 # @param thePlane Tool shape, to intersect theShape.
1906 # @return New GEOM_Object, containing the result shape.
1908 # @ref tui_partition "Example"
1909 def MakeHalfPartition(self,theShape, thePlane):
1910 # Example: see GEOM_TestAll.py
1911 anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)
1912 RaiseIfFailed("MakeHalfPartition", self.BoolOp)
1915 # end of l3_basic_op
1918 ## @addtogroup l3_transform
1921 ## Translate the given object along the vector, specified
1922 # by its end points, creating its copy before the translation.
1923 # @param theObject The object to be translated.
1924 # @param thePoint1 Start point of translation vector.
1925 # @param thePoint2 End point of translation vector.
1926 # @return New GEOM_Object, containing the translated object.
1928 # @ref tui_translation "Example 1"
1929 # \n @ref swig_MakeTranslationTwoPoints "Example 2"
1930 def MakeTranslationTwoPoints(self,theObject, thePoint1, thePoint2):
1931 # Example: see GEOM_TestAll.py
1932 anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
1933 RaiseIfFailed("TranslateTwoPointsCopy", self.TrsfOp)
1936 ## Translate the given object along the vector, specified
1937 # by its components, creating its copy before the translation.
1938 # @param theObject The object to be translated.
1939 # @param theDX,theDY,theDZ Components of translation vector.
1940 # @return New GEOM_Object, containing the translated object.
1942 # @ref tui_translation "Example"
1943 def MakeTranslation(self,theObject, theDX, theDY, theDZ):
1944 # Example: see GEOM_TestAll.py
1945 anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
1946 RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
1949 ## Translate the given object along the given vector,
1950 # creating its copy before the translation.
1951 # @param theObject The object to be translated.
1952 # @param theVector The translation vector.
1953 # @return New GEOM_Object, containing the translated object.
1955 # @ref tui_translation "Example"
1956 def MakeTranslationVector(self,theObject, theVector):
1957 # Example: see GEOM_TestAll.py
1958 anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
1959 RaiseIfFailed("TranslateVectorCopy", self.TrsfOp)
1962 ## Translate the given object along the given vector on given distance,
1963 # creating its copy before the translation.
1964 # @param theObject The object to be translated.
1965 # @param theVector The translation vector.
1966 # @param theDistance The translation distance.
1967 # @return New GEOM_Object, containing the translated object.
1969 # @ref tui_translation "Example"
1970 def MakeTranslationVectorDistance(self, theObject, theVector, theDistance):
1971 # Example: see GEOM_TestAll.py
1972 anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, 1)
1973 RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
1976 ## Rotate the given object around the given axis
1977 # on the given angle, creating its copy before the rotatation.
1978 # @param theObject The object to be rotated.
1979 # @param theAxis Rotation axis.
1980 # @param theAngle Rotation angle in radians.
1981 # @return New GEOM_Object, containing the rotated object.
1983 # @ref tui_rotation "Example"
1984 def MakeRotation(self,theObject, theAxis, theAngle):
1985 # Example: see GEOM_TestAll.py
1986 anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
1987 RaiseIfFailed("RotateCopy", self.TrsfOp)
1990 ## Rotate given object around vector perpendicular to plane
1991 # containing three points, creating its copy before the rotatation.
1992 # @param theObject The object to be rotated.
1993 # @param theCentPoint central point - the axis is the vector perpendicular to the plane
1994 # containing the three points.
1995 # @param thePoint1,thePoint2 - in a perpendicular plane of the axis.
1996 # @return New GEOM_Object, containing the rotated object.
1998 # @ref tui_rotation "Example"
1999 def MakeRotationThreePoints(self,theObject, theCentPoint, thePoint1, thePoint2):
2000 # Example: see GEOM_TestAll.py
2001 anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
2002 RaiseIfFailed("RotateThreePointsCopy", self.TrsfOp)
2005 ## Scale the given object by the factor, creating its copy before the scaling.
2006 # @param theObject The object to be scaled.
2007 # @param thePoint Center point for scaling.
2008 # Passing None for it means scaling relatively the origin of global CS.
2009 # @param theFactor Scaling factor value.
2010 # @return New GEOM_Object, containing the scaled shape.
2012 # @ref tui_scale "Example"
2013 def MakeScaleTransform(self, theObject, thePoint, theFactor):
2014 # Example: see GEOM_TestAll.py
2015 anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
2016 RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
2019 ## Scale the given object by different factors along coordinate axes,
2020 # creating its copy before the scaling.
2021 # @param theObject The object to be scaled.
2022 # @param thePoint Center point for scaling.
2023 # Passing None for it means scaling relatively the origin of global CS.
2024 # @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
2025 # @return New GEOM_Object, containing the scaled shape.
2027 # @ref swig_scale "Example"
2028 def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ):
2029 # Example: see GEOM_TestAll.py
2030 anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
2031 theFactorX, theFactorY, theFactorZ)
2032 RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
2035 ## Create an object, symmetrical
2036 # to the given one relatively the given plane.
2037 # @param theObject The object to be mirrored.
2038 # @param thePlane Plane of symmetry.
2039 # @return New GEOM_Object, containing the mirrored shape.
2041 # @ref tui_mirror "Example"
2042 def MakeMirrorByPlane(self,theObject, thePlane):
2043 # Example: see GEOM_TestAll.py
2044 anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
2045 RaiseIfFailed("MirrorPlaneCopy", self.TrsfOp)
2048 ## Create an object, symmetrical
2049 # to the given one relatively the given axis.
2050 # @param theObject The object to be mirrored.
2051 # @param theAxis Axis of symmetry.
2052 # @return New GEOM_Object, containing the mirrored shape.
2054 # @ref tui_mirror "Example"
2055 def MakeMirrorByAxis(self,theObject, theAxis):
2056 # Example: see GEOM_TestAll.py
2057 anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
2058 RaiseIfFailed("MirrorAxisCopy", self.TrsfOp)
2061 ## Create an object, symmetrical
2062 # to the given one relatively the given point.
2063 # @param theObject The object to be mirrored.
2064 # @param thePoint Point of symmetry.
2065 # @return New GEOM_Object, containing the mirrored shape.
2067 # @ref tui_mirror "Example"
2068 def MakeMirrorByPoint(self,theObject, thePoint):
2069 # Example: see GEOM_TestAll.py
2070 anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
2071 RaiseIfFailed("MirrorPointCopy", self.TrsfOp)
2074 ## Modify the Location of the given object by LCS,
2075 # creating its copy before the setting.
2076 # @param theObject The object to be displaced.
2077 # @param theStartLCS Coordinate system to perform displacement from it.
2078 # If \a theStartLCS is NULL, displacement
2079 # will be performed from global CS.
2080 # If \a theObject itself is used as \a theStartLCS,
2081 # its location will be changed to \a theEndLCS.
2082 # @param theEndLCS Coordinate system to perform displacement to it.
2083 # @return New GEOM_Object, containing the displaced shape.
2085 # @ref tui_modify_location "Example"
2086 def MakePosition(self,theObject, theStartLCS, theEndLCS):
2087 # Example: see GEOM_TestAll.py
2088 anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
2089 RaiseIfFailed("PositionShapeCopy", self.TrsfOp)
2092 ## Create new object as offset of the given one.
2093 # @param theObject The base object for the offset.
2094 # @param theOffset Offset value.
2095 # @return New GEOM_Object, containing the offset object.
2097 # @ref tui_offset "Example"
2098 def MakeOffset(self,theObject, theOffset):
2099 # Example: see GEOM_TestAll.py
2100 anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
2101 RaiseIfFailed("OffsetShapeCopy", self.TrsfOp)
2104 # -----------------------------------------------------------------------------
2106 # -----------------------------------------------------------------------------
2108 ## Translate the given object along the given vector a given number times
2109 # @param theObject The object to be translated.
2110 # @param theVector Direction of the translation.
2111 # @param theStep Distance to translate on.
2112 # @param theNbTimes Quantity of translations to be done.
2113 # @return New GEOM_Object, containing compound of all
2114 # the shapes, obtained after each translation.
2116 # @ref tui_multi_translation "Example"
2117 def MakeMultiTranslation1D(self,theObject, theVector, theStep, theNbTimes):
2118 # Example: see GEOM_TestAll.py
2119 anObj = self.TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
2120 RaiseIfFailed("MultiTranslate1D", self.TrsfOp)
2123 ## Conseqently apply two specified translations to theObject specified number of times.
2124 # @param theObject The object to be translated.
2125 # @param theVector1 Direction of the first translation.
2126 # @param theStep1 Step of the first translation.
2127 # @param theNbTimes1 Quantity of translations to be done along theVector1.
2128 # @param theVector2 Direction of the second translation.
2129 # @param theStep2 Step of the second translation.
2130 # @param theNbTimes2 Quantity of translations to be done along theVector2.
2131 # @return New GEOM_Object, containing compound of all
2132 # the shapes, obtained after each translation.
2134 # @ref tui_multi_translation "Example"
2135 def MakeMultiTranslation2D(self,theObject, theVector1, theStep1, theNbTimes1,
2136 theVector2, theStep2, theNbTimes2):
2137 # Example: see GEOM_TestAll.py
2138 anObj = self.TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
2139 theVector2, theStep2, theNbTimes2)
2140 RaiseIfFailed("MultiTranslate2D", self.TrsfOp)
2143 ## Rotate the given object around the given axis a given number times.
2144 # Rotation angle will be 2*PI/theNbTimes.
2145 # @param theObject The object to be rotated.
2146 # @param theAxis The rotation axis.
2147 # @param theNbTimes Quantity of rotations to be done.
2148 # @return New GEOM_Object, containing compound of all the
2149 # shapes, obtained after each rotation.
2151 # @ref tui_multi_rotation "Example"
2152 def MultiRotate1D(self,theObject, theAxis, theNbTimes):
2153 # Example: see GEOM_TestAll.py
2154 anObj = self.TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
2155 RaiseIfFailed("MultiRotate1D", self.TrsfOp)
2158 ## Rotate the given object around the
2159 # given axis on the given angle a given number
2160 # times and multi-translate each rotation result.
2161 # Translation direction passes through center of gravity
2162 # of rotated shape and its projection on the rotation axis.
2163 # @param theObject The object to be rotated.
2164 # @param theAxis Rotation axis.
2165 # @param theAngle Rotation angle in graduces.
2166 # @param theNbTimes1 Quantity of rotations to be done.
2167 # @param theStep Translation distance.
2168 # @param theNbTimes2 Quantity of translations to be done.
2169 # @return New GEOM_Object, containing compound of all the
2170 # shapes, obtained after each transformation.
2172 # @ref tui_multi_rotation "Example"
2173 def MultiRotate2D(self,theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2):
2174 # Example: see GEOM_TestAll.py
2175 anObj = self.TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
2176 RaiseIfFailed("MultiRotate2D", self.TrsfOp)
2179 ## The same, as MultiRotate1D(), but axis is given by direction and point
2180 # @ref swig_MakeMultiRotation "Example"
2181 def MakeMultiRotation1D(self,aShape,aDir,aPoint,aNbTimes):
2182 # Example: see GEOM_TestOthers.py
2183 aVec = self.MakeLine(aPoint,aDir)
2184 anObj = self.MultiRotate1D(aShape,aVec,aNbTimes)
2187 ## The same, as MultiRotate2D(), but axis is given by direction and point
2188 # @ref swig_MakeMultiRotation "Example"
2189 def MakeMultiRotation2D(self,aShape,aDir,aPoint,anAngle,nbtimes1,aStep,nbtimes2):
2190 # Example: see GEOM_TestOthers.py
2191 aVec = self.MakeLine(aPoint,aDir)
2192 anObj = self.MultiRotate2D(aShape,aVec,anAngle,nbtimes1,aStep,nbtimes2)
2195 # end of l3_transform
2198 ## @addtogroup l3_local
2201 ## Perform a fillet on all edges of the given shape.
2202 # @param theShape Shape, to perform fillet on.
2203 # @param theR Fillet radius.
2204 # @return New GEOM_Object, containing the result shape.
2206 # @ref tui_fillet "Example 1"
2207 # \n @ref swig_MakeFilletAll "Example 2"
2208 def MakeFilletAll(self,theShape, theR):
2209 # Example: see GEOM_TestOthers.py
2210 anObj = self.LocalOp.MakeFilletAll(theShape, theR)
2211 RaiseIfFailed("MakeFilletAll", self.LocalOp)
2214 ## Perform a fillet on the specified edges/faces of the given shape
2215 # @param theShape Shape, to perform fillet on.
2216 # @param theR Fillet radius.
2217 # @param theShapeType Type of shapes in <VAR>theListShapes</VAR>.
2218 # @param theListShapes Global indices of edges/faces to perform fillet on.
2219 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
2220 # @return New GEOM_Object, containing the result shape.
2222 # @ref tui_fillet "Example"
2223 def MakeFillet(self,theShape, theR, theShapeType, theListShapes):
2224 # Example: see GEOM_TestAll.py
2226 if theShapeType == ShapeType["EDGE"]:
2227 anObj = self.LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
2228 RaiseIfFailed("MakeFilletEdges", self.LocalOp)
2230 anObj = self.LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
2231 RaiseIfFailed("MakeFilletFaces", self.LocalOp)
2234 ## The same that MakeFillet but with two Fillet Radius R1 and R2
2235 def MakeFilletR1R2(self, theShape, theR1, theR2, theShapeType, theListShapes):
2237 if theShapeType == ShapeType["EDGE"]:
2238 anObj = self.LocalOp.MakeFilletEdgesR1R2(theShape, theR1, theR2, theListShapes)
2239 RaiseIfFailed("MakeFilletEdgesR1R2", self.LocalOp)
2241 anObj = self.LocalOp.MakeFilletFacesR1R2(theShape, theR1, theR2, theListShapes)
2242 RaiseIfFailed("MakeFilletFacesR1R2", self.LocalOp)
2245 ## Perform a symmetric chamfer on all edges of the given shape.
2246 # @param theShape Shape, to perform chamfer on.
2247 # @param theD Chamfer size along each face.
2248 # @return New GEOM_Object, containing the result shape.
2250 # @ref tui_chamfer "Example 1"
2251 # \n @ref swig_MakeChamferAll "Example 2"
2252 def MakeChamferAll(self,theShape, theD):
2253 # Example: see GEOM_TestOthers.py
2254 anObj = self.LocalOp.MakeChamferAll(theShape, theD)
2255 RaiseIfFailed("MakeChamferAll", self.LocalOp)
2258 ## Perform a chamfer on edges, common to the specified faces,
2259 # with distance D1 on the Face1
2260 # @param theShape Shape, to perform chamfer on.
2261 # @param theD1 Chamfer size along \a theFace1.
2262 # @param theD2 Chamfer size along \a theFace2.
2263 # @param theFace1,theFace2 Global indices of two faces of \a theShape.
2264 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
2265 # @return New GEOM_Object, containing the result shape.
2267 # @ref tui_chamfer "Example"
2268 def MakeChamferEdge(self,theShape, theD1, theD2, theFace1, theFace2):
2269 # Example: see GEOM_TestAll.py
2270 anObj = self.LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
2271 RaiseIfFailed("MakeChamferEdge", self.LocalOp)
2274 ## The Same that MakeChamferEdge but with params theD is chamfer length and
2275 # theAngle is Angle of chamfer (angle in radians)
2276 def MakeChamferEdgeAD(self, theShape, theD, theAngle, theFace1, theFace2):
2277 anObj = self.LocalOp.MakeChamferEdgeAD(theShape, theD, theAngle, theFace1, theFace2)
2278 RaiseIfFailed("MakeChamferEdgeAD", self.LocalOp)
2281 ## Perform a chamfer on all edges of the specified faces,
2282 # with distance D1 on the first specified face (if several for one edge)
2283 # @param theShape Shape, to perform chamfer on.
2284 # @param theD1 Chamfer size along face from \a theFaces. If both faces,
2285 # connected to the edge, are in \a theFaces, \a theD1
2286 # will be get along face, which is nearer to \a theFaces beginning.
2287 # @param theD2 Chamfer size along another of two faces, connected to the edge.
2288 # @param theFaces Sequence of global indices of faces of \a theShape.
2289 # \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
2290 # @return New GEOM_Object, containing the result shape.
2292 # @ref tui_chamfer "Example"
2293 def MakeChamferFaces(self,theShape, theD1, theD2, theFaces):
2294 # Example: see GEOM_TestAll.py
2295 anObj = self.LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
2296 RaiseIfFailed("MakeChamferFaces", self.LocalOp)
2299 ## The Same that MakeChamferFaces but with params theD is chamfer lenght and
2300 # theAngle is Angle of chamfer (angle in radians)
2302 # @ref swig_FilletChamfer "Example"
2303 def MakeChamferFacesAD(self, theShape, theD, theAngle, theFaces):
2304 anObj = self.LocalOp.MakeChamferFacesAD(theShape, theD, theAngle, theFaces)
2305 RaiseIfFailed("MakeChamferFacesAD", self.LocalOp)
2308 ## Perform a chamfer on edges,
2309 # with distance D1 on the first specified face (if several for one edge)
2310 # @param theShape Shape, to perform chamfer on.
2311 # @param theD1,theD2 Chamfer size
2312 # @param theEdges Sequence of edges of \a theShape.
2313 # @return New GEOM_Object, containing the result shape.
2315 # @ref swig_FilletChamfer "Example"
2316 def MakeChamferEdges(self, theShape, theD1, theD2, theEdges):
2317 anObj = self.LocalOp.MakeChamferEdges(theShape, theD1, theD2, theEdges)
2318 RaiseIfFailed("MakeChamferEdges", self.LocalOp)
2321 ## The Same that MakeChamferEdges but with params theD is chamfer lenght and
2322 # theAngle is Angle of chamfer (angle in radians)
2323 def MakeChamferEdgesAD(self, theShape, theD, theAngle, theEdges):
2324 anObj = self.LocalOp.MakeChamferEdgesAD(theShape, theD, theAngle, theEdges)
2325 RaiseIfFailed("MakeChamferEdgesAD", self.LocalOp)
2328 ## Shortcut to MakeChamferEdge() and MakeChamferFaces()
2330 # @ref swig_MakeChamfer "Example"
2331 def MakeChamfer(self,aShape,d1,d2,aShapeType,ListShape):
2332 # Example: see GEOM_TestOthers.py
2334 if aShapeType == ShapeType["EDGE"]:
2335 anObj = self.MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1])
2337 anObj = self.MakeChamferFaces(aShape,d1,d2,ListShape)
2343 ## @addtogroup l3_basic_op
2346 ## Perform an Archimde operation on the given shape with given parameters.
2347 # The object presenting the resulting face is returned.
2348 # @param theShape Shape to be put in water.
2349 # @param theWeight Weight og the shape.
2350 # @param theWaterDensity Density of the water.
2351 # @param theMeshDeflection Deflection of the mesh, using to compute the section.
2352 # @return New GEOM_Object, containing a section of \a theShape
2353 # by a plane, corresponding to water level.
2355 # @ref tui_archimede "Example"
2356 def Archimede(self,theShape, theWeight, theWaterDensity, theMeshDeflection):
2357 # Example: see GEOM_TestAll.py
2358 anObj = self.LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
2359 RaiseIfFailed("MakeArchimede", self.LocalOp)
2362 # end of l3_basic_op
2365 ## @addtogroup l2_measure
2368 ## Get point coordinates
2371 # @ref tui_measurement_tools_page "Example"
2372 def PointCoordinates(self,Point):
2373 # Example: see GEOM_TestMeasures.py
2374 aTuple = self.MeasuOp.PointCoordinates(Point)
2375 RaiseIfFailed("PointCoordinates", self.MeasuOp)
2378 ## Get summarized length of all wires,
2379 # area of surface and volume of the given shape.
2380 # @param theShape Shape to define properties of.
2381 # @return [theLength, theSurfArea, theVolume]
2382 # theLength: Summarized length of all wires of the given shape.
2383 # theSurfArea: Area of surface of the given shape.
2384 # theVolume: Volume of the given shape.
2386 # @ref tui_measurement_tools_page "Example"
2387 def BasicProperties(self,theShape):
2388 # Example: see GEOM_TestMeasures.py
2389 aTuple = self.MeasuOp.GetBasicProperties(theShape)
2390 RaiseIfFailed("GetBasicProperties", self.MeasuOp)
2393 ## Get parameters of bounding box of the given shape
2394 # @param theShape Shape to obtain bounding box of.
2395 # @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
2396 # Xmin,Xmax: Limits of shape along OX axis.
2397 # Ymin,Ymax: Limits of shape along OY axis.
2398 # Zmin,Zmax: Limits of shape along OZ axis.
2400 # @ref tui_measurement_tools_page "Example"
2401 def BoundingBox(self,theShape):
2402 # Example: see GEOM_TestMeasures.py
2403 aTuple = self.MeasuOp.GetBoundingBox(theShape)
2404 RaiseIfFailed("GetBoundingBox", self.MeasuOp)
2407 ## Get inertia matrix and moments of inertia of theShape.
2408 # @param theShape Shape to calculate inertia of.
2409 # @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
2410 # I(1-3)(1-3): Components of the inertia matrix of the given shape.
2411 # Ix,Iy,Iz: Moments of inertia of the given shape.
2413 # @ref tui_measurement_tools_page "Example"
2414 def Inertia(self,theShape):
2415 # Example: see GEOM_TestMeasures.py
2416 aTuple = self.MeasuOp.GetInertia(theShape)
2417 RaiseIfFailed("GetInertia", self.MeasuOp)
2420 ## Get minimal distance between the given shapes.
2421 # @param theShape1,theShape2 Shapes to find minimal distance between.
2422 # @return Value of the minimal distance between the given shapes.
2424 # @ref tui_measurement_tools_page "Example"
2425 def MinDistance(self, theShape1, theShape2):
2426 # Example: see GEOM_TestMeasures.py
2427 aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
2428 RaiseIfFailed("GetMinDistance", self.MeasuOp)
2431 ## Get minimal distance between the given shapes.
2432 # @param theShape1,theShape2 Shapes to find minimal distance between.
2433 # @return Value of the minimal distance between the given shapes.
2435 # @ref swig_all_measure "Example"
2436 def MinDistanceComponents(self, theShape1, theShape2):
2437 # Example: see GEOM_TestMeasures.py
2438 aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
2439 RaiseIfFailed("GetMinDistance", self.MeasuOp)
2440 aRes = [aTuple[0], aTuple[4] - aTuple[1], aTuple[5] - aTuple[2], aTuple[6] - aTuple[3]]
2443 ## Get angle between the given shapes in degrees.
2444 # @param theShape1,theShape2 Lines or linear edges to find angle between.
2445 # @return Value of the angle between the given shapes in degrees.
2447 # @ref tui_measurement_tools_page "Example"
2448 def GetAngle(self, theShape1, theShape2):
2449 # Example: see GEOM_TestMeasures.py
2450 anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
2451 RaiseIfFailed("GetAngle", self.MeasuOp)
2453 ## Get angle between the given shapes in radians.
2454 # @param theShape1,theShape2 Lines or linear edges to find angle between.
2455 # @return Value of the angle between the given shapes in radians.
2457 # @ref tui_measurement_tools_page "Example"
2458 def GetAngleRadians(self, theShape1, theShape2):
2459 # Example: see GEOM_TestMeasures.py
2460 anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)*math.pi/180.
2461 RaiseIfFailed("GetAngle", self.MeasuOp)
2464 ## @name Curve Curvature Measurement
2465 # Methods for receiving radius of curvature of curves
2466 # in the given point
2469 ## Measure curvature of a curve at a point, set by parameter.
2470 # @ref swig_todo "Example"
2471 def CurveCurvatureByParam(self, theCurve, theParam):
2472 # Example: see GEOM_TestMeasures.py
2473 aCurv = self.MeasuOp.CurveCurvatureByParam(theCurve,theParam)
2474 RaiseIfFailed("CurveCurvatureByParam", self.MeasuOp)
2478 # @ref swig_todo "Example"
2479 def CurveCurvatureByPoint(self, theCurve, thePoint):
2480 aCurv = self.MeasuOp.CurveCurvatureByPoint(theCurve,thePoint)
2481 RaiseIfFailed("CurveCurvatureByPoint", self.MeasuOp)
2485 ## @name Surface Curvature Measurement
2486 # Methods for receiving max and min radius of curvature of surfaces
2487 # in the given point
2491 ## @ref swig_todo "Example"
2492 def MaxSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
2493 # Example: see GEOM_TestMeasures.py
2494 aSurf = self.MeasuOp.MaxSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
2495 RaiseIfFailed("MaxSurfaceCurvatureByParam", self.MeasuOp)
2499 ## @ref swig_todo "Example"
2500 def MaxSurfaceCurvatureByPoint(self, theSurf, thePoint):
2501 aSurf = self.MeasuOp.MaxSurfaceCurvatureByPoint(theSurf,thePoint)
2502 RaiseIfFailed("MaxSurfaceCurvatureByPoint", self.MeasuOp)
2506 ## @ref swig_todo "Example"
2507 def MinSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
2508 aSurf = self.MeasuOp.MinSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
2509 RaiseIfFailed("MinSurfaceCurvatureByParam", self.MeasuOp)
2513 ## @ref swig_todo "Example"
2514 def MinSurfaceCurvatureByPoint(self, theSurf, thePoint):
2515 aSurf = self.MeasuOp.MinSurfaceCurvatureByPoint(theSurf,thePoint)
2516 RaiseIfFailed("MinSurfaceCurvatureByPoint", self.MeasuOp)
2520 ## Get min and max tolerances of sub-shapes of theShape
2521 # @param theShape Shape, to get tolerances of.
2522 # @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
2523 # FaceMin,FaceMax: Min and max tolerances of the faces.
2524 # EdgeMin,EdgeMax: Min and max tolerances of the edges.
2525 # VertMin,VertMax: Min and max tolerances of the vertices.
2527 # @ref tui_measurement_tools_page "Example"
2528 def Tolerance(self,theShape):
2529 # Example: see GEOM_TestMeasures.py
2530 aTuple = self.MeasuOp.GetTolerance(theShape)
2531 RaiseIfFailed("GetTolerance", self.MeasuOp)
2534 ## Obtain description of the given shape (number of sub-shapes of each type)
2535 # @param theShape Shape to be described.
2536 # @return Description of the given shape.
2538 # @ref tui_measurement_tools_page "Example"
2539 def WhatIs(self,theShape):
2540 # Example: see GEOM_TestMeasures.py
2541 aDescr = self.MeasuOp.WhatIs(theShape)
2542 RaiseIfFailed("WhatIs", self.MeasuOp)
2545 ## Get a point, situated at the centre of mass of theShape.
2546 # @param theShape Shape to define centre of mass of.
2547 # @return New GEOM_Object, containing the created point.
2549 # @ref tui_measurement_tools_page "Example"
2550 def MakeCDG(self,theShape):
2551 # Example: see GEOM_TestMeasures.py
2552 anObj = self.MeasuOp.GetCentreOfMass(theShape)
2553 RaiseIfFailed("GetCentreOfMass", self.MeasuOp)
2556 ## Get a normale to the given face. If the point is not given,
2557 # the normale is calculated at the center of mass.
2558 # @param theFace Face to define normale of.
2559 # @param theOptionalPoint Point to compute the normale at.
2560 # @return New GEOM_Object, containing the created vector.
2562 # @ref swig_todo "Example"
2563 def GetNormal(self, theFace, theOptionalPoint = None):
2564 # Example: see GEOM_TestMeasures.py
2565 anObj = self.MeasuOp.GetNormal(theFace, theOptionalPoint)
2566 RaiseIfFailed("GetNormal", self.MeasuOp)
2569 ## Check a topology of the given shape.
2570 # @param theShape Shape to check validity of.
2571 # @param theIsCheckGeom If FALSE, only the shape's topology will be checked,
2572 # if TRUE, the shape's geometry will be checked also.
2573 # @return TRUE, if the shape "seems to be valid".
2574 # If theShape is invalid, prints a description of problem.
2576 # @ref tui_measurement_tools_page "Example"
2577 def CheckShape(self,theShape, theIsCheckGeom = 0):
2578 # Example: see GEOM_TestMeasures.py
2580 (IsValid, Status) = self.MeasuOp.CheckShapeWithGeometry(theShape)
2581 RaiseIfFailed("CheckShapeWithGeometry", self.MeasuOp)
2583 (IsValid, Status) = self.MeasuOp.CheckShape(theShape)
2584 RaiseIfFailed("CheckShape", self.MeasuOp)
2589 ## Get position (LCS) of theShape.
2591 # Origin of the LCS is situated at the shape's center of mass.
2592 # Axes of the LCS are obtained from shape's location or,
2593 # if the shape is a planar face, from position of its plane.
2595 # @param theShape Shape to calculate position of.
2596 # @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
2597 # Ox,Oy,Oz: Coordinates of shape's LCS origin.
2598 # Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
2599 # Xx,Xy,Xz: Coordinates of shape's LCS X direction.
2601 # @ref swig_todo "Example"
2602 def GetPosition(self,theShape):
2603 # Example: see GEOM_TestMeasures.py
2604 aTuple = self.MeasuOp.GetPosition(theShape)
2605 RaiseIfFailed("GetPosition", self.MeasuOp)
2608 ## Get kind of theShape.
2610 # @param theShape Shape to get a kind of.
2611 # @return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration
2612 # and a list of parameters, describing the shape.
2613 # @note Concrete meaning of each value, returned via \a theIntegers
2614 # or \a theDoubles list depends on the kind of the shape.
2615 # The full list of possible outputs is:
2617 # - geompy.kind.COMPOUND nb_solids nb_faces nb_edges nb_vertices
2618 # - geompy.kind.COMPSOLID nb_solids nb_faces nb_edges nb_vertices
2620 # - geompy.kind.SHELL geompy.info.CLOSED nb_faces nb_edges nb_vertices
2621 # - geompy.kind.SHELL geompy.info.UNCLOSED nb_faces nb_edges nb_vertices
2623 # - geompy.kind.WIRE geompy.info.CLOSED nb_edges nb_vertices
2624 # - geompy.kind.WIRE geompy.info.UNCLOSED nb_edges nb_vertices
2626 # - geompy.kind.SPHERE xc yc zc R
2627 # - geompy.kind.CYLINDER xb yb zb dx dy dz R H
2628 # - geompy.kind.BOX xc yc zc ax ay az
2629 # - geompy.kind.ROTATED_BOX xc yc zc zx zy zz xx xy xz ax ay az
2630 # - geompy.kind.TORUS xc yc zc dx dy dz R_1 R_2
2631 # - geompy.kind.CONE xb yb zb dx dy dz R_1 R_2 H
2632 # - geompy.kind.POLYHEDRON nb_faces nb_edges nb_vertices
2633 # - geompy.kind.SOLID nb_faces nb_edges nb_vertices
2635 # - geompy.kind.SPHERE2D xc yc zc R
2636 # - geompy.kind.CYLINDER2D xb yb zb dx dy dz R H
2637 # - geompy.kind.TORUS2D xc yc zc dx dy dz R_1 R_2
2638 # - geompy.kind.CONE2D xc yc zc dx dy dz R_1 R_2 H
2639 # - geompy.kind.DISK_CIRCLE xc yc zc dx dy dz R
2640 # - geompy.kind.DISK_ELLIPSE xc yc zc dx dy dz R_1 R_2
2641 # - geompy.kind.POLYGON xo yo zo dx dy dz nb_edges nb_vertices
2642 # - geompy.kind.PLANE xo yo zo dx dy dz
2643 # - geompy.kind.PLANAR xo yo zo dx dy dz nb_edges nb_vertices
2644 # - geompy.kind.FACE nb_edges nb_vertices
2646 # - geompy.kind.CIRCLE xc yc zc dx dy dz R
2647 # - geompy.kind.ARC_CIRCLE xc yc zc dx dy dz R x1 y1 z1 x2 y2 z2
2648 # - geompy.kind.ELLIPSE xc yc zc dx dy dz R_1 R_2
2649 # - geompy.kind.ARC_ELLIPSE xc yc zc dx dy dz R_1 R_2 x1 y1 z1 x2 y2 z2
2650 # - geompy.kind.LINE xo yo zo dx dy dz
2651 # - geompy.kind.SEGMENT x1 y1 z1 x2 y2 z2
2652 # - geompy.kind.EDGE nb_vertices
2654 # - geompy.kind.VERTEX x y z
2656 # @ref swig_todo "Example"
2657 def KindOfShape(self,theShape):
2658 # Example: see GEOM_TestMeasures.py
2659 aRoughTuple = self.MeasuOp.KindOfShape(theShape)
2660 RaiseIfFailed("KindOfShape", self.MeasuOp)
2662 aKind = aRoughTuple[0]
2663 anInts = aRoughTuple[1]
2664 aDbls = aRoughTuple[2]
2666 # Now there is no exception from this rule:
2667 aKindTuple = [aKind] + aDbls + anInts
2669 # If they are we will regroup parameters for such kind of shape.
2671 #if aKind == kind.SOME_KIND:
2672 # # SOME_KIND int int double int double double
2673 # aKindTuple = [aKind, anInts[0], anInts[1], aDbls[0], anInts[2], aDbls[1], aDbls[2]]
2680 ## @addtogroup l2_import_export
2683 ## Import a shape from the BREP or IGES or STEP file
2684 # (depends on given format) with given name.
2685 # @param theFileName The file, containing the shape.
2686 # @param theFormatName Specify format for the file reading.
2687 # Available formats can be obtained with InsertOp.ImportTranslators() method.
2688 # @return New GEOM_Object, containing the imported shape.
2690 # @ref swig_Import_Export "Example"
2691 def Import(self,theFileName, theFormatName):
2692 # Example: see GEOM_TestOthers.py
2693 anObj = self.InsertOp.Import(theFileName, theFormatName)
2694 RaiseIfFailed("Import", self.InsertOp)
2697 ## Shortcut to Import() for BREP format
2699 # @ref swig_Import_Export "Example"
2700 def ImportBREP(self,theFileName):
2701 # Example: see GEOM_TestOthers.py
2702 return self.Import(theFileName, "BREP")
2704 ## Shortcut to Import() for IGES format
2706 # @ref swig_Import_Export "Example"
2707 def ImportIGES(self,theFileName):
2708 # Example: see GEOM_TestOthers.py
2709 return self.Import(theFileName, "IGES")
2711 ## Shortcut to Import() for STEP format
2713 # @ref swig_Import_Export "Example"
2714 def ImportSTEP(self,theFileName):
2715 # Example: see GEOM_TestOthers.py
2716 return self.Import(theFileName, "STEP")
2718 ## Export the given shape into a file with given name.
2719 # @param theObject Shape to be stored in the file.
2720 # @param theFileName Name of the file to store the given shape in.
2721 # @param theFormatName Specify format for the shape storage.
2722 # Available formats can be obtained with InsertOp.ImportTranslators() method.
2724 # @ref swig_Import_Export "Example"
2725 def Export(self,theObject, theFileName, theFormatName):
2726 # Example: see GEOM_TestOthers.py
2727 self.InsertOp.Export(theObject, theFileName, theFormatName)
2728 if self.InsertOp.IsDone() == 0:
2729 raise RuntimeError, "Export : " + self.InsertOp.GetErrorCode()
2733 ## Shortcut to Export() for BREP format
2735 # @ref swig_Import_Export "Example"
2736 def ExportBREP(self,theObject, theFileName):
2737 # Example: see GEOM_TestOthers.py
2738 return self.Export(theObject, theFileName, "BREP")
2740 ## Shortcut to Export() for IGES format
2742 # @ref swig_Import_Export "Example"
2743 def ExportIGES(self,theObject, theFileName):
2744 # Example: see GEOM_TestOthers.py
2745 return self.Export(theObject, theFileName, "IGES")
2747 ## Shortcut to Export() for STEP format
2749 # @ref swig_Import_Export "Example"
2750 def ExportSTEP(self,theObject, theFileName):
2751 # Example: see GEOM_TestOthers.py
2752 return self.Export(theObject, theFileName, "STEP")
2754 # end of l2_import_export
2757 ## @addtogroup l3_blocks
2760 ## Create a quadrangle face from four edges. Order of Edges is not
2761 # important. It is not necessary that edges share the same vertex.
2762 # @param E1,E2,E3,E4 Edges for the face bound.
2763 # @return New GEOM_Object, containing the created face.
2765 # @ref tui_building_by_blocks_page "Example"
2766 def MakeQuad(self,E1, E2, E3, E4):
2767 # Example: see GEOM_Spanner.py
2768 anObj = self.BlocksOp.MakeQuad(E1, E2, E3, E4)
2769 RaiseIfFailed("MakeQuad", self.BlocksOp)
2772 ## Create a quadrangle face on two edges.
2773 # The missing edges will be built by creating the shortest ones.
2774 # @param E1,E2 Two opposite edges for the face.
2775 # @return New GEOM_Object, containing the created face.
2777 # @ref tui_building_by_blocks_page "Example"
2778 def MakeQuad2Edges(self,E1, E2):
2779 # Example: see GEOM_Spanner.py
2780 anObj = self.BlocksOp.MakeQuad2Edges(E1, E2)
2781 RaiseIfFailed("MakeQuad2Edges", self.BlocksOp)
2784 ## Create a quadrangle face with specified corners.
2785 # The missing edges will be built by creating the shortest ones.
2786 # @param V1,V2,V3,V4 Corner vertices for the face.
2787 # @return New GEOM_Object, containing the created face.
2789 # @ref tui_building_by_blocks_page "Example 1"
2790 # \n @ref swig_MakeQuad4Vertices "Example 2"
2791 def MakeQuad4Vertices(self,V1, V2, V3, V4):
2792 # Example: see GEOM_Spanner.py
2793 anObj = self.BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
2794 RaiseIfFailed("MakeQuad4Vertices", self.BlocksOp)
2797 ## Create a hexahedral solid, bounded by the six given faces. Order of
2798 # faces is not important. It is not necessary that Faces share the same edge.
2799 # @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
2800 # @return New GEOM_Object, containing the created solid.
2802 # @ref tui_building_by_blocks_page "Example 1"
2803 # \n @ref swig_MakeHexa "Example 2"
2804 def MakeHexa(self,F1, F2, F3, F4, F5, F6):
2805 # Example: see GEOM_Spanner.py
2806 anObj = self.BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
2807 RaiseIfFailed("MakeHexa", self.BlocksOp)
2810 ## Create a hexahedral solid between two given faces.
2811 # The missing faces will be built by creating the smallest ones.
2812 # @param F1,F2 Two opposite faces for the hexahedral solid.
2813 # @return New GEOM_Object, containing the created solid.
2815 # @ref tui_building_by_blocks_page "Example 1"
2816 # \n @ref swig_MakeHexa2Faces "Example 2"
2817 def MakeHexa2Faces(self,F1, F2):
2818 # Example: see GEOM_Spanner.py
2819 anObj = self.BlocksOp.MakeHexa2Faces(F1, F2)
2820 RaiseIfFailed("MakeHexa2Faces", self.BlocksOp)
2826 ## @addtogroup l3_blocks_op
2829 ## Get a vertex, found in the given shape by its coordinates.
2830 # @param theShape Block or a compound of blocks.
2831 # @param theX,theY,theZ Coordinates of the sought vertex.
2832 # @param theEpsilon Maximum allowed distance between the resulting
2833 # vertex and point with the given coordinates.
2834 # @return New GEOM_Object, containing the found vertex.
2836 # @ref swig_GetPoint "Example"
2837 def GetPoint(self,theShape, theX, theY, theZ, theEpsilon):
2838 # Example: see GEOM_TestOthers.py
2839 anObj = self.BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
2840 RaiseIfFailed("GetPoint", self.BlocksOp)
2843 ## Get an edge, found in the given shape by two given vertices.
2844 # @param theShape Block or a compound of blocks.
2845 # @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2846 # @return New GEOM_Object, containing the found edge.
2848 # @ref swig_todo "Example"
2849 def GetEdge(self,theShape, thePoint1, thePoint2):
2850 # Example: see GEOM_Spanner.py
2851 anObj = self.BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
2852 RaiseIfFailed("GetEdge", self.BlocksOp)
2855 ## Find an edge of the given shape, which has minimal distance to the given point.
2856 # @param theShape Block or a compound of blocks.
2857 # @param thePoint Point, close to the desired edge.
2858 # @return New GEOM_Object, containing the found edge.
2860 # @ref swig_GetEdgeNearPoint "Example"
2861 def GetEdgeNearPoint(self,theShape, thePoint):
2862 # Example: see GEOM_TestOthers.py
2863 anObj = self.BlocksOp.GetEdgeNearPoint(theShape, thePoint)
2864 RaiseIfFailed("GetEdgeNearPoint", self.BlocksOp)
2867 ## Returns a face, found in the given shape by four given corner vertices.
2868 # @param theShape Block or a compound of blocks.
2869 # @param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2870 # @return New GEOM_Object, containing the found face.
2872 # @ref swig_todo "Example"
2873 def GetFaceByPoints(self,theShape, thePoint1, thePoint2, thePoint3, thePoint4):
2874 # Example: see GEOM_Spanner.py
2875 anObj = self.BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
2876 RaiseIfFailed("GetFaceByPoints", self.BlocksOp)
2879 ## Get a face of block, found in the given shape by two given edges.
2880 # @param theShape Block or a compound of blocks.
2881 # @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2882 # @return New GEOM_Object, containing the found face.
2884 # @ref swig_todo "Example"
2885 def GetFaceByEdges(self,theShape, theEdge1, theEdge2):
2886 # Example: see GEOM_Spanner.py
2887 anObj = self.BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
2888 RaiseIfFailed("GetFaceByEdges", self.BlocksOp)
2891 ## Find a face, opposite to the given one in the given block.
2892 # @param theBlock Must be a hexahedral solid.
2893 # @param theFace Face of \a theBlock, opposite to the desired face.
2894 # @return New GEOM_Object, containing the found face.
2896 # @ref swig_GetOppositeFace "Example"
2897 def GetOppositeFace(self,theBlock, theFace):
2898 # Example: see GEOM_Spanner.py
2899 anObj = self.BlocksOp.GetOppositeFace(theBlock, theFace)
2900 RaiseIfFailed("GetOppositeFace", self.BlocksOp)
2903 ## Find a face of the given shape, which has minimal distance to the given point.
2904 # @param theShape Block or a compound of blocks.
2905 # @param thePoint Point, close to the desired face.
2906 # @return New GEOM_Object, containing the found face.
2908 # @ref swig_GetFaceNearPoint "Example"
2909 def GetFaceNearPoint(self,theShape, thePoint):
2910 # Example: see GEOM_Spanner.py
2911 anObj = self.BlocksOp.GetFaceNearPoint(theShape, thePoint)
2912 RaiseIfFailed("GetFaceNearPoint", self.BlocksOp)
2915 ## Find a face of block, whose outside normale has minimal angle with the given vector.
2916 # @param theBlock Block or a compound of blocks.
2917 # @param theVector Vector, close to the normale of the desired face.
2918 # @return New GEOM_Object, containing the found face.
2920 # @ref swig_todo "Example"
2921 def GetFaceByNormale(self, theBlock, theVector):
2922 # Example: see GEOM_Spanner.py
2923 anObj = self.BlocksOp.GetFaceByNormale(theBlock, theVector)
2924 RaiseIfFailed("GetFaceByNormale", self.BlocksOp)
2927 # end of l3_blocks_op
2930 ## @addtogroup l4_blocks_measure
2933 ## Check, if the compound of blocks is given.
2934 # To be considered as a compound of blocks, the
2935 # given shape must satisfy the following conditions:
2936 # - Each element of the compound should be a Block (6 faces and 12 edges).
2937 # - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2938 # - The compound should be connexe.
2939 # - The glue between two quadrangle faces should be applied.
2940 # @param theCompound The compound to check.
2941 # @return TRUE, if the given shape is a compound of blocks.
2942 # If theCompound is not valid, prints all discovered errors.
2944 # @ref tui_measurement_tools_page "Example 1"
2945 # \n @ref swig_CheckCompoundOfBlocks "Example 2"
2946 def CheckCompoundOfBlocks(self,theCompound):
2947 # Example: see GEOM_Spanner.py
2948 (IsValid, BCErrors) = self.BlocksOp.CheckCompoundOfBlocks(theCompound)
2949 RaiseIfFailed("CheckCompoundOfBlocks", self.BlocksOp)
2951 Descr = self.BlocksOp.PrintBCErrors(theCompound, BCErrors)
2955 ## Remove all seam and degenerated edges from \a theShape.
2956 # Unite faces and edges, sharing one surface. It means that
2957 # this faces must have references to one C++ surface object (handle).
2958 # @param theShape The compound or single solid to remove irregular edges from.
2959 # @return Improved shape.
2961 # @ref swig_RemoveExtraEdges "Example"
2962 def RemoveExtraEdges(self,theShape):
2963 # Example: see GEOM_TestOthers.py
2964 anObj = self.BlocksOp.RemoveExtraEdges(theShape)
2965 RaiseIfFailed("RemoveExtraEdges", self.BlocksOp)
2968 ## Check, if the given shape is a blocks compound.
2969 # Fix all detected errors.
2970 # \note Single block can be also fixed by this method.
2971 # @param theShape The compound to check and improve.
2972 # @return Improved compound.
2974 # @ref swig_CheckAndImprove "Example"
2975 def CheckAndImprove(self,theShape):
2976 # Example: see GEOM_TestOthers.py
2977 anObj = self.BlocksOp.CheckAndImprove(theShape)
2978 RaiseIfFailed("CheckAndImprove", self.BlocksOp)
2981 # end of l4_blocks_measure
2984 ## @addtogroup l3_blocks_op
2987 ## Get all the blocks, contained in the given compound.
2988 # @param theCompound The compound to explode.
2989 # @param theMinNbFaces If solid has lower number of faces, it is not a block.
2990 # @param theMaxNbFaces If solid has higher number of faces, it is not a block.
2991 # \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2992 # @return List of GEOM_Objects, containing the retrieved blocks.
2994 # @ref tui_explode_on_blocks "Example 1"
2995 # \n @ref swig_MakeBlockExplode "Example 2"
2996 def MakeBlockExplode(self,theCompound, theMinNbFaces, theMaxNbFaces):
2997 # Example: see GEOM_TestOthers.py
2998 aList = self.BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
2999 RaiseIfFailed("ExplodeCompoundOfBlocks", self.BlocksOp)
3002 ## Find block, containing the given point inside its volume or on boundary.
3003 # @param theCompound Compound, to find block in.
3004 # @param thePoint Point, close to the desired block. If the point lays on
3005 # boundary between some blocks, we return block with nearest center.
3006 # @return New GEOM_Object, containing the found block.
3008 # @ref swig_todo "Example"
3009 def GetBlockNearPoint(self,theCompound, thePoint):
3010 # Example: see GEOM_Spanner.py
3011 anObj = self.BlocksOp.GetBlockNearPoint(theCompound, thePoint)
3012 RaiseIfFailed("GetBlockNearPoint", self.BlocksOp)
3015 ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
3016 # @param theCompound Compound, to find block in.
3017 # @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
3018 # @return New GEOM_Object, containing the found block.
3020 # @ref swig_GetBlockByParts "Example"
3021 def GetBlockByParts(self,theCompound, theParts):
3022 # Example: see GEOM_TestOthers.py
3023 anObj = self.BlocksOp.GetBlockByParts(theCompound, theParts)
3024 RaiseIfFailed("GetBlockByParts", self.BlocksOp)
3027 ## Return all blocks, containing all the elements, passed as the parts.
3028 # @param theCompound Compound, to find blocks in.
3029 # @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
3030 # @return List of GEOM_Objects, containing the found blocks.
3032 # @ref swig_todo "Example"
3033 def GetBlocksByParts(self,theCompound, theParts):
3034 # Example: see GEOM_Spanner.py
3035 aList = self.BlocksOp.GetBlocksByParts(theCompound, theParts)
3036 RaiseIfFailed("GetBlocksByParts", self.BlocksOp)
3039 ## Multi-transformate block and glue the result.
3040 # Transformation is defined so, as to superpose direction faces.
3041 # @param Block Hexahedral solid to be multi-transformed.
3042 # @param DirFace1 ID of First direction face.
3043 # @param DirFace2 ID of Second direction face.
3044 # @param NbTimes Quantity of transformations to be done.
3045 # \note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
3046 # @return New GEOM_Object, containing the result shape.
3048 # @ref tui_multi_transformation "Example"
3049 def MakeMultiTransformation1D(self,Block, DirFace1, DirFace2, NbTimes):
3050 # Example: see GEOM_Spanner.py
3051 anObj = self.BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
3052 RaiseIfFailed("MakeMultiTransformation1D", self.BlocksOp)
3055 ## Multi-transformate block and glue the result.
3056 # @param Block Hexahedral solid to be multi-transformed.
3057 # @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
3058 # @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
3059 # @param NbTimesU,NbTimesV Quantity of transformations to be done.
3060 # @return New GEOM_Object, containing the result shape.
3062 # @ref tui_multi_transformation "Example"
3063 def MakeMultiTransformation2D(self,Block, DirFace1U, DirFace2U, NbTimesU,
3064 DirFace1V, DirFace2V, NbTimesV):
3065 # Example: see GEOM_Spanner.py
3066 anObj = self.BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
3067 DirFace1V, DirFace2V, NbTimesV)
3068 RaiseIfFailed("MakeMultiTransformation2D", self.BlocksOp)
3071 ## Build all possible propagation groups.
3072 # Propagation group is a set of all edges, opposite to one (main)
3073 # edge of this group directly or through other opposite edges.
3074 # Notion of Opposite Edge make sence only on quadrangle face.
3075 # @param theShape Shape to build propagation groups on.
3076 # @return List of GEOM_Objects, each of them is a propagation group.
3078 # @ref swig_Propagate "Example"
3079 def Propagate(self,theShape):
3080 # Example: see GEOM_TestOthers.py
3081 listChains = self.BlocksOp.Propagate(theShape)
3082 RaiseIfFailed("Propagate", self.BlocksOp)
3085 # end of l3_blocks_op
3088 ## @addtogroup l3_groups
3091 ## Creates a new group which will store sub shapes of theMainShape
3092 # @param theMainShape is a GEOM object on which the group is selected
3093 # @param theShapeType defines a shape type of the group
3094 # @return a newly created GEOM group
3096 # @ref tui_working_with_groups_page "Example 1"
3097 # \n @ref swig_CreateGroup "Example 2"
3098 def CreateGroup(self,theMainShape, theShapeType):
3099 # Example: see GEOM_TestOthers.py
3100 anObj = self.GroupOp.CreateGroup(theMainShape, theShapeType)
3101 RaiseIfFailed("CreateGroup", self.GroupOp)
3104 ## Adds a sub object with ID theSubShapeId to the group
3105 # @param theGroup is a GEOM group to which the new sub shape is added
3106 # @param theSubShapeID is a sub shape ID in the main object.
3107 # \note Use method GetSubShapeID() to get an unique ID of the sub shape
3109 # @ref tui_working_with_groups_page "Example"
3110 def AddObject(self,theGroup, theSubShapeID):
3111 # Example: see GEOM_TestOthers.py
3112 self.GroupOp.AddObject(theGroup, theSubShapeID)
3113 RaiseIfFailed("AddObject", self.GroupOp)
3116 ## Removes a sub object with ID \a theSubShapeId from the group
3117 # @param theGroup is a GEOM group from which the new sub shape is removed
3118 # @param theSubShapeID is a sub shape ID in the main object.
3119 # \note Use method GetSubShapeID() to get an unique ID of the sub shape
3121 # @ref tui_working_with_groups_page "Example"
3122 def RemoveObject(self,theGroup, theSubShapeID):
3123 # Example: see GEOM_TestOthers.py
3124 self.GroupOp.RemoveObject(theGroup, theSubShapeID)
3125 RaiseIfFailed("RemoveObject", self.GroupOp)
3128 ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3129 # @param theGroup is a GEOM group to which the new sub shapes are added.
3130 # @param theSubShapes is a list of sub shapes to be added.
3132 # @ref tui_working_with_groups_page "Example"
3133 def UnionList (self,theGroup, theSubShapes):
3134 # Example: see GEOM_TestOthers.py
3135 self.GroupOp.UnionList(theGroup, theSubShapes)
3136 RaiseIfFailed("UnionList", self.GroupOp)
3139 ## Works like the above method, but argument
3140 # theSubShapes here is a list of sub-shapes indices
3142 # @ref swig_UnionIDs "Example"
3143 def UnionIDs(self,theGroup, theSubShapes):
3144 # Example: see GEOM_TestOthers.py
3145 self.GroupOp.UnionIDs(theGroup, theSubShapes)
3146 RaiseIfFailed("UnionIDs", self.GroupOp)
3149 ## Removes from the group all the given shapes. No errors, if some shapes are not included.
3150 # @param theGroup is a GEOM group from which the sub-shapes are removed.
3151 # @param theSubShapes is a list of sub-shapes to be removed.
3153 # @ref tui_working_with_groups_page "Example"
3154 def DifferenceList (self,theGroup, theSubShapes):
3155 # Example: see GEOM_TestOthers.py
3156 self.GroupOp.DifferenceList(theGroup, theSubShapes)
3157 RaiseIfFailed("DifferenceList", self.GroupOp)
3160 ## Works like the above method, but argument
3161 # theSubShapes here is a list of sub-shapes indices
3163 # @ref swig_DifferenceIDs "Example"
3164 def DifferenceIDs(self,theGroup, theSubShapes):
3165 # Example: see GEOM_TestOthers.py
3166 self.GroupOp.DifferenceIDs(theGroup, theSubShapes)
3167 RaiseIfFailed("DifferenceIDs", self.GroupOp)
3170 ## Returns a list of sub objects ID stored in the group
3171 # @param theGroup is a GEOM group for which a list of IDs is requested
3173 # @ref swig_GetObjectIDs "Example"
3174 def GetObjectIDs(self,theGroup):
3175 # Example: see GEOM_TestOthers.py
3176 ListIDs = self.GroupOp.GetObjects(theGroup)
3177 RaiseIfFailed("GetObjects", self.GroupOp)
3180 ## Returns a type of sub objects stored in the group
3181 # @param theGroup is a GEOM group which type is returned.
3183 # @ref swig_GetType "Example"
3184 def GetType(self,theGroup):
3185 # Example: see GEOM_TestOthers.py
3186 aType = self.GroupOp.GetType(theGroup)
3187 RaiseIfFailed("GetType", self.GroupOp)
3190 ## Returns a main shape associated with the group
3191 # @param theGroup is a GEOM group for which a main shape object is requested
3192 # @return a GEOM object which is a main shape for theGroup
3194 # @ref swig_GetMainShape "Example"
3195 def GetMainShape(self,theGroup):
3196 # Example: see GEOM_TestOthers.py
3197 anObj = self.GroupOp.GetMainShape(theGroup)
3198 RaiseIfFailed("GetMainShape", self.GroupOp)
3201 ## Create group of edges of theShape, whose length is in range [min_length, max_length].
3202 # If include_min/max == 0, edges with length == min/max_length will not be included in result.
3204 # @ref swig_todo "Example"
3205 def GetEdgesByLength (self, theShape, min_length, max_length, include_min = 1, include_max = 1):
3206 edges = self.SubShapeAll(theShape, ShapeType["EDGE"])
3209 Props = self.BasicProperties(edge)
3210 if min_length <= Props[0] and Props[0] <= max_length:
3211 if (not include_min) and (min_length == Props[0]):
3214 if (not include_max) and (Props[0] == max_length):
3217 edges_in_range.append(edge)
3219 if len(edges_in_range) <= 0:
3220 print "No edges found by given criteria"
3223 group_edges = self.CreateGroup(theShape, ShapeType["EDGE"])
3224 self.UnionList(group_edges, edges_in_range)
3228 ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
3229 # If include_min/max == 0, edges with length == min/max_length will not be included in result.
3231 # @ref swig_todo "Example"
3232 def SelectEdges (self, min_length, max_length, include_min = 1, include_max = 1):
3233 nb_selected = sg.SelectedCount()
3235 print "Select a shape before calling this function, please."
3238 print "Only one shape must be selected"
3241 id_shape = sg.getSelected(0)
3242 shape = IDToObject( id_shape )
3244 group_edges = self.GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
3248 if include_min: left_str = " <= "
3249 if include_max: right_str = " <= "
3251 self.addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
3252 + left_str + "length" + right_str + `max_length`)
3254 sg.updateObjBrowser(1)
3261 ## Create a copy of the given object
3262 # @ingroup l1_geompy_auxiliary
3264 # @ref swig_all_advanced "Example"
3265 def MakeCopy(self,theOriginal):
3266 # Example: see GEOM_TestAll.py
3267 anObj = self.InsertOp.MakeCopy(theOriginal)
3268 RaiseIfFailed("MakeCopy", self.InsertOp)
3271 ## Add Path to load python scripts from
3272 # @ingroup l1_geompy_auxiliary
3273 def addPath(self,Path):
3274 if (sys.path.count(Path) < 1):
3275 sys.path.append(Path)
3278 #Register the new proxy for GEOM_Gen
3279 omniORB.registerObjref(GEOM._objref_GEOM_Gen._NP_RepositoryId, geompyDC)