src/GEOM_SWIG/geompyDC.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 #
  20 #  File   : geompy.py
  21 #  Author : Paul RASCLE, EDF
  22 #  Module : GEOM
  23
  24 """
  25     \namespace geompy
  26     \brief Module geompy
  27 """
  28
  29 ## @defgroup l1_geompy_auxiliary Auxiliary data structures and methods
  30
  31 ## @defgroup l1_geompy_purpose   All package methods, grouped by their purpose
  32 ## @{
  33 ##   @defgroup l2_import_export Importing/exporting geometrical objects
  34 ##   @defgroup l2_creating      Creating geometrical objects
  35 ##   @{
  36 ##     @defgroup l3_basic_go      Creating Basic Geometric Objects
  37 ##     @{
  38 ##       @defgroup l4_curves        Creating Curves
  39
  40 ##     @}
  41 ##     @defgroup l3_3d_primitives Creating 3D Primitives
  42 ##     @defgroup l3_complex       Creating Complex Objects
  43 ##     @defgroup l3_groups        Working with groups
  44 ##     @defgroup l3_blocks        Building by blocks
  45 ##     @{
  46 ##       @defgroup l4_blocks_measure Check and Improve
  47
  48 ##     @}
  49 ##     @defgroup l3_sketcher      Sketcher
  50 ##     @defgroup l3_advanced      Creating Advanced Geometrical Objects
  51 ##     @{
  52 ##       @defgroup l4_decompose     Decompose objects
  53 ##       @defgroup l4_decompose_d   Decompose objects deprecated methods
  54 ##       @defgroup l4_access        Access to sub-shapes by their unique IDs inside the main shape
  55 ##       @defgroup l4_obtain        Access to subshapes by a criteria
  56 ##       @defgroup l4_advanced      Advanced objects creation functions
  57
  58 ##     @}
  59
  60 ##   @}
  61 ##   @defgroup l2_transforming  Transforming geometrical objects
  62 ##   @{
  63 ##     @defgroup l3_basic_op      Basic Operations
  64 ##     @defgroup l3_boolean       Boolean Operations
  65 ##     @defgroup l3_transform     Transformation Operations
  66 ##     @defgroup l3_local         Local Operations (Fillet and Chamfer)
  67 ##     @defgroup l3_blocks_op     Blocks Operations
  68 ##     @defgroup l3_healing       Repairing Operations
  69 ##     @defgroup l3_restore_ss    Restore presentation parameters and a tree of subshapes
  70
  71 ##   @}
  72 ##   @defgroup l2_measure       Using measurement tools
  73
  74 ## @}
  75
  76 import salome
  77 salome.salome_init()
  78 from salome import *
  79
  80 from salome_notebook import *
  81
  82 import GEOM
  83 import math
  84
  85 ## Enumeration ShapeType as a dictionary
  86 #  @ingroup l1_geompy_auxiliary
  87 ShapeType = {"AUTO":-1, "COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8}
  88
  89 ## Raise an Error, containing the Method_name, if Operation is Failed
  90 ## @ingroup l1_geompy_auxiliary
  91 def RaiseIfFailed (Method_name, Operation):
  92     if Operation.IsDone() == 0 and Operation.GetErrorCode() != "NOT_FOUND_ANY":
  93         raise RuntimeError, Method_name + " : " + Operation.GetErrorCode()
  94
  95 ## Return list of variables value from salome notebook
  96 ## @ingroup l1_geompy_auxiliary
  97 def ParseParameters(*parameters):
  98     Result = []
  99     StringResult = []
 100     for parameter in parameters:
 101         if isinstance(parameter, list):
 102             lResults = ParseParameters(*parameter)
 103             if len(lResults) > 0:
 104                 Result.append(lResults[:-1])
 105                 StringResult += lResults[-1].split(":")
 106                 pass
 107             pass
 108         else:
 109             if isinstance(parameter,str):
 110                 if notebook.isVariable(parameter):
 111                     Result.append(notebook.get(parameter))
 112                 else:
 113                     raise RuntimeError, "Variable with name '" + parameter + "' doesn't exist!!!"
 114                 pass
 115             else:
 116                 Result.append(parameter)
 117                 pass
 118             StringResult.append(str(parameter))
 119             pass
 120         pass
 121     if Result:
 122         Result.append(":".join(StringResult))
 123     else:
 124         Result = ":".join(StringResult)
 125     return Result
 126
 127 ## Return list of variables value from salome notebook
 128 ## @ingroup l1_geompy_auxiliary
 129 def ParseList(list):
 130     Result = []
 131     StringResult = ""
 132     for parameter in list:
 133         if isinstance(parameter,str) and notebook.isVariable(parameter):
 134             Result.append(str(notebook.get(parameter)))
 135             pass
 136         else:
 137             Result.append(str(parameter))
 138             pass
 139
 140         StringResult = StringResult + str(parameter)
 141         StringResult = StringResult + ":"
 142         pass
 143     StringResult = StringResult[:len(StringResult)-1]
 144     return Result, StringResult
 145
 146 ## Return list of variables value from salome notebook
 147 ## @ingroup l1_geompy_auxiliary
 148 def ParseSketcherCommand(command):
 149     Result = ""
 150     StringResult = ""
 151     sections = command.split(":")
 152     for section in sections:
 153         parameters = section.split(" ")
 154         paramIndex = 1
 155         for parameter in parameters:
 156             if paramIndex > 1 and parameter.find("'") != -1:
 157                 parameter = parameter.replace("'","")
 158                 if notebook.isVariable(parameter):
 159                     Result = Result + str(notebook.get(parameter)) + " "
 160                     pass
 161                 else:
 162                     raise RuntimeError, "Variable with name '" + parameter + "' doesn't exist!!!"
 163                     pass
 164                 pass
 165             else:
 166                 Result = Result + str(parameter) + " "
 167                 pass
 168             if paramIndex > 1:
 169                 StringResult = StringResult + parameter
 170                 StringResult = StringResult + ":"
 171                 pass
 172             paramIndex = paramIndex + 1
 173             pass
 174         Result = Result[:len(Result)-1] + ":"
 175         pass
 176     Result = Result[:len(Result)-1]
 177     return Result, StringResult
 178
 179 ## Helper function which can be used to pack the passed string to the byte data.
 180 ## Only '1' an '0' symbols are valid for the string. The missing bits are replaced by zeroes.
 181 ## If the string contains invalid symbol (neither '1' nor '0'), the function raises an exception.
 182 ## For example,
 183 ## \code
 184 ## val = PackData("10001110") # val = 0xAE
 185 ## val = PackData("1")        # val = 0x80
 186 ## \endcode
 187 ## @param data unpacked data - a string containing '1' and '0' symbols
 188 ## @return data packed to the byte stream
 189 ## @ingroup l1_geompy_auxiliary
 190 def PackData(data):
 191     bytes = len(data)/8
 192     if len(data)%8: bytes += 1
 193     res = ""
 194     for b in range(bytes):
 195         d = data[b*8:(b+1)*8]
 196         val = 0
 197         for i in range(8):
 198             val *= 2
 199             if i < len(d):
 200                 if d[i] == "1": val += 1
 201                 elif d[i] != "0":
 202                     raise "Invalid symbol %s" % d[i]
 203                 pass
 204             pass
 205         res += chr(val)
 206         pass
 207     return res
 208
 209 ## Read bitmap texture from the text file.
 210 ## In that file, any non-zero symbol represents '1' opaque pixel of the bitmap.
 211 ## A zero symbol ('0') represents transparent pixel of the texture bitmap.
 212 ## The function returns width and height of the pixmap in pixels and byte stream representing
 213 ## texture bitmap itself.
 214 ##
 215 ## This function can be used to read the texture to the byte stream in order to pass it to
 216 ## the AddTexture() function of geompy class.
 217 ## For example,
 218 ## \code
 219 ## import geompy
 220 ## geompy.init_geom(salome.myStudy)
 221 ## texture = geompy.readtexture('mytexture.dat')
 222 ## texture = geompy.AddTexture(*texture)
 223 ## obj.SetMarkerTexture(texture)
 224 ## \endcode
 225 ## @param fname texture file name
 226 ## @return sequence of tree values: texture's width, height in pixels and its byte stream
 227 ## @ingroup l1_geompy_auxiliary
 228 def ReadTexture(fname):
 229     try:
 230         f = open(fname)
 231         lines = [ l.strip() for l in f.readlines()]
 232         f.close()
 233         maxlen = 0
 234         if lines: maxlen = max([len(x) for x in lines])
 235         lenbytes = maxlen/8
 236         if maxlen%8: lenbytes += 1
 237         bytedata=""
 238         for line in lines:
 239             if len(line)%8:
 240                 lenline = (len(line)/8+1)*8
 241                 pass
 242             else:
 243                 lenline = (len(line)/8)*8
 244                 pass
 245             for i in range(lenline/8):
 246                 byte=""
 247                 for j in range(8):
 248                     if i*8+j < len(line) and line[i*8+j] != "0": byte += "1"
 249                     else: byte += "0"
 250                     pass
 251                 bytedata += PackData(byte)
 252                 pass
 253             for i in range(lenline/8, lenbytes):
 254                 bytedata += PackData("0")
 255             pass
 256         return lenbytes*8, len(lines), bytedata
 257     except:
 258         pass
 259     return 0, 0, ""
 260
 261 ## Returns a long value from enumeration type
 262 #  Can be used for CORBA enumerator types like GEOM.shape_type
 263 #  @ingroup l1_geompy_auxiliary
 264 def EnumToLong(theItem):
 265     ret = theItem
 266     if hasattr(theItem, "_v"): ret = theItem._v
 267     return ret
 268
 269 ## Kinds of shape enumeration
 270 #  @ingroup l1_geompy_auxiliary
 271 kind = GEOM.GEOM_IKindOfShape
 272
 273 ## Information about closed/unclosed state of shell or wire
 274 #  @ingroup l1_geompy_auxiliary
 275 class info:
 276     UNKNOWN  = 0
 277     CLOSED   = 1
 278     UNCLOSED = 2
 279
 280 class geompyDC(GEOM._objref_GEOM_Gen):
 281
 282         def __init__(self):
 283             GEOM._objref_GEOM_Gen.__init__(self)
 284             self.myBuilder = None
 285             self.myStudyId = 0
 286             self.father    = None
 287
 288             self.BasicOp  = None
 289             self.CurvesOp = None
 290             self.PrimOp   = None
 291             self.ShapesOp = None
 292             self.HealOp   = None
 293             self.InsertOp = None
 294             self.BoolOp   = None
 295             self.TrsfOp   = None
 296             self.LocalOp  = None
 297             self.MeasuOp  = None
 298             self.BlocksOp = None
 299             self.GroupOp  = None
 300             self.AdvOp    = None
 301             pass
 302
 303         ## @addtogroup l1_geompy_auxiliary
 304         ## @{
 305         def init_geom(self,theStudy):
 306             self.myStudy = theStudy
 307             self.myStudyId = self.myStudy._get_StudyId()
 308             self.myBuilder = self.myStudy.NewBuilder()
 309             self.father = self.myStudy.FindComponent("GEOM")
 310             if self.father is None:
 311                 self.father = self.myBuilder.NewComponent("GEOM")
 312                 A1 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributeName")
 313                 FName = A1._narrow(SALOMEDS.AttributeName)
 314                 FName.SetValue("Geometry")
 315                 A2 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributePixMap")
 316                 aPixmap = A2._narrow(SALOMEDS.AttributePixMap)
 317                 aPixmap.SetPixMap("ICON_OBJBROWSER_Geometry")
 318                 self.myBuilder.DefineComponentInstance(self.father,self)
 319                 pass
 320             self.BasicOp  = self.GetIBasicOperations    (self.myStudyId)
 321             self.CurvesOp = self.GetICurvesOperations   (self.myStudyId)
 322             self.PrimOp   = self.GetI3DPrimOperations   (self.myStudyId)
 323             self.ShapesOp = self.GetIShapesOperations   (self.myStudyId)
 324             self.HealOp   = self.GetIHealingOperations  (self.myStudyId)
 325             self.InsertOp = self.GetIInsertOperations   (self.myStudyId)
 326             self.BoolOp   = self.GetIBooleanOperations  (self.myStudyId)
 327             self.TrsfOp   = self.GetITransformOperations(self.myStudyId)
 328             self.LocalOp  = self.GetILocalOperations    (self.myStudyId)
 329             self.MeasuOp  = self.GetIMeasureOperations  (self.myStudyId)
 330             self.BlocksOp = self.GetIBlocksOperations   (self.myStudyId)
 331             self.GroupOp  = self.GetIGroupOperations    (self.myStudyId)
 332             self.AdvOp    = self.GetIAdvancedOperations (self.myStudyId)
 333             pass
 334
 335         ## Dump component to the Python script
 336         #  This method overrides IDL function to allow default values for the parameters.
 337         def DumpPython(self, theStudy, theIsPublished=True, theIsMultiFile=True):
 338             return GEOM._objref_GEOM_Gen.DumpPython(self, theStudy, theIsPublished, theIsMultiFile)
 339
 340         ## Get name for sub-shape aSubObj of shape aMainObj
 341         #
 342         # @ref swig_SubShapeAllSorted "Example"
 343         def SubShapeName(self,aSubObj, aMainObj):
 344             # Example: see GEOM_TestAll.py
 345
 346             #aSubId  = orb.object_to_string(aSubObj)
 347             #aMainId = orb.object_to_string(aMainObj)
 348             #index = gg.getIndexTopology(aSubId, aMainId)
 349             #name = gg.getShapeTypeString(aSubId) + "_%d"%(index)
 350             index = self.ShapesOp.GetTopologyIndex(aMainObj, aSubObj)
 351             name = self.ShapesOp.GetShapeTypeString(aSubObj) + "_%d"%(index)
 352             return name
 353
 354         ## Publish in study aShape with name aName
 355         #
 356         #  \param aShape the shape to be published
 357         #  \param aName  the name for the shape
 358         #  \param doRestoreSubShapes if True, finds and publishes also
 359         #         sub-shapes of <VAR>aShape</VAR>, corresponding to its arguments
 360         #         and published sub-shapes of arguments
 361         #  \param theArgs,theFindMethod,theInheritFirstArg see geompy.RestoreSubShapes for
 362         #                                                  these arguments description
 363         #  \return study entry of the published shape in form of string
 364         #
 365         #  @ref swig_MakeQuad4Vertices "Example"
 366         def addToStudy(self, aShape, aName, doRestoreSubShapes=False,
 367                        theArgs=[], theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False):
 368             # Example: see GEOM_TestAll.py
 369             try:
 370                 aSObject = self.AddInStudy(self.myStudy, aShape, aName, None)
 371                 if doRestoreSubShapes:
 372                     self.RestoreSubShapesSO(self.myStudy, aSObject, theArgs,
 373                                             theFindMethod, theInheritFirstArg, True )
 374             except:
 375                 print "addToStudy() failed"
 376                 return ""
 377             return aShape.GetStudyEntry()
 378
 379         ## Publish in study aShape with name aName as sub-object of previously published aFather
 380         #
 381         #  @ref swig_SubShapeAllSorted "Example"
 382         def addToStudyInFather(self, aFather, aShape, aName):
 383             # Example: see GEOM_TestAll.py
 384             try:
 385                 aSObject = self.AddInStudy(self.myStudy, aShape, aName, aFather)
 386             except:
 387                 print "addToStudyInFather() failed"
 388                 return ""
 389             return aShape.GetStudyEntry()
 390
 391         ## Unpublish object in study
 392         #
 393         def hideInStudy(self, obj):
 394             ior = salome.orb.object_to_string(obj)
 395             aSObject = self.myStudy.FindObjectIOR(ior)
 396             if aSObject is not None:
 397                 genericAttribute = self.myBuilder.FindOrCreateAttribute(aSObject, "AttributeDrawable")
 398                 drwAttribute = genericAttribute._narrow(SALOMEDS.AttributeDrawable)
 399                 drwAttribute.SetDrawable(False)
 400             pass
 401
 402         # end of l1_geompy_auxiliary
 403         ## @}
 404
 405         ## @addtogroup l3_restore_ss
 406         ## @{
 407
 408         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
 409         #  To be used from python scripts out of geompy.addToStudy (non-default usage)
 410         #  \param theObject published GEOM object, arguments of which will be published
 411         #  \param theArgs   list of GEOM_Object, operation arguments to be published.
 412         #                   If this list is empty, all operation arguments will be published
 413         #  \param theFindMethod method to search subshapes, corresponding to arguments and
 414         #                       their subshapes. Value from enumeration GEOM::find_shape_method.
 415         #  \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
 416         #                            Do not publish subshapes in place of arguments, but only
 417         #                            in place of subshapes of the first argument,
 418         #                            because the whole shape corresponds to the first argument.
 419         #                            Mainly to be used after transformations, but it also can be
 420         #                            usefull after partition with one object shape, and some other
 421         #                            operations, where only the first argument has to be considered.
 422         #                            If theObject has only one argument shape, this flag is automatically
 423         #                            considered as True, not regarding really passed value.
 424         #  \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
 425         #                      and prefix "from_subshapes_of_" to names of partially restored subshapes.
 426         #  \return list of published sub-shapes
 427         #
 428         #  @ref tui_restore_prs_params "Example"
 429         def RestoreSubShapes (self, theObject, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace,
 430                               theInheritFirstArg=False, theAddPrefix=True):
 431             # Example: see GEOM_TestAll.py
 432             return self.RestoreSubShapesO(self.myStudy, theObject, theArgs,
 433                                           theFindMethod, theInheritFirstArg, theAddPrefix)
 434
 435         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
 436         #  To be used from python scripts out of geompy.addToStudy (non-default usage)
 437         #  \param theObject published GEOM object, arguments of which will be published
 438         #  \param theArgs   list of GEOM_Object, operation arguments to be published.
 439         #                   If this list is empty, all operation arguments will be published
 440         #  \param theFindMethod method to search subshapes, corresponding to arguments and
 441         #                       their subshapes. Value from enumeration GEOM::find_shape_method.
 442         #  \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
 443         #                            Do not publish subshapes in place of arguments, but only
 444         #                            in place of subshapes of the first argument,
 445         #                            because the whole shape corresponds to the first argument.
 446         #                            Mainly to be used after transformations, but it also can be
 447         #                            usefull after partition with one object shape, and some other
 448         #                            operations, where only the first argument has to be considered.
 449         #                            If theObject has only one argument shape, this flag is automatically
 450         #                            considered as True, not regarding really passed value.
 451         #  \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
 452         #                      and prefix "from_subshapes_of_" to names of partially restored subshapes.
 453         #  \return list of published sub-shapes
 454         #
 455         #  @ref tui_restore_prs_params "Example"
 456         def RestoreGivenSubShapes (self, theObject, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace,
 457                                    theInheritFirstArg=False, theAddPrefix=True):
 458             # Example: see GEOM_TestAll.py
 459             return self.RestoreGivenSubShapesO(self.myStudy, theObject, theArgs,
 460                                                theFindMethod, theInheritFirstArg, theAddPrefix)
 461
 462         # end of l3_restore_ss
 463         ## @}
 464
 465         ## @addtogroup l3_basic_go
 466         ## @{
 467
 468         ## Create point by three coordinates.
 469         #  @param theX The X coordinate of the point.
 470         #  @param theY The Y coordinate of the point.
 471         #  @param theZ The Z coordinate of the point.
 472         #  @return New GEOM_Object, containing the created point.
 473         #
 474         #  @ref tui_creation_point "Example"
 475         def MakeVertex(self, theX, theY, theZ):
 476             # Example: see GEOM_TestAll.py
 477             theX,theY,theZ,Parameters = ParseParameters(theX, theY, theZ)
 478             anObj = self.BasicOp.MakePointXYZ(theX, theY, theZ)
 479             RaiseIfFailed("MakePointXYZ", self.BasicOp)
 480             anObj.SetParameters(Parameters)
 481             return anObj
 482
 483         ## Create a point, distant from the referenced point
 484         #  on the given distances along the coordinate axes.
 485         #  @param theReference The referenced point.
 486         #  @param theX Displacement from the referenced point along OX axis.
 487         #  @param theY Displacement from the referenced point along OY axis.
 488         #  @param theZ Displacement from the referenced point along OZ axis.
 489         #  @return New GEOM_Object, containing the created point.
 490         #
 491         #  @ref tui_creation_point "Example"
 492         def MakeVertexWithRef(self,theReference, theX, theY, theZ):
 493             # Example: see GEOM_TestAll.py
 494             theX,theY,theZ,Parameters = ParseParameters(theX, theY, theZ)
 495             anObj = self.BasicOp.MakePointWithReference(theReference, theX, theY, theZ)
 496             RaiseIfFailed("MakePointWithReference", self.BasicOp)
 497             anObj.SetParameters(Parameters)
 498             return anObj
 499
 500         ## Create a point, corresponding to the given parameter on the given curve.
 501         #  @param theRefCurve The referenced curve.
 502         #  @param theParameter Value of parameter on the referenced curve.
 503         #  @return New GEOM_Object, containing the created point.
 504         #
 505         #  @ref tui_creation_point "Example"
 506         def MakeVertexOnCurve(self,theRefCurve, theParameter):
 507             # Example: see GEOM_TestAll.py
 508             theParameter, Parameters = ParseParameters(theParameter)
 509             anObj = self.BasicOp.MakePointOnCurve(theRefCurve, theParameter)
 510             RaiseIfFailed("MakePointOnCurve", self.BasicOp)
 511             anObj.SetParameters(Parameters)
 512             return anObj
 513
 514         ## Create a point by projection give coordinates on the given curve
 515         #  @param theRefCurve The referenced curve.
 516         #  @param theX X-coordinate in 3D space
 517         #  @param theY Y-coordinate in 3D space
 518         #  @param theZ Z-coordinate in 3D space
 519         #  @return New GEOM_Object, containing the created point.
 520         #
 521         #  @ref tui_creation_point "Example"
 522         def MakeVertexOnCurveByCoord(self,theRefCurve, theX, theY, theZ):
 523             # Example: see GEOM_TestAll.py
 524             theX, theY, theZ, Parameters = ParseParameters(theX, theY, theZ)
 525             anObj = self.BasicOp.MakePointOnCurveByCoord(theRefCurve, theX, theY, theZ)
 526             RaiseIfFailed("MakeVertexOnCurveByCoord", self.BasicOp)
 527             anObj.SetParameters(Parameters)
 528             return anObj
 529
 530         ## Create a point, corresponding to the given length on the given curve.
 531         #  @param theRefCurve The referenced curve.
 532         #  @param theLength Length on the referenced curve. It can be negative.
 533         #  @param theStartPoint Point allowing to choose the direction for the calculation
 534         #                       of the length. If None, start from the first point of theRefCurve.
 535         #  @return New GEOM_Object, containing the created point.
 536         #
 537         #  @ref tui_creation_point "Example"
 538         def MakeVertexOnCurveByLength(self, theRefCurve, theLength, theStartPoint = None):
 539             # Example: see GEOM_TestAll.py
 540             theLength, Parameters = ParseParameters(theLength)
 541             anObj = self.BasicOp.MakePointOnCurveByLength(theRefCurve, theLength, theStartPoint)
 542             RaiseIfFailed("MakePointOnCurveByLength", self.BasicOp)
 543             anObj.SetParameters(Parameters)
 544             return anObj
 545
 546         ## Create a point, corresponding to the given parameters on the
 547         #    given surface.
 548         #  @param theRefSurf The referenced surface.
 549         #  @param theUParameter Value of U-parameter on the referenced surface.
 550         #  @param theVParameter Value of V-parameter on the referenced surface.
 551         #  @return New GEOM_Object, containing the created point.
 552         #
 553         #  @ref swig_MakeVertexOnSurface "Example"
 554         def MakeVertexOnSurface(self, theRefSurf, theUParameter, theVParameter):
 555             theUParameter, theVParameter, Parameters = ParseParameters(theUParameter, theVParameter)
 556             # Example: see GEOM_TestAll.py
 557             anObj = self.BasicOp.MakePointOnSurface(theRefSurf, theUParameter, theVParameter)
 558             RaiseIfFailed("MakePointOnSurface", self.BasicOp)
 559             anObj.SetParameters(Parameters);
 560             return anObj
 561
 562         ## Create a point by projection give coordinates on the given surface
 563         #  @param theRefSurf The referenced surface.
 564         #  @param theX X-coordinate in 3D space
 565         #  @param theY Y-coordinate in 3D space
 566         #  @param theZ Z-coordinate in 3D space
 567         #  @return New GEOM_Object, containing the created point.
 568         #
 569         #  @ref swig_MakeVertexOnSurfaceByCoord "Example"
 570         def MakeVertexOnSurfaceByCoord(self, theRefSurf, theX, theY, theZ):
 571             theX, theY, theZ, Parameters = ParseParameters(theX, theY, theZ)
 572             # Example: see GEOM_TestAll.py
 573             anObj = self.BasicOp.MakePointOnSurfaceByCoord(theRefSurf, theX, theY, theZ)
 574             RaiseIfFailed("MakeVertexOnSurfaceByCoord", self.BasicOp)
 575             anObj.SetParameters(Parameters);
 576             return anObj
 577
 578         ## Create a point on intersection of two lines.
 579         #  @param theRefLine1, theRefLine2 The referenced lines.
 580         #  @return New GEOM_Object, containing the created point.
 581         #
 582         #  @ref swig_MakeVertexOnLinesIntersection "Example"
 583         def MakeVertexOnLinesIntersection(self, theRefLine1, theRefLine2):
 584             # Example: see GEOM_TestAll.py
 585             anObj = self.BasicOp.MakePointOnLinesIntersection(theRefLine1, theRefLine2)
 586             RaiseIfFailed("MakePointOnLinesIntersection", self.BasicOp)
 587             return anObj
 588
 589         ## Create a tangent, corresponding to the given parameter on the given curve.
 590         #  @param theRefCurve The referenced curve.
 591         #  @param theParameter Value of parameter on the referenced curve.
 592         #  @return New GEOM_Object, containing the created tangent.
 593         #
 594         #  @ref swig_MakeTangentOnCurve "Example"
 595         def MakeTangentOnCurve(self, theRefCurve, theParameter):
 596             anObj = self.BasicOp.MakeTangentOnCurve(theRefCurve, theParameter)
 597             RaiseIfFailed("MakeTangentOnCurve", self.BasicOp)
 598             return anObj
 599
 600         ## Create a tangent plane, corresponding to the given parameter on the given face.
 601         #  @param theFace The face for which tangent plane should be built.
 602         #  @param theParameterV vertical value of the center point (0.0 - 1.0).
 603         #  @param theParameterU horisontal value of the center point (0.0 - 1.0).
 604         #  @param theTrimSize the size of plane.
 605         #  @return New GEOM_Object, containing the created tangent.
 606         #
 607         #  @ref swig_MakeTangentPlaneOnFace "Example"
 608         def MakeTangentPlaneOnFace(self, theFace, theParameterU, theParameterV, theTrimSize):
 609             anObj = self.BasicOp.MakeTangentPlaneOnFace(theFace, theParameterU, theParameterV, theTrimSize)
 610             RaiseIfFailed("MakeTangentPlaneOnFace", self.BasicOp)
 611             return anObj
 612
 613         ## Create a vector with the given components.
 614         #  @param theDX X component of the vector.
 615         #  @param theDY Y component of the vector.
 616         #  @param theDZ Z component of the vector.
 617         #  @return New GEOM_Object, containing the created vector.
 618         #
 619         #  @ref tui_creation_vector "Example"
 620         def MakeVectorDXDYDZ(self,theDX, theDY, theDZ):
 621             # Example: see GEOM_TestAll.py
 622             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
 623             anObj = self.BasicOp.MakeVectorDXDYDZ(theDX, theDY, theDZ)
 624             RaiseIfFailed("MakeVectorDXDYDZ", self.BasicOp)
 625             anObj.SetParameters(Parameters)
 626             return anObj
 627
 628         ## Create a vector between two points.
 629         #  @param thePnt1 Start point for the vector.
 630         #  @param thePnt2 End point for the vector.
 631         #  @return New GEOM_Object, containing the created vector.
 632         #
 633         #  @ref tui_creation_vector "Example"
 634         def MakeVector(self,thePnt1, thePnt2):
 635             # Example: see GEOM_TestAll.py
 636             anObj = self.BasicOp.MakeVectorTwoPnt(thePnt1, thePnt2)
 637             RaiseIfFailed("MakeVectorTwoPnt", self.BasicOp)
 638             return anObj
 639
 640         ## Create a line, passing through the given point
 641         #  and parrallel to the given direction
 642         #  @param thePnt Point. The resulting line will pass through it.
 643         #  @param theDir Direction. The resulting line will be parallel to it.
 644         #  @return New GEOM_Object, containing the created line.
 645         #
 646         #  @ref tui_creation_line "Example"
 647         def MakeLine(self,thePnt, theDir):
 648             # Example: see GEOM_TestAll.py
 649             anObj = self.BasicOp.MakeLine(thePnt, theDir)
 650             RaiseIfFailed("MakeLine", self.BasicOp)
 651             return anObj
 652
 653         ## Create a line, passing through the given points
 654         #  @param thePnt1 First of two points, defining the line.
 655         #  @param thePnt2 Second of two points, defining the line.
 656         #  @return New GEOM_Object, containing the created line.
 657         #
 658         #  @ref tui_creation_line "Example"
 659         def MakeLineTwoPnt(self,thePnt1, thePnt2):
 660             # Example: see GEOM_TestAll.py
 661             anObj = self.BasicOp.MakeLineTwoPnt(thePnt1, thePnt2)
 662             RaiseIfFailed("MakeLineTwoPnt", self.BasicOp)
 663             return anObj
 664
 665         ## Create a line on two faces intersection.
 666         #  @param theFace1 First of two faces, defining the line.
 667         #  @param theFace2 Second of two faces, defining the line.
 668         #  @return New GEOM_Object, containing the created line.
 669         #
 670         #  @ref swig_MakeLineTwoFaces "Example"
 671         def MakeLineTwoFaces(self, theFace1, theFace2):
 672             # Example: see GEOM_TestAll.py
 673             anObj = self.BasicOp.MakeLineTwoFaces(theFace1, theFace2)
 674             RaiseIfFailed("MakeLineTwoFaces", self.BasicOp)
 675             return anObj
 676
 677         ## Create a plane, passing through the given point
 678         #  and normal to the given vector.
 679         #  @param thePnt Point, the plane has to pass through.
 680         #  @param theVec Vector, defining the plane normal direction.
 681         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
 682         #  @return New GEOM_Object, containing the created plane.
 683         #
 684         #  @ref tui_creation_plane "Example"
 685         def MakePlane(self,thePnt, theVec, theTrimSize):
 686             # Example: see GEOM_TestAll.py
 687             theTrimSize, Parameters = ParseParameters(theTrimSize);
 688             anObj = self.BasicOp.MakePlanePntVec(thePnt, theVec, theTrimSize)
 689             RaiseIfFailed("MakePlanePntVec", self.BasicOp)
 690             anObj.SetParameters(Parameters)
 691             return anObj
 692
 693         ## Create a plane, passing through the three given points
 694         #  @param thePnt1 First of three points, defining the plane.
 695         #  @param thePnt2 Second of three points, defining the plane.
 696         #  @param thePnt3 Fird of three points, defining the plane.
 697         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
 698         #  @return New GEOM_Object, containing the created plane.
 699         #
 700         #  @ref tui_creation_plane "Example"
 701         def MakePlaneThreePnt(self,thePnt1, thePnt2, thePnt3, theTrimSize):
 702             # Example: see GEOM_TestAll.py
 703             theTrimSize, Parameters = ParseParameters(theTrimSize);
 704             anObj = self.BasicOp.MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize)
 705             RaiseIfFailed("MakePlaneThreePnt", self.BasicOp)
 706             anObj.SetParameters(Parameters)
 707             return anObj
 708
 709         ## Create a plane, similar to the existing one, but with another size of representing face.
 710         #  @param theFace Referenced plane or LCS(Marker).
 711         #  @param theTrimSize New half size of a side of quadrangle face, representing the plane.
 712         #  @return New GEOM_Object, containing the created plane.
 713         #
 714         #  @ref tui_creation_plane "Example"
 715         def MakePlaneFace(self,theFace, theTrimSize):
 716             # Example: see GEOM_TestAll.py
 717             theTrimSize, Parameters = ParseParameters(theTrimSize);
 718             anObj = self.BasicOp.MakePlaneFace(theFace, theTrimSize)
 719             RaiseIfFailed("MakePlaneFace", self.BasicOp)
 720             anObj.SetParameters(Parameters)
 721             return anObj
 722
 723         ## Create a plane, passing through the 2 vectors
 724         #  with center in a start point of the first vector.
 725         #  @param theVec1 Vector, defining center point and plane direction.
 726         #  @param theVec2 Vector, defining the plane normal direction.
 727         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
 728         #  @return New GEOM_Object, containing the created plane.
 729         #
 730         #  @ref tui_creation_plane "Example"
 731         def MakePlane2Vec(self,theVec1, theVec2, theTrimSize):
 732             # Example: see GEOM_TestAll.py
 733             theTrimSize, Parameters = ParseParameters(theTrimSize);
 734             anObj = self.BasicOp.MakePlane2Vec(theVec1, theVec2, theTrimSize)
 735             RaiseIfFailed("MakePlane2Vec", self.BasicOp)
 736             anObj.SetParameters(Parameters)
 737             return anObj
 738
 739         ## Create a plane, based on a Local coordinate system.
 740         #  @param theLCS  coordinate system, defining plane.
 741         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
 742         #  @param theOrientation OXY, OYZ or OZX orientation - (1, 2 or 3)
 743         #  @return New GEOM_Object, containing the created plane.
 744         #
 745         #  @ref tui_creation_plane "Example"
 746         def MakePlaneLCS(self,theLCS, theTrimSize, theOrientation):
 747             # Example: see GEOM_TestAll.py
 748             theTrimSize, Parameters = ParseParameters(theTrimSize);
 749             anObj = self.BasicOp.MakePlaneLCS(theLCS, theTrimSize, theOrientation)
 750             RaiseIfFailed("MakePlaneLCS", self.BasicOp)
 751             anObj.SetParameters(Parameters)
 752             return anObj
 753
 754         ## Create a local coordinate system.
 755         #  @param OX,OY,OZ Three coordinates of coordinate system origin.
 756         #  @param XDX,XDY,XDZ Three components of OX direction
 757         #  @param YDX,YDY,YDZ Three components of OY direction
 758         #  @return New GEOM_Object, containing the created coordinate system.
 759         #
 760         #  @ref swig_MakeMarker "Example"
 761         def MakeMarker(self, OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ):
 762             # Example: see GEOM_TestAll.py
 763             OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ, Parameters = ParseParameters(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ);
 764             anObj = self.BasicOp.MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ)
 765             RaiseIfFailed("MakeMarker", self.BasicOp)
 766             anObj.SetParameters(Parameters)
 767             return anObj
 768
 769         ## Create a local coordinate system from shape.
 770         #  @param theShape The initial shape to detect the coordinate system.
 771         #  @return New GEOM_Object, containing the created coordinate system.
 772         #
 773         #  @ref tui_creation_lcs "Example"
 774         def MakeMarkerFromShape(self, theShape):
 775             anObj = self.BasicOp.MakeMarkerFromShape(theShape)
 776             RaiseIfFailed("MakeMarkerFromShape", self.BasicOp)
 777             return anObj
 778
 779         ## Create a local coordinate system from point and two vectors.
 780         #  @param theOrigin Point of coordinate system origin.
 781         #  @param theXVec Vector of X direction
 782         #  @param theYVec Vector of Y direction
 783         #  @return New GEOM_Object, containing the created coordinate system.
 784         #
 785         #  @ref tui_creation_lcs "Example"
 786         def MakeMarkerPntTwoVec(self, theOrigin, theXVec, theYVec):
 787             anObj = self.BasicOp.MakeMarkerPntTwoVec(theOrigin, theXVec, theYVec)
 788             RaiseIfFailed("MakeMarkerPntTwoVec", self.BasicOp)
 789             return anObj
 790
 791         # end of l3_basic_go
 792         ## @}
 793
 794         ## @addtogroup l4_curves
 795         ## @{
 796
 797         ##  Create an arc of circle, passing through three given points.
 798         #  @param thePnt1 Start point of the arc.
 799         #  @param thePnt2 Middle point of the arc.
 800         #  @param thePnt3 End point of the arc.
 801         #  @return New GEOM_Object, containing the created arc.
 802         #
 803         #  @ref swig_MakeArc "Example"
 804         def MakeArc(self,thePnt1, thePnt2, thePnt3):
 805             # Example: see GEOM_TestAll.py
 806             anObj = self.CurvesOp.MakeArc(thePnt1, thePnt2, thePnt3)
 807             RaiseIfFailed("MakeArc", self.CurvesOp)
 808             return anObj
 809
 810         ##  Create an arc of circle from a center and 2 points.
 811         #  @param thePnt1 Center of the arc
 812         #  @param thePnt2 Start point of the arc. (Gives also the radius of the arc)
 813         #  @param thePnt3 End point of the arc (Gives also a direction)
 814         #  @param theSense Orientation of the arc
 815         #  @return New GEOM_Object, containing the created arc.
 816         #
 817         #  @ref swig_MakeArc "Example"
 818         def MakeArcCenter(self, thePnt1, thePnt2, thePnt3, theSense=False):
 819             # Example: see GEOM_TestAll.py
 820             anObj = self.CurvesOp.MakeArcCenter(thePnt1, thePnt2, thePnt3, theSense)
 821             RaiseIfFailed("MakeArcCenter", self.CurvesOp)
 822             return anObj
 823
 824         ##  Create an arc of ellipse, of center and two points.
 825         #  @param theCenter Center of the arc.
 826         #  @param thePnt1 defines major radius of the arc by distance from Pnt1 to Pnt2.
 827         #  @param thePnt2 defines plane of ellipse and minor radius as distance from Pnt3 to line from Pnt1 to Pnt2.
 828         #  @return New GEOM_Object, containing the created arc.
 829         #
 830         #  @ref swig_MakeArc "Example"
 831         def MakeArcOfEllipse(self,theCenter, thePnt1, thePnt2):
 832             # Example: see GEOM_TestAll.py
 833             anObj = self.CurvesOp.MakeArcOfEllipse(theCenter, thePnt1, thePnt2)
 834             RaiseIfFailed("MakeArcOfEllipse", self.CurvesOp)
 835             return anObj
 836
 837         ## Create a circle with given center, normal vector and radius.
 838         #  @param thePnt Circle center.
 839         #  @param theVec Vector, normal to the plane of the circle.
 840         #  @param theR Circle radius.
 841         #  @return New GEOM_Object, containing the created circle.
 842         #
 843         #  @ref tui_creation_circle "Example"
 844         def MakeCircle(self, thePnt, theVec, theR):
 845             # Example: see GEOM_TestAll.py
 846             theR, Parameters = ParseParameters(theR)
 847             anObj = self.CurvesOp.MakeCirclePntVecR(thePnt, theVec, theR)
 848             RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
 849             anObj.SetParameters(Parameters)
 850             return anObj
 851
 852         ## Create a circle with given radius.
 853         #  Center of the circle will be in the origin of global
 854         #  coordinate system and normal vector will be codirected with Z axis
 855         #  @param theR Circle radius.
 856         #  @return New GEOM_Object, containing the created circle.
 857         def MakeCircleR(self, theR):
 858             anObj = self.CurvesOp.MakeCirclePntVecR(None, None, theR)
 859             RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
 860             return anObj
 861
 862         ## Create a circle, passing through three given points
 863         #  @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
 864         #  @return New GEOM_Object, containing the created circle.
 865         #
 866         #  @ref tui_creation_circle "Example"
 867         def MakeCircleThreePnt(self,thePnt1, thePnt2, thePnt3):
 868             # Example: see GEOM_TestAll.py
 869             anObj = self.CurvesOp.MakeCircleThreePnt(thePnt1, thePnt2, thePnt3)
 870             RaiseIfFailed("MakeCircleThreePnt", self.CurvesOp)
 871             return anObj
 872
 873         ## Create a circle, with given point1 as center,
 874         #  passing through the point2 as radius and laying in the plane,
 875         #  defined by all three given points.
 876         #  @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
 877         #  @return New GEOM_Object, containing the created circle.
 878         #
 879         #  @ref swig_MakeCircle "Example"
 880         def MakeCircleCenter2Pnt(self,thePnt1, thePnt2, thePnt3):
 881             # Example: see GEOM_example6.py
 882             anObj = self.CurvesOp.MakeCircleCenter2Pnt(thePnt1, thePnt2, thePnt3)
 883             RaiseIfFailed("MakeCircleCenter2Pnt", self.CurvesOp)
 884             return anObj
 885
 886         ## Create an ellipse with given center, normal vector and radiuses.
 887         #  @param thePnt Ellipse center.
 888         #  @param theVec Vector, normal to the plane of the ellipse.
 889         #  @param theRMajor Major ellipse radius.
 890         #  @param theRMinor Minor ellipse radius.
 891         #  @param theVecMaj Vector, direction of the ellipse's main axis.
 892         #  @return New GEOM_Object, containing the created ellipse.
 893         #
 894         #  @ref tui_creation_ellipse "Example"
 895         def MakeEllipse(self, thePnt, theVec, theRMajor, theRMinor, theVecMaj=None):
 896             # Example: see GEOM_TestAll.py
 897             theRMajor, theRMinor, Parameters = ParseParameters(theRMajor, theRMinor)
 898             if theVecMaj is not None:
 899                 anObj = self.CurvesOp.MakeEllipseVec(thePnt, theVec, theRMajor, theRMinor, theVecMaj)
 900             else:
 901                 anObj = self.CurvesOp.MakeEllipse(thePnt, theVec, theRMajor, theRMinor)
 902                 pass
 903             RaiseIfFailed("MakeEllipse", self.CurvesOp)
 904             anObj.SetParameters(Parameters)
 905             return anObj
 906
 907         ## Create an ellipse with given radiuses.
 908         #  Center of the ellipse will be in the origin of global
 909         #  coordinate system and normal vector will be codirected with Z axis
 910         #  @param theRMajor Major ellipse radius.
 911         #  @param theRMinor Minor ellipse radius.
 912         #  @return New GEOM_Object, containing the created ellipse.
 913         def MakeEllipseRR(self, theRMajor, theRMinor):
 914             anObj = self.CurvesOp.MakeEllipse(None, None, theRMajor, theRMinor)
 915             RaiseIfFailed("MakeEllipse", self.CurvesOp)
 916             return anObj
 917
 918         ## Create a polyline on the set of points.
 919         #  @param thePoints Sequence of points for the polyline.
 920         #  @param theIsClosed If True, build a closed wire.
 921         #  @return New GEOM_Object, containing the created polyline.
 922         #
 923         #  @ref tui_creation_curve "Example"
 924         def MakePolyline(self, thePoints, theIsClosed=False):
 925             # Example: see GEOM_TestAll.py
 926             anObj = self.CurvesOp.MakePolyline(thePoints, theIsClosed)
 927             RaiseIfFailed("MakePolyline", self.CurvesOp)
 928             return anObj
 929
 930         ## Create bezier curve on the set of points.
 931         #  @param thePoints Sequence of points for the bezier curve.
 932         #  @param theIsClosed If True, build a closed curve.
 933         #  @return New GEOM_Object, containing the created bezier curve.
 934         #
 935         #  @ref tui_creation_curve "Example"
 936         def MakeBezier(self, thePoints, theIsClosed=False):
 937             # Example: see GEOM_TestAll.py
 938             anObj = self.CurvesOp.MakeSplineBezier(thePoints, theIsClosed)
 939             RaiseIfFailed("MakeSplineBezier", self.CurvesOp)
 940             return anObj
 941
 942         ## Create B-Spline curve on the set of points.
 943         #  @param thePoints Sequence of points for the B-Spline curve.
 944         #  @param theIsClosed If True, build a closed curve.
 945         #  @param theDoReordering If TRUE, the algo does not follow the order of
 946         #                         \a thePoints but searches for the closest vertex.
 947         #  @return New GEOM_Object, containing the created B-Spline curve.
 948         #
 949         #  @ref tui_creation_curve "Example"
 950         def MakeInterpol(self, thePoints, theIsClosed=False, theDoReordering=False):
 951             # Example: see GEOM_TestAll.py
 952             anObj = self.CurvesOp.MakeSplineInterpolation(thePoints, theIsClosed, theDoReordering)
 953             RaiseIfFailed("MakeSplineInterpolation", self.CurvesOp)
 954             return anObj
 955
 956
 957         ## Creates a curve using the parametric definition of the basic points.
 958         #  @param thexExpr parametric equation of the coordinates X.
 959         #  @param theyExpr parametric equation of the coordinates Y.
 960         #  @param thezExpr parametric equation of the coordinates Z.
 961         #  @param theParamMin the minimal value of the parameter.
 962         #  @param theParamMax the maximum value of the parameter.
 963         #  @param theParamStep the step of the parameter.
 964         #  @param theCurveType the type of the curve.
 965         #  @return New GEOM_Object, containing the created curve.
 966         #
 967         #  @ref tui_creation_curve "Example"
 968         def MakeCurveParametric(self, thexExpr, theyExpr, thezExpr,
 969                                 theParamMin, theParamMax, theParamStep, theCurveType):
 970             theParamMin,theParamMax,theParamStep,Parameters = ParseParameters(theParamMin,theParamMax,theParamStep)
 971             anObj = self.CurvesOp.MakeCurveParametric(thexExpr,theyExpr,thezExpr,theParamMin,theParamMax,theParamStep,theCurveType)
 972             RaiseIfFailed("MakeSplineInterpolation", self.CurvesOp)
 973             anObj.SetParameters(Parameters)
 974             return anObj
 975
 976
 977
 978         # end of l4_curves
 979         ## @}
 980
 981         ## @addtogroup l3_sketcher
 982         ## @{
 983
 984         ## Create a sketcher (wire or face), following the textual description,
 985         #  passed through <VAR>theCommand</VAR> argument. \n
 986         #  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
 987         #  Format of the description string have to be the following:
 988         #
 989         #  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
 990         #
 991         #  Where:
 992         #  - x1, y1 are coordinates of the first sketcher point (zero by default),
 993         #  - CMD is one of
 994         #     - "R angle" : Set the direction by angle
 995         #     - "D dx dy" : Set the direction by DX & DY
 996         #     .
 997         #       \n
 998         #     - "TT x y" : Create segment by point at X & Y
 999         #     - "T dx dy" : Create segment by point with DX & DY
1000         #     - "L length" : Create segment by direction & Length
1001         #     - "IX x" : Create segment by direction & Intersect. X
1002         #     - "IY y" : Create segment by direction & Intersect. Y
1003         #     .
1004         #       \n
1005         #     - "C radius length" : Create arc by direction, radius and length(in degree)
1006         #     - "AA x y": Create arc by point at X & Y
1007         #     - "A dx dy" : Create arc by point with DX & DY
1008         #     - "A dx dy" : Create arc by point with DX & DY
1009         #     - "UU x y radius flag1": Create arc by point at X & Y with given radiUs
1010         #     - "U dx dy radius flag1" : Create arc by point with DX & DY with given radiUs
1011         #     - "EE x y xc yc flag1 flag2": Create arc by point at X & Y with given cEnter coordinates
1012         #     - "E dx dy dxc dyc radius flag1 flag2" : Create arc by point with DX & DY with given cEnter coordinates
1013         #     .
1014         #       \n
1015         #     - "WW" : Close Wire (to finish)
1016         #     - "WF" : Close Wire and build face (to finish)
1017         #     .
1018         #        \n
1019         #  - Flag1 (= reverse) is 0 or 2 ...
1020         #     - if 0 the drawn arc is the one of lower angle (< Pi)
1021         #     - if 2 the drawn arc ius the one of greater angle (> Pi)
1022         #     .
1023         #        \n
1024         #  - Flag2 (= control tolerance) is 0 or 1 ...
1025         #     - if 0 the specified end point can be at a distance of the arc greater than the tolerance (10^-7)
1026         #     - if 1 the wire is built only if the end point is on the arc
1027         #       with a tolerance of 10^-7 on the distance else the creation fails
1028         #
1029         #  @param theCommand String, defining the sketcher in local
1030         #                    coordinates of the working plane.
1031         #  @param theWorkingPlane Nine double values, defining origin,
1032         #                         OZ and OX directions of the working plane.
1033         #  @return New GEOM_Object, containing the created wire.
1034         #
1035         #  @ref tui_sketcher_page "Example"
1036         def MakeSketcher(self, theCommand, theWorkingPlane = [0,0,0, 0,0,1, 1,0,0]):
1037             # Example: see GEOM_TestAll.py
1038             theCommand,Parameters = ParseSketcherCommand(theCommand)
1039             anObj = self.CurvesOp.MakeSketcher(theCommand, theWorkingPlane)
1040             RaiseIfFailed("MakeSketcher", self.CurvesOp)
1041             anObj.SetParameters(Parameters)
1042             return anObj
1043
1044         ## Create a sketcher (wire or face), following the textual description,
1045         #  passed through <VAR>theCommand</VAR> argument. \n
1046         #  For format of the description string see the previous method.\n
1047         #  @param theCommand String, defining the sketcher in local
1048         #                    coordinates of the working plane.
1049         #  @param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
1050         #  @return New GEOM_Object, containing the created wire.
1051         #
1052         #  @ref tui_sketcher_page "Example"
1053         def MakeSketcherOnPlane(self, theCommand, theWorkingPlane):
1054             anObj = self.CurvesOp.MakeSketcherOnPlane(theCommand, theWorkingPlane)
1055             RaiseIfFailed("MakeSketcherOnPlane", self.CurvesOp)
1056             return anObj
1057
1058         ## Create a sketcher wire, following the numerical description,
1059         #  passed through <VAR>theCoordinates</VAR> argument. \n
1060         #  @param theCoordinates double values, defining points to create a wire,
1061         #                                                      passing from it.
1062         #  @return New GEOM_Object, containing the created wire.
1063         #
1064         #  @ref tui_sketcher_page "Example"
1065         def Make3DSketcher(self, theCoordinates):
1066             theCoordinates,Parameters = ParseParameters(theCoordinates)
1067             anObj = self.CurvesOp.Make3DSketcher(theCoordinates)
1068             RaiseIfFailed("Make3DSketcher", self.CurvesOp)
1069             anObj.SetParameters(Parameters)
1070             return anObj
1071
1072         # end of l3_sketcher
1073         ## @}
1074
1075         ## @addtogroup l3_3d_primitives
1076         ## @{
1077
1078         ## Create a box by coordinates of two opposite vertices.
1079         #
1080         #  @ref tui_creation_box "Example"
1081         def MakeBox(self,x1,y1,z1,x2,y2,z2):
1082             # Example: see GEOM_TestAll.py
1083             pnt1 = self.MakeVertex(x1,y1,z1)
1084             pnt2 = self.MakeVertex(x2,y2,z2)
1085             return self.MakeBoxTwoPnt(pnt1,pnt2)
1086
1087         ## Create a box with specified dimensions along the coordinate axes
1088         #  and with edges, parallel to the coordinate axes.
1089         #  Center of the box will be at point (DX/2, DY/2, DZ/2).
1090         #  @param theDX Length of Box edges, parallel to OX axis.
1091         #  @param theDY Length of Box edges, parallel to OY axis.
1092         #  @param theDZ Length of Box edges, parallel to OZ axis.
1093         #  @return New GEOM_Object, containing the created box.
1094         #
1095         #  @ref tui_creation_box "Example"
1096         def MakeBoxDXDYDZ(self,theDX, theDY, theDZ):
1097             # Example: see GEOM_TestAll.py
1098             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
1099             anObj = self.PrimOp.MakeBoxDXDYDZ(theDX, theDY, theDZ)
1100             RaiseIfFailed("MakeBoxDXDYDZ", self.PrimOp)
1101             anObj.SetParameters(Parameters)
1102             return anObj
1103
1104         ## Create a box with two specified opposite vertices,
1105         #  and with edges, parallel to the coordinate axes
1106         #  @param thePnt1 First of two opposite vertices.
1107         #  @param thePnt2 Second of two opposite vertices.
1108         #  @return New GEOM_Object, containing the created box.
1109         #
1110         #  @ref tui_creation_box "Example"
1111         def MakeBoxTwoPnt(self,thePnt1, thePnt2):
1112             # Example: see GEOM_TestAll.py
1113             anObj = self.PrimOp.MakeBoxTwoPnt(thePnt1, thePnt2)
1114             RaiseIfFailed("MakeBoxTwoPnt", self.PrimOp)
1115             return anObj
1116
1117         ## Create a face with specified dimensions along OX-OY coordinate axes,
1118         #  with edges, parallel to this coordinate axes.
1119         #  @param theH height of Face.
1120         #  @param theW width of Face.
1121         #  @param theOrientation orientation belong axis OXY OYZ OZX
1122         #  @return New GEOM_Object, containing the created face.
1123         #
1124         #  @ref tui_creation_face "Example"
1125         def MakeFaceHW(self,theH, theW, theOrientation):
1126             # Example: see GEOM_TestAll.py
1127             theH,theW,Parameters = ParseParameters(theH, theW)
1128             anObj = self.PrimOp.MakeFaceHW(theH, theW, theOrientation)
1129             RaiseIfFailed("MakeFaceHW", self.PrimOp)
1130             anObj.SetParameters(Parameters)
1131             return anObj
1132
1133         ## Create a face from another plane and two sizes,
1134         #  vertical size and horisontal size.
1135         #  @param theObj   Normale vector to the creating face or
1136         #  the face object.
1137         #  @param theH     Height (vertical size).
1138         #  @param theW     Width (horisontal size).
1139         #  @return New GEOM_Object, containing the created face.
1140         #
1141         #  @ref tui_creation_face "Example"
1142         def MakeFaceObjHW(self, theObj, theH, theW):
1143             # Example: see GEOM_TestAll.py
1144             theH,theW,Parameters = ParseParameters(theH, theW)
1145             anObj = self.PrimOp.MakeFaceObjHW(theObj, theH, theW)
1146             RaiseIfFailed("MakeFaceObjHW", self.PrimOp)
1147             anObj.SetParameters(Parameters)
1148             return anObj
1149
1150         ## Create a disk with given center, normal vector and radius.
1151         #  @param thePnt Disk center.
1152         #  @param theVec Vector, normal to the plane of the disk.
1153         #  @param theR Disk radius.
1154         #  @return New GEOM_Object, containing the created disk.
1155         #
1156         #  @ref tui_creation_disk "Example"
1157         def MakeDiskPntVecR(self,thePnt, theVec, theR):
1158             # Example: see GEOM_TestAll.py
1159             theR,Parameters = ParseParameters(theR)
1160             anObj = self.PrimOp.MakeDiskPntVecR(thePnt, theVec, theR)
1161             RaiseIfFailed("MakeDiskPntVecR", self.PrimOp)
1162             anObj.SetParameters(Parameters)
1163             return anObj
1164
1165         ## Create a disk, passing through three given points
1166         #  @param thePnt1,thePnt2,thePnt3 Points, defining the disk.
1167         #  @return New GEOM_Object, containing the created disk.
1168         #
1169         #  @ref tui_creation_disk "Example"
1170         def MakeDiskThreePnt(self,thePnt1, thePnt2, thePnt3):
1171             # Example: see GEOM_TestAll.py
1172             anObj = self.PrimOp.MakeDiskThreePnt(thePnt1, thePnt2, thePnt3)
1173             RaiseIfFailed("MakeDiskThreePnt", self.PrimOp)
1174             return anObj
1175
1176         ## Create a disk with specified dimensions along OX-OY coordinate axes.
1177         #  @param theR Radius of Face.
1178         #  @param theOrientation set the orientation belong axis OXY or OYZ or OZX
1179         #  @return New GEOM_Object, containing the created disk.
1180         #
1181         #  @ref tui_creation_face "Example"
1182         def MakeDiskR(self,theR, theOrientation):
1183             # Example: see GEOM_TestAll.py
1184             theR,Parameters = ParseParameters(theR)
1185             anObj = self.PrimOp.MakeDiskR(theR, theOrientation)
1186             RaiseIfFailed("MakeDiskR", self.PrimOp)
1187             anObj.SetParameters(Parameters)
1188             return anObj
1189
1190         ## Create a cylinder with given base point, axis, radius and height.
1191         #  @param thePnt Central point of cylinder base.
1192         #  @param theAxis Cylinder axis.
1193         #  @param theR Cylinder radius.
1194         #  @param theH Cylinder height.
1195         #  @return New GEOM_Object, containing the created cylinder.
1196         #
1197         #  @ref tui_creation_cylinder "Example"
1198         def MakeCylinder(self,thePnt, theAxis, theR, theH):
1199             # Example: see GEOM_TestAll.py
1200             theR,theH,Parameters = ParseParameters(theR, theH)
1201             anObj = self.PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
1202             RaiseIfFailed("MakeCylinderPntVecRH", self.PrimOp)
1203             anObj.SetParameters(Parameters)
1204             return anObj
1205
1206         ## Create a cylinder with given radius and height at
1207         #  the origin of coordinate system. Axis of the cylinder
1208         #  will be collinear to the OZ axis of the coordinate system.
1209         #  @param theR Cylinder radius.
1210         #  @param theH Cylinder height.
1211         #  @return New GEOM_Object, containing the created cylinder.
1212         #
1213         #  @ref tui_creation_cylinder "Example"
1214         def MakeCylinderRH(self,theR, theH):
1215             # Example: see GEOM_TestAll.py
1216             theR,theH,Parameters = ParseParameters(theR, theH)
1217             anObj = self.PrimOp.MakeCylinderRH(theR, theH)
1218             RaiseIfFailed("MakeCylinderRH", self.PrimOp)
1219             anObj.SetParameters(Parameters)
1220             return anObj
1221
1222         ## Create a sphere with given center and radius.
1223         #  @param thePnt Sphere center.
1224         #  @param theR Sphere radius.
1225         #  @return New GEOM_Object, containing the created sphere.
1226         #
1227         #  @ref tui_creation_sphere "Example"
1228         def MakeSpherePntR(self, thePnt, theR):
1229             # Example: see GEOM_TestAll.py
1230             theR,Parameters = ParseParameters(theR)
1231             anObj = self.PrimOp.MakeSpherePntR(thePnt, theR)
1232             RaiseIfFailed("MakeSpherePntR", self.PrimOp)
1233             anObj.SetParameters(Parameters)
1234             return anObj
1235
1236         ## Create a sphere with given center and radius.
1237         #  @param x,y,z Coordinates of sphere center.
1238         #  @param theR Sphere radius.
1239         #  @return New GEOM_Object, containing the created sphere.
1240         #
1241         #  @ref tui_creation_sphere "Example"
1242         def MakeSphere(self, x, y, z, theR):
1243             # Example: see GEOM_TestAll.py
1244             point = self.MakeVertex(x, y, z)
1245             anObj = self.MakeSpherePntR(point, theR)
1246             return anObj
1247
1248         ## Create a sphere with given radius at the origin of coordinate system.
1249         #  @param theR Sphere radius.
1250         #  @return New GEOM_Object, containing the created sphere.
1251         #
1252         #  @ref tui_creation_sphere "Example"
1253         def MakeSphereR(self, theR):
1254             # Example: see GEOM_TestAll.py
1255             theR,Parameters = ParseParameters(theR)
1256             anObj = self.PrimOp.MakeSphereR(theR)
1257             RaiseIfFailed("MakeSphereR", self.PrimOp)
1258             anObj.SetParameters(Parameters)
1259             return anObj
1260
1261         ## Create a cone with given base point, axis, height and radiuses.
1262         #  @param thePnt Central point of the first cone base.
1263         #  @param theAxis Cone axis.
1264         #  @param theR1 Radius of the first cone base.
1265         #  @param theR2 Radius of the second cone base.
1266         #    \note If both radiuses are non-zero, the cone will be truncated.
1267         #    \note If the radiuses are equal, a cylinder will be created instead.
1268         #  @param theH Cone height.
1269         #  @return New GEOM_Object, containing the created cone.
1270         #
1271         #  @ref tui_creation_cone "Example"
1272         def MakeCone(self,thePnt, theAxis, theR1, theR2, theH):
1273             # Example: see GEOM_TestAll.py
1274             theR1,theR2,theH,Parameters = ParseParameters(theR1,theR2,theH)
1275             anObj = self.PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
1276             RaiseIfFailed("MakeConePntVecR1R2H", self.PrimOp)
1277             anObj.SetParameters(Parameters)
1278             return anObj
1279
1280         ## Create a cone with given height and radiuses at
1281         #  the origin of coordinate system. Axis of the cone will
1282         #  be collinear to the OZ axis of the coordinate system.
1283         #  @param theR1 Radius of the first cone base.
1284         #  @param theR2 Radius of the second cone base.
1285         #    \note If both radiuses are non-zero, the cone will be truncated.
1286         #    \note If the radiuses are equal, a cylinder will be created instead.
1287         #  @param theH Cone height.
1288         #  @return New GEOM_Object, containing the created cone.
1289         #
1290         #  @ref tui_creation_cone "Example"
1291         def MakeConeR1R2H(self,theR1, theR2, theH):
1292             # Example: see GEOM_TestAll.py
1293             theR1,theR2,theH,Parameters = ParseParameters(theR1,theR2,theH)
1294             anObj = self.PrimOp.MakeConeR1R2H(theR1, theR2, theH)
1295             RaiseIfFailed("MakeConeR1R2H", self.PrimOp)
1296             anObj.SetParameters(Parameters)
1297             return anObj
1298
1299         ## Create a torus with given center, normal vector and radiuses.
1300         #  @param thePnt Torus central point.
1301         #  @param theVec Torus axis of symmetry.
1302         #  @param theRMajor Torus major radius.
1303         #  @param theRMinor Torus minor radius.
1304         #  @return New GEOM_Object, containing the created torus.
1305         #
1306         #  @ref tui_creation_torus "Example"
1307         def MakeTorus(self, thePnt, theVec, theRMajor, theRMinor):
1308             # Example: see GEOM_TestAll.py
1309             theRMajor,theRMinor,Parameters = ParseParameters(theRMajor,theRMinor)
1310             anObj = self.PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
1311             RaiseIfFailed("MakeTorusPntVecRR", self.PrimOp)
1312             anObj.SetParameters(Parameters)
1313             return anObj
1314
1315         ## Create a torus with given radiuses at the origin of coordinate system.
1316         #  @param theRMajor Torus major radius.
1317         #  @param theRMinor Torus minor radius.
1318         #  @return New GEOM_Object, containing the created torus.
1319         #
1320         #  @ref tui_creation_torus "Example"
1321         def MakeTorusRR(self, theRMajor, theRMinor):
1322             # Example: see GEOM_TestAll.py
1323             theRMajor,theRMinor,Parameters = ParseParameters(theRMajor,theRMinor)
1324             anObj = self.PrimOp.MakeTorusRR(theRMajor, theRMinor)
1325             RaiseIfFailed("MakeTorusRR", self.PrimOp)
1326             anObj.SetParameters(Parameters)
1327             return anObj
1328
1329         # end of l3_3d_primitives
1330         ## @}
1331
1332         ## @addtogroup l3_complex
1333         ## @{
1334
1335         ## Create a shape by extrusion of the base shape along a vector, defined by two points.
1336         #  @param theBase Base shape to be extruded.
1337         #  @param thePoint1 First end of extrusion vector.
1338         #  @param thePoint2 Second end of extrusion vector.
1339         #  @param theScaleFactor Use it to make prism with scaled second base.
1340         #                        Nagative value means not scaled second base.
1341         #  @return New GEOM_Object, containing the created prism.
1342         #
1343         #  @ref tui_creation_prism "Example"
1344         def MakePrism(self, theBase, thePoint1, thePoint2, theScaleFactor = -1.0):
1345             # Example: see GEOM_TestAll.py
1346             anObj = None
1347             Parameters = ""
1348             if theScaleFactor > 0:
1349                 theScaleFactor,Parameters = ParseParameters(theScaleFactor)
1350                 anObj = self.PrimOp.MakePrismTwoPntWithScaling(theBase, thePoint1, thePoint2, theScaleFactor)
1351             else:
1352                 anObj = self.PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
1353             RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
1354             anObj.SetParameters(Parameters)
1355             return anObj
1356
1357         ## Create a shape by extrusion of the base shape along a
1358         #  vector, defined by two points, in 2 Ways (forward/backward).
1359         #  @param theBase Base shape to be extruded.
1360         #  @param thePoint1 First end of extrusion vector.
1361         #  @param thePoint2 Second end of extrusion vector.
1362         #  @return New GEOM_Object, containing the created prism.
1363         #
1364         #  @ref tui_creation_prism "Example"
1365         def MakePrism2Ways(self, theBase, thePoint1, thePoint2):
1366             # Example: see GEOM_TestAll.py
1367             anObj = self.PrimOp.MakePrismTwoPnt2Ways(theBase, thePoint1, thePoint2)
1368             RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
1369             return anObj
1370
1371         ## Create a shape by extrusion of the base shape along the vector,
1372         #  i.e. all the space, transfixed by the base shape during its translation
1373         #  along the vector on the given distance.
1374         #  @param theBase Base shape to be extruded.
1375         #  @param theVec Direction of extrusion.
1376         #  @param theH Prism dimension along theVec.
1377         #  @param theScaleFactor Use it to make prism with scaled second base.
1378         #                        Nagative value means not scaled second base.
1379         #  @return New GEOM_Object, containing the created prism.
1380         #
1381         #  @ref tui_creation_prism "Example"
1382         def MakePrismVecH(self, theBase, theVec, theH, theScaleFactor = -1.0):
1383             # Example: see GEOM_TestAll.py
1384             anObj = None
1385             Parameters = ""
1386             if theScaleFactor > 0:
1387                 theH,theScaleFactor,Parameters = ParseParameters(theH,theScaleFactor)
1388                 anObj = self.PrimOp.MakePrismVecHWithScaling(theBase, theVec, theH, theScaleFactor)
1389             else:
1390                 theH,Parameters = ParseParameters(theH)
1391                 anObj = self.PrimOp.MakePrismVecH(theBase, theVec, theH)
1392             RaiseIfFailed("MakePrismVecH", self.PrimOp)
1393             anObj.SetParameters(Parameters)
1394             return anObj
1395
1396         ## Create a shape by extrusion of the base shape along the vector,
1397         #  i.e. all the space, transfixed by the base shape during its translation
1398         #  along the vector on the given distance in 2 Ways (forward/backward).
1399         #  @param theBase Base shape to be extruded.
1400         #  @param theVec Direction of extrusion.
1401         #  @param theH Prism dimension along theVec in forward direction.
1402         #  @return New GEOM_Object, containing the created prism.
1403         #
1404         #  @ref tui_creation_prism "Example"
1405         def MakePrismVecH2Ways(self, theBase, theVec, theH):
1406             # Example: see GEOM_TestAll.py
1407             theH,Parameters = ParseParameters(theH)
1408             anObj = self.PrimOp.MakePrismVecH2Ways(theBase, theVec, theH)
1409             RaiseIfFailed("MakePrismVecH2Ways", self.PrimOp)
1410             anObj.SetParameters(Parameters)
1411             return anObj
1412
1413         ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
1414         #  @param theBase Base shape to be extruded.
1415         #  @param theDX, theDY, theDZ Directions of extrusion.
1416         #  @param theScaleFactor Use it to make prism with scaled second base.
1417         #                        Nagative value means not scaled second base.
1418         #  @return New GEOM_Object, containing the created prism.
1419         #
1420         #  @ref tui_creation_prism "Example"
1421         def MakePrismDXDYDZ(self, theBase, theDX, theDY, theDZ, theScaleFactor = -1.0):
1422             # Example: see GEOM_TestAll.py
1423             anObj = None
1424             Parameters = ""
1425             if theScaleFactor > 0:
1426                 theDX,theDY,theDZ,theScaleFactor,Parameters = ParseParameters(theDX, theDY, theDZ, theScaleFactor)
1427                 anObj = self.PrimOp.MakePrismDXDYDZWithScaling(theBase, theDX, theDY, theDZ, theScaleFactor)
1428             else:
1429                 theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
1430                 anObj = self.PrimOp.MakePrismDXDYDZ(theBase, theDX, theDY, theDZ)
1431             RaiseIfFailed("MakePrismDXDYDZ", self.PrimOp)
1432             anObj.SetParameters(Parameters)
1433             return anObj
1434
1435         ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
1436         #  i.e. all the space, transfixed by the base shape during its translation
1437         #  along the vector on the given distance in 2 Ways (forward/backward).
1438         #  @param theBase Base shape to be extruded.
1439         #  @param theDX, theDY, theDZ Directions of extrusion.
1440         #  @return New GEOM_Object, containing the created prism.
1441         #
1442         #  @ref tui_creation_prism "Example"
1443         def MakePrismDXDYDZ2Ways(self, theBase, theDX, theDY, theDZ):
1444             # Example: see GEOM_TestAll.py
1445             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
1446             anObj = self.PrimOp.MakePrismDXDYDZ2Ways(theBase, theDX, theDY, theDZ)
1447             RaiseIfFailed("MakePrismDXDYDZ2Ways", self.PrimOp)
1448             anObj.SetParameters(Parameters)
1449             return anObj
1450
1451         ## Create a shape by revolution of the base shape around the axis
1452         #  on the given angle, i.e. all the space, transfixed by the base
1453         #  shape during its rotation around the axis on the given angle.
1454         #  @param theBase Base shape to be rotated.
1455         #  @param theAxis Rotation axis.
1456         #  @param theAngle Rotation angle in radians.
1457         #  @return New GEOM_Object, containing the created revolution.
1458         #
1459         #  @ref tui_creation_revolution "Example"
1460         def MakeRevolution(self, theBase, theAxis, theAngle):
1461             # Example: see GEOM_TestAll.py
1462             theAngle,Parameters = ParseParameters(theAngle)
1463             anObj = self.PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
1464             RaiseIfFailed("MakeRevolutionAxisAngle", self.PrimOp)
1465             anObj.SetParameters(Parameters)
1466             return anObj
1467
1468         ## The Same Revolution but in both ways forward&backward.
1469         def MakeRevolution2Ways(self, theBase, theAxis, theAngle):
1470             theAngle,Parameters = ParseParameters(theAngle)
1471             anObj = self.PrimOp.MakeRevolutionAxisAngle2Ways(theBase, theAxis, theAngle)
1472             RaiseIfFailed("MakeRevolutionAxisAngle2Ways", self.PrimOp)
1473             anObj.SetParameters(Parameters)
1474             return anObj
1475
1476         ## Create a filling from the given compound of contours.
1477         #  @param theShape the compound of contours
1478         #  @param theMinDeg a minimal degree of BSpline surface to create
1479         #  @param theMaxDeg a maximal degree of BSpline surface to create
1480         #  @param theTol2D a 2d tolerance to be reached
1481         #  @param theTol3D a 3d tolerance to be reached
1482         #  @param theNbIter a number of iteration of approximation algorithm
1483         #  @param theMethod Kind of method to perform filling operation:
1484         #                   GEOM.FOM_Default - Default - standard behaviour
1485         #                   /GEOM.FOM_UseOri - Use edges orientation - orientation of edges is
1486         #                       used: if the edge is reversed, the curve from this edge
1487         #                       is reversed before using it in the filling algorithm.
1488         #                   /GEOM.FOM_AutoCorrect - Auto-correct orientation - changes the orientation
1489         #                       of the curves using minimization of sum of distances
1490         #                       between the end points of the edges.
1491         #  @param isApprox if True, BSpline curves are generated in the process
1492         #                  of surface construction. By default it is False, that means
1493         #                  the surface is created using Besier curves. The usage of
1494         #                  Approximation makes the algorithm work slower, but allows
1495         #                  building the surface for rather complex cases
1496         #  @return New GEOM_Object, containing the created filling surface.
1497         #
1498         #  @ref tui_creation_filling "Example"
1499         def MakeFilling(self, theShape, theMinDeg, theMaxDeg, theTol2D,
1500                         theTol3D, theNbIter, theMethod=GEOM.FOM_Default, isApprox=0):
1501             # Example: see GEOM_TestAll.py
1502             theMinDeg,theMaxDeg,theTol2D,theTol3D,theNbIter,Parameters = ParseParameters(theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter)
1503             anObj = self.PrimOp.MakeFilling(theShape, theMinDeg, theMaxDeg,
1504                                             theTol2D, theTol3D, theNbIter,
1505                                             theMethod, isApprox)
1506             RaiseIfFailed("MakeFilling", self.PrimOp)
1507             anObj.SetParameters(Parameters)
1508             return anObj
1509
1510         ## Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1511         #  @param theSeqSections - set of specified sections.
1512         #  @param theModeSolid - mode defining building solid or shell
1513         #  @param thePreci - precision 3D used for smoothing by default 1.e-6
1514         #  @param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1515         #  @return New GEOM_Object, containing the created shell or solid.
1516         #
1517         #  @ref swig_todo "Example"
1518         def MakeThruSections(self,theSeqSections,theModeSolid,thePreci,theRuled):
1519             # Example: see GEOM_TestAll.py
1520             anObj = self.PrimOp.MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled)
1521             RaiseIfFailed("MakeThruSections", self.PrimOp)
1522             return anObj
1523
1524         ## Create a shape by extrusion of the base shape along
1525         #  the path shape. The path shape can be a wire or an edge.
1526         #  @param theBase Base shape to be extruded.
1527         #  @param thePath Path shape to extrude the base shape along it.
1528         #  @return New GEOM_Object, containing the created pipe.
1529         #
1530         #  @ref tui_creation_pipe "Example"
1531         def MakePipe(self,theBase, thePath):
1532             # Example: see GEOM_TestAll.py
1533             anObj = self.PrimOp.MakePipe(theBase, thePath)
1534             RaiseIfFailed("MakePipe", self.PrimOp)
1535             return anObj
1536
1537         ## Create a shape by extrusion of the profile shape along
1538         #  the path shape. The path shape can be a wire or an edge.
1539         #  the several profiles can be specified in the several locations of path.
1540         #  @param theSeqBases - list of  Bases shape to be extruded.
1541         #  @param theLocations - list of locations on the path corresponding
1542         #                        specified list of the Bases shapes. Number of locations
1543         #                        should be equal to number of bases or list of locations can be empty.
1544         #  @param thePath - Path shape to extrude the base shape along it.
1545         #  @param theWithContact - the mode defining that the section is translated to be in
1546         #                          contact with the spine.
1547         #  @param theWithCorrection - defining that the section is rotated to be
1548         #                             orthogonal to the spine tangent in the correspondent point
1549         #  @return New GEOM_Object, containing the created pipe.
1550         #
1551         #  @ref tui_creation_pipe_with_diff_sec "Example"
1552         def MakePipeWithDifferentSections(self, theSeqBases,
1553                                           theLocations, thePath,
1554                                           theWithContact, theWithCorrection):
1555             anObj = self.PrimOp.MakePipeWithDifferentSections(theSeqBases,
1556                                                               theLocations, thePath,
1557                                                               theWithContact, theWithCorrection)
1558             RaiseIfFailed("MakePipeWithDifferentSections", self.PrimOp)
1559             return anObj
1560
1561         ## Create a shape by extrusion of the profile shape along
1562         #  the path shape. The path shape can be a wire or a edge.
1563         #  the several profiles can be specified in the several locations of path.
1564         #  @param theSeqBases - list of  Bases shape to be extruded. Base shape must be
1565         #                       shell or face. If number of faces in neighbour sections
1566         #                       aren't coincided result solid between such sections will
1567         #                       be created using external boundaries of this shells.
1568         #  @param theSeqSubBases - list of corresponding subshapes of section shapes.
1569         #                          This list is used for searching correspondences between
1570         #                          faces in the sections. Size of this list must be equal
1571         #                          to size of list of base shapes.
1572         #  @param theLocations - list of locations on the path corresponding
1573         #                        specified list of the Bases shapes. Number of locations
1574         #                        should be equal to number of bases. First and last
1575         #                        locations must be coincided with first and last vertexes
1576         #                        of path correspondingly.
1577         #  @param thePath - Path shape to extrude the base shape along it.
1578         #  @param theWithContact - the mode defining that the section is translated to be in
1579         #                          contact with the spine.
1580         #  @param theWithCorrection - defining that the section is rotated to be
1581         #                             orthogonal to the spine tangent in the correspondent point
1582         #  @return New GEOM_Object, containing the created solids.
1583         #
1584         #  @ref tui_creation_pipe_with_shell_sec "Example"
1585         def MakePipeWithShellSections(self,theSeqBases, theSeqSubBases,
1586                                       theLocations, thePath,
1587                                       theWithContact, theWithCorrection):
1588             anObj = self.PrimOp.MakePipeWithShellSections(theSeqBases, theSeqSubBases,
1589                                                           theLocations, thePath,
1590                                                           theWithContact, theWithCorrection)
1591             RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
1592             return anObj
1593
1594         ## Create a shape by extrusion of the profile shape along
1595         #  the path shape. This function is used only for debug pipe
1596         #  functionality - it is a version of previous function
1597         #  (MakePipeWithShellSections(...)) which give a possibility to
1598         #  recieve information about creating pipe between each pair of
1599         #  sections step by step.
1600         def MakePipeWithShellSectionsBySteps(self, theSeqBases, theSeqSubBases,
1601                                              theLocations, thePath,
1602                                              theWithContact, theWithCorrection):
1603             res = []
1604             nbsect = len(theSeqBases)
1605             nbsubsect = len(theSeqSubBases)
1606             #print "nbsect = ",nbsect
1607             for i in range(1,nbsect):
1608                 #print "  i = ",i
1609                 tmpSeqBases = [ theSeqBases[i-1], theSeqBases[i] ]
1610                 tmpLocations = [ theLocations[i-1], theLocations[i] ]
1611                 tmpSeqSubBases = []
1612                 if nbsubsect>0: tmpSeqSubBases = [ theSeqSubBases[i-1], theSeqSubBases[i] ]
1613                 anObj = self.PrimOp.MakePipeWithShellSections(tmpSeqBases, tmpSeqSubBases,
1614                                                               tmpLocations, thePath,
1615                                                               theWithContact, theWithCorrection)
1616                 if self.PrimOp.IsDone() == 0:
1617                     print "Problems with pipe creation between ",i," and ",i+1," sections"
1618                     RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
1619                     break
1620                 else:
1621                     print "Pipe between ",i," and ",i+1," sections is OK"
1622                     res.append(anObj)
1623                     pass
1624                 pass
1625
1626             resc = self.MakeCompound(res)
1627             #resc = self.MakeSewing(res, 0.001)
1628             #print "resc: ",resc
1629             return resc
1630
1631         ## Create solids between given sections
1632         #  @param theSeqBases - list of sections (shell or face).
1633         #  @param theLocations - list of corresponding vertexes
1634         #  @return New GEOM_Object, containing the created solids.
1635         #
1636         #  @ref tui_creation_pipe_without_path "Example"
1637         def MakePipeShellsWithoutPath(self, theSeqBases, theLocations):
1638             anObj = self.PrimOp.MakePipeShellsWithoutPath(theSeqBases, theLocations)
1639             RaiseIfFailed("MakePipeShellsWithoutPath", self.PrimOp)
1640             return anObj
1641
1642         ## Create a shape by extrusion of the base shape along
1643         #  the path shape with constant bi-normal direction along the given vector.
1644         #  The path shape can be a wire or an edge.
1645         #  @param theBase Base shape to be extruded.
1646         #  @param thePath Path shape to extrude the base shape along it.
1647         #  @param theVec Vector defines a constant binormal direction to keep the
1648         #                same angle beetween the direction and the sections
1649         #                along the sweep surface.
1650         #  @return New GEOM_Object, containing the created pipe.
1651         #
1652         #  @ref tui_creation_pipe "Example"
1653         def MakePipeBiNormalAlongVector(self,theBase, thePath, theVec):
1654             # Example: see GEOM_TestAll.py
1655             anObj = self.PrimOp.MakePipeBiNormalAlongVector(theBase, thePath, theVec)
1656             RaiseIfFailed("MakePipeBiNormalAlongVector", self.PrimOp)
1657             return anObj
1658
1659         # end of l3_complex
1660         ## @}
1661
1662         ## @addtogroup l3_advanced
1663         ## @{
1664
1665         ## Create a linear edge with specified ends.
1666         #  @param thePnt1 Point for the first end of edge.
1667         #  @param thePnt2 Point for the second end of edge.
1668         #  @return New GEOM_Object, containing the created edge.
1669         #
1670         #  @ref tui_creation_edge "Example"
1671         def MakeEdge(self,thePnt1, thePnt2):
1672             # Example: see GEOM_TestAll.py
1673             anObj = self.ShapesOp.MakeEdge(thePnt1, thePnt2)
1674             RaiseIfFailed("MakeEdge", self.ShapesOp)
1675             return anObj
1676
1677         ## Create a new edge, corresponding to the given length on the given curve.
1678         #  @param theRefCurve The referenced curve (edge).
1679         #  @param theLength Length on the referenced curve. It can be negative.
1680         #  @param theStartPoint Any point can be selected for it, the new edge will begin
1681         #                       at the end of \a theRefCurve, close to the selected point.
1682         #                       If None, start from the first point of \a theRefCurve.
1683         #  @return New GEOM_Object, containing the created edge.
1684         #
1685         #  @ref tui_creation_edge "Example"
1686         def MakeEdgeOnCurveByLength(self, theRefCurve, theLength, theStartPoint = None):
1687             # Example: see GEOM_TestAll.py
1688             theLength, Parameters = ParseParameters(theLength)
1689             anObj = self.ShapesOp.MakeEdgeOnCurveByLength(theRefCurve, theLength, theStartPoint)
1690             RaiseIfFailed("MakeEdgeOnCurveByLength", self.ShapesOp)
1691             anObj.SetParameters(Parameters)
1692             return anObj
1693
1694         ## Create an edge from specified wire.
1695         #  @param theWire source Wire.
1696         #  @param theLinearTolerance linear tolerance value.
1697         #  @param theAngularTolerance angular tolerance value.
1698         #  @return New GEOM_Object, containing the created edge.
1699         #
1700         #  @ref tui_creation_edge "Example"
1701         def MakeEdgeWire(self, theWire, theLinearTolerance = 1e-07, theAngularTolerance = 1e-12):
1702             # Example: see GEOM_TestAll.py
1703             anObj = self.ShapesOp.MakeEdgeWire(theWire, theLinearTolerance, theAngularTolerance)
1704             RaiseIfFailed("MakeEdgeWire", self.ShapesOp)
1705             return anObj
1706
1707         ## Create a wire from the set of edges and wires.
1708         #  @param theEdgesAndWires List of edges and/or wires.
1709         #  @param theTolerance Maximum distance between vertices, that will be merged.
1710         #                      Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1711         #  @return New GEOM_Object, containing the created wire.
1712         #
1713         #  @ref tui_creation_wire "Example"
1714         def MakeWire(self, theEdgesAndWires, theTolerance = 1e-07):
1715             # Example: see GEOM_TestAll.py
1716             anObj = self.ShapesOp.MakeWire(theEdgesAndWires, theTolerance)
1717             RaiseIfFailed("MakeWire", self.ShapesOp)
1718             return anObj
1719
1720         ## Create a face on the given wire.
1721         #  @param theWire closed Wire or Edge to build the face on.
1722         #  @param isPlanarWanted If TRUE, only planar face will be built.
1723         #                        If impossible, NULL object will be returned.
1724         #  @return New GEOM_Object, containing the created face.
1725         #
1726         #  @ref tui_creation_face "Example"
1727         def MakeFace(self,theWire, isPlanarWanted):
1728             # Example: see GEOM_TestAll.py
1729             anObj = self.ShapesOp.MakeFace(theWire, isPlanarWanted)
1730             RaiseIfFailed("MakeFace", self.ShapesOp)
1731             return anObj
1732
1733         ## Create a face on the given wires set.
1734         #  @param theWires List of closed wires or edges to build the face on.
1735         #  @param isPlanarWanted If TRUE, only planar face will be built.
1736         #                        If impossible, NULL object will be returned.
1737         #  @return New GEOM_Object, containing the created face.
1738         #
1739         #  @ref tui_creation_face "Example"
1740         def MakeFaceWires(self,theWires, isPlanarWanted):
1741             # Example: see GEOM_TestAll.py
1742             anObj = self.ShapesOp.MakeFaceWires(theWires, isPlanarWanted)
1743             RaiseIfFailed("MakeFaceWires", self.ShapesOp)
1744             return anObj
1745
1746         ## Shortcut to MakeFaceWires()
1747         #
1748         #  @ref tui_creation_face "Example 1"
1749         #  \n @ref swig_MakeFaces  "Example 2"
1750         def MakeFaces(self,theWires, isPlanarWanted):
1751             # Example: see GEOM_TestOthers.py
1752             anObj = self.MakeFaceWires(theWires, isPlanarWanted)
1753             return anObj
1754
1755         ## Create a shell from the set of faces and shells.
1756         #  @param theFacesAndShells List of faces and/or shells.
1757         #  @return New GEOM_Object, containing the created shell.
1758         #
1759         #  @ref tui_creation_shell "Example"
1760         def MakeShell(self,theFacesAndShells):
1761             # Example: see GEOM_TestAll.py
1762             anObj = self.ShapesOp.MakeShell(theFacesAndShells)
1763             RaiseIfFailed("MakeShell", self.ShapesOp)
1764             return anObj
1765
1766         ## Create a solid, bounded by the given shells.
1767         #  @param theShells Sequence of bounding shells.
1768         #  @return New GEOM_Object, containing the created solid.
1769         #
1770         #  @ref tui_creation_solid "Example"
1771         def MakeSolid(self,theShells):
1772             # Example: see GEOM_TestAll.py
1773             anObj = self.ShapesOp.MakeSolidShells(theShells)
1774             RaiseIfFailed("MakeSolidShells", self.ShapesOp)
1775             return anObj
1776
1777         ## Create a compound of the given shapes.
1778         #  @param theShapes List of shapes to put in compound.
1779         #  @return New GEOM_Object, containing the created compound.
1780         #
1781         #  @ref tui_creation_compound "Example"
1782         def MakeCompound(self,theShapes):
1783             # Example: see GEOM_TestAll.py
1784             anObj = self.ShapesOp.MakeCompound(theShapes)
1785             RaiseIfFailed("MakeCompound", self.ShapesOp)
1786             return anObj
1787
1788         # end of l3_advanced
1789         ## @}
1790
1791         ## @addtogroup l2_measure
1792         ## @{
1793
1794         ## Gives quantity of faces in the given shape.
1795         #  @param theShape Shape to count faces of.
1796         #  @return Quantity of faces.
1797         #
1798         #  @ref swig_NumberOf "Example"
1799         def NumberOfFaces(self, theShape):
1800             # Example: see GEOM_TestOthers.py
1801             nb_faces = self.ShapesOp.NumberOfFaces(theShape)
1802             RaiseIfFailed("NumberOfFaces", self.ShapesOp)
1803             return nb_faces
1804
1805         ## Gives quantity of edges in the given shape.
1806         #  @param theShape Shape to count edges of.
1807         #  @return Quantity of edges.
1808         #
1809         #  @ref swig_NumberOf "Example"
1810         def NumberOfEdges(self, theShape):
1811             # Example: see GEOM_TestOthers.py
1812             nb_edges = self.ShapesOp.NumberOfEdges(theShape)
1813             RaiseIfFailed("NumberOfEdges", self.ShapesOp)
1814             return nb_edges
1815
1816         ## Gives quantity of subshapes of type theShapeType in the given shape.
1817         #  @param theShape Shape to count subshapes of.
1818         #  @param theShapeType Type of subshapes to count.
1819         #  @return Quantity of subshapes of given type.
1820         #
1821         #  @ref swig_NumberOf "Example"
1822         def NumberOfSubShapes(self, theShape, theShapeType):
1823             # Example: see GEOM_TestOthers.py
1824             nb_ss = self.ShapesOp.NumberOfSubShapes(theShape, theShapeType)
1825             RaiseIfFailed("NumberOfSubShapes", self.ShapesOp)
1826             return nb_ss
1827
1828         ## Gives quantity of solids in the given shape.
1829         #  @param theShape Shape to count solids in.
1830         #  @return Quantity of solids.
1831         #
1832         #  @ref swig_NumberOf "Example"
1833         def NumberOfSolids(self, theShape):
1834             # Example: see GEOM_TestOthers.py
1835             nb_solids = self.ShapesOp.NumberOfSubShapes(theShape, ShapeType["SOLID"])
1836             RaiseIfFailed("NumberOfSolids", self.ShapesOp)
1837             return nb_solids
1838
1839         # end of l2_measure
1840         ## @}
1841
1842         ## @addtogroup l3_healing
1843         ## @{
1844
1845         ## Reverses an orientation the given shape.
1846         #  @param theShape Shape to be reversed.
1847         #  @return The reversed copy of theShape.
1848         #
1849         #  @ref swig_ChangeOrientation "Example"
1850         def ChangeOrientation(self,theShape):
1851             # Example: see GEOM_TestAll.py
1852             anObj = self.ShapesOp.ChangeOrientation(theShape)
1853             RaiseIfFailed("ChangeOrientation", self.ShapesOp)
1854             return anObj
1855
1856         ## Shortcut to ChangeOrientation()
1857         #
1858         #  @ref swig_OrientationChange "Example"
1859         def OrientationChange(self,theShape):
1860             # Example: see GEOM_TestOthers.py
1861             anObj = self.ChangeOrientation(theShape)
1862             return anObj
1863
1864         # end of l3_healing
1865         ## @}
1866
1867         ## @addtogroup l4_obtain
1868         ## @{
1869
1870         ## Retrieve all free faces from the given shape.
1871         #  Free face is a face, which is not shared between two shells of the shape.
1872         #  @param theShape Shape to find free faces in.
1873         #  @return List of IDs of all free faces, contained in theShape.
1874         #
1875         #  @ref tui_measurement_tools_page "Example"
1876         def GetFreeFacesIDs(self,theShape):
1877             # Example: see GEOM_TestOthers.py
1878             anIDs = self.ShapesOp.GetFreeFacesIDs(theShape)
1879             RaiseIfFailed("GetFreeFacesIDs", self.ShapesOp)
1880             return anIDs
1881
1882         ## Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1883         #  @param theShape1 Shape to find sub-shapes in.
1884         #  @param theShape2 Shape to find shared sub-shapes with.
1885         #  @param theShapeType Type of sub-shapes to be retrieved.
1886         #  @return List of sub-shapes of theShape1, shared with theShape2.
1887         #
1888         #  @ref swig_GetSharedShapes "Example"
1889         def GetSharedShapes(self,theShape1, theShape2, theShapeType):
1890             # Example: see GEOM_TestOthers.py
1891             aList = self.ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
1892             RaiseIfFailed("GetSharedShapes", self.ShapesOp)
1893             return aList
1894
1895         ## Get all sub-shapes, shared by all shapes in the list <VAR>theShapes</VAR>.
1896         #  @param theShapes Shapes to find common sub-shapes of.
1897         #  @param theShapeType Type of sub-shapes to be retrieved.
1898         #  @return List of objects, that are sub-shapes of all given shapes.
1899         #
1900         #  @ref swig_GetSharedShapes "Example"
1901         def GetSharedShapesMulti(self, theShapes, theShapeType):
1902             # Example: see GEOM_TestOthers.py
1903             aList = self.ShapesOp.GetSharedShapesMulti(theShapes, theShapeType)
1904             RaiseIfFailed("GetSharedShapesMulti", self.ShapesOp)
1905             return aList
1906
1907         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
1908         #  situated relatively the specified plane by the certain way,
1909         #  defined through <VAR>theState</VAR> parameter.
1910         #  @param theShape Shape to find sub-shapes of.
1911         #  @param theShapeType Type of sub-shapes to be retrieved.
1912         #  @param theAx1 Vector (or line, or linear edge), specifying normal
1913         #                direction and location of the plane to find shapes on.
1914         #  @param theState The state of the subshapes to find. It can be one of
1915         #   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1916         #  @return List of all found sub-shapes.
1917         #
1918         #  @ref swig_GetShapesOnPlane "Example"
1919         def GetShapesOnPlane(self,theShape, theShapeType, theAx1, theState):
1920             # Example: see GEOM_TestOthers.py
1921             aList = self.ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
1922             RaiseIfFailed("GetShapesOnPlane", self.ShapesOp)
1923             return aList
1924
1925         ## Works like the above method, but returns list of sub-shapes indices
1926         #
1927         #  @ref swig_GetShapesOnPlaneIDs "Example"
1928         def GetShapesOnPlaneIDs(self,theShape, theShapeType, theAx1, theState):
1929             # Example: see GEOM_TestOthers.py
1930             aList = self.ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
1931             RaiseIfFailed("GetShapesOnPlaneIDs", self.ShapesOp)
1932             return aList
1933
1934         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
1935         #  situated relatively the specified plane by the certain way,
1936         #  defined through <VAR>theState</VAR> parameter.
1937         #  @param theShape Shape to find sub-shapes of.
1938         #  @param theShapeType Type of sub-shapes to be retrieved.
1939         #  @param theAx1 Vector (or line, or linear edge), specifying normal
1940         #                direction of the plane to find shapes on.
1941         #  @param thePnt Point specifying location of the plane to find shapes on.
1942         #  @param theState The state of the subshapes to find. It can be one of
1943         #                  ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1944         #  @return List of all found sub-shapes.
1945         #
1946         #  @ref swig_GetShapesOnPlaneWithLocation "Example"
1947         def GetShapesOnPlaneWithLocation(self, theShape, theShapeType, theAx1, thePnt, theState):
1948             # Example: see GEOM_TestOthers.py
1949             aList = self.ShapesOp.GetShapesOnPlaneWithLocation(theShape, theShapeType,
1950                                                                theAx1, thePnt, theState)
1951             RaiseIfFailed("GetShapesOnPlaneWithLocation", self.ShapesOp)
1952             return aList
1953
1954         ## Works like the above method, but returns list of sub-shapes indices
1955         #
1956         #  @ref swig_GetShapesOnPlaneWithLocationIDs "Example"
1957         def GetShapesOnPlaneWithLocationIDs(self, theShape, theShapeType, theAx1, thePnt, theState):
1958             # Example: see GEOM_TestOthers.py
1959             aList = self.ShapesOp.GetShapesOnPlaneWithLocationIDs(theShape, theShapeType,
1960                                                                   theAx1, thePnt, theState)
1961             RaiseIfFailed("GetShapesOnPlaneWithLocationIDs", self.ShapesOp)
1962             return aList
1963
1964         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1965         #  the specified cylinder by the certain way, defined through \a theState parameter.
1966         #  @param theShape Shape to find sub-shapes of.
1967         #  @param theShapeType Type of sub-shapes to be retrieved.
1968         #  @param theAxis Vector (or line, or linear edge), specifying
1969         #                 axis of the cylinder to find shapes on.
1970         #  @param theRadius Radius of the cylinder to find shapes on.
1971         #  @param theState The state of the subshapes to find. It can be one of
1972         #   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
1973         #  @return List of all found sub-shapes.
1974         #
1975         #  @ref swig_GetShapesOnCylinder "Example"
1976         def GetShapesOnCylinder(self, theShape, theShapeType, theAxis, theRadius, theState):
1977             # Example: see GEOM_TestOthers.py
1978             aList = self.ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
1979             RaiseIfFailed("GetShapesOnCylinder", self.ShapesOp)
1980             return aList
1981
1982         ## Works like the above method, but returns list of sub-shapes indices
1983         #
1984         #  @ref swig_GetShapesOnCylinderIDs "Example"
1985         def GetShapesOnCylinderIDs(self, theShape, theShapeType, theAxis, theRadius, theState):
1986             # Example: see GEOM_TestOthers.py
1987             aList = self.ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
1988             RaiseIfFailed("GetShapesOnCylinderIDs", self.ShapesOp)
1989             return aList
1990
1991         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1992         #  the specified cylinder by the certain way, defined through \a theState parameter.
1993         #  @param theShape Shape to find sub-shapes of.
1994         #  @param theShapeType Type of sub-shapes to be retrieved.
1995         #  @param theAxis Vector (or line, or linear edge), specifying
1996         #                 axis of the cylinder to find shapes on.
1997         #  @param thePnt Point specifying location of the bottom of the cylinder.
1998         #  @param theRadius Radius of the cylinder to find shapes on.
1999         #  @param theState The state of the subshapes to find. It can be one of
2000         #   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
2001         #  @return List of all found sub-shapes.
2002         #
2003         #  @ref swig_GetShapesOnCylinderWithLocation "Example"
2004         def GetShapesOnCylinderWithLocation(self, theShape, theShapeType, theAxis, thePnt, theRadius, theState):
2005             # Example: see GEOM_TestOthers.py
2006             aList = self.ShapesOp.GetShapesOnCylinderWithLocation(theShape, theShapeType, theAxis, thePnt, theRadius, theState)
2007             RaiseIfFailed("GetShapesOnCylinderWithLocation", self.ShapesOp)
2008             return aList
2009
2010         ## Works like the above method, but returns list of sub-shapes indices
2011         #
2012         #  @ref swig_GetShapesOnCylinderWithLocationIDs "Example"
2013         def GetShapesOnCylinderWithLocationIDs(self, theShape, theShapeType, theAxis, thePnt, theRadius, theState):
2014             # Example: see GEOM_TestOthers.py
2015             aList = self.ShapesOp.GetShapesOnCylinderWithLocationIDs(theShape, theShapeType, theAxis, thePnt, theRadius, theState)
2016             RaiseIfFailed("GetShapesOnCylinderWithLocationIDs", self.ShapesOp)
2017             return aList
2018
2019         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2020         #  the specified sphere by the certain way, defined through \a theState parameter.
2021         #  @param theShape Shape to find sub-shapes of.
2022         #  @param theShapeType Type of sub-shapes to be retrieved.
2023         #  @param theCenter Point, specifying center of the sphere to find shapes on.
2024         #  @param theRadius Radius of the sphere to find shapes on.
2025         #  @param theState The state of the subshapes to find. It can be one of
2026         #   ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
2027         #  @return List of all found sub-shapes.
2028         #
2029         #  @ref swig_GetShapesOnSphere "Example"
2030         def GetShapesOnSphere(self,theShape, theShapeType, theCenter, theRadius, theState):
2031             # Example: see GEOM_TestOthers.py
2032             aList = self.ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
2033             RaiseIfFailed("GetShapesOnSphere", self.ShapesOp)
2034             return aList
2035
2036         ## Works like the above method, but returns list of sub-shapes indices
2037         #
2038         #  @ref swig_GetShapesOnSphereIDs "Example"
2039         def GetShapesOnSphereIDs(self,theShape, theShapeType, theCenter, theRadius, theState):
2040             # Example: see GEOM_TestOthers.py
2041             aList = self.ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
2042             RaiseIfFailed("GetShapesOnSphereIDs", self.ShapesOp)
2043             return aList
2044
2045         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2046         #  the specified quadrangle by the certain way, defined through \a theState parameter.
2047         #  @param theShape Shape to find sub-shapes of.
2048         #  @param theShapeType Type of sub-shapes to be retrieved.
2049         #  @param theTopLeftPoint Point, specifying top left corner of a quadrangle
2050         #  @param theTopRigthPoint Point, specifying top right corner of a quadrangle
2051         #  @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
2052         #  @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
2053         #  @param theState The state of the subshapes to find. It can be one of
2054         #                  ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
2055         #  @return List of all found sub-shapes.
2056         #
2057         #  @ref swig_GetShapesOnQuadrangle "Example"
2058         def GetShapesOnQuadrangle(self, theShape, theShapeType,
2059                                   theTopLeftPoint, theTopRigthPoint,
2060                                   theBottomLeftPoint, theBottomRigthPoint, theState):
2061             # Example: see GEOM_TestOthers.py
2062             aList = self.ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType,
2063                                                         theTopLeftPoint, theTopRigthPoint,
2064                                                         theBottomLeftPoint, theBottomRigthPoint, theState)
2065             RaiseIfFailed("GetShapesOnQuadrangle", self.ShapesOp)
2066             return aList
2067
2068         ## Works like the above method, but returns list of sub-shapes indices
2069         #
2070         #  @ref swig_GetShapesOnQuadrangleIDs "Example"
2071         def GetShapesOnQuadrangleIDs(self, theShape, theShapeType,
2072                                      theTopLeftPoint, theTopRigthPoint,
2073                                      theBottomLeftPoint, theBottomRigthPoint, theState):
2074             # Example: see GEOM_TestOthers.py
2075             aList = self.ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType,
2076                                                            theTopLeftPoint, theTopRigthPoint,
2077                                                            theBottomLeftPoint, theBottomRigthPoint, theState)
2078             RaiseIfFailed("GetShapesOnQuadrangleIDs", self.ShapesOp)
2079             return aList
2080
2081         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2082         #  the specified \a theBox by the certain way, defined through \a theState parameter.
2083         #  @param theBox Shape for relative comparing.
2084         #  @param theShape Shape to find sub-shapes of.
2085         #  @param theShapeType Type of sub-shapes to be retrieved.
2086         #  @param theState The state of the subshapes to find. It can be one of
2087         #                  ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
2088         #  @return List of all found sub-shapes.
2089         #
2090         #  @ref swig_GetShapesOnBox "Example"
2091         def GetShapesOnBox(self, theBox, theShape, theShapeType, theState):
2092             # Example: see GEOM_TestOthers.py
2093             aList = self.ShapesOp.GetShapesOnBox(theBox, theShape, theShapeType, theState)
2094             RaiseIfFailed("GetShapesOnBox", self.ShapesOp)
2095             return aList
2096
2097         ## Works like the above method, but returns list of sub-shapes indices
2098         #
2099         #  @ref swig_GetShapesOnBoxIDs "Example"
2100         def GetShapesOnBoxIDs(self, theBox, theShape, theShapeType, theState):
2101             # Example: see GEOM_TestOthers.py
2102             aList = self.ShapesOp.GetShapesOnBoxIDs(theBox, theShape, theShapeType, theState)
2103             RaiseIfFailed("GetShapesOnBoxIDs", self.ShapesOp)
2104             return aList
2105
2106         ## Find in \a theShape all sub-shapes of type \a theShapeType,
2107         #  situated relatively the specified \a theCheckShape by the
2108         #  certain way, defined through \a theState parameter.
2109         #  @param theCheckShape Shape for relative comparing. It must be a solid.
2110         #  @param theShape Shape to find sub-shapes of.
2111         #  @param theShapeType Type of sub-shapes to be retrieved.
2112         #  @param theState The state of the subshapes to find. It can be one of
2113         #                  ST_ON, ST_OUT, ST_ONOUT, ST_IN, ST_ONIN.
2114         #  @return List of all found sub-shapes.
2115         #
2116         #  @ref swig_GetShapesOnShape "Example"
2117         def GetShapesOnShape(self, theCheckShape, theShape, theShapeType, theState):
2118             # Example: see GEOM_TestOthers.py
2119             aList = self.ShapesOp.GetShapesOnShape(theCheckShape, theShape,
2120                                                    theShapeType, theState)
2121             RaiseIfFailed("GetShapesOnShape", self.ShapesOp)
2122             return aList
2123
2124         ## Works like the above method, but returns result as compound
2125         #
2126         #  @ref swig_GetShapesOnShapeAsCompound "Example"
2127         def GetShapesOnShapeAsCompound(self, theCheckShape, theShape, theShapeType, theState):
2128             # Example: see GEOM_TestOthers.py
2129             anObj = self.ShapesOp.GetShapesOnShapeAsCompound(theCheckShape, theShape,
2130                                                              theShapeType, theState)
2131             RaiseIfFailed("GetShapesOnShapeAsCompound", self.ShapesOp)
2132             return anObj
2133
2134         ## Works like the above method, but returns list of sub-shapes indices
2135         #
2136         #  @ref swig_GetShapesOnShapeIDs "Example"
2137         def GetShapesOnShapeIDs(self, theCheckShape, theShape, theShapeType, theState):
2138             # Example: see GEOM_TestOthers.py
2139             aList = self.ShapesOp.GetShapesOnShapeIDs(theCheckShape, theShape,
2140                                                       theShapeType, theState)
2141             RaiseIfFailed("GetShapesOnShapeIDs", self.ShapesOp)
2142             return aList
2143
2144         ## Get sub-shape(s) of theShapeWhere, which are
2145         #  coincident with \a theShapeWhat or could be a part of it.
2146         #  @param theShapeWhere Shape to find sub-shapes of.
2147         #  @param theShapeWhat Shape, specifying what to find.
2148         #  @return Group of all found sub-shapes or a single found sub-shape.
2149         #
2150         #  @note This function has a restriction on argument shapes.
2151         #        If \a theShapeWhere has curved parts with significantly
2152         #        outstanding centres (i.e. the mass centre of a part is closer to
2153         #        \a theShapeWhat than to the part), such parts will not be found.
2154         #        @image html get_in_place_lost_part.png
2155         #
2156         #  @ref swig_GetInPlace "Example"
2157         def GetInPlace(self, theShapeWhere, theShapeWhat, isNewImplementation = False):
2158             # Example: see GEOM_TestOthers.py
2159             anObj = None
2160             if isNewImplementation:
2161                 anObj = self.ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
2162             else:
2163                 anObj = self.ShapesOp.GetInPlaceOld(theShapeWhere, theShapeWhat)
2164                 pass
2165             RaiseIfFailed("GetInPlace", self.ShapesOp)
2166             return anObj
2167
2168         ## Get sub-shape(s) of \a theShapeWhere, which are
2169         #  coincident with \a theShapeWhat or could be a part of it.
2170         #
2171         #  Implementation of this method is based on a saved history of an operation,
2172         #  produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
2173         #  arguments (an argument shape or a sub-shape of an argument shape).
2174         #  The operation could be the Partition or one of boolean operations,
2175         #  performed on simple shapes (not on compounds).
2176         #
2177         #  @param theShapeWhere Shape to find sub-shapes of.
2178         #  @param theShapeWhat Shape, specifying what to find (must be in the
2179         #                      building history of the ShapeWhere).
2180         #  @return Group of all found sub-shapes or a single found sub-shape.
2181         #
2182         #  @ref swig_GetInPlace "Example"
2183         def GetInPlaceByHistory(self, theShapeWhere, theShapeWhat):
2184             # Example: see GEOM_TestOthers.py
2185             anObj = self.ShapesOp.GetInPlaceByHistory(theShapeWhere, theShapeWhat)
2186             RaiseIfFailed("GetInPlaceByHistory", self.ShapesOp)
2187             return anObj
2188
2189         ## Get sub-shape of theShapeWhere, which is
2190         #  equal to \a theShapeWhat.
2191         #  @param theShapeWhere Shape to find sub-shape of.
2192         #  @param theShapeWhat Shape, specifying what to find.
2193         #  @return New GEOM_Object for found sub-shape.
2194         #
2195         #  @ref swig_GetSame "Example"
2196         def GetSame(self,theShapeWhere, theShapeWhat):
2197             anObj = self.ShapesOp.GetSame(theShapeWhere, theShapeWhat)
2198             RaiseIfFailed("GetSame", self.ShapesOp)
2199             return anObj
2200
2201         # end of l4_obtain
2202         ## @}
2203
2204         ## @addtogroup l4_access
2205         ## @{
2206
2207         ## Obtain a composite sub-shape of <VAR>aShape</VAR>, composed from sub-shapes
2208         #  of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
2209         #
2210         #  @ref swig_all_decompose "Example"
2211         def GetSubShape(self, aShape, ListOfID):
2212             # Example: see GEOM_TestAll.py
2213             anObj = self.AddSubShape(aShape,ListOfID)
2214             return anObj
2215
2216         ## Obtain unique ID of sub-shape <VAR>aSubShape</VAR> inside <VAR>aShape</VAR>
2217         #
2218         #  @ref swig_all_decompose "Example"
2219         def GetSubShapeID(self, aShape, aSubShape):
2220             # Example: see GEOM_TestAll.py
2221             anID = self.LocalOp.GetSubShapeIndex(aShape, aSubShape)
2222             RaiseIfFailed("GetSubShapeIndex", self.LocalOp)
2223             return anID
2224
2225         # end of l4_access
2226         ## @}
2227
2228         ## @addtogroup l4_decompose
2229         ## @{
2230
2231         ## Get all sub-shapes and groups of \a theShape,
2232         #  that were created already by any other methods.
2233         #  @param theShape Any shape.
2234         #  @param theGroupsOnly If this parameter is TRUE, only groups will be
2235         #                       returned, else all found sub-shapes and groups.
2236         #  @return List of existing sub-objects of \a theShape.
2237         #
2238         #  @ref swig_all_decompose "Example"
2239         def GetExistingSubObjects(self, theShape, theGroupsOnly = False):
2240             # Example: see GEOM_TestAll.py
2241             ListObj = self.ShapesOp.GetExistingSubObjects(theShape, theGroupsOnly)
2242             RaiseIfFailed("GetExistingSubObjects", self.ShapesOp)
2243             return ListObj
2244
2245         ## Get all groups of \a theShape,
2246         #  that were created already by any other methods.
2247         #  @param theShape Any shape.
2248         #  @return List of existing groups of \a theShape.
2249         #
2250         #  @ref swig_all_decompose "Example"
2251         def GetGroups(self, theShape):
2252             # Example: see GEOM_TestAll.py
2253             ListObj = self.ShapesOp.GetExistingSubObjects(theShape, True)
2254             RaiseIfFailed("GetExistingSubObjects", self.ShapesOp)
2255             return ListObj
2256
2257         ## Explode a shape on subshapes of a given type.
2258         #  If the shape itself matches the type, it is also returned.
2259         #  @param aShape Shape to be exploded.
2260         #  @param aType Type of sub-shapes to be retrieved.
2261         #  @return List of sub-shapes of type theShapeType, contained in theShape.
2262         #
2263         #  @ref swig_all_decompose "Example"
2264         def SubShapeAll(self, aShape, aType):
2265             # Example: see GEOM_TestAll.py
2266             ListObj = self.ShapesOp.MakeAllSubShapes(aShape, aType, False)
2267             RaiseIfFailed("SubShapeAll", self.ShapesOp)
2268             return ListObj
2269
2270         ## Explode a shape on subshapes of a given type.
2271         #  @param aShape Shape to be exploded.
2272         #  @param aType Type of sub-shapes to be retrieved.
2273         #  @return List of IDs of sub-shapes.
2274         #
2275         #  @ref swig_all_decompose "Example"
2276         def SubShapeAllIDs(self, aShape, aType):
2277             ListObj = self.ShapesOp.GetAllSubShapesIDs(aShape, aType, False)
2278             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
2279             return ListObj
2280
2281         ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
2282         #  selected by they indices in list of all sub-shapes of type <VAR>aType</VAR>.
2283         #  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
2284         #
2285         #  @ref swig_all_decompose "Example"
2286         def SubShape(self, aShape, aType, ListOfInd):
2287             # Example: see GEOM_TestAll.py
2288             ListOfIDs = []
2289             AllShapeIDsList = self.SubShapeAllIDs(aShape, aType)
2290             for ind in ListOfInd:
2291                 ListOfIDs.append(AllShapeIDsList[ind - 1])
2292             anObj = self.GetSubShape(aShape, ListOfIDs)
2293             return anObj
2294
2295         ## Explode a shape on subshapes of a given type.
2296         #  Sub-shapes will be sorted by coordinates of their gravity centers.
2297         #  If the shape itself matches the type, it is also returned.
2298         #  @param aShape Shape to be exploded.
2299         #  @param aType Type of sub-shapes to be retrieved.
2300         #  @return List of sub-shapes of type theShapeType, contained in theShape.
2301         #
2302         #  @ref swig_SubShapeAllSorted "Example"
2303         def SubShapeAllSortedCentres(self, aShape, aType):
2304             # Example: see GEOM_TestAll.py
2305             ListObj = self.ShapesOp.MakeAllSubShapes(aShape, aType, True)
2306             RaiseIfFailed("SubShapeAllSortedCentres", self.ShapesOp)
2307             return ListObj
2308
2309         ## Explode a shape on subshapes of a given type.
2310         #  Sub-shapes will be sorted by coordinates of their gravity centers.
2311         #  @param aShape Shape to be exploded.
2312         #  @param aType Type of sub-shapes to be retrieved.
2313         #  @return List of IDs of sub-shapes.
2314         #
2315         #  @ref swig_all_decompose "Example"
2316         def SubShapeAllSortedCentresIDs(self, aShape, aType):
2317             ListIDs = self.ShapesOp.GetAllSubShapesIDs(aShape, aType, True)
2318             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
2319             return ListIDs
2320
2321         ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
2322         #  selected by they indices in sorted list of all sub-shapes of type <VAR>aType</VAR>.
2323         #  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
2324         #
2325         #  @ref swig_all_decompose "Example"
2326         def SubShapeSortedCentres(self, aShape, aType, ListOfInd):
2327             # Example: see GEOM_TestAll.py
2328             ListOfIDs = []
2329             AllShapeIDsList = self.SubShapeAllSortedCentresIDs(aShape, aType)
2330             for ind in ListOfInd:
2331                 ListOfIDs.append(AllShapeIDsList[ind - 1])
2332             anObj = self.GetSubShape(aShape, ListOfIDs)
2333             return anObj
2334
2335         ## Extract shapes (excluding the main shape) of given type.
2336         #  @param aShape The shape.
2337         #  @param aType  The shape type.
2338         #  @param isSorted Boolean flag to switch sorting on/off.
2339         #  @return List of sub-shapes of type aType, contained in aShape.
2340         #
2341         #  @ref swig_FilletChamfer "Example"
2342         def ExtractShapes(self, aShape, aType, isSorted = False):
2343             # Example: see GEOM_TestAll.py
2344             ListObj = self.ShapesOp.ExtractSubShapes(aShape, aType, isSorted)
2345             RaiseIfFailed("ExtractSubShapes", self.ShapesOp)
2346             return ListObj
2347
2348         ## Get a set of sub shapes defined by their unique IDs inside <VAR>theMainShape</VAR>
2349         #  @param theMainShape Main shape.
2350         #  @param theIndices List of unique IDs of sub shapes inside <VAR>theMainShape</VAR>.
2351         #  @return List of GEOM_Objects, corresponding to found sub shapes.
2352         #
2353         #  @ref swig_all_decompose "Example"
2354         def SubShapes(self, aShape, anIDs):
2355             # Example: see GEOM_TestAll.py
2356             ListObj = self.ShapesOp.MakeSubShapes(aShape, anIDs)
2357             RaiseIfFailed("SubShapes", self.ShapesOp)
2358             return ListObj
2359
2360         # end of l4_decompose
2361         ## @}
2362
2363         ## @addtogroup l4_decompose_d
2364         ## @{
2365
2366         ## Deprecated method
2367         #  It works like SubShapeAllSortedCentres, but wrongly
2368         #  defines centres of faces, shells and solids.
2369         def SubShapeAllSorted(self, aShape, aType):
2370             ListObj = self.ShapesOp.MakeExplode(aShape, aType, True)
2371             RaiseIfFailed("MakeExplode", self.ShapesOp)
2372             return ListObj
2373
2374         ## Deprecated method
2375         #  It works like SubShapeAllSortedCentresIDs, but wrongly
2376         #  defines centres of faces, shells and solids.
2377         def SubShapeAllSortedIDs(self, aShape, aType):
2378             ListIDs = self.ShapesOp.SubShapeAllIDs(aShape, aType, True)
2379             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
2380             return ListIDs
2381
2382         ## Deprecated method
2383         #  It works like SubShapeSortedCentres, but has a bug
2384         #  (wrongly defines centres of faces, shells and solids).
2385         def SubShapeSorted(self, aShape, aType, ListOfInd):
2386             ListOfIDs = []
2387             AllShapeIDsList = self.SubShapeAllSortedIDs(aShape, aType)
2388             for ind in ListOfInd:
2389                 ListOfIDs.append(AllShapeIDsList[ind - 1])
2390             anObj = self.GetSubShape(aShape, ListOfIDs)
2391             return anObj
2392
2393         # end of l4_decompose_d
2394         ## @}
2395
2396         ## @addtogroup l3_healing
2397         ## @{
2398
2399         ## Apply a sequence of Shape Healing operators to the given object.
2400         #  @param theShape Shape to be processed.
2401         #  @param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2402         #  @param theParameters List of names of parameters
2403         #                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2404         #  @param theValues List of values of parameters, in the same order
2405         #                    as parameters are listed in <VAR>theParameters</VAR> list.
2406         #  @return New GEOM_Object, containing processed shape.
2407         #
2408         #  @ref tui_shape_processing "Example"
2409         def ProcessShape(self, theShape, theOperators, theParameters, theValues):
2410             # Example: see GEOM_TestHealing.py
2411             theValues,Parameters = ParseList(theValues)
2412             anObj = self.HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
2413             # To avoid script failure in case of good argument shape
2414             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
2415                 return theShape
2416             RaiseIfFailed("ProcessShape", self.HealOp)
2417             for string in (theOperators + theParameters):
2418                 Parameters = ":" + Parameters
2419                 pass
2420             anObj.SetParameters(Parameters)
2421             return anObj
2422
2423         ## Remove faces from the given object (shape).
2424         #  @param theObject Shape to be processed.
2425         #  @param theFaces Indices of faces to be removed, if EMPTY then the method
2426         #                  removes ALL faces of the given object.
2427         #  @return New GEOM_Object, containing processed shape.
2428         #
2429         #  @ref tui_suppress_faces "Example"
2430         def SuppressFaces(self,theObject, theFaces):
2431             # Example: see GEOM_TestHealing.py
2432             anObj = self.HealOp.SuppressFaces(theObject, theFaces)
2433             RaiseIfFailed("SuppressFaces", self.HealOp)
2434             return anObj
2435
2436         ## Sewing of some shapes into single shape.
2437         #
2438         #  @ref tui_sewing "Example"
2439         def MakeSewing(self, ListShape, theTolerance):
2440             # Example: see GEOM_TestHealing.py
2441             comp = self.MakeCompound(ListShape)
2442             anObj = self.Sew(comp, theTolerance)
2443             return anObj
2444
2445         ## Sewing of the given object.
2446         #  @param theObject Shape to be processed.
2447         #  @param theTolerance Required tolerance value.
2448         #  @return New GEOM_Object, containing processed shape.
2449         def Sew(self, theObject, theTolerance):
2450             # Example: see MakeSewing() above
2451             theTolerance,Parameters = ParseParameters(theTolerance)
2452             anObj = self.HealOp.Sew(theObject, theTolerance)
2453             RaiseIfFailed("Sew", self.HealOp)
2454             anObj.SetParameters(Parameters)
2455             return anObj
2456
2457         ## Remove internal wires and edges from the given object (face).
2458         #  @param theObject Shape to be processed.
2459         #  @param theWires Indices of wires to be removed, if EMPTY then the method
2460         #                  removes ALL internal wires of the given object.
2461         #  @return New GEOM_Object, containing processed shape.
2462         #
2463         #  @ref tui_suppress_internal_wires "Example"
2464         def SuppressInternalWires(self,theObject, theWires):
2465             # Example: see GEOM_TestHealing.py
2466             anObj = self.HealOp.RemoveIntWires(theObject, theWires)
2467             RaiseIfFailed("RemoveIntWires", self.HealOp)
2468             return anObj
2469
2470         ## Remove internal closed contours (holes) from the given object.
2471         #  @param theObject Shape to be processed.
2472         #  @param theWires Indices of wires to be removed, if EMPTY then the method
2473         #                  removes ALL internal holes of the given object
2474         #  @return New GEOM_Object, containing processed shape.
2475         #
2476         #  @ref tui_suppress_holes "Example"
2477         def SuppressHoles(self,theObject, theWires):
2478             # Example: see GEOM_TestHealing.py
2479             anObj = self.HealOp.FillHoles(theObject, theWires)
2480             RaiseIfFailed("FillHoles", self.HealOp)
2481             return anObj
2482
2483         ## Close an open wire.
2484         #  @param theObject Shape to be processed.
2485         #  @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2486         #                  if [ ], then <VAR>theObject</VAR> itself is a wire.
2487         #  @param isCommonVertex If True  : closure by creation of a common vertex,
2488         #                        If False : closure by creation of an edge between ends.
2489         #  @return New GEOM_Object, containing processed shape.
2490         #
2491         #  @ref tui_close_contour "Example"
2492         def CloseContour(self,theObject, theWires, isCommonVertex):
2493             # Example: see GEOM_TestHealing.py
2494             anObj = self.HealOp.CloseContour(theObject, theWires, isCommonVertex)
2495             RaiseIfFailed("CloseContour", self.HealOp)
2496             return anObj
2497
2498         ## Addition of a point to a given edge object.
2499         #  @param theObject Shape to be processed.
2500         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
2501         #                      if -1, then theObject itself is the edge.
2502         #  @param theValue Value of parameter on edge or length parameter,
2503         #                  depending on \a isByParameter.
2504         #  @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2505         #                       if FALSE : \a theValue is treated as a length parameter [0..1]
2506         #  @return New GEOM_Object, containing processed shape.
2507         #
2508         #  @ref tui_add_point_on_edge "Example"
2509         def DivideEdge(self,theObject, theEdgeIndex, theValue, isByParameter):
2510             # Example: see GEOM_TestHealing.py
2511             theEdgeIndex,theValue,isByParameter,Parameters = ParseParameters(theEdgeIndex,theValue,isByParameter)
2512             anObj = self.HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
2513             RaiseIfFailed("DivideEdge", self.HealOp)
2514             anObj.SetParameters(Parameters)
2515             return anObj
2516
2517         ## Change orientation of the given object. Updates given shape.
2518         #  @param theObject Shape to be processed.
2519         #
2520         #  @ref swig_todo "Example"
2521         def ChangeOrientationShell(self,theObject):
2522             theObject = self.HealOp.ChangeOrientation(theObject)
2523             RaiseIfFailed("ChangeOrientation", self.HealOp)
2524             pass
2525
2526         ## Change orientation of the given object.
2527         #  @param theObject Shape to be processed.
2528         #  @return New GEOM_Object, containing processed shape.
2529         #
2530         #  @ref swig_todo "Example"
2531         def ChangeOrientationShellCopy(self, theObject):
2532             anObj = self.HealOp.ChangeOrientationCopy(theObject)
2533             RaiseIfFailed("ChangeOrientationCopy", self.HealOp)
2534             return anObj
2535
2536         ## Try to limit tolerance of the given object by value \a theTolerance.
2537         #  @param theObject Shape to be processed.
2538         #  @param theTolerance Required tolerance value.
2539         #  @return New GEOM_Object, containing processed shape.
2540         #
2541         #  @ref tui_limit_tolerance "Example"
2542         def LimitTolerance(self, theObject, theTolerance = 1e-07):
2543             anObj = self.HealOp.LimitTolerance(theObject, theTolerance)
2544             RaiseIfFailed("LimitTolerance", self.HealOp)
2545             return anObj
2546
2547         ## Get a list of wires (wrapped in GEOM_Object-s),
2548         #  that constitute a free boundary of the given shape.
2549         #  @param theObject Shape to get free boundary of.
2550         #  @return [status, theClosedWires, theOpenWires]
2551         #  status: FALSE, if an error(s) occured during the method execution.
2552         #  theClosedWires: Closed wires on the free boundary of the given shape.
2553         #  theOpenWires: Open wires on the free boundary of the given shape.
2554         #
2555         #  @ref tui_measurement_tools_page "Example"
2556         def GetFreeBoundary(self, theObject):
2557             # Example: see GEOM_TestHealing.py
2558             anObj = self.HealOp.GetFreeBoundary(theObject)
2559             RaiseIfFailed("GetFreeBoundary", self.HealOp)
2560             return anObj
2561
2562         ## Replace coincident faces in theShape by one face.
2563         #  @param theShape Initial shape.
2564         #  @param theTolerance Maximum distance between faces, which can be considered as coincident.
2565         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
2566         #                         otherwise all initial shapes.
2567         #  @return New GEOM_Object, containing a copy of theShape without coincident faces.
2568         #
2569         #  @ref tui_glue_faces "Example"
2570         def MakeGlueFaces(self, theShape, theTolerance, doKeepNonSolids=True):
2571             # Example: see GEOM_Spanner.py
2572             theTolerance,Parameters = ParseParameters(theTolerance)
2573             anObj = self.ShapesOp.MakeGlueFaces(theShape, theTolerance, doKeepNonSolids)
2574             if anObj is None:
2575                 raise RuntimeError, "MakeGlueFaces : " + self.ShapesOp.GetErrorCode()
2576             anObj.SetParameters(Parameters)
2577             return anObj
2578
2579         ## Find coincident faces in theShape for possible gluing.
2580         #  @param theShape Initial shape.
2581         #  @param theTolerance Maximum distance between faces,
2582         #                      which can be considered as coincident.
2583         #  @return ListOfGO.
2584         #
2585         #  @ref tui_glue_faces "Example"
2586         def GetGlueFaces(self, theShape, theTolerance):
2587             anObj = self.ShapesOp.GetGlueFaces(theShape, theTolerance)
2588             RaiseIfFailed("GetGlueFaces", self.ShapesOp)
2589             return anObj
2590
2591         ## Replace coincident faces in theShape by one face
2592         #  in compliance with given list of faces
2593         #  @param theShape Initial shape.
2594         #  @param theTolerance Maximum distance between faces,
2595         #                      which can be considered as coincident.
2596         #  @param theFaces List of faces for gluing.
2597         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
2598         #                         otherwise all initial shapes.
2599         #  @param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
2600         #                        will be glued, otherwise only the edges,
2601         #                        belonging to <VAR>theFaces</VAR>.
2602         #  @return New GEOM_Object, containing a copy of theShape
2603         #          without some faces.
2604         #
2605         #  @ref tui_glue_faces "Example"
2606         def MakeGlueFacesByList(self, theShape, theTolerance, theFaces,
2607                                 doKeepNonSolids=True, doGlueAllEdges=True):
2608             anObj = self.ShapesOp.MakeGlueFacesByList(theShape, theTolerance, theFaces,
2609                                                       doKeepNonSolids, doGlueAllEdges)
2610             if anObj is None:
2611                 raise RuntimeError, "MakeGlueFacesByList : " + self.ShapesOp.GetErrorCode()
2612             return anObj
2613
2614         ## Replace coincident edges in theShape by one edge.
2615         #  @param theShape Initial shape.
2616         #  @param theTolerance Maximum distance between edges, which can be considered as coincident.
2617         #  @return New GEOM_Object, containing a copy of theShape without coincident edges.
2618         #
2619         #  @ref tui_glue_edges "Example"
2620         def MakeGlueEdges(self, theShape, theTolerance):
2621             theTolerance,Parameters = ParseParameters(theTolerance)
2622             anObj = self.ShapesOp.MakeGlueEdges(theShape, theTolerance)
2623             if anObj is None:
2624                 raise RuntimeError, "MakeGlueEdges : " + self.ShapesOp.GetErrorCode()
2625             anObj.SetParameters(Parameters)
2626             return anObj
2627
2628         ## Find coincident edges in theShape for possible gluing.
2629         #  @param theShape Initial shape.
2630         #  @param theTolerance Maximum distance between edges,
2631         #                      which can be considered as coincident.
2632         #  @return ListOfGO.
2633         #
2634         #  @ref tui_glue_edges "Example"
2635         def GetGlueEdges(self, theShape, theTolerance):
2636             anObj = self.ShapesOp.GetGlueEdges(theShape, theTolerance)
2637             RaiseIfFailed("GetGlueEdges", self.ShapesOp)
2638             return anObj
2639
2640         ## Replace coincident edges in theShape by one edge
2641         #  in compliance with given list of edges
2642         #  @param theShape Initial shape.
2643         #  @param theTolerance Maximum distance between edges,
2644         #                      which can be considered as coincident.
2645         #  @param theFaces List of edges for gluing.
2646         #  @return New GEOM_Object, containing a copy of theShape
2647         #          without some edges.
2648         #
2649         #  @ref tui_glue_edges "Example"
2650         def MakeGlueEdgesByList(self, theShape, theTolerance, theEdges):
2651             anObj = self.ShapesOp.MakeGlueEdgesByList(theShape, theTolerance, theEdges)
2652             if anObj is None:
2653                 raise RuntimeError, "MakeGlueEdgesByList : " + self.ShapesOp.GetErrorCode()
2654             return anObj
2655
2656         # end of l3_healing
2657         ## @}
2658
2659         ## @addtogroup l3_boolean Boolean Operations
2660         ## @{
2661
2662         # -----------------------------------------------------------------------------
2663         # Boolean (Common, Cut, Fuse, Section)
2664         # -----------------------------------------------------------------------------
2665
2666         ## Perform one of boolean operations on two given shapes.
2667         #  @param theShape1 First argument for boolean operation.
2668         #  @param theShape2 Second argument for boolean operation.
2669         #  @param theOperation Indicates the operation to be done:
2670         #                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2671         #  @return New GEOM_Object, containing the result shape.
2672         #
2673         #  @ref tui_fuse "Example"
2674         def MakeBoolean(self,theShape1, theShape2, theOperation):
2675             # Example: see GEOM_TestAll.py
2676             anObj = self.BoolOp.MakeBoolean(theShape1, theShape2, theOperation)
2677             RaiseIfFailed("MakeBoolean", self.BoolOp)
2678             return anObj
2679
2680         ## Shortcut to MakeBoolean(s1, s2, 1)
2681         #
2682         #  @ref tui_common "Example 1"
2683         #  \n @ref swig_MakeCommon "Example 2"
2684         def MakeCommon(self, s1, s2):
2685             # Example: see GEOM_TestOthers.py
2686             return self.MakeBoolean(s1, s2, 1)
2687
2688         ## Shortcut to MakeBoolean(s1, s2, 2)
2689         #
2690         #  @ref tui_cut "Example 1"
2691         #  \n @ref swig_MakeCommon "Example 2"
2692         def MakeCut(self, s1, s2):
2693             # Example: see GEOM_TestOthers.py
2694             return self.MakeBoolean(s1, s2, 2)
2695
2696         ## Shortcut to MakeBoolean(s1, s2, 3)
2697         #
2698         #  @ref tui_fuse "Example 1"
2699         #  \n @ref swig_MakeCommon "Example 2"
2700         def MakeFuse(self, s1, s2):
2701             # Example: see GEOM_TestOthers.py
2702             return self.MakeBoolean(s1, s2, 3)
2703
2704         ## Shortcut to MakeBoolean(s1, s2, 4)
2705         #
2706         #  @ref tui_section "Example 1"
2707         #  \n @ref swig_MakeCommon "Example 2"
2708         def MakeSection(self, s1, s2):
2709             # Example: see GEOM_TestOthers.py
2710             return self.MakeBoolean(s1, s2, 4)
2711
2712         # end of l3_boolean
2713         ## @}
2714
2715         ## @addtogroup l3_basic_op
2716         ## @{
2717
2718         ## Perform partition operation.
2719         #  @param ListShapes Shapes to be intersected.
2720         #  @param ListTools Shapes to intersect theShapes.
2721         #  !!!NOTE: Each compound from ListShapes and ListTools will be exploded
2722         #           in order to avoid possible intersection between shapes from
2723         #           this compound.
2724         #  @param Limit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2725         #         If this parameter is set to -1 ("Auto"), most appropriate shape limit
2726         #         type will be detected automatically.
2727         #  @param KeepNonlimitShapes: if this parameter == 0, then only shapes of
2728         #                             target type (equal to Limit) are kept in the result,
2729         #                             else standalone shapes of lower dimension
2730         #                             are kept also (if they exist).
2731         #
2732         #  After implementation new version of PartitionAlgo (October 2006)
2733         #  other parameters are ignored by current functionality. They are kept
2734         #  in this function only for support old versions.
2735         #  Ignored parameters:
2736         #      @param ListKeepInside Shapes, outside which the results will be deleted.
2737         #         Each shape from theKeepInside must belong to theShapes also.
2738         #      @param ListRemoveInside Shapes, inside which the results will be deleted.
2739         #         Each shape from theRemoveInside must belong to theShapes also.
2740         #      @param RemoveWebs If TRUE, perform Glue 3D algorithm.
2741         #      @param ListMaterials Material indices for each shape. Make sence,
2742         #         only if theRemoveWebs is TRUE.
2743         #
2744         #  @return New GEOM_Object, containing the result shapes.
2745         #
2746         #  @ref tui_partition "Example"
2747         def MakePartition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
2748                           Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
2749                           KeepNonlimitShapes=0):
2750             # Example: see GEOM_TestAll.py
2751             if Limit == ShapeType["AUTO"]:
2752                 # automatic detection of the most appropriate shape limit type
2753                 lim = GEOM.SHAPE
2754                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
2755                 Limit = EnumToLong(lim)
2756                 pass
2757             anObj = self.BoolOp.MakePartition(ListShapes, ListTools,
2758                                               ListKeepInside, ListRemoveInside,
2759                                               Limit, RemoveWebs, ListMaterials,
2760                                               KeepNonlimitShapes);
2761             RaiseIfFailed("MakePartition", self.BoolOp)
2762             return anObj
2763
2764         ## Perform partition operation.
2765         #  This method may be useful if it is needed to make a partition for
2766         #  compound contains nonintersected shapes. Performance will be better
2767         #  since intersection between shapes from compound is not performed.
2768         #
2769         #  Description of all parameters as in previous method MakePartition()
2770         #
2771         #  !!!NOTE: Passed compounds (via ListShapes or via ListTools)
2772         #           have to consist of nonintersecting shapes.
2773         #
2774         #  @return New GEOM_Object, containing the result shapes.
2775         #
2776         #  @ref swig_todo "Example"
2777         def MakePartitionNonSelfIntersectedShape(self, ListShapes, ListTools=[],
2778                                                  ListKeepInside=[], ListRemoveInside=[],
2779                                                  Limit=ShapeType["AUTO"], RemoveWebs=0,
2780                                                  ListMaterials=[], KeepNonlimitShapes=0):
2781             if Limit == ShapeType["AUTO"]:
2782                 # automatic detection of the most appropriate shape limit type
2783                 lim = GEOM.SHAPE
2784                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
2785                 Limit = EnumToLong(lim)
2786                 pass
2787             anObj = self.BoolOp.MakePartitionNonSelfIntersectedShape(ListShapes, ListTools,
2788                                                                      ListKeepInside, ListRemoveInside,
2789                                                                      Limit, RemoveWebs, ListMaterials,
2790                                                                      KeepNonlimitShapes);
2791             RaiseIfFailed("MakePartitionNonSelfIntersectedShape", self.BoolOp)
2792             return anObj
2793
2794         ## Shortcut to MakePartition()
2795         #
2796         #  @ref tui_partition "Example 1"
2797         #  \n @ref swig_Partition "Example 2"
2798         def Partition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
2799                       Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
2800                       KeepNonlimitShapes=0):
2801             # Example: see GEOM_TestOthers.py
2802             anObj = self.MakePartition(ListShapes, ListTools,
2803                                        ListKeepInside, ListRemoveInside,
2804                                        Limit, RemoveWebs, ListMaterials,
2805                                        KeepNonlimitShapes);
2806             return anObj
2807
2808         ## Perform partition of the Shape with the Plane
2809         #  @param theShape Shape to be intersected.
2810         #  @param thePlane Tool shape, to intersect theShape.
2811         #  @return New GEOM_Object, containing the result shape.
2812         #
2813         #  @ref tui_partition "Example"
2814         def MakeHalfPartition(self,theShape, thePlane):
2815             # Example: see GEOM_TestAll.py
2816             anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)
2817             RaiseIfFailed("MakeHalfPartition", self.BoolOp)
2818             return anObj
2819
2820         # end of l3_basic_op
2821         ## @}
2822
2823         ## @addtogroup l3_transform
2824         ## @{
2825
2826         ## Translate the given object along the vector, specified
2827         #  by its end points, creating its copy before the translation.
2828         #  @param theObject The object to be translated.
2829         #  @param thePoint1 Start point of translation vector.
2830         #  @param thePoint2 End point of translation vector.
2831         #  @return New GEOM_Object, containing the translated object.
2832         #
2833         #  @ref tui_translation "Example 1"
2834         #  \n @ref swig_MakeTranslationTwoPoints "Example 2"
2835         def MakeTranslationTwoPoints(self,theObject, thePoint1, thePoint2):
2836             # Example: see GEOM_TestAll.py
2837             anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
2838             RaiseIfFailed("TranslateTwoPointsCopy", self.TrsfOp)
2839             return anObj
2840
2841         ## Translate the given object along the vector, specified by its components.
2842         #  @param theObject The object to be translated.
2843         #  @param theDX,theDY,theDZ Components of translation vector.
2844         #  @return Translated GEOM_Object.
2845         #
2846         #  @ref tui_translation "Example"
2847         def TranslateDXDYDZ(self,theObject, theDX, theDY, theDZ):
2848             # Example: see GEOM_TestAll.py
2849             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
2850             anObj = self.TrsfOp.TranslateDXDYDZ(theObject, theDX, theDY, theDZ)
2851             anObj.SetParameters(Parameters)
2852             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
2853             return anObj
2854
2855         ## Translate the given object along the vector, specified
2856         #  by its components, creating its copy before the translation.
2857         #  @param theObject The object to be translated.
2858         #  @param theDX,theDY,theDZ Components of translation vector.
2859         #  @return New GEOM_Object, containing the translated object.
2860         #
2861         #  @ref tui_translation "Example"
2862         def MakeTranslation(self,theObject, theDX, theDY, theDZ):
2863             # Example: see GEOM_TestAll.py
2864             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
2865             anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
2866             anObj.SetParameters(Parameters)
2867             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
2868             return anObj
2869
2870         ## Translate the given object along the given vector,
2871         #  creating its copy before the translation.
2872         #  @param theObject The object to be translated.
2873         #  @param theVector The translation vector.
2874         #  @return New GEOM_Object, containing the translated object.
2875         #
2876         #  @ref tui_translation "Example"
2877         def MakeTranslationVector(self,theObject, theVector):
2878             # Example: see GEOM_TestAll.py
2879             anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
2880             RaiseIfFailed("TranslateVectorCopy", self.TrsfOp)
2881             return anObj
2882
2883         ## Translate the given object along the given vector on given distance.
2884         #  @param theObject The object to be translated.
2885         #  @param theVector The translation vector.
2886         #  @param theDistance The translation distance.
2887         #  @param theCopy Flag used to translate object itself or create a copy.
2888         #  @return Translated GEOM_Object.
2889         #
2890         #  @ref tui_translation "Example"
2891         def TranslateVectorDistance(self, theObject, theVector, theDistance, theCopy):
2892             # Example: see GEOM_TestAll.py
2893             theDistance,Parameters = ParseParameters(theDistance)
2894             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, theCopy)
2895             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
2896             anObj.SetParameters(Parameters)
2897             return anObj
2898
2899         ## Translate the given object along the given vector on given distance,
2900         #  creating its copy before the translation.
2901         #  @param theObject The object to be translated.
2902         #  @param theVector The translation vector.
2903         #  @param theDistance The translation distance.
2904         #  @return New GEOM_Object, containing the translated object.
2905         #
2906         #  @ref tui_translation "Example"
2907         def MakeTranslationVectorDistance(self, theObject, theVector, theDistance):
2908             # Example: see GEOM_TestAll.py
2909             theDistance,Parameters = ParseParameters(theDistance)
2910             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, 1)
2911             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
2912             anObj.SetParameters(Parameters)
2913             return anObj
2914
2915         ## Rotate the given object around the given axis on the given angle.
2916         #  @param theObject The object to be rotated.
2917         #  @param theAxis Rotation axis.
2918         #  @param theAngle Rotation angle in radians.
2919         #  @return Rotated GEOM_Object.
2920         #
2921         #  @ref tui_rotation "Example"
2922         def Rotate(self,theObject, theAxis, theAngle):
2923             # Example: see GEOM_TestAll.py
2924             flag = False
2925             if isinstance(theAngle,str):
2926                 flag = True
2927             theAngle, Parameters = ParseParameters(theAngle)
2928             if flag:
2929                 theAngle = theAngle*math.pi/180.0
2930             anObj = self.TrsfOp.Rotate(theObject, theAxis, theAngle)
2931             RaiseIfFailed("RotateCopy", self.TrsfOp)
2932             anObj.SetParameters(Parameters)
2933             return anObj
2934
2935         ## Rotate the given object around the given axis
2936         #  on the given angle, creating its copy before the rotatation.
2937         #  @param theObject The object to be rotated.
2938         #  @param theAxis Rotation axis.
2939         #  @param theAngle Rotation angle in radians.
2940         #  @return New GEOM_Object, containing the rotated object.
2941         #
2942         #  @ref tui_rotation "Example"
2943         def MakeRotation(self,theObject, theAxis, theAngle):
2944             # Example: see GEOM_TestAll.py
2945             flag = False
2946             if isinstance(theAngle,str):
2947                 flag = True
2948             theAngle, Parameters = ParseParameters(theAngle)
2949             if flag:
2950                 theAngle = theAngle*math.pi/180.0
2951             anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
2952             RaiseIfFailed("RotateCopy", self.TrsfOp)
2953             anObj.SetParameters(Parameters)
2954             return anObj
2955
2956         ## Rotate given object around vector perpendicular to plane
2957         #  containing three points, creating its copy before the rotatation.
2958         #  @param theObject The object to be rotated.
2959         #  @param theCentPoint central point - the axis is the vector perpendicular to the plane
2960         #  containing the three points.
2961         #  @param thePoint1,thePoint2 - in a perpendicular plane of the axis.
2962         #  @return New GEOM_Object, containing the rotated object.
2963         #
2964         #  @ref tui_rotation "Example"
2965         def MakeRotationThreePoints(self,theObject, theCentPoint, thePoint1, thePoint2):
2966             # Example: see GEOM_TestAll.py
2967             anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
2968             RaiseIfFailed("RotateThreePointsCopy", self.TrsfOp)
2969             return anObj
2970
2971         ## Scale the given object by the factor, creating its copy before the scaling.
2972         #  @param theObject The object to be scaled.
2973         #  @param thePoint Center point for scaling.
2974         #                  Passing None for it means scaling relatively the origin of global CS.
2975         #  @param theFactor Scaling factor value.
2976         #  @return New GEOM_Object, containing the scaled shape.
2977         #
2978         #  @ref tui_scale "Example"
2979         def MakeScaleTransform(self, theObject, thePoint, theFactor):
2980             # Example: see GEOM_TestAll.py
2981             theFactor, Parameters = ParseParameters(theFactor)
2982             anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
2983             RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
2984             anObj.SetParameters(Parameters)
2985             return anObj
2986
2987         ## Scale the given object by different factors along coordinate axes,
2988         #  creating its copy before the scaling.
2989         #  @param theObject The object to be scaled.
2990         #  @param thePoint Center point for scaling.
2991         #                  Passing None for it means scaling relatively the origin of global CS.
2992         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
2993         #  @return New GEOM_Object, containing the scaled shape.
2994         #
2995         #  @ref swig_scale "Example"
2996         def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ):
2997             # Example: see GEOM_TestAll.py
2998             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
2999             anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
3000                                                         theFactorX, theFactorY, theFactorZ)
3001             RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
3002             anObj.SetParameters(Parameters)
3003             return anObj
3004
3005         ## Create an object, symmetrical
3006         #  to the given one relatively the given plane.
3007         #  @param theObject The object to be mirrored.
3008         #  @param thePlane Plane of symmetry.
3009         #  @return New GEOM_Object, containing the mirrored shape.
3010         #
3011         #  @ref tui_mirror "Example"
3012         def MakeMirrorByPlane(self,theObject, thePlane):
3013             # Example: see GEOM_TestAll.py
3014             anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
3015             RaiseIfFailed("MirrorPlaneCopy", self.TrsfOp)
3016             return anObj
3017
3018         ## Create an object, symmetrical
3019         #  to the given one relatively the given axis.
3020         #  @param theObject The object to be mirrored.
3021         #  @param theAxis Axis of symmetry.
3022         #  @return New GEOM_Object, containing the mirrored shape.
3023         #
3024         #  @ref tui_mirror "Example"
3025         def MakeMirrorByAxis(self,theObject, theAxis):
3026             # Example: see GEOM_TestAll.py
3027             anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
3028             RaiseIfFailed("MirrorAxisCopy", self.TrsfOp)
3029             return anObj
3030
3031         ## Create an object, symmetrical
3032         #  to the given one relatively the given point.
3033         #  @param theObject The object to be mirrored.
3034         #  @param thePoint Point of symmetry.
3035         #  @return New GEOM_Object, containing the mirrored shape.
3036         #
3037         #  @ref tui_mirror "Example"
3038         def MakeMirrorByPoint(self,theObject, thePoint):
3039             # Example: see GEOM_TestAll.py
3040             anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
3041             RaiseIfFailed("MirrorPointCopy", self.TrsfOp)
3042             return anObj
3043
3044         ## Modify the Location of the given object by LCS,
3045         #  creating its copy before the setting.
3046         #  @param theObject The object to be displaced.
3047         #  @param theStartLCS Coordinate system to perform displacement from it.
3048         #                     If \a theStartLCS is NULL, displacement
3049         #                     will be performed from global CS.
3050         #                     If \a theObject itself is used as \a theStartLCS,
3051         #                     its location will be changed to \a theEndLCS.
3052         #  @param theEndLCS Coordinate system to perform displacement to it.
3053         #  @return New GEOM_Object, containing the displaced shape.
3054         #
3055         #  @ref tui_modify_location "Example"
3056         def MakePosition(self,theObject, theStartLCS, theEndLCS):
3057             # Example: see GEOM_TestAll.py
3058             anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
3059             RaiseIfFailed("PositionShapeCopy", self.TrsfOp)
3060             return anObj
3061
3062         ## Modify the Location of the given object by Path,
3063         #  @param  theObject The object to be displaced.
3064         #  @param  thePath Wire or Edge along that the object will be translated.
3065         #  @param  theDistance progress of Path (0 = start location, 1 = end of path location).
3066         #  @param  theCopy is to create a copy objects if true.
3067         #  @param  theReverse - 0 for usual direction, 1 to reverse path direction.
3068         #  @return New GEOM_Object, containing the displaced shape.
3069         #
3070         #  @ref tui_modify_location "Example"
3071         def PositionAlongPath(self,theObject, thePath, theDistance, theCopy, theReverse):
3072             # Example: see GEOM_TestAll.py
3073             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, theCopy, theReverse)
3074             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
3075             return anObj
3076
3077         ## Create new object as offset of the given one.
3078         #  @param theObject The base object for the offset.
3079         #  @param theOffset Offset value.
3080         #  @return New GEOM_Object, containing the offset object.
3081         #
3082         #  @ref tui_offset "Example"
3083         def MakeOffset(self,theObject, theOffset):
3084             # Example: see GEOM_TestAll.py
3085             theOffset, Parameters = ParseParameters(theOffset)
3086             anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
3087             RaiseIfFailed("OffsetShapeCopy", self.TrsfOp)
3088             anObj.SetParameters(Parameters)
3089             return anObj
3090
3091         ## Create new object as projection of the given one on a 2D surface.
3092         #  @param theSource The source object for the projection. It can be a point, edge or wire.
3093         #  @param theTarget The target object. It can be planar or cylindrical face.
3094         #  @return New GEOM_Object, containing the projection.
3095         #
3096         #  @ref tui_projection "Example"
3097         def MakeProjection(self, theSource, theTarget):
3098             # Example: see GEOM_TestAll.py
3099             anObj = self.TrsfOp.ProjectShapeCopy(theSource, theTarget)
3100             RaiseIfFailed("ProjectShapeCopy", self.TrsfOp)
3101             return anObj
3102
3103         # -----------------------------------------------------------------------------
3104         # Patterns
3105         # -----------------------------------------------------------------------------
3106
3107         ## Translate the given object along the given vector a given number times
3108         #  @param theObject The object to be translated.
3109         #  @param theVector Direction of the translation.
3110         #  @param theStep Distance to translate on.
3111         #  @param theNbTimes Quantity of translations to be done.
3112         #  @return New GEOM_Object, containing compound of all
3113         #          the shapes, obtained after each translation.
3114         #
3115         #  @ref tui_multi_translation "Example"
3116         def MakeMultiTranslation1D(self,theObject, theVector, theStep, theNbTimes):
3117             # Example: see GEOM_TestAll.py
3118             theStep, theNbTimes, Parameters = ParseParameters(theStep, theNbTimes)
3119             anObj = self.TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
3120             RaiseIfFailed("MultiTranslate1D", self.TrsfOp)
3121             anObj.SetParameters(Parameters)
3122             return anObj
3123
3124         ## Conseqently apply two specified translations to theObject specified number of times.
3125         #  @param theObject The object to be translated.
3126         #  @param theVector1 Direction of the first translation.
3127         #  @param theStep1 Step of the first translation.
3128         #  @param theNbTimes1 Quantity of translations to be done along theVector1.
3129         #  @param theVector2 Direction of the second translation.
3130         #  @param theStep2 Step of the second translation.
3131         #  @param theNbTimes2 Quantity of translations to be done along theVector2.
3132         #  @return New GEOM_Object, containing compound of all
3133         #          the shapes, obtained after each translation.
3134         #
3135         #  @ref tui_multi_translation "Example"
3136         def MakeMultiTranslation2D(self,theObject, theVector1, theStep1, theNbTimes1,
3137                                    theVector2, theStep2, theNbTimes2):
3138             # Example: see GEOM_TestAll.py
3139             theStep1,theNbTimes1,theStep2,theNbTimes2, Parameters = ParseParameters(theStep1,theNbTimes1,theStep2,theNbTimes2)
3140             anObj = self.TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
3141                                                  theVector2, theStep2, theNbTimes2)
3142             RaiseIfFailed("MultiTranslate2D", self.TrsfOp)
3143             anObj.SetParameters(Parameters)
3144             return anObj
3145
3146         ## Rotate the given object around the given axis a given number times.
3147         #  Rotation angle will be 2*PI/theNbTimes.
3148         #  @param theObject The object to be rotated.
3149         #  @param theAxis The rotation axis.
3150         #  @param theNbTimes Quantity of rotations to be done.
3151         #  @return New GEOM_Object, containing compound of all the
3152         #          shapes, obtained after each rotation.
3153         #
3154         #  @ref tui_multi_rotation "Example"
3155         def MultiRotate1D(self,theObject, theAxis, theNbTimes):
3156             # Example: see GEOM_TestAll.py
3157             theAxis, theNbTimes, Parameters = ParseParameters(theAxis, theNbTimes)
3158             anObj = self.TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
3159             RaiseIfFailed("MultiRotate1D", self.TrsfOp)
3160             anObj.SetParameters(Parameters)
3161             return anObj
3162
3163         ## Rotate the given object around the
3164         #  given axis on the given angle a given number
3165         #  times and multi-translate each rotation result.
3166         #  Translation direction passes through center of gravity
3167         #  of rotated shape and its projection on the rotation axis.
3168         #  @param theObject The object to be rotated.
3169         #  @param theAxis Rotation axis.
3170         #  @param theAngle Rotation angle in graduces.
3171         #  @param theNbTimes1 Quantity of rotations to be done.
3172         #  @param theStep Translation distance.
3173         #  @param theNbTimes2 Quantity of translations to be done.
3174         #  @return New GEOM_Object, containing compound of all the
3175         #          shapes, obtained after each transformation.
3176         #
3177         #  @ref tui_multi_rotation "Example"
3178         def MultiRotate2D(self,theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2):
3179             # Example: see GEOM_TestAll.py
3180             theAngle, theNbTimes1, theStep, theNbTimes2, Parameters = ParseParameters(theAngle, theNbTimes1, theStep, theNbTimes2)
3181             anObj = self.TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
3182             RaiseIfFailed("MultiRotate2D", self.TrsfOp)
3183             anObj.SetParameters(Parameters)
3184             return anObj
3185
3186         ## The same, as MultiRotate1D(), but axis is given by direction and point
3187         #  @ref swig_MakeMultiRotation "Example"
3188         def MakeMultiRotation1D(self,aShape,aDir,aPoint,aNbTimes):
3189             # Example: see GEOM_TestOthers.py
3190             aVec = self.MakeLine(aPoint,aDir)
3191             anObj = self.MultiRotate1D(aShape,aVec,aNbTimes)
3192             return anObj
3193
3194         ## The same, as MultiRotate2D(), but axis is given by direction and point
3195         #  @ref swig_MakeMultiRotation "Example"
3196         def MakeMultiRotation2D(self,aShape,aDir,aPoint,anAngle,nbtimes1,aStep,nbtimes2):
3197             # Example: see GEOM_TestOthers.py
3198             aVec = self.MakeLine(aPoint,aDir)
3199             anObj = self.MultiRotate2D(aShape,aVec,anAngle,nbtimes1,aStep,nbtimes2)
3200             return anObj
3201
3202         # end of l3_transform
3203         ## @}
3204
3205         ## @addtogroup l3_local
3206         ## @{
3207
3208         ## Perform a fillet on all edges of the given shape.
3209         #  @param theShape Shape, to perform fillet on.
3210         #  @param theR Fillet radius.
3211         #  @return New GEOM_Object, containing the result shape.
3212         #
3213         #  @ref tui_fillet "Example 1"
3214         #  \n @ref swig_MakeFilletAll "Example 2"
3215         def MakeFilletAll(self,theShape, theR):
3216             # Example: see GEOM_TestOthers.py
3217             theR,Parameters = ParseParameters(theR)
3218             anObj = self.LocalOp.MakeFilletAll(theShape, theR)
3219             RaiseIfFailed("MakeFilletAll", self.LocalOp)
3220             anObj.SetParameters(Parameters)
3221             return anObj
3222
3223         ## Perform a fillet on the specified edges/faces of the given shape
3224         #  @param theShape Shape, to perform fillet on.
3225         #  @param theR Fillet radius.
3226         #  @param theShapeType Type of shapes in <VAR>theListShapes</VAR>.
3227         #  @param theListShapes Global indices of edges/faces to perform fillet on.
3228         #    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
3229         #  @return New GEOM_Object, containing the result shape.
3230         #
3231         #  @ref tui_fillet "Example"
3232         def MakeFillet(self,theShape, theR, theShapeType, theListShapes):
3233             # Example: see GEOM_TestAll.py
3234             theR,Parameters = ParseParameters(theR)
3235             anObj = None
3236             if theShapeType == ShapeType["EDGE"]:
3237                 anObj = self.LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
3238                 RaiseIfFailed("MakeFilletEdges", self.LocalOp)
3239             else:
3240                 anObj = self.LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
3241                 RaiseIfFailed("MakeFilletFaces", self.LocalOp)
3242             anObj.SetParameters(Parameters)
3243             return anObj
3244
3245         ## The same that MakeFillet but with two Fillet Radius R1 and R2
3246         def MakeFilletR1R2(self, theShape, theR1, theR2, theShapeType, theListShapes):
3247             theR1,theR2,Parameters = ParseParameters(theR1,theR2)
3248             anObj = None
3249             if theShapeType == ShapeType["EDGE"]:
3250                 anObj = self.LocalOp.MakeFilletEdgesR1R2(theShape, theR1, theR2, theListShapes)
3251                 RaiseIfFailed("MakeFilletEdgesR1R2", self.LocalOp)
3252             else:
3253                 anObj = self.LocalOp.MakeFilletFacesR1R2(theShape, theR1, theR2, theListShapes)
3254                 RaiseIfFailed("MakeFilletFacesR1R2", self.LocalOp)
3255             anObj.SetParameters(Parameters)
3256             return anObj
3257
3258         ## Perform a fillet on the specified edges of the given shape
3259         #  @param theShape - Wire Shape to perform fillet on.
3260         #  @param theR - Fillet radius.
3261         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
3262         #    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
3263         #    \note The list of vertices could be empty,
3264         #          in this case fillet will done done at all vertices in wire
3265         #  @return New GEOM_Object, containing the result shape.
3266         #
3267         #  @ref tui_fillet2d "Example"
3268         def MakeFillet1D(self,theShape, theR, theListOfVertexes):
3269             # Example: see GEOM_TestAll.py
3270             theR,Parameters = ParseParameters(theR)
3271             anObj = self.LocalOp.MakeFillet1D(theShape, theR, theListOfVertexes)
3272             RaiseIfFailed("MakeFillet1D", self.LocalOp)
3273             anObj.SetParameters(Parameters)
3274             return anObj
3275
3276         ## Perform a fillet on the specified edges/faces of the given shape
3277         #  @param theShape - Face Shape to perform fillet on.
3278         #  @param theR - Fillet radius.
3279         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
3280         #    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
3281         #  @return New GEOM_Object, containing the result shape.
3282         #
3283         #  @ref tui_fillet2d "Example"
3284         def MakeFillet2D(self,theShape, theR, theListOfVertexes):
3285             # Example: see GEOM_TestAll.py
3286             theR,Parameters = ParseParameters(theR)
3287             anObj = self.LocalOp.MakeFillet2D(theShape, theR, theListOfVertexes)
3288             RaiseIfFailed("MakeFillet2D", self.LocalOp)
3289             anObj.SetParameters(Parameters)
3290             return anObj
3291
3292         ## Perform a symmetric chamfer on all edges of the given shape.
3293         #  @param theShape Shape, to perform chamfer on.
3294         #  @param theD Chamfer size along each face.
3295         #  @return New GEOM_Object, containing the result shape.
3296         #
3297         #  @ref tui_chamfer "Example 1"
3298         #  \n @ref swig_MakeChamferAll "Example 2"
3299         def MakeChamferAll(self,theShape, theD):
3300             # Example: see GEOM_TestOthers.py
3301             theD,Parameters = ParseParameters(theD)
3302             anObj = self.LocalOp.MakeChamferAll(theShape, theD)
3303             RaiseIfFailed("MakeChamferAll", self.LocalOp)
3304             anObj.SetParameters(Parameters)
3305             return anObj
3306
3307         ## Perform a chamfer on edges, common to the specified faces,
3308         #  with distance D1 on the Face1
3309         #  @param theShape Shape, to perform chamfer on.
3310         #  @param theD1 Chamfer size along \a theFace1.
3311         #  @param theD2 Chamfer size along \a theFace2.
3312         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
3313         #    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
3314         #  @return New GEOM_Object, containing the result shape.
3315         #
3316         #  @ref tui_chamfer "Example"
3317         def MakeChamferEdge(self,theShape, theD1, theD2, theFace1, theFace2):
3318             # Example: see GEOM_TestAll.py
3319             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
3320             anObj = self.LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
3321             RaiseIfFailed("MakeChamferEdge", self.LocalOp)
3322             anObj.SetParameters(Parameters)
3323             return anObj
3324
3325         ## The Same that MakeChamferEdge but with params theD is chamfer length and
3326         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
3327         def MakeChamferEdgeAD(self, theShape, theD, theAngle, theFace1, theFace2):
3328             flag = False
3329             if isinstance(theAngle,str):
3330                 flag = True
3331             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
3332             if flag:
3333                 theAngle = theAngle*math.pi/180.0
3334             anObj = self.LocalOp.MakeChamferEdgeAD(theShape, theD, theAngle, theFace1, theFace2)
3335             RaiseIfFailed("MakeChamferEdgeAD", self.LocalOp)
3336             anObj.SetParameters(Parameters)
3337             return anObj
3338
3339         ## Perform a chamfer on all edges of the specified faces,
3340         #  with distance D1 on the first specified face (if several for one edge)
3341         #  @param theShape Shape, to perform chamfer on.
3342         #  @param theD1 Chamfer size along face from \a theFaces. If both faces,
3343         #               connected to the edge, are in \a theFaces, \a theD1
3344         #               will be get along face, which is nearer to \a theFaces beginning.
3345         #  @param theD2 Chamfer size along another of two faces, connected to the edge.
3346         #  @param theFaces Sequence of global indices of faces of \a theShape.
3347         #    \note Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
3348         #  @return New GEOM_Object, containing the result shape.
3349         #
3350         #  @ref tui_chamfer "Example"
3351         def MakeChamferFaces(self,theShape, theD1, theD2, theFaces):
3352             # Example: see GEOM_TestAll.py
3353             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
3354             anObj = self.LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
3355             RaiseIfFailed("MakeChamferFaces", self.LocalOp)
3356             anObj.SetParameters(Parameters)
3357             return anObj
3358
3359         ## The Same that MakeChamferFaces but with params theD is chamfer lenght and
3360         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
3361         #
3362         #  @ref swig_FilletChamfer "Example"
3363         def MakeChamferFacesAD(self, theShape, theD, theAngle, theFaces):
3364             flag = False
3365             if isinstance(theAngle,str):
3366                 flag = True
3367             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
3368             if flag:
3369                 theAngle = theAngle*math.pi/180.0
3370             anObj = self.LocalOp.MakeChamferFacesAD(theShape, theD, theAngle, theFaces)
3371             RaiseIfFailed("MakeChamferFacesAD", self.LocalOp)
3372             anObj.SetParameters(Parameters)
3373             return anObj
3374
3375         ## Perform a chamfer on edges,
3376         #  with distance D1 on the first specified face (if several for one edge)
3377         #  @param theShape Shape, to perform chamfer on.
3378         #  @param theD1,theD2 Chamfer size
3379         #  @param theEdges Sequence of edges of \a theShape.
3380         #  @return New GEOM_Object, containing the result shape.
3381         #
3382         #  @ref swig_FilletChamfer "Example"
3383         def MakeChamferEdges(self, theShape, theD1, theD2, theEdges):
3384             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
3385             anObj = self.LocalOp.MakeChamferEdges(theShape, theD1, theD2, theEdges)
3386             RaiseIfFailed("MakeChamferEdges", self.LocalOp)
3387             anObj.SetParameters(Parameters)
3388             return anObj
3389
3390         ## The Same that MakeChamferEdges but with params theD is chamfer lenght and
3391         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
3392         def MakeChamferEdgesAD(self, theShape, theD, theAngle, theEdges):
3393             flag = False
3394             if isinstance(theAngle,str):
3395                 flag = True
3396             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
3397             if flag:
3398                 theAngle = theAngle*math.pi/180.0
3399             anObj = self.LocalOp.MakeChamferEdgesAD(theShape, theD, theAngle, theEdges)
3400             RaiseIfFailed("MakeChamferEdgesAD", self.LocalOp)
3401             anObj.SetParameters(Parameters)
3402             return anObj
3403
3404         ## Shortcut to MakeChamferEdge() and MakeChamferFaces()
3405         #
3406         #  @ref swig_MakeChamfer "Example"
3407         def MakeChamfer(self,aShape,d1,d2,aShapeType,ListShape):
3408             # Example: see GEOM_TestOthers.py
3409             anObj = None
3410             if aShapeType == ShapeType["EDGE"]:
3411                 anObj = self.MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1])
3412             else:
3413                 anObj = self.MakeChamferFaces(aShape,d1,d2,ListShape)
3414             return anObj
3415
3416         # end of l3_local
3417         ## @}
3418
3419         ## @addtogroup l3_basic_op
3420         ## @{
3421
3422         ## Perform an Archimde operation on the given shape with given parameters.
3423         #  The object presenting the resulting face is returned.
3424         #  @param theShape Shape to be put in water.
3425         #  @param theWeight Weight og the shape.
3426         #  @param theWaterDensity Density of the water.
3427         #  @param theMeshDeflection Deflection of the mesh, using to compute the section.
3428         #  @return New GEOM_Object, containing a section of \a theShape
3429         #          by a plane, corresponding to water level.
3430         #
3431         #  @ref tui_archimede "Example"
3432         def Archimede(self,theShape, theWeight, theWaterDensity, theMeshDeflection):
3433             # Example: see GEOM_TestAll.py
3434             theWeight,theWaterDensity,theMeshDeflection,Parameters = ParseParameters(
3435               theWeight,theWaterDensity,theMeshDeflection)
3436             anObj = self.LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
3437             RaiseIfFailed("MakeArchimede", self.LocalOp)
3438             anObj.SetParameters(Parameters)
3439             return anObj
3440
3441         # end of l3_basic_op
3442         ## @}
3443
3444         ## @addtogroup l2_measure
3445         ## @{
3446
3447         ## Get point coordinates
3448         #  @return [x, y, z]
3449         #
3450         #  @ref tui_measurement_tools_page "Example"
3451         def PointCoordinates(self,Point):
3452             # Example: see GEOM_TestMeasures.py
3453             aTuple = self.MeasuOp.PointCoordinates(Point)
3454             RaiseIfFailed("PointCoordinates", self.MeasuOp)
3455             return aTuple
3456
3457         ## Get summarized length of all wires,
3458         #  area of surface and volume of the given shape.
3459         #  @param theShape Shape to define properties of.
3460         #  @return [theLength, theSurfArea, theVolume]
3461         #  theLength:   Summarized length of all wires of the given shape.
3462         #  theSurfArea: Area of surface of the given shape.
3463         #  theVolume:   Volume of the given shape.
3464         #
3465         #  @ref tui_measurement_tools_page "Example"
3466         def BasicProperties(self,theShape):
3467             # Example: see GEOM_TestMeasures.py
3468             aTuple = self.MeasuOp.GetBasicProperties(theShape)
3469             RaiseIfFailed("GetBasicProperties", self.MeasuOp)
3470             return aTuple
3471
3472         ## Get parameters of bounding box of the given shape
3473         #  @param theShape Shape to obtain bounding box of.
3474         #  @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
3475         #  Xmin,Xmax: Limits of shape along OX axis.
3476         #  Ymin,Ymax: Limits of shape along OY axis.
3477         #  Zmin,Zmax: Limits of shape along OZ axis.
3478         #
3479         #  @ref tui_measurement_tools_page "Example"
3480         def BoundingBox(self,theShape):
3481             # Example: see GEOM_TestMeasures.py
3482             aTuple = self.MeasuOp.GetBoundingBox(theShape)
3483             RaiseIfFailed("GetBoundingBox", self.MeasuOp)
3484             return aTuple
3485
3486         ## Get inertia matrix and moments of inertia of theShape.
3487         #  @param theShape Shape to calculate inertia of.
3488         #  @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
3489         #  I(1-3)(1-3): Components of the inertia matrix of the given shape.
3490         #  Ix,Iy,Iz:    Moments of inertia of the given shape.
3491         #
3492         #  @ref tui_measurement_tools_page "Example"
3493         def Inertia(self,theShape):
3494             # Example: see GEOM_TestMeasures.py
3495             aTuple = self.MeasuOp.GetInertia(theShape)
3496             RaiseIfFailed("GetInertia", self.MeasuOp)
3497             return aTuple
3498
3499         ## Get if coords are included in the shape (ST_IN or ST_ON)
3500         #  @param theShape Shape
3501         #  @param coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
3502         #  @param tolerance to be used (default is 1.0e-7)
3503         #  @return list_of_boolean = [res1, res2, ...]
3504         def AreCoordsInside(self, theShape, coords, tolerance=1.e-7):
3505             return self.MeasuOp.AreCoordsInside(theShape, coords, tolerance)
3506
3507         ## Get minimal distance between the given shapes.
3508         #  @param theShape1,theShape2 Shapes to find minimal distance between.
3509         #  @return Value of the minimal distance between the given shapes.
3510         #
3511         #  @ref tui_measurement_tools_page "Example"
3512         def MinDistance(self, theShape1, theShape2):
3513             # Example: see GEOM_TestMeasures.py
3514             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
3515             RaiseIfFailed("GetMinDistance", self.MeasuOp)
3516             return aTuple[0]
3517
3518         ## Get minimal distance between the given shapes.
3519         #  @param theShape1,theShape2 Shapes to find minimal distance between.
3520         #  @return Value of the minimal distance between the given shapes.
3521         #
3522         #  @ref swig_all_measure "Example"
3523         def MinDistanceComponents(self, theShape1, theShape2):
3524             # Example: see GEOM_TestMeasures.py
3525             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
3526             RaiseIfFailed("GetMinDistance", self.MeasuOp)
3527             aRes = [aTuple[0], aTuple[4] - aTuple[1], aTuple[5] - aTuple[2], aTuple[6] - aTuple[3]]
3528             return aRes
3529
3530         ## Get angle between the given shapes in degrees.
3531         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
3532         #  @return Value of the angle between the given shapes in degrees.
3533         #
3534         #  @ref tui_measurement_tools_page "Example"
3535         def GetAngle(self, theShape1, theShape2):
3536             # Example: see GEOM_TestMeasures.py
3537             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
3538             RaiseIfFailed("GetAngle", self.MeasuOp)
3539             return anAngle
3540         ## Get angle between the given shapes in radians.
3541         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
3542         #  @return Value of the angle between the given shapes in radians.
3543         #
3544         #  @ref tui_measurement_tools_page "Example"
3545         def GetAngleRadians(self, theShape1, theShape2):
3546             # Example: see GEOM_TestMeasures.py
3547             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)*math.pi/180.
3548             RaiseIfFailed("GetAngle", self.MeasuOp)
3549             return anAngle
3550
3551         ## @name Curve Curvature Measurement
3552         #  Methods for receiving radius of curvature of curves
3553         #  in the given point
3554         ## @{
3555
3556         ## Measure curvature of a curve at a point, set by parameter.
3557         #  @ref swig_todo "Example"
3558         def CurveCurvatureByParam(self, theCurve, theParam):
3559             # Example: see GEOM_TestMeasures.py
3560             aCurv = self.MeasuOp.CurveCurvatureByParam(theCurve,theParam)
3561             RaiseIfFailed("CurveCurvatureByParam", self.MeasuOp)
3562             return aCurv
3563
3564         ## @details
3565         #  @ref swig_todo "Example"
3566         def CurveCurvatureByPoint(self, theCurve, thePoint):
3567             aCurv = self.MeasuOp.CurveCurvatureByPoint(theCurve,thePoint)
3568             RaiseIfFailed("CurveCurvatureByPoint", self.MeasuOp)
3569             return aCurv
3570         ## @}
3571
3572         ## @name Surface Curvature Measurement
3573         #  Methods for receiving max and min radius of curvature of surfaces
3574         #  in the given point
3575         ## @{
3576
3577         ## @details
3578         ## @ref swig_todo "Example"
3579         def MaxSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
3580             # Example: see GEOM_TestMeasures.py
3581             aSurf = self.MeasuOp.MaxSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
3582             RaiseIfFailed("MaxSurfaceCurvatureByParam", self.MeasuOp)
3583             return aSurf
3584
3585         ## @details
3586         ## @ref swig_todo "Example"
3587         def MaxSurfaceCurvatureByPoint(self, theSurf, thePoint):
3588             aSurf = self.MeasuOp.MaxSurfaceCurvatureByPoint(theSurf,thePoint)
3589             RaiseIfFailed("MaxSurfaceCurvatureByPoint", self.MeasuOp)
3590             return aSurf
3591
3592         ## @details
3593         ## @ref swig_todo "Example"
3594         def MinSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
3595             aSurf = self.MeasuOp.MinSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
3596             RaiseIfFailed("MinSurfaceCurvatureByParam", self.MeasuOp)
3597             return aSurf
3598
3599         ## @details
3600         ## @ref swig_todo "Example"
3601         def MinSurfaceCurvatureByPoint(self, theSurf, thePoint):
3602             aSurf = self.MeasuOp.MinSurfaceCurvatureByPoint(theSurf,thePoint)
3603             RaiseIfFailed("MinSurfaceCurvatureByPoint", self.MeasuOp)
3604             return aSurf
3605         ## @}
3606
3607         ## Get min and max tolerances of sub-shapes of theShape
3608         #  @param theShape Shape, to get tolerances of.
3609         #  @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
3610         #  FaceMin,FaceMax: Min and max tolerances of the faces.
3611         #  EdgeMin,EdgeMax: Min and max tolerances of the edges.
3612         #  VertMin,VertMax: Min and max tolerances of the vertices.
3613         #
3614         #  @ref tui_measurement_tools_page "Example"
3615         def Tolerance(self,theShape):
3616             # Example: see GEOM_TestMeasures.py
3617             aTuple = self.MeasuOp.GetTolerance(theShape)
3618             RaiseIfFailed("GetTolerance", self.MeasuOp)
3619             return aTuple
3620
3621         ## Obtain description of the given shape (number of sub-shapes of each type)
3622         #  @param theShape Shape to be described.
3623         #  @return Description of the given shape.
3624         #
3625         #  @ref tui_measurement_tools_page "Example"
3626         def WhatIs(self,theShape):
3627             # Example: see GEOM_TestMeasures.py
3628             aDescr = self.MeasuOp.WhatIs(theShape)
3629             RaiseIfFailed("WhatIs", self.MeasuOp)
3630             return aDescr
3631
3632         ## Obtain quantity of shapes of the given type in \a theShape.
3633         #  If \a theShape is of type \a theType, it is also counted.
3634         #  @param theShape Shape to be described.
3635         #  @return Quantity of shapes of type \a theType in \a theShape.
3636         #
3637         #  @ref tui_measurement_tools_page "Example"
3638         def NbShapes (self, theShape, theType):
3639             # Example: see GEOM_TestMeasures.py
3640             listSh = self.SubShapeAllIDs(theShape, theType)
3641             Nb = len(listSh)
3642             t       = EnumToLong(theShape.GetShapeType())
3643             theType = EnumToLong(theType)
3644             if t == theType:
3645                 Nb = Nb + 1
3646                 pass
3647             return Nb
3648
3649         ## Obtain quantity of shapes of each type in \a theShape.
3650         #  The \a theShape is also counted.
3651         #  @param theShape Shape to be described.
3652         #  @return Dictionary of shape types with bound quantities of shapes.
3653         #
3654         #  @ref tui_measurement_tools_page "Example"
3655         def ShapeInfo (self, theShape):
3656             # Example: see GEOM_TestMeasures.py
3657             aDict = {}
3658             for typeSh in ShapeType:
3659                 if typeSh in ( "AUTO", "SHAPE" ): continue
3660                 listSh = self.SubShapeAllIDs(theShape, ShapeType[typeSh])
3661                 Nb = len(listSh)
3662                 if EnumToLong(theShape.GetShapeType()) == ShapeType[typeSh]:
3663                     Nb = Nb + 1
3664                     pass
3665                 aDict[typeSh] = Nb
3666                 pass
3667             return aDict
3668
3669         ## Get a point, situated at the centre of mass of theShape.
3670         #  @param theShape Shape to define centre of mass of.
3671         #  @return New GEOM_Object, containing the created point.
3672         #
3673         #  @ref tui_measurement_tools_page "Example"
3674         def MakeCDG(self,theShape):
3675             # Example: see GEOM_TestMeasures.py
3676             anObj = self.MeasuOp.GetCentreOfMass(theShape)
3677             RaiseIfFailed("GetCentreOfMass", self.MeasuOp)
3678             return anObj
3679
3680         ## Get a vertex subshape by index depended with orientation.
3681         #  @param theShape Shape to find subshape.
3682         #  @param theIndex Index to find vertex by this index.
3683         #  @return New GEOM_Object, containing the created vertex.
3684         #
3685         #  @ref tui_measurement_tools_page "Example"
3686         def GetVertexByIndex(self,theShape, theIndex):
3687             # Example: see GEOM_TestMeasures.py
3688             anObj = self.MeasuOp.GetVertexByIndex(theShape, theIndex)
3689             RaiseIfFailed("GetVertexByIndex", self.MeasuOp)
3690             return anObj
3691
3692         ## Get the first vertex of wire/edge depended orientation.
3693         #  @param theShape Shape to find first vertex.
3694         #  @return New GEOM_Object, containing the created vertex.
3695         #
3696         #  @ref tui_measurement_tools_page "Example"
3697         def GetFirstVertex(self,theShape):
3698             # Example: see GEOM_TestMeasures.py
3699             anObj = self.GetVertexByIndex(theShape, 0)
3700             RaiseIfFailed("GetFirstVertex", self.MeasuOp)
3701             return anObj
3702
3703         ## Get the last vertex of wire/edge depended orientation.
3704         #  @param theShape Shape to find last vertex.
3705         #  @return New GEOM_Object, containing the created vertex.
3706         #
3707         #  @ref tui_measurement_tools_page "Example"
3708         def GetLastVertex(self,theShape):
3709             # Example: see GEOM_TestMeasures.py
3710             nb_vert =  self.ShapesOp.NumberOfSubShapes(theShape, ShapeType["VERTEX"])
3711             anObj = self.GetVertexByIndex(theShape, (nb_vert-1))
3712             RaiseIfFailed("GetLastVertex", self.MeasuOp)
3713             return anObj
3714
3715         ## Get a normale to the given face. If the point is not given,
3716         #  the normale is calculated at the center of mass.
3717         #  @param theFace Face to define normale of.
3718         #  @param theOptionalPoint Point to compute the normale at.
3719         #  @return New GEOM_Object, containing the created vector.
3720         #
3721         #  @ref swig_todo "Example"
3722         def GetNormal(self, theFace, theOptionalPoint = None):
3723             # Example: see GEOM_TestMeasures.py
3724             anObj = self.MeasuOp.GetNormal(theFace, theOptionalPoint)
3725             RaiseIfFailed("GetNormal", self.MeasuOp)
3726             return anObj
3727
3728         ## Check a topology of the given shape.
3729         #  @param theShape Shape to check validity of.
3730         #  @param theIsCheckGeom If FALSE, only the shape's topology will be checked,
3731         #                        if TRUE, the shape's geometry will be checked also.
3732         #  @return TRUE, if the shape "seems to be valid".
3733         #  If theShape is invalid, prints a description of problem.
3734         #
3735         #  @ref tui_measurement_tools_page "Example"
3736         def CheckShape(self,theShape, theIsCheckGeom = 0):
3737             # Example: see GEOM_TestMeasures.py
3738             if theIsCheckGeom:
3739                 (IsValid, Status) = self.MeasuOp.CheckShapeWithGeometry(theShape)
3740                 RaiseIfFailed("CheckShapeWithGeometry", self.MeasuOp)
3741             else:
3742                 (IsValid, Status) = self.MeasuOp.CheckShape(theShape)
3743                 RaiseIfFailed("CheckShape", self.MeasuOp)
3744             if IsValid == 0:
3745                 print Status
3746             return IsValid
3747
3748         ## Get position (LCS) of theShape.
3749         #
3750         #  Origin of the LCS is situated at the shape's center of mass.
3751         #  Axes of the LCS are obtained from shape's location or,
3752         #  if the shape is a planar face, from position of its plane.
3753         #
3754         #  @param theShape Shape to calculate position of.
3755         #  @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
3756         #          Ox,Oy,Oz: Coordinates of shape's LCS origin.
3757         #          Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
3758         #          Xx,Xy,Xz: Coordinates of shape's LCS X direction.
3759         #
3760         #  @ref swig_todo "Example"
3761         def GetPosition(self,theShape):
3762             # Example: see GEOM_TestMeasures.py
3763             aTuple = self.MeasuOp.GetPosition(theShape)
3764             RaiseIfFailed("GetPosition", self.MeasuOp)
3765             return aTuple
3766
3767         ## Get kind of theShape.
3768         #
3769         #  @param theShape Shape to get a kind of.
3770         #  @return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration
3771         #          and a list of parameters, describing the shape.
3772         #  @note  Concrete meaning of each value, returned via \a theIntegers
3773         #         or \a theDoubles list depends on the kind of the shape.
3774         #         The full list of possible outputs is:
3775         #
3776         #  - geompy.kind.COMPOUND              nb_solids  nb_faces  nb_edges  nb_vertices
3777         #  - geompy.kind.COMPSOLID             nb_solids  nb_faces  nb_edges  nb_vertices
3778         #
3779         #  - geompy.kind.SHELL       geompy.info.CLOSED   nb_faces  nb_edges  nb_vertices
3780         #  - geompy.kind.SHELL       geompy.info.UNCLOSED nb_faces  nb_edges  nb_vertices
3781         #
3782         #  - geompy.kind.WIRE        geompy.info.CLOSED             nb_edges  nb_vertices
3783         #  - geompy.kind.WIRE        geompy.info.UNCLOSED           nb_edges  nb_vertices
3784         #
3785         #  - geompy.kind.SPHERE       xc yc zc            R
3786         #  - geompy.kind.CYLINDER     xb yb zb  dx dy dz  R         H
3787         #  - geompy.kind.BOX          xc yc zc                      ax ay az
3788         #  - geompy.kind.ROTATED_BOX  xc yc zc  zx zy zz  xx xy xz  ax ay az
3789         #  - geompy.kind.TORUS        xc yc zc  dx dy dz  R_1  R_2
3790         #  - geompy.kind.CONE         xb yb zb  dx dy dz  R_1  R_2  H
3791         #  - geompy.kind.POLYHEDRON                       nb_faces  nb_edges  nb_vertices
3792         #  - geompy.kind.SOLID                            nb_faces  nb_edges  nb_vertices
3793         #
3794         #  - geompy.kind.SPHERE2D     xc yc zc            R
3795         #  - geompy.kind.CYLINDER2D   xb yb zb  dx dy dz  R         H
3796         #  - geompy.kind.TORUS2D      xc yc zc  dx dy dz  R_1  R_2
3797         #  - geompy.kind.CONE2D       xc yc zc  dx dy dz  R_1  R_2  H
3798         #  - geompy.kind.DISK_CIRCLE  xc yc zc  dx dy dz  R
3799         #  - geompy.kind.DISK_ELLIPSE xc yc zc  dx dy dz  R_1  R_2
3800         #  - geompy.kind.POLYGON      xo yo zo  dx dy dz            nb_edges  nb_vertices
3801         #  - geompy.kind.PLANE        xo yo zo  dx dy dz
3802         #  - geompy.kind.PLANAR       xo yo zo  dx dy dz            nb_edges  nb_vertices
3803         #  - geompy.kind.FACE                                       nb_edges  nb_vertices
3804         #
3805         #  - geompy.kind.CIRCLE       xc yc zc  dx dy dz  R
3806         #  - geompy.kind.ARC_CIRCLE   xc yc zc  dx dy dz  R         x1 y1 z1  x2 y2 z2
3807         #  - geompy.kind.ELLIPSE      xc yc zc  dx dy dz  R_1  R_2
3808         #  - geompy.kind.ARC_ELLIPSE  xc yc zc  dx dy dz  R_1  R_2  x1 y1 z1  x2 y2 z2
3809         #  - geompy.kind.LINE         xo yo zo  dx dy dz
3810         #  - geompy.kind.SEGMENT      x1 y1 z1  x2 y2 z2
3811         #  - geompy.kind.EDGE                                                 nb_vertices
3812         #
3813         #  - geompy.kind.VERTEX       x  y  z
3814         #
3815         #  @ref swig_todo "Example"
3816         def KindOfShape(self,theShape):
3817             # Example: see GEOM_TestMeasures.py
3818             aRoughTuple = self.MeasuOp.KindOfShape(theShape)
3819             RaiseIfFailed("KindOfShape", self.MeasuOp)
3820
3821             aKind  = aRoughTuple[0]
3822             anInts = aRoughTuple[1]
3823             aDbls  = aRoughTuple[2]
3824
3825             # Now there is no exception from this rule:
3826             aKindTuple = [aKind] + aDbls + anInts
3827
3828             # If they are we will regroup parameters for such kind of shape.
3829             # For example:
3830             #if aKind == kind.SOME_KIND:
3831             #    #  SOME_KIND     int int double int double double
3832             #    aKindTuple = [aKind, anInts[0], anInts[1], aDbls[0], anInts[2], aDbls[1], aDbls[2]]
3833
3834             return aKindTuple
3835
3836         # end of l2_measure
3837         ## @}
3838
3839         ## @addtogroup l2_import_export
3840         ## @{
3841
3842         ## Import a shape from the BREP or IGES or STEP file
3843         #  (depends on given format) with given name.
3844         #  @param theFileName The file, containing the shape.
3845         #  @param theFormatName Specify format for the file reading.
3846         #         Available formats can be obtained with InsertOp.ImportTranslators() method.
3847         #         If format 'IGES_SCALE' is used instead 'IGES' length unit will be
3848         #         set to 'meter' and result model will be scaled.
3849         #  @return New GEOM_Object, containing the imported shape.
3850         #
3851         #  @ref swig_Import_Export "Example"
3852         def ImportFile(self,theFileName, theFormatName):
3853             # Example: see GEOM_TestOthers.py
3854             anObj = self.InsertOp.ImportFile(theFileName, theFormatName)
3855             RaiseIfFailed("Import", self.InsertOp)
3856             return anObj
3857
3858         ## Deprecated analog of ImportFile
3859         def Import(self,theFileName, theFormatName):
3860             print "WARNING: Function Import is deprecated, use ImportFile instead"
3861             anObj = self.InsertOp.ImportFile(theFileName, theFormatName)
3862             RaiseIfFailed("Import", self.InsertOp)
3863             return anObj
3864
3865         ## Shortcut to ImportFile() for BREP format
3866         #
3867         #  @ref swig_Import_Export "Example"
3868         def ImportBREP(self,theFileName):
3869             # Example: see GEOM_TestOthers.py
3870             return self.ImportFile(theFileName, "BREP")
3871
3872         ## Shortcut to ImportFile() for IGES format
3873         #
3874         #  @ref swig_Import_Export "Example"
3875         def ImportIGES(self,theFileName):
3876             # Example: see GEOM_TestOthers.py
3877             return self.ImportFile(theFileName, "IGES")
3878
3879         ## Return length unit from given IGES file
3880         #
3881         #  @ref swig_Import_Export "Example"
3882         def GetIGESUnit(self,theFileName):
3883             # Example: see GEOM_TestOthers.py
3884             anObj = self.InsertOp.ImportFile(theFileName, "IGES_UNIT")
3885             #RaiseIfFailed("Import", self.InsertOp)
3886             # recieve name using returned vertex
3887             UnitName = "M"
3888             if anObj.GetShapeType() == GEOM.VERTEX:
3889                 vertices = [anObj]
3890             else:
3891                 vertices = self.SubShapeAll(anObj,ShapeType["VERTEX"])
3892             if len(vertices)>0:
3893                 p = self.PointCoordinates(vertices[0])
3894                 if abs(p[0]-0.01) < 1.e-6:
3895                     UnitName = "CM"
3896                 elif abs(p[0]-0.001) < 1.e-6:
3897                     UnitName = "MM"
3898             return UnitName
3899
3900         ## Shortcut to ImportFile() for STEP format
3901         #
3902         #  @ref swig_Import_Export "Example"
3903         def ImportSTEP(self,theFileName):
3904             # Example: see GEOM_TestOthers.py
3905             return self.ImportFile(theFileName, "STEP")
3906
3907         ## Export the given shape into a file with given name.
3908         #  @param theObject Shape to be stored in the file.
3909         #  @param theFileName Name of the file to store the given shape in.
3910         #  @param theFormatName Specify format for the shape storage.
3911         #         Available formats can be obtained with InsertOp.ImportTranslators() method.
3912         #
3913         #  @ref swig_Import_Export "Example"
3914         def Export(self,theObject, theFileName, theFormatName):
3915             # Example: see GEOM_TestOthers.py
3916             self.InsertOp.Export(theObject, theFileName, theFormatName)
3917             if self.InsertOp.IsDone() == 0:
3918                 raise RuntimeError,  "Export : " + self.InsertOp.GetErrorCode()
3919                 pass
3920             pass
3921
3922         ## Shortcut to Export() for BREP format
3923         #
3924         #  @ref swig_Import_Export "Example"
3925         def ExportBREP(self,theObject, theFileName):
3926             # Example: see GEOM_TestOthers.py
3927             return self.Export(theObject, theFileName, "BREP")
3928
3929         ## Shortcut to Export() for IGES format
3930         #
3931         #  @ref swig_Import_Export "Example"
3932         def ExportIGES(self,theObject, theFileName):
3933             # Example: see GEOM_TestOthers.py
3934             return self.Export(theObject, theFileName, "IGES")
3935
3936         ## Shortcut to Export() for STEP format
3937         #
3938         #  @ref swig_Import_Export "Example"
3939         def ExportSTEP(self,theObject, theFileName):
3940             # Example: see GEOM_TestOthers.py
3941             return self.Export(theObject, theFileName, "STEP")
3942
3943         # end of l2_import_export
3944         ## @}
3945
3946         ## @addtogroup l3_blocks
3947         ## @{
3948
3949         ## Create a quadrangle face from four edges. Order of Edges is not
3950         #  important. It is  not necessary that edges share the same vertex.
3951         #  @param E1,E2,E3,E4 Edges for the face bound.
3952         #  @return New GEOM_Object, containing the created face.
3953         #
3954         #  @ref tui_building_by_blocks_page "Example"
3955         def MakeQuad(self,E1, E2, E3, E4):
3956             # Example: see GEOM_Spanner.py
3957             anObj = self.BlocksOp.MakeQuad(E1, E2, E3, E4)
3958             RaiseIfFailed("MakeQuad", self.BlocksOp)
3959             return anObj
3960
3961         ## Create a quadrangle face on two edges.
3962         #  The missing edges will be built by creating the shortest ones.
3963         #  @param E1,E2 Two opposite edges for the face.
3964         #  @return New GEOM_Object, containing the created face.
3965         #
3966         #  @ref tui_building_by_blocks_page "Example"
3967         def MakeQuad2Edges(self,E1, E2):
3968             # Example: see GEOM_Spanner.py
3969             anObj = self.BlocksOp.MakeQuad2Edges(E1, E2)
3970             RaiseIfFailed("MakeQuad2Edges", self.BlocksOp)
3971             return anObj
3972
3973         ## Create a quadrangle face with specified corners.
3974         #  The missing edges will be built by creating the shortest ones.
3975         #  @param V1,V2,V3,V4 Corner vertices for the face.
3976         #  @return New GEOM_Object, containing the created face.
3977         #
3978         #  @ref tui_building_by_blocks_page "Example 1"
3979         #  \n @ref swig_MakeQuad4Vertices "Example 2"
3980         def MakeQuad4Vertices(self,V1, V2, V3, V4):
3981             # Example: see GEOM_Spanner.py
3982             anObj = self.BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
3983             RaiseIfFailed("MakeQuad4Vertices", self.BlocksOp)
3984             return anObj
3985
3986         ## Create a hexahedral solid, bounded by the six given faces. Order of
3987         #  faces is not important. It is  not necessary that Faces share the same edge.
3988         #  @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
3989         #  @return New GEOM_Object, containing the created solid.
3990         #
3991         #  @ref tui_building_by_blocks_page "Example 1"
3992         #  \n @ref swig_MakeHexa "Example 2"
3993         def MakeHexa(self,F1, F2, F3, F4, F5, F6):
3994             # Example: see GEOM_Spanner.py
3995             anObj = self.BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
3996             RaiseIfFailed("MakeHexa", self.BlocksOp)
3997             return anObj
3998
3999         ## Create a hexahedral solid between two given faces.
4000         #  The missing faces will be built by creating the smallest ones.
4001         #  @param F1,F2 Two opposite faces for the hexahedral solid.
4002         #  @return New GEOM_Object, containing the created solid.
4003         #
4004         #  @ref tui_building_by_blocks_page "Example 1"
4005         #  \n @ref swig_MakeHexa2Faces "Example 2"
4006         def MakeHexa2Faces(self,F1, F2):
4007             # Example: see GEOM_Spanner.py
4008             anObj = self.BlocksOp.MakeHexa2Faces(F1, F2)
4009             RaiseIfFailed("MakeHexa2Faces", self.BlocksOp)
4010             return anObj
4011
4012         # end of l3_blocks
4013         ## @}
4014
4015         ## @addtogroup l3_blocks_op
4016         ## @{
4017
4018         ## Get a vertex, found in the given shape by its coordinates.
4019         #  @param theShape Block or a compound of blocks.
4020         #  @param theX,theY,theZ Coordinates of the sought vertex.
4021         #  @param theEpsilon Maximum allowed distance between the resulting
4022         #                    vertex and point with the given coordinates.
4023         #  @return New GEOM_Object, containing the found vertex.
4024         #
4025         #  @ref swig_GetPoint "Example"
4026         def GetPoint(self, theShape, theX, theY, theZ, theEpsilon):
4027             # Example: see GEOM_TestOthers.py
4028             anObj = self.BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
4029             RaiseIfFailed("GetPoint", self.BlocksOp)
4030             return anObj
4031
4032         ## Find a vertex of the given shape, which has minimal distance to the given point.
4033         #  @param theShape Any shape.
4034         #  @param thePoint Point, close to the desired vertex.
4035         #  @return New GEOM_Object, containing the found vertex.
4036         #
4037         #  @ref swig_GetVertexNearPoint "Example"
4038         def GetVertexNearPoint(self, theShape, thePoint):
4039             # Example: see GEOM_TestOthers.py
4040             anObj = self.BlocksOp.GetVertexNearPoint(theShape, thePoint)
4041             RaiseIfFailed("GetVertexNearPoint", self.BlocksOp)
4042             return anObj
4043
4044         ## Get an edge, found in the given shape by two given vertices.
4045         #  @param theShape Block or a compound of blocks.
4046         #  @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
4047         #  @return New GEOM_Object, containing the found edge.
4048         #
4049         #  @ref swig_GetEdge "Example"
4050         def GetEdge(self, theShape, thePoint1, thePoint2):
4051             # Example: see GEOM_Spanner.py
4052             anObj = self.BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
4053             RaiseIfFailed("GetEdge", self.BlocksOp)
4054             return anObj
4055
4056         ## Find an edge of the given shape, which has minimal distance to the given point.
4057         #  @param theShape Block or a compound of blocks.
4058         #  @param thePoint Point, close to the desired edge.
4059         #  @return New GEOM_Object, containing the found edge.
4060         #
4061         #  @ref swig_GetEdgeNearPoint "Example"
4062         def GetEdgeNearPoint(self, theShape, thePoint):
4063             # Example: see GEOM_TestOthers.py
4064             anObj = self.BlocksOp.GetEdgeNearPoint(theShape, thePoint)
4065             RaiseIfFailed("GetEdgeNearPoint", self.BlocksOp)
4066             return anObj
4067
4068         ## Returns a face, found in the given shape by four given corner vertices.
4069         #  @param theShape Block or a compound of blocks.
4070         #  @param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
4071         #  @return New GEOM_Object, containing the found face.
4072         #
4073         #  @ref swig_todo "Example"
4074         def GetFaceByPoints(self,theShape, thePoint1, thePoint2, thePoint3, thePoint4):
4075             # Example: see GEOM_Spanner.py
4076             anObj = self.BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
4077             RaiseIfFailed("GetFaceByPoints", self.BlocksOp)
4078             return anObj
4079
4080         ## Get a face of block, found in the given shape by two given edges.
4081         #  @param theShape Block or a compound of blocks.
4082         #  @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
4083         #  @return New GEOM_Object, containing the found face.
4084         #
4085         #  @ref swig_todo "Example"
4086         def GetFaceByEdges(self,theShape, theEdge1, theEdge2):
4087             # Example: see GEOM_Spanner.py
4088             anObj = self.BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
4089             RaiseIfFailed("GetFaceByEdges", self.BlocksOp)
4090             return anObj
4091
4092         ## Find a face, opposite to the given one in the given block.
4093         #  @param theBlock Must be a hexahedral solid.
4094         #  @param theFace Face of \a theBlock, opposite to the desired face.
4095         #  @return New GEOM_Object, containing the found face.
4096         #
4097         #  @ref swig_GetOppositeFace "Example"
4098         def GetOppositeFace(self,theBlock, theFace):
4099             # Example: see GEOM_Spanner.py
4100             anObj = self.BlocksOp.GetOppositeFace(theBlock, theFace)
4101             RaiseIfFailed("GetOppositeFace", self.BlocksOp)
4102             return anObj
4103
4104         ## Find a face of the given shape, which has minimal distance to the given point.
4105         #  @param theShape Block or a compound of blocks.
4106         #  @param thePoint Point, close to the desired face.
4107         #  @return New GEOM_Object, containing the found face.
4108         #
4109         #  @ref swig_GetFaceNearPoint "Example"
4110         def GetFaceNearPoint(self, theShape, thePoint):
4111             # Example: see GEOM_Spanner.py
4112             anObj = self.BlocksOp.GetFaceNearPoint(theShape, thePoint)
4113             RaiseIfFailed("GetFaceNearPoint", self.BlocksOp)
4114             return anObj
4115
4116         ## Find a face of block, whose outside normale has minimal angle with the given vector.
4117         #  @param theBlock Block or a compound of blocks.
4118         #  @param theVector Vector, close to the normale of the desired face.
4119         #  @return New GEOM_Object, containing the found face.
4120         #
4121         #  @ref swig_todo "Example"
4122         def GetFaceByNormale(self, theBlock, theVector):
4123             # Example: see GEOM_Spanner.py
4124             anObj = self.BlocksOp.GetFaceByNormale(theBlock, theVector)
4125             RaiseIfFailed("GetFaceByNormale", self.BlocksOp)
4126             return anObj
4127
4128         ## Find all subshapes of type \a theShapeType of the given shape,
4129         #  which have minimal distance to the given point.
4130         #  @param theShape Any shape.
4131         #  @param thePoint Point, close to the desired shape.
4132         #  @param theShapeType Defines what kind of subshapes is searched.
4133         #  @param theTolerance The tolerance for distances comparison. All shapes
4134         #                      with distances to the given point in interval
4135         #                      [minimal_distance, minimal_distance + theTolerance] will be gathered.
4136         #  @return New GEOM_Object, containing a group of all found shapes.
4137         #
4138         #  @ref swig_GetShapesNearPoint "Example"
4139         def GetShapesNearPoint(self, theShape, thePoint, theShapeType, theTolerance = 1e-07):
4140             # Example: see GEOM_TestOthers.py
4141             anObj = self.BlocksOp.GetShapesNearPoint(theShape, thePoint, theShapeType, theTolerance)
4142             RaiseIfFailed("GetShapesNearPoint", self.BlocksOp)
4143             return anObj
4144
4145         # end of l3_blocks_op
4146         ## @}
4147
4148         ## @addtogroup l4_blocks_measure
4149         ## @{
4150
4151         ## Check, if the compound of blocks is given.
4152         #  To be considered as a compound of blocks, the
4153         #  given shape must satisfy the following conditions:
4154         #  - Each element of the compound should be a Block (6 faces and 12 edges).
4155         #  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
4156         #  - The compound should be connexe.
4157         #  - The glue between two quadrangle faces should be applied.
4158         #  @param theCompound The compound to check.
4159         #  @return TRUE, if the given shape is a compound of blocks.
4160         #  If theCompound is not valid, prints all discovered errors.
4161         #
4162         #  @ref tui_measurement_tools_page "Example 1"
4163         #  \n @ref swig_CheckCompoundOfBlocks "Example 2"
4164         def CheckCompoundOfBlocks(self,theCompound):
4165             # Example: see GEOM_Spanner.py
4166             (IsValid, BCErrors) = self.BlocksOp.CheckCompoundOfBlocks(theCompound)
4167             RaiseIfFailed("CheckCompoundOfBlocks", self.BlocksOp)
4168             if IsValid == 0:
4169                 Descr = self.BlocksOp.PrintBCErrors(theCompound, BCErrors)
4170                 print Descr
4171             return IsValid
4172
4173         ## Remove all seam and degenerated edges from \a theShape.
4174         #  Unite faces and edges, sharing one surface. It means that
4175         #  this faces must have references to one C++ surface object (handle).
4176         #  @param theShape The compound or single solid to remove irregular edges from.
4177         #  @param doUnionFaces If True, then unite faces. If False (the default value),
4178         #         do not unite faces.
4179         #  @return Improved shape.
4180         #
4181         #  @ref swig_RemoveExtraEdges "Example"
4182         def RemoveExtraEdges(self, theShape, doUnionFaces=False):
4183             # Example: see GEOM_TestOthers.py
4184             nbFacesOptimum = -1 # -1 means do not unite faces
4185             if doUnionFaces is True: nbFacesOptimum = 0 # 0 means unite faces
4186             anObj = self.BlocksOp.RemoveExtraEdges(theShape, nbFacesOptimum)
4187             RaiseIfFailed("RemoveExtraEdges", self.BlocksOp)
4188             return anObj
4189
4190         ## Check, if the given shape is a blocks compound.
4191         #  Fix all detected errors.
4192         #    \note Single block can be also fixed by this method.
4193         #  @param theShape The compound to check and improve.
4194         #  @return Improved compound.
4195         #
4196         #  @ref swig_CheckAndImprove "Example"
4197         def CheckAndImprove(self,theShape):
4198             # Example: see GEOM_TestOthers.py
4199             anObj = self.BlocksOp.CheckAndImprove(theShape)
4200             RaiseIfFailed("CheckAndImprove", self.BlocksOp)
4201             return anObj
4202
4203         # end of l4_blocks_measure
4204         ## @}
4205
4206         ## @addtogroup l3_blocks_op
4207         ## @{
4208
4209         ## Get all the blocks, contained in the given compound.
4210         #  @param theCompound The compound to explode.
4211         #  @param theMinNbFaces If solid has lower number of faces, it is not a block.
4212         #  @param theMaxNbFaces If solid has higher number of faces, it is not a block.
4213         #    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
4214         #  @return List of GEOM_Objects, containing the retrieved blocks.
4215         #
4216         #  @ref tui_explode_on_blocks "Example 1"
4217         #  \n @ref swig_MakeBlockExplode "Example 2"
4218         def MakeBlockExplode(self,theCompound, theMinNbFaces, theMaxNbFaces):
4219             # Example: see GEOM_TestOthers.py
4220             theMinNbFaces,theMaxNbFaces,Parameters = ParseParameters(theMinNbFaces,theMaxNbFaces)
4221             aList = self.BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
4222             RaiseIfFailed("ExplodeCompoundOfBlocks", self.BlocksOp)
4223             for anObj in aList:
4224                 anObj.SetParameters(Parameters)
4225                 pass
4226             return aList
4227
4228         ## Find block, containing the given point inside its volume or on boundary.
4229         #  @param theCompound Compound, to find block in.
4230         #  @param thePoint Point, close to the desired block. If the point lays on
4231         #         boundary between some blocks, we return block with nearest center.
4232         #  @return New GEOM_Object, containing the found block.
4233         #
4234         #  @ref swig_todo "Example"
4235         def GetBlockNearPoint(self,theCompound, thePoint):
4236             # Example: see GEOM_Spanner.py
4237             anObj = self.BlocksOp.GetBlockNearPoint(theCompound, thePoint)
4238             RaiseIfFailed("GetBlockNearPoint", self.BlocksOp)
4239             return anObj
4240
4241         ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
4242         #  @param theCompound Compound, to find block in.
4243         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
4244         #  @return New GEOM_Object, containing the found block.
4245         #
4246         #  @ref swig_GetBlockByParts "Example"
4247         def GetBlockByParts(self,theCompound, theParts):
4248             # Example: see GEOM_TestOthers.py
4249             anObj = self.BlocksOp.GetBlockByParts(theCompound, theParts)
4250             RaiseIfFailed("GetBlockByParts", self.BlocksOp)
4251             return anObj
4252
4253         ## Return all blocks, containing all the elements, passed as the parts.
4254         #  @param theCompound Compound, to find blocks in.
4255         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
4256         #  @return List of GEOM_Objects, containing the found blocks.
4257         #
4258         #  @ref swig_todo "Example"
4259         def GetBlocksByParts(self,theCompound, theParts):
4260             # Example: see GEOM_Spanner.py
4261             aList = self.BlocksOp.GetBlocksByParts(theCompound, theParts)
4262             RaiseIfFailed("GetBlocksByParts", self.BlocksOp)
4263             return aList
4264
4265         ## Multi-transformate block and glue the result.
4266         #  Transformation is defined so, as to superpose direction faces.
4267         #  @param Block Hexahedral solid to be multi-transformed.
4268         #  @param DirFace1 ID of First direction face.
4269         #  @param DirFace2 ID of Second direction face.
4270         #  @param NbTimes Quantity of transformations to be done.
4271         #    \note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
4272         #  @return New GEOM_Object, containing the result shape.
4273         #
4274         #  @ref tui_multi_transformation "Example"
4275         def MakeMultiTransformation1D(self,Block, DirFace1, DirFace2, NbTimes):
4276             # Example: see GEOM_Spanner.py
4277             DirFace1,DirFace2,NbTimes,Parameters = ParseParameters(DirFace1,DirFace2,NbTimes)
4278             anObj = self.BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
4279             RaiseIfFailed("MakeMultiTransformation1D", self.BlocksOp)
4280             anObj.SetParameters(Parameters)
4281             return anObj
4282
4283         ## Multi-transformate block and glue the result.
4284         #  @param Block Hexahedral solid to be multi-transformed.
4285         #  @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
4286         #  @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
4287         #  @param NbTimesU,NbTimesV Quantity of transformations to be done.
4288         #  @return New GEOM_Object, containing the result shape.
4289         #
4290         #  @ref tui_multi_transformation "Example"
4291         def MakeMultiTransformation2D(self,Block, DirFace1U, DirFace2U, NbTimesU,
4292                                       DirFace1V, DirFace2V, NbTimesV):
4293             # Example: see GEOM_Spanner.py
4294             DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV,Parameters = ParseParameters(
4295               DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV)
4296             anObj = self.BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
4297                                                             DirFace1V, DirFace2V, NbTimesV)
4298             RaiseIfFailed("MakeMultiTransformation2D", self.BlocksOp)
4299             anObj.SetParameters(Parameters)
4300             return anObj
4301
4302         ## Build all possible propagation groups.
4303         #  Propagation group is a set of all edges, opposite to one (main)
4304         #  edge of this group directly or through other opposite edges.
4305         #  Notion of Opposite Edge make sence only on quadrangle face.
4306         #  @param theShape Shape to build propagation groups on.
4307         #  @return List of GEOM_Objects, each of them is a propagation group.
4308         #
4309         #  @ref swig_Propagate "Example"
4310         def Propagate(self,theShape):
4311             # Example: see GEOM_TestOthers.py
4312             listChains = self.BlocksOp.Propagate(theShape)
4313             RaiseIfFailed("Propagate", self.BlocksOp)
4314             return listChains
4315
4316         # end of l3_blocks_op
4317         ## @}
4318
4319         ## @addtogroup l3_groups
4320         ## @{
4321
4322         ## Creates a new group which will store sub shapes of theMainShape
4323         #  @param theMainShape is a GEOM object on which the group is selected
4324         #  @param theShapeType defines a shape type of the group
4325         #  @return a newly created GEOM group
4326         #
4327         #  @ref tui_working_with_groups_page "Example 1"
4328         #  \n @ref swig_CreateGroup "Example 2"
4329         def CreateGroup(self,theMainShape, theShapeType):
4330             # Example: see GEOM_TestOthers.py
4331             anObj = self.GroupOp.CreateGroup(theMainShape, theShapeType)
4332             RaiseIfFailed("CreateGroup", self.GroupOp)
4333             return anObj
4334
4335         ## Adds a sub object with ID theSubShapeId to the group
4336         #  @param theGroup is a GEOM group to which the new sub shape is added
4337         #  @param theSubShapeID is a sub shape ID in the main object.
4338         #  \note Use method GetSubShapeID() to get an unique ID of the sub shape
4339         #
4340         #  @ref tui_working_with_groups_page "Example"
4341         def AddObject(self,theGroup, theSubShapeID):
4342             # Example: see GEOM_TestOthers.py
4343             self.GroupOp.AddObject(theGroup, theSubShapeID)
4344             if self.GroupOp.GetErrorCode() != "PAL_ELEMENT_ALREADY_PRESENT":
4345                 RaiseIfFailed("AddObject", self.GroupOp)
4346                 pass
4347             pass
4348
4349         ## Removes a sub object with ID \a theSubShapeId from the group
4350         #  @param theGroup is a GEOM group from which the new sub shape is removed
4351         #  @param theSubShapeID is a sub shape ID in the main object.
4352         #  \note Use method GetSubShapeID() to get an unique ID of the sub shape
4353         #
4354         #  @ref tui_working_with_groups_page "Example"
4355         def RemoveObject(self,theGroup, theSubShapeID):
4356             # Example: see GEOM_TestOthers.py
4357             self.GroupOp.RemoveObject(theGroup, theSubShapeID)
4358             RaiseIfFailed("RemoveObject", self.GroupOp)
4359             pass
4360
4361         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
4362         #  @param theGroup is a GEOM group to which the new sub shapes are added.
4363         #  @param theSubShapes is a list of sub shapes to be added.
4364         #
4365         #  @ref tui_working_with_groups_page "Example"
4366         def UnionList (self,theGroup, theSubShapes):
4367             # Example: see GEOM_TestOthers.py
4368             self.GroupOp.UnionList(theGroup, theSubShapes)
4369             RaiseIfFailed("UnionList", self.GroupOp)
4370             pass
4371
4372         ## Works like the above method, but argument
4373         #  theSubShapes here is a list of sub-shapes indices
4374         #
4375         #  @ref swig_UnionIDs "Example"
4376         def UnionIDs(self,theGroup, theSubShapes):
4377             # Example: see GEOM_TestOthers.py
4378             self.GroupOp.UnionIDs(theGroup, theSubShapes)
4379             RaiseIfFailed("UnionIDs", self.GroupOp)
4380             pass
4381
4382         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
4383         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
4384         #  @param theSubShapes is a list of sub-shapes to be removed.
4385         #
4386         #  @ref tui_working_with_groups_page "Example"
4387         def DifferenceList (self,theGroup, theSubShapes):
4388             # Example: see GEOM_TestOthers.py
4389             self.GroupOp.DifferenceList(theGroup, theSubShapes)
4390             RaiseIfFailed("DifferenceList", self.GroupOp)
4391             pass
4392
4393         ## Works like the above method, but argument
4394         #  theSubShapes here is a list of sub-shapes indices
4395         #
4396         #  @ref swig_DifferenceIDs "Example"
4397         def DifferenceIDs(self,theGroup, theSubShapes):
4398             # Example: see GEOM_TestOthers.py
4399             self.GroupOp.DifferenceIDs(theGroup, theSubShapes)
4400             RaiseIfFailed("DifferenceIDs", self.GroupOp)
4401             pass
4402
4403         ## Returns a list of sub objects ID stored in the group
4404         #  @param theGroup is a GEOM group for which a list of IDs is requested
4405         #
4406         #  @ref swig_GetObjectIDs "Example"
4407         def GetObjectIDs(self,theGroup):
4408             # Example: see GEOM_TestOthers.py
4409             ListIDs = self.GroupOp.GetObjects(theGroup)
4410             RaiseIfFailed("GetObjects", self.GroupOp)
4411             return ListIDs
4412
4413         ## Returns a type of sub objects stored in the group
4414         #  @param theGroup is a GEOM group which type is returned.
4415         #
4416         #  @ref swig_GetType "Example"
4417         def GetType(self,theGroup):
4418             # Example: see GEOM_TestOthers.py
4419             aType = self.GroupOp.GetType(theGroup)
4420             RaiseIfFailed("GetType", self.GroupOp)
4421             return aType
4422
4423         ## Convert a type of geom object from id to string value
4424         #  @param theId is a GEOM obect type id.
4425         #
4426         #  @ref swig_GetType "Example"
4427         def ShapeIdToType(self, theId):
4428             if theId == 0:
4429                 return "COPY"
4430             if theId == 1:
4431                 return "IMPORT"
4432             if theId == 2:
4433                 return "POINT"
4434             if theId == 3:
4435                 return "VECTOR"
4436             if theId == 4:
4437                 return "PLANE"
4438             if theId == 5:
4439                 return "LINE"
4440             if theId == 6:
4441                 return "TORUS"
4442             if theId == 7:
4443                 return "BOX"
4444             if theId == 8:
4445                 return "CYLINDER"
4446             if theId == 9:
4447                 return "CONE"
4448             if theId == 10:
4449                 return "SPHERE"
4450             if theId == 11:
4451                 return "PRISM"
4452             if theId == 12:
4453                 return "REVOLUTION"
4454             if theId == 13:
4455                 return "BOOLEAN"
4456             if theId == 14:
4457                 return "PARTITION"
4458             if theId == 15:
4459                 return "POLYLINE"
4460             if theId == 16:
4461                 return "CIRCLE"
4462             if theId == 17:
4463                 return "SPLINE"
4464             if theId == 18:
4465                 return "ELLIPSE"
4466             if theId == 19:
4467                 return "CIRC_ARC"
4468             if theId == 20:
4469                 return "FILLET"
4470             if theId == 21:
4471                 return "CHAMFER"
4472             if theId == 22:
4473                 return "EDGE"
4474             if theId == 23:
4475                 return "WIRE"
4476             if theId == 24:
4477                 return "FACE"
4478             if theId == 25:
4479                 return "SHELL"
4480             if theId == 26:
4481                 return "SOLID"
4482             if theId == 27:
4483                 return "COMPOUND"
4484             if theId == 28:
4485                 return "SUBSHAPE"
4486             if theId == 29:
4487                 return "PIPE"
4488             if theId == 30:
4489                 return "ARCHIMEDE"
4490             if theId == 31:
4491                 return "FILLING"
4492             if theId == 32:
4493                 return "EXPLODE"
4494             if theId == 33:
4495                 return "GLUED"
4496             if theId == 34:
4497                 return "SKETCHER"
4498             if theId == 35:
4499                 return "CDG"
4500             if theId == 36:
4501                 return "FREE_BOUNDS"
4502             if theId == 37:
4503                 return "GROUP"
4504             if theId == 38:
4505                 return "BLOCK"
4506             if theId == 39:
4507                 return "MARKER"
4508             if theId == 40:
4509                 return "THRUSECTIONS"
4510             if theId == 41:
4511                 return "COMPOUNDFILTER"
4512             if theId == 42:
4513                 return "SHAPES_ON_SHAPE"
4514             if theId == 43:
4515                 return "ELLIPSE_ARC"
4516             if theId == 44:
4517                 return "3DSKETCHER"
4518             if theId == 45:
4519                 return "FILLET_2D"
4520             if theId == 46:
4521                 return "FILLET_1D"
4522             return "Shape Id not exist."
4523
4524         ## Returns a main shape associated with the group
4525         #  @param theGroup is a GEOM group for which a main shape object is requested
4526         #  @return a GEOM object which is a main shape for theGroup
4527         #
4528         #  @ref swig_GetMainShape "Example"
4529         def GetMainShape(self,theGroup):
4530             # Example: see GEOM_TestOthers.py
4531             anObj = self.GroupOp.GetMainShape(theGroup)
4532             RaiseIfFailed("GetMainShape", self.GroupOp)
4533             return anObj
4534
4535         ## Create group of edges of theShape, whose length is in range [min_length, max_length].
4536         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
4537         #
4538         #  @ref swig_todo "Example"
4539         def GetEdgesByLength (self, theShape, min_length, max_length, include_min = 1, include_max = 1):
4540             edges = self.SubShapeAll(theShape, ShapeType["EDGE"])
4541             edges_in_range = []
4542             for edge in edges:
4543                 Props = self.BasicProperties(edge)
4544                 if min_length <= Props[0] and Props[0] <= max_length:
4545                     if (not include_min) and (min_length == Props[0]):
4546                         skip = 1
4547                     else:
4548                         if (not include_max) and (Props[0] == max_length):
4549                             skip = 1
4550                         else:
4551                             edges_in_range.append(edge)
4552
4553             if len(edges_in_range) <= 0:
4554                 print "No edges found by given criteria"
4555                 return 0
4556
4557             group_edges = self.CreateGroup(theShape, ShapeType["EDGE"])
4558             self.UnionList(group_edges, edges_in_range)
4559
4560             return group_edges
4561
4562         ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
4563         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
4564         #
4565         #  @ref swig_todo "Example"
4566         def SelectEdges (self, min_length, max_length, include_min = 1, include_max = 1):
4567             nb_selected = sg.SelectedCount()
4568             if nb_selected < 1:
4569                 print "Select a shape before calling this function, please."
4570                 return 0
4571             if nb_selected > 1:
4572                 print "Only one shape must be selected"
4573                 return 0
4574
4575             id_shape = sg.getSelected(0)
4576             shape = IDToObject( id_shape )
4577
4578             group_edges = self.GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
4579
4580             left_str  = " < "
4581             right_str = " < "
4582             if include_min: left_str  = " <= "
4583             if include_max: right_str  = " <= "
4584
4585             self.addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
4586                                     + left_str + "length" + right_str + `max_length`)
4587
4588             sg.updateObjBrowser(1)
4589
4590             return group_edges
4591
4592         # end of l3_groups
4593         ## @}
4594
4595         ## @addtogroup l4_advanced
4596         ## @{
4597
4598         ## Create a T-shape object with specified caracteristics for the main
4599         #  and the incident pipes (radius, width, half-length).
4600         #  The extremities of the main pipe are located on junctions points P1 and P2.
4601         #  The extremity of the incident pipe is located on junction point P3.
4602         #  If P1, P2 and P3 are not given, the center of the shape is (0,0,0) and
4603         #  the main plane of the T-shape is XOY.
4604         #  @param theR1 Internal radius of main pipe
4605         #  @param theW1 Width of main pipe
4606         #  @param theL1 Half-length of main pipe
4607         #  @param theR2 Internal radius of incident pipe (R2 < R1)
4608         #  @param theW2 Width of incident pipe (R2+W2 < R1+W1)
4609         #  @param theL2 Half-length of incident pipe
4610         #  @param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=True)
4611         #  @param theP1 1st junction point of main pipe
4612         #  @param theP2 2nd junction point of main pipe
4613         #  @param theP3 Junction point of incident pipe
4614         #  @return List of GEOM_Objects, containing the created shape and propagation groups.
4615         #
4616         #  @ref tui_creation_pipetshape "Example"
4617         def MakePipeTShape(self, theR1, theW1, theL1, theR2, theW2, theL2, theHexMesh=True, theP1=None, theP2=None, theP3=None):
4618             theR1, theW1, theL1, theR2, theW2, theL2, Parameters = ParseParameters(theR1, theW1, theL1, theR2, theW2, theL2)
4619             if (theP1 and theP2 and theP3):
4620                 anObj = self.AdvOp.MakePipeTShapeWithPosition(theR1, theW1, theL1, theR2, theW2, theL2, theHexMesh, theP1, theP2, theP3)
4621             else:
4622                 anObj = self.AdvOp.MakePipeTShape(theR1, theW1, theL1, theR2, theW2, theL2, theHexMesh)
4623             RaiseIfFailed("MakePipeTShape", self.AdvOp)
4624             if Parameters: anObj[0].SetParameters(Parameters)
4625             return anObj
4626
4627         ## Create a T-shape object with chamfer and with specified caracteristics for the main
4628         #  and the incident pipes (radius, width, half-length). The chamfer is
4629         #  created on the junction of the pipes.
4630         #  The extremities of the main pipe are located on junctions points P1 and P2.
4631         #  The extremity of the incident pipe is located on junction point P3.
4632         #  If P1, P2 and P3 are not given, the center of the shape is (0,0,0) and
4633         #  the main plane of the T-shape is XOY.
4634         #  @param theR1 Internal radius of main pipe
4635         #  @param theW1 Width of main pipe
4636         #  @param theL1 Half-length of main pipe
4637         #  @param theR2 Internal radius of incident pipe (R2 < R1)
4638         #  @param theW2 Width of incident pipe (R2+W2 < R1+W1)
4639         #  @param theL2 Half-length of incident pipe
4640         #  @param theH Height of the chamfer.
4641         #  @param theW Width of the chamfer.
4642         #  @param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=True)
4643         #  @param theP1 1st junction point of main pipe
4644         #  @param theP2 2nd junction point of main pipe
4645         #  @param theP3 Junction point of incident pipe
4646         #  @return List of GEOM_Objects, containing the created shape and propagation groups.
4647         #
4648         #  @ref tui_creation_pipetshape "Example"
4649         def MakePipeTShapeChamfer(self, theR1, theW1, theL1, theR2, theW2, theL2, theH, theW, theHexMesh=True, theP1=None, theP2=None, theP3=None):
4650             theR1, theW1, theL1, theR2, theW2, theL2, theH, theW, Parameters = ParseParameters(theR1, theW1, theL1, theR2, theW2, theL2, theH, theW)
4651             if (theP1 and theP2 and theP3):
4652               anObj = self.AdvOp.MakePipeTShapeChamferWithPosition(theR1, theW1, theL1, theR2, theW2, theL2, theH, theW, theHexMesh, theP1, theP2, theP3)
4653             else:
4654               anObj = self.AdvOp.MakePipeTShapeChamfer(theR1, theW1, theL1, theR2, theW2, theL2, theH, theW, theHexMesh)
4655             RaiseIfFailed("MakePipeTShapeChamfer", self.AdvOp)
4656             if Parameters: anObj[0].SetParameters(Parameters)
4657             return anObj
4658
4659         ## Create a T-shape object with fillet and with specified caracteristics for the main
4660         #  and the incident pipes (radius, width, half-length). The fillet is
4661         #  created on the junction of the pipes.
4662         #  The extremities of the main pipe are located on junctions points P1 and P2.
4663         #  The extremity of the incident pipe is located on junction point P3.
4664         #  If P1, P2 and P3 are not given, the center of the shape is (0,0,0) and
4665         #  the main plane of the T-shape is XOY.
4666         #  @param theR1 Internal radius of main pipe
4667         #  @param theW1 Width of main pipe
4668         #  @param theL1 Half-length of main pipe
4669         #  @param theR2 Internal radius of incident pipe (R2 < R1)
4670         #  @param theW2 Width of incident pipe (R2+W2 < R1+W1)
4671         #  @param theL2 Half-length of incident pipe
4672         #  @param theRF Radius of curvature of fillet.
4673         #  @param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=True)
4674         #  @param theP1 1st junction point of main pipe
4675         #  @param theP2 2nd junction point of main pipe
4676         #  @param theP3 Junction point of incident pipe
4677         #  @return List of GEOM_Objects, containing the created shape and propagation groups.
4678         #
4679         #  @ref tui_creation_pipetshape "Example"
4680         def MakePipeTShapeFillet(self, theR1, theW1, theL1, theR2, theW2, theL2, theRF, theHexMesh=True, theP1=None, theP2=None, theP3=None):
4681             theR1, theW1, theL1, theR2, theW2, theL2, theRF, Parameters = ParseParameters(theR1, theW1, theL1, theR2, theW2, theL2, theRF)
4682             if (theP1 and theP2 and theP3):
4683               anObj = self.AdvOp.MakePipeTShapeFilletWithPosition(theR1, theW1, theL1, theR2, theW2, theL2, theRF, theHexMesh, theP1, theP2, theP3)
4684             else:
4685               anObj = self.AdvOp.MakePipeTShapeFillet(theR1, theW1, theL1, theR2, theW2, theL2, theRF, theHexMesh)
4686             RaiseIfFailed("MakePipeTShapeFillet", self.AdvOp)
4687             if Parameters: anObj[0].SetParameters(Parameters)
4688             return anObj
4689
4690         #@@ insert new functions before this line @@ do not remove this line @@#
4691
4692         # end of l4_advanced
4693         ## @}
4694
4695         ## Create a copy of the given object
4696         #  @ingroup l1_geompy_auxiliary
4697         #
4698         #  @ref swig_all_advanced "Example"
4699         def MakeCopy(self,theOriginal):
4700             # Example: see GEOM_TestAll.py
4701             anObj = self.InsertOp.MakeCopy(theOriginal)
4702             RaiseIfFailed("MakeCopy", self.InsertOp)
4703             return anObj
4704
4705         ## Add Path to load python scripts from
4706         #  @ingroup l1_geompy_auxiliary
4707         def addPath(self,Path):
4708             if (sys.path.count(Path) < 1):
4709                 sys.path.append(Path)
4710                 pass
4711             pass
4712
4713         ## Load marker texture from the file
4714         #  @param Path a path to the texture file
4715         #  @return unique texture identifier
4716         #  @ingroup l1_geompy_auxiliary
4717         def LoadTexture(self, Path):
4718             # Example: see GEOM_TestAll.py
4719             ID = self.InsertOp.LoadTexture(Path)
4720             RaiseIfFailed("LoadTexture", self.InsertOp)
4721             return ID
4722
4723         ## Get entry of the object
4724         #  @param obj geometry object
4725         #  @return unique object identifier
4726         #  @ingroup l1_geompy_auxiliary
4727         def getObjectID(self, obj):
4728             ID = ""
4729             entry = salome.ObjectToID(obj)
4730             if entry is not None:
4731                 lst = entry.split(":")
4732                 if len(lst) > 0:
4733                     ID = lst[-1] # -1 means last item in the list
4734                     return "GEOM_" + ID
4735             return ID
4736
4737
4738
4739         ## Add marker texture. @a Width and @a Height parameters
4740         #  specify width and height of the texture in pixels.
4741         #  If @a RowData is @c True, @a Texture parameter should represent texture data
4742         #  packed into the byte array. If @a RowData is @c False (default), @a Texture
4743         #  parameter should be unpacked string, in which '1' symbols represent opaque
4744         #  pixels and '0' represent transparent pixels of the texture bitmap.
4745         #
4746         #  @param Width texture width in pixels
4747         #  @param Height texture height in pixels
4748         #  @param Texture texture data
4749         #  @param RowData if @c True, @a Texture data are packed in the byte stream
4750         #  @ingroup l1_geompy_auxiliary
4751         def AddTexture(self, Width, Height, Texture, RowData=False):
4752             # Example: see GEOM_TestAll.py
4753             if not RowData: Texture = PackData(Texture)
4754             ID = self.InsertOp.AddTexture(Width, Height, Texture)
4755             RaiseIfFailed("AddTexture", self.InsertOp)
4756             return ID
4757
4758 import omniORB
4759 #Register the new proxy for GEOM_Gen
4760 omniORB.registerObjref(GEOM._objref_GEOM_Gen._NP_RepositoryId, geompyDC)