src/SMESH_SWIG/smeshBuilder.py

   1 # Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19 #  File   : smeshBuilder.py
  20 #  Author : Francis KLOSS, OCC
  21 #  Module : SMESH
  22
  23 ## @package smeshBuilder
  24 #  Python API for SALOME %Mesh module
  25
  26 ## @defgroup l1_auxiliary Auxiliary methods and structures
  27 ## @defgroup l1_creating  Creating meshes
  28 ## @{
  29 ##   @defgroup l2_impexp     Importing and exporting meshes
  30 ##   @defgroup l2_construct  Constructing meshes
  31 ##   @defgroup l2_algorithms Defining Algorithms
  32 ##   @{
  33 ##     @defgroup l3_algos_basic   Basic meshing algorithms
  34 ##     @defgroup l3_algos_proj    Projection Algorithms
  35 ##     @defgroup l3_algos_radialp Radial Prism
  36 ##     @defgroup l3_algos_segmarv Segments around Vertex
  37 ##     @defgroup l3_algos_3dextr  3D extrusion meshing algorithm
  38
  39 ##   @}
  40 ##   @defgroup l2_hypotheses Defining hypotheses
  41 ##   @{
  42 ##     @defgroup l3_hypos_1dhyps 1D Meshing Hypotheses
  43 ##     @defgroup l3_hypos_2dhyps 2D Meshing Hypotheses
  44 ##     @defgroup l3_hypos_maxvol Max Element Volume hypothesis
  45 ##     @defgroup l3_hypos_quad Quadrangle Parameters hypothesis
  46 ##     @defgroup l3_hypos_additi Additional Hypotheses
  47
  48 ##   @}
  49 ##   @defgroup l2_submeshes Constructing submeshes
  50 ##   @defgroup l2_compounds Building Compounds
  51 ##   @defgroup l2_editing   Editing Meshes
  52
  53 ## @}
  54 ## @defgroup l1_meshinfo  Mesh Information
  55 ## @defgroup l1_controls  Quality controls and Filtering
  56 ## @defgroup l1_grouping  Grouping elements
  57 ## @{
  58 ##   @defgroup l2_grps_create Creating groups
  59 ##   @defgroup l2_grps_edit   Editing groups
  60 ##   @defgroup l2_grps_operon Using operations on groups
  61 ##   @defgroup l2_grps_delete Deleting Groups
  62
  63 ## @}
  64 ## @defgroup l1_modifying Modifying meshes
  65 ## @{
  66 ##   @defgroup l2_modif_add      Adding nodes and elements
  67 ##   @defgroup l2_modif_del      Removing nodes and elements
  68 ##   @defgroup l2_modif_edit     Modifying nodes and elements
  69 ##   @defgroup l2_modif_renumber Renumbering nodes and elements
  70 ##   @defgroup l2_modif_trsf     Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
  71 ##   @defgroup l2_modif_movenode Moving nodes
  72 ##   @defgroup l2_modif_throughp Mesh through point
  73 ##   @defgroup l2_modif_invdiag  Diagonal inversion of elements
  74 ##   @defgroup l2_modif_unitetri Uniting triangles
  75 ##   @defgroup l2_modif_changori Changing orientation of elements
  76 ##   @defgroup l2_modif_cutquadr Cutting quadrangles
  77 ##   @defgroup l2_modif_smooth   Smoothing
  78 ##   @defgroup l2_modif_extrurev Extrusion and Revolution
  79 ##   @defgroup l2_modif_patterns Pattern mapping
  80 ##   @defgroup l2_modif_tofromqu Convert to/from Quadratic Mesh
  81
  82 ## @}
  83 ## @defgroup l1_measurements Measurements
  84
  85 import salome
  86 from salome.geom import geomBuilder
  87
  88 import SMESH # This is necessary for back compatibility
  89 from   SMESH import *
  90 from   salome.smesh.smesh_algorithm import Mesh_Algorithm
  91
  92 import SALOME
  93 import SALOMEDS
  94 import os
  95
  96 ## @addtogroup l1_auxiliary
  97 ## @{
  98
  99 ## Converts an angle from degrees to radians
 100 def DegreesToRadians(AngleInDegrees):
 101     from math import pi
 102     return AngleInDegrees * pi / 180.0
 103
 104 import salome_notebook
 105 notebook = salome_notebook.notebook
 106 # Salome notebook variable separator
 107 var_separator = ":"
 108
 109 ## Return list of variable values from salome notebook.
 110 #  The last argument, if is callable, is used to modify values got from notebook
 111 def ParseParameters(*args):
 112     Result = []
 113     Parameters = ""
 114     hasVariables = False
 115     varModifFun=None
 116     if args and callable( args[-1] ):
 117         args, varModifFun = args[:-1], args[-1]
 118     for parameter in args:
 119
 120         Parameters += str(parameter) + var_separator
 121
 122         if isinstance(parameter,str):
 123             # check if there is an inexistent variable name
 124             if not notebook.isVariable(parameter):
 125                 raise ValueError, "Variable with name '" + parameter + "' doesn't exist!!!"
 126             parameter = notebook.get(parameter)
 127             hasVariables = True
 128             if varModifFun:
 129                 parameter = varModifFun(parameter)
 130                 pass
 131             pass
 132         Result.append(parameter)
 133
 134         pass
 135     Parameters = Parameters[:-1]
 136     Result.append( Parameters )
 137     Result.append( hasVariables )
 138     return Result
 139
 140 # Parse parameters converting variables to radians
 141 def ParseAngles(*args):
 142     return ParseParameters( *( args + (DegreesToRadians, )))
 143
 144 # Substitute PointStruct.__init__() to create SMESH.PointStruct using notebook variables.
 145 # Parameters are stored in PointStruct.parameters attribute
 146 def __initPointStruct(point,*args):
 147     point.x, point.y, point.z, point.parameters,hasVars = ParseParameters(*args)
 148     pass
 149 SMESH.PointStruct.__init__ = __initPointStruct
 150
 151 # Substitute AxisStruct.__init__() to create SMESH.AxisStruct using notebook variables.
 152 # Parameters are stored in AxisStruct.parameters attribute
 153 def __initAxisStruct(ax,*args):
 154     ax.x, ax.y, ax.z, ax.vx, ax.vy, ax.vz, ax.parameters,hasVars = ParseParameters(*args)
 155     pass
 156 SMESH.AxisStruct.__init__ = __initAxisStruct
 157
 158 smeshPrecisionConfusion = 1.e-07
 159 def IsEqual(val1, val2, tol=smeshPrecisionConfusion):
 160     if abs(val1 - val2) < tol:
 161         return True
 162     return False
 163
 164 NO_NAME = "NoName"
 165
 166 ## Gets object name
 167 def GetName(obj):
 168     if obj:
 169         # object not null
 170         if isinstance(obj, SALOMEDS._objref_SObject):
 171             # study object
 172             return obj.GetName()
 173         try:
 174             ior  = salome.orb.object_to_string(obj)
 175         except:
 176             ior = None
 177         if ior:
 178             # CORBA object
 179             studies = salome.myStudyManager.GetOpenStudies()
 180             for sname in studies:
 181                 s = salome.myStudyManager.GetStudyByName(sname)
 182                 if not s: continue
 183                 sobj = s.FindObjectIOR(ior)
 184                 if not sobj: continue
 185                 return sobj.GetName()
 186             if hasattr(obj, "GetName"):
 187                 # unknown CORBA object, having GetName() method
 188                 return obj.GetName()
 189             else:
 190                 # unknown CORBA object, no GetName() method
 191                 return NO_NAME
 192             pass
 193         if hasattr(obj, "GetName"):
 194             # unknown non-CORBA object, having GetName() method
 195             return obj.GetName()
 196         pass
 197     raise RuntimeError, "Null or invalid object"
 198
 199 ## Prints error message if a hypothesis was not assigned.
 200 def TreatHypoStatus(status, hypName, geomName, isAlgo):
 201     if isAlgo:
 202         hypType = "algorithm"
 203     else:
 204         hypType = "hypothesis"
 205         pass
 206     if status == HYP_UNKNOWN_FATAL :
 207         reason = "for unknown reason"
 208     elif status == HYP_INCOMPATIBLE :
 209         reason = "this hypothesis mismatches the algorithm"
 210     elif status == HYP_NOTCONFORM :
 211         reason = "a non-conform mesh would be built"
 212     elif status == HYP_ALREADY_EXIST :
 213         if isAlgo: return # it does not influence anything
 214         reason = hypType + " of the same dimension is already assigned to this shape"
 215     elif status == HYP_BAD_DIM :
 216         reason = hypType + " mismatches the shape"
 217     elif status == HYP_CONCURENT :
 218         reason = "there are concurrent hypotheses on sub-shapes"
 219     elif status == HYP_BAD_SUBSHAPE :
 220         reason = "the shape is neither the main one, nor its sub-shape, nor a valid group"
 221     elif status == HYP_BAD_GEOMETRY:
 222         reason = "geometry mismatches the expectation of the algorithm"
 223     elif status == HYP_HIDDEN_ALGO:
 224         reason = "it is hidden by an algorithm of an upper dimension, which generates elements of all dimensions"
 225     elif status == HYP_HIDING_ALGO:
 226         reason = "it hides algorithms of lower dimensions by generating elements of all dimensions"
 227     elif status == HYP_NEED_SHAPE:
 228         reason = "Algorithm can't work without shape"
 229     else:
 230         return
 231     hypName = '"' + hypName + '"'
 232     geomName= '"' + geomName+ '"'
 233     if status < HYP_UNKNOWN_FATAL and not geomName =='""':
 234         print hypName, "was assigned to",    geomName,"but", reason
 235     elif not geomName == '""':
 236         print hypName, "was not assigned to",geomName,":", reason
 237     else:
 238         print hypName, "was not assigned:", reason
 239         pass
 240
 241 ## Private method. Add geom (sub-shape of the main shape) into the study if not yet there
 242 def AssureGeomPublished(mesh, geom, name=''):
 243     if not isinstance( geom, geomBuilder.GEOM._objref_GEOM_Object ):
 244         return
 245     if not geom.GetStudyEntry() and \
 246            mesh.smeshpyD.GetCurrentStudy():
 247         ## set the study
 248         studyID = mesh.smeshpyD.GetCurrentStudy()._get_StudyId()
 249         if studyID != mesh.geompyD.myStudyId:
 250             mesh.geompyD.init_geom( mesh.smeshpyD.GetCurrentStudy())
 251         ## get a name
 252         if not name and geom.GetShapeType() != geomBuilder.GEOM.COMPOUND:
 253             # for all groups SubShapeName() returns "Compound_-1"
 254             name = mesh.geompyD.SubShapeName(geom, mesh.geom)
 255         if not name:
 256             name = "%s_%s"%(geom.GetShapeType(), id(geom)%10000)
 257         ## publish
 258         mesh.geompyD.addToStudyInFather( mesh.geom, geom, name )
 259     return
 260
 261 ## Return the first vertex of a geometrical edge by ignoring orientation
 262 def FirstVertexOnCurve(mesh, edge):
 263     vv = mesh.geompyD.SubShapeAll( edge, geomBuilder.geomBuilder.ShapeType["VERTEX"])
 264     if not vv:
 265         raise TypeError, "Given object has no vertices"
 266     if len( vv ) == 1: return vv[0]
 267     v0   = mesh.geompyD.MakeVertexOnCurve(edge,0.)
 268     xyz  = mesh.geompyD.PointCoordinates( v0 ) # coords of the first vertex
 269     xyz1 = mesh.geompyD.PointCoordinates( vv[0] )
 270     xyz2 = mesh.geompyD.PointCoordinates( vv[1] )
 271     dist1, dist2 = 0,0
 272     for i in range(3):
 273         dist1 += abs( xyz[i] - xyz1[i] )
 274         dist2 += abs( xyz[i] - xyz2[i] )
 275     if dist1 < dist2:
 276         return vv[0]
 277     else:
 278         return vv[1]
 279
 280 # end of l1_auxiliary
 281 ## @}
 282
 283
 284 # Warning: smeshInst is a singleton
 285 smeshInst = None
 286 engine = None
 287 doLcc = False
 288 created = False
 289
 290 ## This class allows to create, load or manipulate meshes
 291 #  It has a set of methods to create load or copy meshes, to combine several meshes.
 292 #  It also has methods to get infos on meshes.
 293 class smeshBuilder(object, SMESH._objref_SMESH_Gen):
 294
 295     # MirrorType enumeration
 296     POINT = SMESH_MeshEditor.POINT
 297     AXIS =  SMESH_MeshEditor.AXIS
 298     PLANE = SMESH_MeshEditor.PLANE
 299
 300     # Smooth_Method enumeration
 301     LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH
 302     CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH
 303
 304     PrecisionConfusion = smeshPrecisionConfusion
 305
 306     # TopAbs_State enumeration
 307     [TopAbs_IN, TopAbs_OUT, TopAbs_ON, TopAbs_UNKNOWN] = range(4)
 308
 309     # Methods of splitting a hexahedron into tetrahedra
 310     Hex_5Tet, Hex_6Tet, Hex_24Tet = 1, 2, 3
 311
 312     def __new__(cls):
 313         global engine
 314         global smeshInst
 315         global doLcc
 316         #print "==== __new__", engine, smeshInst, doLcc
 317
 318         if smeshInst is None:
 319             # smesh engine is either retrieved from engine, or created
 320             smeshInst = engine
 321             # Following test avoids a recursive loop
 322             if doLcc:
 323                 if smeshInst is not None:
 324                     # smesh engine not created: existing engine found
 325                     doLcc = False
 326                 if doLcc:
 327                     doLcc = False
 328                     # FindOrLoadComponent called:
 329                     # 1. CORBA resolution of server
 330                     # 2. the __new__ method is called again
 331                     #print "==== smeshInst = lcc.FindOrLoadComponent ", engine, smeshInst, doLcc
 332                     smeshInst = salome.lcc.FindOrLoadComponent( "FactoryServer", "SMESH" )
 333             else:
 334                 # FindOrLoadComponent not called
 335                 if smeshInst is None:
 336                     # smeshBuilder instance is created from lcc.FindOrLoadComponent
 337                     #print "==== smeshInst = super(smeshBuilder,cls).__new__(cls) ", engine, smeshInst, doLcc
 338                     smeshInst = super(smeshBuilder,cls).__new__(cls)
 339                 else:
 340                     # smesh engine not created: existing engine found
 341                     #print "==== existing ", engine, smeshInst, doLcc
 342                     pass
 343             #print "====1 ", smeshInst
 344             return smeshInst
 345
 346         #print "====2 ", smeshInst
 347         return smeshInst
 348
 349     def __init__(self):
 350         global created
 351         #print "--------------- smeshbuilder __init__ ---", created
 352         if not created:
 353           created = True
 354           SMESH._objref_SMESH_Gen.__init__(self)
 355
 356     ## Dump component to the Python script
 357     #  This method overrides IDL function to allow default values for the parameters.
 358     def DumpPython(self, theStudy, theIsPublished=True, theIsMultiFile=True):
 359         return SMESH._objref_SMESH_Gen.DumpPython(self, theStudy, theIsPublished, theIsMultiFile)
 360
 361     ## Set mode of DumpPython(), \a historical or \a snapshot.
 362     # In the \a historical mode, the Python Dump script includes all commands
 363     # performed by SMESH engine. In the \a snapshot mode, commands
 364     # relating to objects removed from the Study are excluded from the script
 365     # as well as commands not influencing the current state of meshes
 366     def SetDumpPythonHistorical(self, isHistorical):
 367         if isHistorical: val = "true"
 368         else:            val = "false"
 369         SMESH._objref_SMESH_Gen.SetOption(self, "historical_python_dump", val)
 370
 371     ## Sets the current study and Geometry component
 372     #  @ingroup l1_auxiliary
 373     def init_smesh(self,theStudy,geompyD = None):
 374         #print "init_smesh"
 375         self.SetCurrentStudy(theStudy,geompyD)
 376
 377     ## Creates an empty Mesh. This mesh can have an underlying geometry.
 378     #  @param obj the Geometrical object on which the mesh is built. If not defined,
 379     #             the mesh will have no underlying geometry.
 380     #  @param name the name for the new mesh.
 381     #  @return an instance of Mesh class.
 382     #  @ingroup l2_construct
 383     def Mesh(self, obj=0, name=0):
 384         if isinstance(obj,str):
 385             obj,name = name,obj
 386         return Mesh(self,self.geompyD,obj,name)
 387
 388     ## Returns a long value from enumeration
 389     #  @ingroup l1_controls
 390     def EnumToLong(self,theItem):
 391         return theItem._v
 392
 393     ## Returns a string representation of the color.
 394     #  To be used with filters.
 395     #  @param c color value (SALOMEDS.Color)
 396     #  @ingroup l1_controls
 397     def ColorToString(self,c):
 398         val = ""
 399         if isinstance(c, SALOMEDS.Color):
 400             val = "%s;%s;%s" % (c.R, c.G, c.B)
 401         elif isinstance(c, str):
 402             val = c
 403         else:
 404             raise ValueError, "Color value should be of string or SALOMEDS.Color type"
 405         return val
 406
 407     ## Gets PointStruct from vertex
 408     #  @param theVertex a GEOM object(vertex)
 409     #  @return SMESH.PointStruct
 410     #  @ingroup l1_auxiliary
 411     def GetPointStruct(self,theVertex):
 412         [x, y, z] = self.geompyD.PointCoordinates(theVertex)
 413         return PointStruct(x,y,z)
 414
 415     ## Gets DirStruct from vector
 416     #  @param theVector a GEOM object(vector)
 417     #  @return SMESH.DirStruct
 418     #  @ingroup l1_auxiliary
 419     def GetDirStruct(self,theVector):
 420         vertices = self.geompyD.SubShapeAll( theVector, geomBuilder.geomBuilder.ShapeType["VERTEX"] )
 421         if(len(vertices) != 2):
 422             print "Error: vector object is incorrect."
 423             return None
 424         p1 = self.geompyD.PointCoordinates(vertices[0])
 425         p2 = self.geompyD.PointCoordinates(vertices[1])
 426         pnt = PointStruct(p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2])
 427         dirst = DirStruct(pnt)
 428         return dirst
 429
 430     ## Makes DirStruct from a triplet
 431     #  @param x,y,z vector components
 432     #  @return SMESH.DirStruct
 433     #  @ingroup l1_auxiliary
 434     def MakeDirStruct(self,x,y,z):
 435         pnt = PointStruct(x,y,z)
 436         return DirStruct(pnt)
 437
 438     ## Get AxisStruct from object
 439     #  @param theObj a GEOM object (line or plane)
 440     #  @return SMESH.AxisStruct
 441     #  @ingroup l1_auxiliary
 442     def GetAxisStruct(self,theObj):
 443         edges = self.geompyD.SubShapeAll( theObj, geomBuilder.geomBuilder.ShapeType["EDGE"] )
 444         if len(edges) > 1:
 445             vertex1, vertex2 = self.geompyD.SubShapeAll( edges[0], geomBuilder.geomBuilder.ShapeType["VERTEX"] )
 446             vertex3, vertex4 = self.geompyD.SubShapeAll( edges[1], geomBuilder.geomBuilder.ShapeType["VERTEX"] )
 447             vertex1 = self.geompyD.PointCoordinates(vertex1)
 448             vertex2 = self.geompyD.PointCoordinates(vertex2)
 449             vertex3 = self.geompyD.PointCoordinates(vertex3)
 450             vertex4 = self.geompyD.PointCoordinates(vertex4)
 451             v1 = [vertex2[0]-vertex1[0], vertex2[1]-vertex1[1], vertex2[2]-vertex1[2]]
 452             v2 = [vertex4[0]-vertex3[0], vertex4[1]-vertex3[1], vertex4[2]-vertex3[2]]
 453             normal = [ v1[1]*v2[2]-v2[1]*v1[2], v1[2]*v2[0]-v2[2]*v1[0], v1[0]*v2[1]-v2[0]*v1[1] ]
 454             axis = AxisStruct(vertex1[0], vertex1[1], vertex1[2], normal[0], normal[1], normal[2])
 455             return axis
 456         elif len(edges) == 1:
 457             vertex1, vertex2 = self.geompyD.SubShapeAll( edges[0], geomBuilder.geomBuilder.ShapeType["VERTEX"] )
 458             p1 = self.geompyD.PointCoordinates( vertex1 )
 459             p2 = self.geompyD.PointCoordinates( vertex2 )
 460             axis = AxisStruct(p1[0], p1[1], p1[2], p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2])
 461             return axis
 462         return None
 463
 464     # From SMESH_Gen interface:
 465     # ------------------------
 466
 467     ## Sets the given name to the object
 468     #  @param obj the object to rename
 469     #  @param name a new object name
 470     #  @ingroup l1_auxiliary
 471     def SetName(self, obj, name):
 472         if isinstance( obj, Mesh ):
 473             obj = obj.GetMesh()
 474         elif isinstance( obj, Mesh_Algorithm ):
 475             obj = obj.GetAlgorithm()
 476         ior  = salome.orb.object_to_string(obj)
 477         SMESH._objref_SMESH_Gen.SetName(self, ior, name)
 478
 479     ## Sets the current mode
 480     #  @ingroup l1_auxiliary
 481     def SetEmbeddedMode( self,theMode ):
 482         #self.SetEmbeddedMode(theMode)
 483         SMESH._objref_SMESH_Gen.SetEmbeddedMode(self,theMode)
 484
 485     ## Gets the current mode
 486     #  @ingroup l1_auxiliary
 487     def IsEmbeddedMode(self):
 488         #return self.IsEmbeddedMode()
 489         return SMESH._objref_SMESH_Gen.IsEmbeddedMode(self)
 490
 491     ## Sets the current study
 492     #  @ingroup l1_auxiliary
 493     def SetCurrentStudy( self, theStudy, geompyD = None ):
 494         #self.SetCurrentStudy(theStudy)
 495         if not geompyD:
 496             from salome.geom import geomBuilder
 497             geompyD = geomBuilder.geom
 498             pass
 499         self.geompyD=geompyD
 500         self.SetGeomEngine(geompyD)
 501         SMESH._objref_SMESH_Gen.SetCurrentStudy(self,theStudy)
 502         global notebook
 503         if theStudy:
 504             notebook = salome_notebook.NoteBook( theStudy )
 505         else:
 506             notebook = salome_notebook.NoteBook( salome_notebook.PseudoStudyForNoteBook() )
 507
 508     ## Gets the current study
 509     #  @ingroup l1_auxiliary
 510     def GetCurrentStudy(self):
 511         #return self.GetCurrentStudy()
 512         return SMESH._objref_SMESH_Gen.GetCurrentStudy(self)
 513
 514     ## Creates a Mesh object importing data from the given UNV file
 515     #  @return an instance of Mesh class
 516     #  @ingroup l2_impexp
 517     def CreateMeshesFromUNV( self,theFileName ):
 518         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromUNV(self,theFileName)
 519         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
 520         return aMesh
 521
 522     ## Creates a Mesh object(s) importing data from the given MED file
 523     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
 524     #  @ingroup l2_impexp
 525     def CreateMeshesFromMED( self,theFileName ):
 526         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromMED(self,theFileName)
 527         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
 528         return aMeshes, aStatus
 529
 530     ## Creates a Mesh object(s) importing data from the given SAUV file
 531     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
 532     #  @ingroup l2_impexp
 533     def CreateMeshesFromSAUV( self,theFileName ):
 534         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromSAUV(self,theFileName)
 535         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
 536         return aMeshes, aStatus
 537
 538     ## Creates a Mesh object importing data from the given STL file
 539     #  @return an instance of Mesh class
 540     #  @ingroup l2_impexp
 541     def CreateMeshesFromSTL( self, theFileName ):
 542         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromSTL(self,theFileName)
 543         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
 544         return aMesh
 545
 546     ## Creates Mesh objects importing data from the given CGNS file
 547     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
 548     #  @ingroup l2_impexp
 549     def CreateMeshesFromCGNS( self, theFileName ):
 550         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromCGNS(self,theFileName)
 551         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
 552         return aMeshes, aStatus
 553
 554     ## Creates a Mesh object importing data from the given GMF file
 555     #  @return [ an instance of Mesh class, SMESH.ComputeError ]
 556     #  @ingroup l2_impexp
 557     def CreateMeshesFromGMF( self, theFileName ):
 558         aSmeshMesh, error = SMESH._objref_SMESH_Gen.CreateMeshesFromGMF(self,
 559                                                                         theFileName,
 560                                                                         True)
 561         if error.comment: print "*** CreateMeshesFromGMF() errors:\n", error.comment
 562         return Mesh(self, self.geompyD, aSmeshMesh), error
 563
 564     ## Concatenate the given meshes into one mesh.
 565     #  @return an instance of Mesh class
 566     #  @param meshes the meshes to combine into one mesh
 567     #  @param uniteIdenticalGroups if true, groups with same names are united, else they are renamed
 568     #  @param mergeNodesAndElements if true, equal nodes and elements aremerged
 569     #  @param mergeTolerance tolerance for merging nodes
 570     #  @param allGroups forces creation of groups of all elements
 571     #  @param name name of a new mesh
 572     def Concatenate( self, meshes, uniteIdenticalGroups,
 573                      mergeNodesAndElements = False, mergeTolerance = 1e-5, allGroups = False,
 574                      name = ""):
 575         if not meshes: return None
 576         for i,m in enumerate(meshes):
 577             if isinstance(m, Mesh):
 578                 meshes[i] = m.GetMesh()
 579         mergeTolerance,Parameters,hasVars = ParseParameters(mergeTolerance)
 580         meshes[0].SetParameters(Parameters)
 581         if allGroups:
 582             aSmeshMesh = SMESH._objref_SMESH_Gen.ConcatenateWithGroups(
 583                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
 584         else:
 585             aSmeshMesh = SMESH._objref_SMESH_Gen.Concatenate(
 586                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
 587         aMesh = Mesh(self, self.geompyD, aSmeshMesh, name=name)
 588         return aMesh
 589
 590     ## Create a mesh by copying a part of another mesh.
 591     #  @param meshPart a part of mesh to copy, either a Mesh, a sub-mesh or a group;
 592     #                  to copy nodes or elements not contained in any mesh object,
 593     #                  pass result of Mesh.GetIDSource( list_of_ids, type ) as meshPart
 594     #  @param meshName a name of the new mesh
 595     #  @param toCopyGroups to create in the new mesh groups the copied elements belongs to
 596     #  @param toKeepIDs to preserve IDs of the copied elements or not
 597     #  @return an instance of Mesh class
 598     def CopyMesh( self, meshPart, meshName, toCopyGroups=False, toKeepIDs=False):
 599         if (isinstance( meshPart, Mesh )):
 600             meshPart = meshPart.GetMesh()
 601         mesh = SMESH._objref_SMESH_Gen.CopyMesh( self,meshPart,meshName,toCopyGroups,toKeepIDs )
 602         return Mesh(self, self.geompyD, mesh)
 603
 604     ## From SMESH_Gen interface
 605     #  @return the list of integer values
 606     #  @ingroup l1_auxiliary
 607     def GetSubShapesId( self, theMainObject, theListOfSubObjects ):
 608         return SMESH._objref_SMESH_Gen.GetSubShapesId(self,theMainObject, theListOfSubObjects)
 609
 610     ## From SMESH_Gen interface. Creates a pattern
 611     #  @return an instance of SMESH_Pattern
 612     #
 613     #  <a href="../tui_modifying_meshes_page.html#tui_pattern_mapping">Example of Patterns usage</a>
 614     #  @ingroup l2_modif_patterns
 615     def GetPattern(self):
 616         return SMESH._objref_SMESH_Gen.GetPattern(self)
 617
 618     ## Sets number of segments per diagonal of boundary box of geometry by which
 619     #  default segment length of appropriate 1D hypotheses is defined.
 620     #  Default value is 10
 621     #  @ingroup l1_auxiliary
 622     def SetBoundaryBoxSegmentation(self, nbSegments):
 623         SMESH._objref_SMESH_Gen.SetBoundaryBoxSegmentation(self,nbSegments)
 624
 625     # Filtering. Auxiliary functions:
 626     # ------------------------------
 627
 628     ## Creates an empty criterion
 629     #  @return SMESH.Filter.Criterion
 630     #  @ingroup l1_controls
 631     def GetEmptyCriterion(self):
 632         Type = self.EnumToLong(FT_Undefined)
 633         Compare = self.EnumToLong(FT_Undefined)
 634         Threshold = 0
 635         ThresholdStr = ""
 636         ThresholdID = ""
 637         UnaryOp = self.EnumToLong(FT_Undefined)
 638         BinaryOp = self.EnumToLong(FT_Undefined)
 639         Tolerance = 1e-07
 640         TypeOfElement = ALL
 641         Precision = -1 ##@1e-07
 642         return Filter.Criterion(Type, Compare, Threshold, ThresholdStr, ThresholdID,
 643                                 UnaryOp, BinaryOp, Tolerance, TypeOfElement, Precision)
 644
 645     ## Creates a criterion by the given parameters
 646     #  \n Criterion structures allow to define complex filters by combining them with logical operations (AND / OR) (see example below)
 647     #  @param elementType the type of elements(NODE, EDGE, FACE, VOLUME)
 648     #  @param CritType the type of criterion (FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc.)
 649     #  @param Compare  belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
 650     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
 651     #  @param UnaryOp  FT_LogicalNOT or FT_Undefined
 652     #  @param BinaryOp a binary logical operation FT_LogicalAND, FT_LogicalOR or
 653     #                  FT_Undefined (must be for the last criterion of all criteria)
 654     #  @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface,
 655     #         FT_LyingOnGeom, FT_CoplanarFaces criteria
 656     #  @return SMESH.Filter.Criterion
 657     #
 658     #  <a href="../tui_filters_page.html#combining_filters">Example of Criteria usage</a>
 659     #  @ingroup l1_controls
 660     def GetCriterion(self,elementType,
 661                      CritType,
 662                      Compare = FT_EqualTo,
 663                      Threshold="",
 664                      UnaryOp=FT_Undefined,
 665                      BinaryOp=FT_Undefined,
 666                      Tolerance=1e-07):
 667         if not CritType in SMESH.FunctorType._items:
 668             raise TypeError, "CritType should be of SMESH.FunctorType"
 669         aCriterion               = self.GetEmptyCriterion()
 670         aCriterion.TypeOfElement = elementType
 671         aCriterion.Type          = self.EnumToLong(CritType)
 672         aCriterion.Tolerance     = Tolerance
 673
 674         aThreshold = Threshold
 675
 676         if Compare in [FT_LessThan, FT_MoreThan, FT_EqualTo]:
 677             aCriterion.Compare = self.EnumToLong(Compare)
 678         elif Compare == "=" or Compare == "==":
 679             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
 680         elif Compare == "<":
 681             aCriterion.Compare = self.EnumToLong(FT_LessThan)
 682         elif Compare == ">":
 683             aCriterion.Compare = self.EnumToLong(FT_MoreThan)
 684         elif Compare != FT_Undefined:
 685             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
 686             aThreshold = Compare
 687
 688         if CritType in [FT_BelongToGeom,     FT_BelongToPlane, FT_BelongToGenSurface,
 689                         FT_BelongToCylinder, FT_LyingOnGeom]:
 690             # Checks that Threshold is GEOM object
 691             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object):
 692                 aCriterion.ThresholdStr = GetName(aThreshold)
 693                 aCriterion.ThresholdID  = aThreshold.GetStudyEntry()
 694                 if not aCriterion.ThresholdID:
 695                     name = aCriterion.ThresholdStr
 696                     if not name:
 697                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
 698                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
 699                     #raise RuntimeError, "Threshold shape must be published"
 700             else:
 701                 print "Error: The Threshold should be a shape."
 702                 return None
 703             if isinstance(UnaryOp,float):
 704                 aCriterion.Tolerance = UnaryOp
 705                 UnaryOp = FT_Undefined
 706                 pass
 707         elif CritType == FT_RangeOfIds:
 708             # Checks that Threshold is string
 709             if isinstance(aThreshold, str):
 710                 aCriterion.ThresholdStr = aThreshold
 711             else:
 712                 print "Error: The Threshold should be a string."
 713                 return None
 714         elif CritType == FT_CoplanarFaces:
 715             # Checks the Threshold
 716             if isinstance(aThreshold, int):
 717                 aCriterion.ThresholdID = str(aThreshold)
 718             elif isinstance(aThreshold, str):
 719                 ID = int(aThreshold)
 720                 if ID < 1:
 721                     raise ValueError, "Invalid ID of mesh face: '%s'"%aThreshold
 722                 aCriterion.ThresholdID = aThreshold
 723             else:
 724                 raise ValueError,\
 725                       "The Threshold should be an ID of mesh face and not '%s'"%aThreshold
 726         elif CritType == FT_ConnectedElements:
 727             # Checks the Threshold
 728             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object): # shape
 729                 aCriterion.ThresholdID = aThreshold.GetStudyEntry()
 730                 if not aCriterion.ThresholdID:
 731                     name = aThreshold.GetName()
 732                     if not name:
 733                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
 734                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
 735             elif isinstance(aThreshold, int): # node id
 736                 aCriterion.Threshold = aThreshold
 737             elif isinstance(aThreshold, list): # 3 point coordinates
 738                 if len( aThreshold ) < 3:
 739                     raise ValueError, "too few point coordinates, must be 3"
 740                 aCriterion.ThresholdStr = " ".join( [str(c) for c in aThreshold[:3]] )
 741             elif isinstance(aThreshold, str):
 742                 if aThreshold.isdigit():
 743                     aCriterion.Threshold = aThreshold # node id
 744                 else:
 745                     aCriterion.ThresholdStr = aThreshold # hope that it's point coordinates
 746             else:
 747                 raise ValueError,\
 748                       "The Threshold should either a VERTEX, or a node ID, "\
 749                       "or a list of point coordinates and not '%s'"%aThreshold
 750         elif CritType == FT_ElemGeomType:
 751             # Checks the Threshold
 752             try:
 753                 aCriterion.Threshold = self.EnumToLong(aThreshold)
 754                 assert( aThreshold in SMESH.GeometryType._items )
 755             except:
 756                 if isinstance(aThreshold, int):
 757                     aCriterion.Threshold = aThreshold
 758                 else:
 759                     print "Error: The Threshold should be an integer or SMESH.GeometryType."
 760                     return None
 761                 pass
 762             pass
 763         elif CritType == FT_EntityType:
 764             # Checks the Threshold
 765             try:
 766                 aCriterion.Threshold = self.EnumToLong(aThreshold)
 767                 assert( aThreshold in SMESH.EntityType._items )
 768             except:
 769                 if isinstance(aThreshold, int):
 770                     aCriterion.Threshold = aThreshold
 771                 else:
 772                     print "Error: The Threshold should be an integer or SMESH.EntityType."
 773                     return None
 774                 pass
 775             pass
 776
 777         elif CritType == FT_GroupColor:
 778             # Checks the Threshold
 779             try:
 780                 aCriterion.ThresholdStr = self.ColorToString(aThreshold)
 781             except:
 782                 print "Error: The threshold value should be of SALOMEDS.Color type"
 783                 return None
 784             pass
 785         elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_FreeNodes, FT_FreeFaces,
 786                           FT_LinearOrQuadratic, FT_BadOrientedVolume,
 787                           FT_BareBorderFace, FT_BareBorderVolume,
 788                           FT_OverConstrainedFace, FT_OverConstrainedVolume,
 789                           FT_EqualNodes,FT_EqualEdges,FT_EqualFaces,FT_EqualVolumes ]:
 790             # At this point the Threshold is unnecessary
 791             if aThreshold ==  FT_LogicalNOT:
 792                 aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
 793             elif aThreshold in [FT_LogicalAND, FT_LogicalOR]:
 794                 aCriterion.BinaryOp = aThreshold
 795         else:
 796             # Check Threshold
 797             try:
 798                 aThreshold = float(aThreshold)
 799                 aCriterion.Threshold = aThreshold
 800             except:
 801                 print "Error: The Threshold should be a number."
 802                 return None
 803
 804         if Threshold ==  FT_LogicalNOT or UnaryOp ==  FT_LogicalNOT:
 805             aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
 806
 807         if Threshold in [FT_LogicalAND, FT_LogicalOR]:
 808             aCriterion.BinaryOp = self.EnumToLong(Threshold)
 809
 810         if UnaryOp in [FT_LogicalAND, FT_LogicalOR]:
 811             aCriterion.BinaryOp = self.EnumToLong(UnaryOp)
 812
 813         if BinaryOp in [FT_LogicalAND, FT_LogicalOR]:
 814             aCriterion.BinaryOp = self.EnumToLong(BinaryOp)
 815
 816         return aCriterion
 817
 818     ## Creates a filter with the given parameters
 819     #  @param elementType the type of elements in the group
 820     #  @param CritType the type of criterion ( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
 821     #  @param Compare  belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
 822     #  @param Threshold the threshold value (range of id ids as string, shape, numeric)
 823     #  @param UnaryOp  FT_LogicalNOT or FT_Undefined
 824     #  @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface,
 825     #         FT_LyingOnGeom, FT_CoplanarFaces and FT_EqualNodes criteria
 826     #  @param mesh the mesh to initialize the filter with
 827     #  @return SMESH_Filter
 828     #
 829     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
 830     #  @ingroup l1_controls
 831     def GetFilter(self,elementType,
 832                   CritType=FT_Undefined,
 833                   Compare=FT_EqualTo,
 834                   Threshold="",
 835                   UnaryOp=FT_Undefined,
 836                   Tolerance=1e-07,
 837                   mesh=None):
 838         aCriterion = self.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
 839         aFilterMgr = self.CreateFilterManager()
 840         aFilter = aFilterMgr.CreateFilter()
 841         aCriteria = []
 842         aCriteria.append(aCriterion)
 843         aFilter.SetCriteria(aCriteria)
 844         if mesh:
 845             if isinstance( mesh, Mesh ): aFilter.SetMesh( mesh.GetMesh() )
 846             else                       : aFilter.SetMesh( mesh )
 847         aFilterMgr.UnRegister()
 848         return aFilter
 849
 850     ## Creates a filter from criteria
 851     #  @param criteria a list of criteria
 852     #  @return SMESH_Filter
 853     #
 854     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
 855     #  @ingroup l1_controls
 856     def GetFilterFromCriteria(self,criteria):
 857         aFilterMgr = self.CreateFilterManager()
 858         aFilter = aFilterMgr.CreateFilter()
 859         aFilter.SetCriteria(criteria)
 860         aFilterMgr.UnRegister()
 861         return aFilter
 862
 863     ## Creates a numerical functor by its type
 864     #  @param theCriterion FT_...; functor type
 865     #  @return SMESH_NumericalFunctor
 866     #  @ingroup l1_controls
 867     def GetFunctor(self,theCriterion):
 868         if isinstance( theCriterion, SMESH._objref_NumericalFunctor ):
 869             return theCriterion
 870         aFilterMgr = self.CreateFilterManager()
 871         functor = None
 872         if theCriterion == FT_AspectRatio:
 873             functor = aFilterMgr.CreateAspectRatio()
 874         elif theCriterion == FT_AspectRatio3D:
 875             functor = aFilterMgr.CreateAspectRatio3D()
 876         elif theCriterion == FT_Warping:
 877             functor = aFilterMgr.CreateWarping()
 878         elif theCriterion == FT_MinimumAngle:
 879             functor = aFilterMgr.CreateMinimumAngle()
 880         elif theCriterion == FT_Taper:
 881             functor = aFilterMgr.CreateTaper()
 882         elif theCriterion == FT_Skew:
 883             functor = aFilterMgr.CreateSkew()
 884         elif theCriterion == FT_Area:
 885             functor = aFilterMgr.CreateArea()
 886         elif theCriterion == FT_Volume3D:
 887             functor = aFilterMgr.CreateVolume3D()
 888         elif theCriterion == FT_MaxElementLength2D:
 889             functor = aFilterMgr.CreateMaxElementLength2D()
 890         elif theCriterion == FT_MaxElementLength3D:
 891             functor = aFilterMgr.CreateMaxElementLength3D()
 892         elif theCriterion == FT_MultiConnection:
 893             functor = aFilterMgr.CreateMultiConnection()
 894         elif theCriterion == FT_MultiConnection2D:
 895             functor = aFilterMgr.CreateMultiConnection2D()
 896         elif theCriterion == FT_Length:
 897             functor = aFilterMgr.CreateLength()
 898         elif theCriterion == FT_Length2D:
 899             functor = aFilterMgr.CreateLength2D()
 900         else:
 901             print "Error: given parameter is not numerical functor type."
 902         aFilterMgr.UnRegister()
 903         return functor
 904
 905     ## Creates hypothesis
 906     #  @param theHType mesh hypothesis type (string)
 907     #  @param theLibName mesh plug-in library name
 908     #  @return created hypothesis instance
 909     def CreateHypothesis(self, theHType, theLibName="libStdMeshersEngine.so"):
 910         hyp = SMESH._objref_SMESH_Gen.CreateHypothesis(self, theHType, theLibName )
 911
 912         if isinstance( hyp, SMESH._objref_SMESH_Algo ):
 913             return hyp
 914
 915         # wrap hypothesis methods
 916         #print "HYPOTHESIS", theHType
 917         for meth_name in dir( hyp.__class__ ):
 918             if not meth_name.startswith("Get") and \
 919                not meth_name in dir ( SMESH._objref_SMESH_Hypothesis ):
 920                 method = getattr ( hyp.__class__, meth_name )
 921                 if callable(method):
 922                     setattr( hyp, meth_name, hypMethodWrapper( hyp, method ))
 923
 924         return hyp
 925
 926     ## Gets the mesh statistic
 927     #  @return dictionary "element type" - "count of elements"
 928     #  @ingroup l1_meshinfo
 929     def GetMeshInfo(self, obj):
 930         if isinstance( obj, Mesh ):
 931             obj = obj.GetMesh()
 932         d = {}
 933         if hasattr(obj, "GetMeshInfo"):
 934             values = obj.GetMeshInfo()
 935             for i in range(SMESH.Entity_Last._v):
 936                 if i < len(values): d[SMESH.EntityType._item(i)]=values[i]
 937             pass
 938         return d
 939
 940     ## Get minimum distance between two objects
 941     #
 942     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
 943     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
 944     #
 945     #  @param src1 first source object
 946     #  @param src2 second source object
 947     #  @param id1 node/element id from the first source
 948     #  @param id2 node/element id from the second (or first) source
 949     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
 950     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
 951     #  @return minimum distance value
 952     #  @sa GetMinDistance()
 953     #  @ingroup l1_measurements
 954     def MinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
 955         result = self.GetMinDistance(src1, src2, id1, id2, isElem1, isElem2)
 956         if result is None:
 957             result = 0.0
 958         else:
 959             result = result.value
 960         return result
 961
 962     ## Get measure structure specifying minimum distance data between two objects
 963     #
 964     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
 965     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
 966     #
 967     #  @param src1 first source object
 968     #  @param src2 second source object
 969     #  @param id1 node/element id from the first source
 970     #  @param id2 node/element id from the second (or first) source
 971     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
 972     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
 973     #  @return Measure structure or None if input data is invalid
 974     #  @sa MinDistance()
 975     #  @ingroup l1_measurements
 976     def GetMinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
 977         if isinstance(src1, Mesh): src1 = src1.mesh
 978         if isinstance(src2, Mesh): src2 = src2.mesh
 979         if src2 is None and id2 != 0: src2 = src1
 980         if not hasattr(src1, "_narrow"): return None
 981         src1 = src1._narrow(SMESH.SMESH_IDSource)
 982         if not src1: return None
 983         if id1 != 0:
 984             m = src1.GetMesh()
 985             e = m.GetMeshEditor()
 986             if isElem1:
 987                 src1 = e.MakeIDSource([id1], SMESH.FACE)
 988             else:
 989                 src1 = e.MakeIDSource([id1], SMESH.NODE)
 990             pass
 991         if hasattr(src2, "_narrow"):
 992             src2 = src2._narrow(SMESH.SMESH_IDSource)
 993             if src2 and id2 != 0:
 994                 m = src2.GetMesh()
 995                 e = m.GetMeshEditor()
 996                 if isElem2:
 997                     src2 = e.MakeIDSource([id2], SMESH.FACE)
 998                 else:
 999                     src2 = e.MakeIDSource([id2], SMESH.NODE)
1000                 pass
1001             pass
1002         aMeasurements = self.CreateMeasurements()
1003         result = aMeasurements.MinDistance(src1, src2)
1004         aMeasurements.UnRegister()
1005         return result
1006
1007     ## Get bounding box of the specified object(s)
1008     #  @param objects single source object or list of source objects
1009     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
1010     #  @sa GetBoundingBox()
1011     #  @ingroup l1_measurements
1012     def BoundingBox(self, objects):
1013         result = self.GetBoundingBox(objects)
1014         if result is None:
1015             result = (0.0,)*6
1016         else:
1017             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
1018         return result
1019
1020     ## Get measure structure specifying bounding box data of the specified object(s)
1021     #  @param objects single source object or list of source objects
1022     #  @return Measure structure
1023     #  @sa BoundingBox()
1024     #  @ingroup l1_measurements
1025     def GetBoundingBox(self, objects):
1026         if isinstance(objects, tuple):
1027             objects = list(objects)
1028         if not isinstance(objects, list):
1029             objects = [objects]
1030         srclist = []
1031         for o in objects:
1032             if isinstance(o, Mesh):
1033                 srclist.append(o.mesh)
1034             elif hasattr(o, "_narrow"):
1035                 src = o._narrow(SMESH.SMESH_IDSource)
1036                 if src: srclist.append(src)
1037                 pass
1038             pass
1039         aMeasurements = self.CreateMeasurements()
1040         result = aMeasurements.BoundingBox(srclist)
1041         aMeasurements.UnRegister()
1042         return result
1043
1044 import omniORB
1045 #Registering the new proxy for SMESH_Gen
1046 omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshBuilder)
1047
1048 ## Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1049 #  interface to create or load meshes.
1050 #
1051 #  Typical use is:
1052 #  \code
1053 #    import salome
1054 #    salome.salome_init()
1055 #    from salome.smesh import smeshBuilder
1056 #    smesh = smeshBuilder.New(theStudy)
1057 #  \endcode
1058 #  @param  study     SALOME study, generally obtained by salome.myStudy.
1059 #  @param  instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1060 #  @return smeshBuilder instance
1061
1062 def New( study, instance=None):
1063     """
1064     Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1065     interface to create or load meshes.
1066
1067     Typical use is:
1068         import salome
1069         salome.salome_init()
1070         from salome.smesh import smeshBuilder
1071         smesh = smeshBuilder.New(theStudy)
1072
1073     Parameters:
1074         study     SALOME study, generally obtained by salome.myStudy.
1075         instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1076     Returns:
1077         smeshBuilder instance
1078     """
1079     global engine
1080     global smeshInst
1081     global doLcc
1082     engine = instance
1083     if engine is None:
1084       doLcc = True
1085     smeshInst = smeshBuilder()
1086     assert isinstance(smeshInst,smeshBuilder), "Smesh engine class is %s but should be smeshBuilder.smeshBuilder. Import salome.smesh.smeshBuilder before creating the instance."%smeshInst.__class__
1087     smeshInst.init_smesh(study)
1088     return smeshInst
1089
1090
1091 # Public class: Mesh
1092 # ==================
1093
1094 ## This class allows defining and managing a mesh.
1095 #  It has a set of methods to build a mesh on the given geometry, including the definition of sub-meshes.
1096 #  It also has methods to define groups of mesh elements, to modify a mesh (by addition of
1097 #  new nodes and elements and by changing the existing entities), to get information
1098 #  about a mesh and to export a mesh into different formats.
1099 class Mesh:
1100
1101     geom = 0
1102     mesh = 0
1103     editor = 0
1104
1105     ## Constructor
1106     #
1107     #  Creates a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and
1108     #  sets the GUI name of this mesh to \a name.
1109     #  @param smeshpyD an instance of smeshBuilder class
1110     #  @param geompyD an instance of geomBuilder class
1111     #  @param obj Shape to be meshed or SMESH_Mesh object
1112     #  @param name Study name of the mesh
1113     #  @ingroup l2_construct
1114     def __init__(self, smeshpyD, geompyD, obj=0, name=0):
1115         self.smeshpyD=smeshpyD
1116         self.geompyD=geompyD
1117         if obj is None:
1118             obj = 0
1119         objHasName = False
1120         if obj != 0:
1121             if isinstance(obj, geomBuilder.GEOM._objref_GEOM_Object):
1122                 self.geom = obj
1123                 objHasName = True
1124                 # publish geom of mesh (issue 0021122)
1125                 if not self.geom.GetStudyEntry() and smeshpyD.GetCurrentStudy():
1126                     objHasName = False
1127                     studyID = smeshpyD.GetCurrentStudy()._get_StudyId()
1128                     if studyID != geompyD.myStudyId:
1129                         geompyD.init_geom( smeshpyD.GetCurrentStudy())
1130                         pass
1131                     if name:
1132                         geo_name = name + " shape"
1133                     else:
1134                         geo_name = "%s_%s to mesh"%(self.geom.GetShapeType(), id(self.geom)%100)
1135                     geompyD.addToStudy( self.geom, geo_name )
1136                 self.mesh = self.smeshpyD.CreateMesh(self.geom)
1137
1138             elif isinstance(obj, SMESH._objref_SMESH_Mesh):
1139                 self.SetMesh(obj)
1140         else:
1141             self.mesh = self.smeshpyD.CreateEmptyMesh()
1142         if name:
1143             self.smeshpyD.SetName(self.mesh, name)
1144         elif objHasName:
1145             self.smeshpyD.SetName(self.mesh, GetName(obj)) # + " mesh"
1146
1147         if not self.geom:
1148             self.geom = self.mesh.GetShapeToMesh()
1149
1150         self.editor   = self.mesh.GetMeshEditor()
1151         self.functors = [None] * SMESH.FT_Undefined._v
1152
1153         # set self to algoCreator's
1154         for attrName in dir(self):
1155             attr = getattr( self, attrName )
1156             if isinstance( attr, algoCreator ):
1157                 #print "algoCreator ", attrName
1158                 setattr( self, attrName, attr.copy( self ))
1159
1160     ## Initializes the Mesh object from an instance of SMESH_Mesh interface
1161     #  @param theMesh a SMESH_Mesh object
1162     #  @ingroup l2_construct
1163     def SetMesh(self, theMesh):
1164         if self.mesh: self.mesh.UnRegister()
1165         self.mesh = theMesh
1166         if self.mesh:
1167             self.mesh.Register()
1168             self.geom = self.mesh.GetShapeToMesh()
1169
1170     ## Returns the mesh, that is an instance of SMESH_Mesh interface
1171     #  @return a SMESH_Mesh object
1172     #  @ingroup l2_construct
1173     def GetMesh(self):
1174         return self.mesh
1175
1176     ## Gets the name of the mesh
1177     #  @return the name of the mesh as a string
1178     #  @ingroup l2_construct
1179     def GetName(self):
1180         name = GetName(self.GetMesh())
1181         return name
1182
1183     ## Sets a name to the mesh
1184     #  @param name a new name of the mesh
1185     #  @ingroup l2_construct
1186     def SetName(self, name):
1187         self.smeshpyD.SetName(self.GetMesh(), name)
1188
1189     ## Gets the subMesh object associated to a \a theSubObject geometrical object.
1190     #  The subMesh object gives access to the IDs of nodes and elements.
1191     #  @param geom a geometrical object (shape)
1192     #  @param name a name for the submesh
1193     #  @return an object of type SMESH_SubMesh, representing a part of mesh, which lies on the given shape
1194     #  @ingroup l2_submeshes
1195     def GetSubMesh(self, geom, name):
1196         AssureGeomPublished( self, geom, name )
1197         submesh = self.mesh.GetSubMesh( geom, name )
1198         return submesh
1199
1200     ## Returns the shape associated to the mesh
1201     #  @return a GEOM_Object
1202     #  @ingroup l2_construct
1203     def GetShape(self):
1204         return self.geom
1205
1206     ## Associates the given shape to the mesh (entails the recreation of the mesh)
1207     #  @param geom the shape to be meshed (GEOM_Object)
1208     #  @ingroup l2_construct
1209     def SetShape(self, geom):
1210         self.mesh = self.smeshpyD.CreateMesh(geom)
1211
1212     ## Loads mesh from the study after opening the study
1213     def Load(self):
1214         self.mesh.Load()
1215
1216     ## Returns true if the hypotheses are defined well
1217     #  @param theSubObject a sub-shape of a mesh shape
1218     #  @return True or False
1219     #  @ingroup l2_construct
1220     def IsReadyToCompute(self, theSubObject):
1221         return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject)
1222
1223     ## Returns errors of hypotheses definition.
1224     #  The list of errors is empty if everything is OK.
1225     #  @param theSubObject a sub-shape of a mesh shape
1226     #  @return a list of errors
1227     #  @ingroup l2_construct
1228     def GetAlgoState(self, theSubObject):
1229         return self.smeshpyD.GetAlgoState(self.mesh, theSubObject)
1230
1231     ## Returns a geometrical object on which the given element was built.
1232     #  The returned geometrical object, if not nil, is either found in the
1233     #  study or published by this method with the given name
1234     #  @param theElementID the id of the mesh element
1235     #  @param theGeomName the user-defined name of the geometrical object
1236     #  @return GEOM::GEOM_Object instance
1237     #  @ingroup l2_construct
1238     def GetGeometryByMeshElement(self, theElementID, theGeomName):
1239         return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName )
1240
1241     ## Returns the mesh dimension depending on the dimension of the underlying shape
1242     #  or, if the mesh is not based on any shape, basing on deimension of elements
1243     #  @return mesh dimension as an integer value [0,3]
1244     #  @ingroup l1_auxiliary
1245     def MeshDimension(self):
1246         if self.mesh.HasShapeToMesh():
1247             shells = self.geompyD.SubShapeAllIDs( self.geom, self.geompyD.ShapeType["SOLID"] )
1248             if len( shells ) > 0 :
1249                 return 3
1250             elif self.geompyD.NumberOfFaces( self.geom ) > 0 :
1251                 return 2
1252             elif self.geompyD.NumberOfEdges( self.geom ) > 0 :
1253                 return 1
1254             else:
1255                 return 0;
1256         else:
1257             if self.NbVolumes() > 0: return 3
1258             if self.NbFaces()   > 0: return 2
1259             if self.NbEdges()   > 0: return 1
1260         return 0
1261
1262     ## Evaluates size of prospective mesh on a shape
1263     #  @return a list where i-th element is a number of elements of i-th SMESH.EntityType
1264     #  To know predicted number of e.g. edges, inquire it this way
1265     #  Evaluate()[ EnumToLong( Entity_Edge )]
1266     def Evaluate(self, geom=0):
1267         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1268             if self.geom == 0:
1269                 geom = self.mesh.GetShapeToMesh()
1270             else:
1271                 geom = self.geom
1272         return self.smeshpyD.Evaluate(self.mesh, geom)
1273
1274
1275     ## Computes the mesh and returns the status of the computation
1276     #  @param geom geomtrical shape on which mesh data should be computed
1277     #  @param discardModifs if True and the mesh has been edited since
1278     #         a last total re-compute and that may prevent successful partial re-compute,
1279     #         then the mesh is cleaned before Compute()
1280     #  @return True or False
1281     #  @ingroup l2_construct
1282     def Compute(self, geom=0, discardModifs=False):
1283         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1284             if self.geom == 0:
1285                 geom = self.mesh.GetShapeToMesh()
1286             else:
1287                 geom = self.geom
1288         ok = False
1289         try:
1290             if discardModifs and self.mesh.HasModificationsToDiscard(): # issue 0020693
1291                 self.mesh.Clear()
1292             ok = self.smeshpyD.Compute(self.mesh, geom)
1293         except SALOME.SALOME_Exception, ex:
1294             print "Mesh computation failed, exception caught:"
1295             print "    ", ex.details.text
1296         except:
1297             import traceback
1298             print "Mesh computation failed, exception caught:"
1299             traceback.print_exc()
1300         if True:#not ok:
1301             allReasons = ""
1302
1303             # Treat compute errors
1304             computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, geom )
1305             for err in computeErrors:
1306                 shapeText = ""
1307                 if self.mesh.HasShapeToMesh():
1308                     try:
1309                         mainIOR  = salome.orb.object_to_string(geom)
1310                         for sname in salome.myStudyManager.GetOpenStudies():
1311                             s = salome.myStudyManager.GetStudyByName(sname)
1312                             if not s: continue
1313                             mainSO = s.FindObjectIOR(mainIOR)
1314                             if not mainSO: continue
1315                             if err.subShapeID == 1:
1316                                 shapeText = ' on "%s"' % mainSO.GetName()
1317                             subIt = s.NewChildIterator(mainSO)
1318                             while subIt.More():
1319                                 subSO = subIt.Value()
1320                                 subIt.Next()
1321                                 obj = subSO.GetObject()
1322                                 if not obj: continue
1323                                 go = obj._narrow( geomBuilder.GEOM._objref_GEOM_Object )
1324                                 if not go: continue
1325                                 ids = go.GetSubShapeIndices()
1326                                 if len(ids) == 1 and ids[0] == err.subShapeID:
1327                                     shapeText = ' on "%s"' % subSO.GetName()
1328                                     break
1329                         if not shapeText:
1330                             shape = self.geompyD.GetSubShape( geom, [err.subShapeID])
1331                             if shape:
1332                                 shapeText = " on %s #%s" % (shape.GetShapeType(), err.subShapeID)
1333                             else:
1334                                 shapeText = " on subshape #%s" % (err.subShapeID)
1335                     except:
1336                         shapeText = " on subshape #%s" % (err.subShapeID)
1337                 errText = ""
1338                 stdErrors = ["OK",                   #COMPERR_OK
1339                              "Invalid input mesh",   #COMPERR_BAD_INPUT_MESH
1340                              "std::exception",       #COMPERR_STD_EXCEPTION
1341                              "OCC exception",        #COMPERR_OCC_EXCEPTION
1342                              "..",                   #COMPERR_SLM_EXCEPTION
1343                              "Unknown exception",    #COMPERR_EXCEPTION
1344                              "Memory allocation problem", #COMPERR_MEMORY_PB
1345                              "Algorithm failed",     #COMPERR_ALGO_FAILED
1346                              "Unexpected geometry",  #COMPERR_BAD_SHAPE
1347                              "Warning",              #COMPERR_WARNING
1348                              "Computation cancelled",#COMPERR_CANCELED
1349                              "No mesh on sub-shape"] #COMPERR_NO_MESH_ON_SHAPE
1350                 if err.code > 0:
1351                     if err.code < len(stdErrors): errText = stdErrors[err.code]
1352                 else:
1353                     errText = "code %s" % -err.code
1354                 if errText: errText += ". "
1355                 errText += err.comment
1356                 if allReasons != "":allReasons += "\n"
1357                 if ok:
1358                     allReasons += '-  "%s"%s - %s' %(err.algoName, shapeText, errText)
1359                 else:
1360                     allReasons += '-  "%s" failed%s. Error: %s' %(err.algoName, shapeText, errText)
1361                 pass
1362
1363             # Treat hyp errors
1364             errors = self.smeshpyD.GetAlgoState( self.mesh, geom )
1365             for err in errors:
1366                 if err.isGlobalAlgo:
1367                     glob = "global"
1368                 else:
1369                     glob = "local"
1370                     pass
1371                 dim = err.algoDim
1372                 name = err.algoName
1373                 if len(name) == 0:
1374                     reason = '%s %sD algorithm is missing' % (glob, dim)
1375                 elif err.state == HYP_MISSING:
1376                     reason = ('%s %sD algorithm "%s" misses %sD hypothesis'
1377                               % (glob, dim, name, dim))
1378                 elif err.state == HYP_NOTCONFORM:
1379                     reason = 'Global "Not Conform mesh allowed" hypothesis is missing'
1380                 elif err.state == HYP_BAD_PARAMETER:
1381                     reason = ('Hypothesis of %s %sD algorithm "%s" has a bad parameter value'
1382                               % ( glob, dim, name ))
1383                 elif err.state == HYP_BAD_GEOMETRY:
1384                     reason = ('%s %sD algorithm "%s" is assigned to mismatching'
1385                               'geometry' % ( glob, dim, name ))
1386                 elif err.state == HYP_HIDDEN_ALGO:
1387                     reason = ('%s %sD algorithm "%s" is ignored due to presence of a %s '
1388                               'algorithm of upper dimension generating %sD mesh'
1389                               % ( glob, dim, name, glob, dim ))
1390                 else:
1391                     reason = ("For unknown reason. "
1392                               "Developer, revise Mesh.Compute() implementation in smeshBuilder.py!")
1393                     pass
1394                 if allReasons != "":allReasons += "\n"
1395                 allReasons += "-  " + reason
1396                 pass
1397             if not ok or allReasons != "":
1398                 msg = '"' + GetName(self.mesh) + '"'
1399                 if ok: msg += " has been computed with warnings"
1400                 else:  msg += " has not been computed"
1401                 if allReasons != "": msg += ":"
1402                 else:                msg += "."
1403                 print msg
1404                 print allReasons
1405             pass
1406         if salome.sg.hasDesktop() and self.mesh.GetStudyId() >= 0:
1407             smeshgui = salome.ImportComponentGUI("SMESH")
1408             smeshgui.Init(self.mesh.GetStudyId())
1409             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) )
1410             salome.sg.updateObjBrowser(1)
1411             pass
1412         return ok
1413
1414     ## Return submesh objects list in meshing order
1415     #  @return list of list of submesh objects
1416     #  @ingroup l2_construct
1417     def GetMeshOrder(self):
1418         return self.mesh.GetMeshOrder()
1419
1420     ## Return submesh objects list in meshing order
1421     #  @return list of list of submesh objects
1422     #  @ingroup l2_construct
1423     def SetMeshOrder(self, submeshes):
1424         return self.mesh.SetMeshOrder(submeshes)
1425
1426     ## Removes all nodes and elements
1427     #  @ingroup l2_construct
1428     def Clear(self):
1429         self.mesh.Clear()
1430         if ( salome.sg.hasDesktop() and
1431              salome.myStudyManager.GetStudyByID( self.mesh.GetStudyId() )):
1432             smeshgui = salome.ImportComponentGUI("SMESH")
1433             smeshgui.Init(self.mesh.GetStudyId())
1434             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1435             salome.sg.updateObjBrowser(1)
1436
1437     ## Removes all nodes and elements of indicated shape
1438     #  @ingroup l2_construct
1439     def ClearSubMesh(self, geomId):
1440         self.mesh.ClearSubMesh(geomId)
1441         if salome.sg.hasDesktop():
1442             smeshgui = salome.ImportComponentGUI("SMESH")
1443             smeshgui.Init(self.mesh.GetStudyId())
1444             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1445             salome.sg.updateObjBrowser(1)
1446
1447     ## Computes a tetrahedral mesh using AutomaticLength + MEFISTO + NETGEN
1448     #  @param fineness [0.0,1.0] defines mesh fineness
1449     #  @return True or False
1450     #  @ingroup l3_algos_basic
1451     def AutomaticTetrahedralization(self, fineness=0):
1452         dim = self.MeshDimension()
1453         # assign hypotheses
1454         self.RemoveGlobalHypotheses()
1455         self.Segment().AutomaticLength(fineness)
1456         if dim > 1 :
1457             self.Triangle().LengthFromEdges()
1458             pass
1459         if dim > 2 :
1460             from salome.NETGENPlugin.NETGENPluginBuilder import NETGEN
1461             self.Tetrahedron(NETGEN)
1462             pass
1463         return self.Compute()
1464
1465     ## Computes an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron
1466     #  @param fineness [0.0, 1.0] defines mesh fineness
1467     #  @return True or False
1468     #  @ingroup l3_algos_basic
1469     def AutomaticHexahedralization(self, fineness=0):
1470         dim = self.MeshDimension()
1471         # assign the hypotheses
1472         self.RemoveGlobalHypotheses()
1473         self.Segment().AutomaticLength(fineness)
1474         if dim > 1 :
1475             self.Quadrangle()
1476             pass
1477         if dim > 2 :
1478             self.Hexahedron()
1479             pass
1480         return self.Compute()
1481
1482     ## Assigns a hypothesis
1483     #  @param hyp a hypothesis to assign
1484     #  @param geom a subhape of mesh geometry
1485     #  @return SMESH.Hypothesis_Status
1486     #  @ingroup l2_hypotheses
1487     def AddHypothesis(self, hyp, geom=0):
1488         if isinstance( hyp, Mesh_Algorithm ):
1489             hyp = hyp.GetAlgorithm()
1490             pass
1491         if not geom:
1492             geom = self.geom
1493             if not geom:
1494                 geom = self.mesh.GetShapeToMesh()
1495             pass
1496         AssureGeomPublished( self, geom, "shape for %s" % hyp.GetName())
1497         status = self.mesh.AddHypothesis(geom, hyp)
1498         isAlgo = hyp._narrow( SMESH_Algo )
1499         hyp_name = GetName( hyp )
1500         geom_name = ""
1501         if geom:
1502             geom_name = GetName( geom )
1503         TreatHypoStatus( status, hyp_name, geom_name, isAlgo )
1504         return status
1505
1506     ## Return True if an algorithm of hypothesis is assigned to a given shape
1507     #  @param hyp a hypothesis to check
1508     #  @param geom a subhape of mesh geometry
1509     #  @return True of False
1510     #  @ingroup l2_hypotheses
1511     def IsUsedHypothesis(self, hyp, geom):
1512         if not hyp: # or not geom
1513             return False
1514         if isinstance( hyp, Mesh_Algorithm ):
1515             hyp = hyp.GetAlgorithm()
1516             pass
1517         hyps = self.GetHypothesisList(geom)
1518         for h in hyps:
1519             if h.GetId() == hyp.GetId():
1520                 return True
1521         return False
1522
1523     ## Unassigns a hypothesis
1524     #  @param hyp a hypothesis to unassign
1525     #  @param geom a sub-shape of mesh geometry
1526     #  @return SMESH.Hypothesis_Status
1527     #  @ingroup l2_hypotheses
1528     def RemoveHypothesis(self, hyp, geom=0):
1529         if not hyp:
1530             return None
1531         if isinstance( hyp, Mesh_Algorithm ):
1532             hyp = hyp.GetAlgorithm()
1533             pass
1534         shape = geom
1535         if not shape:
1536             shape = self.geom
1537             pass
1538         if self.IsUsedHypothesis( hyp, shape ):
1539             return self.mesh.RemoveHypothesis( shape, hyp )
1540         hypName = GetName( hyp )
1541         geoName = GetName( shape )
1542         print "WARNING: RemoveHypothesis() failed as '%s' is not assigned to '%s' shape" % ( hypName, geoName )
1543         return None
1544
1545     ## Gets the list of hypotheses added on a geometry
1546     #  @param geom a sub-shape of mesh geometry
1547     #  @return the sequence of SMESH_Hypothesis
1548     #  @ingroup l2_hypotheses
1549     def GetHypothesisList(self, geom):
1550         return self.mesh.GetHypothesisList( geom )
1551
1552     ## Removes all global hypotheses
1553     #  @ingroup l2_hypotheses
1554     def RemoveGlobalHypotheses(self):
1555         current_hyps = self.mesh.GetHypothesisList( self.geom )
1556         for hyp in current_hyps:
1557             self.mesh.RemoveHypothesis( self.geom, hyp )
1558             pass
1559         pass
1560
1561    ## Exports the mesh in a file in MED format and chooses the \a version of MED format
1562     ## allowing to overwrite the file if it exists or add the exported data to its contents
1563     #  @param f is the file name
1564     #  @param auto_groups boolean parameter for creating/not creating
1565     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1566     #  the typical use is auto_groups=false.
1567     #  @param version MED format version(MED_V2_1 or MED_V2_2)
1568     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1569     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1570     #  @param autoDimension: if @c True (default), a space dimension of a MED mesh can be either
1571     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1572     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1573     #         - 3D in the rest cases.
1574     #
1575     #         If @a autoDimension is @c False, the space dimension is always 3.
1576     #  @ingroup l2_impexp
1577     def ExportMED(self, f, auto_groups=0, version=MED_V2_2,
1578                   overwrite=1, meshPart=None, autoDimension=True):
1579         if meshPart:
1580             if isinstance( meshPart, list ):
1581                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1582             self.mesh.ExportPartToMED( meshPart, f, auto_groups, version, overwrite, autoDimension)
1583         else:
1584             self.mesh.ExportToMEDX(f, auto_groups, version, overwrite, autoDimension)
1585
1586     ## Exports the mesh in a file in SAUV format
1587     #  @param f is the file name
1588     #  @param auto_groups boolean parameter for creating/not creating
1589     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1590     #  the typical use is auto_groups=false.
1591     #  @ingroup l2_impexp
1592     def ExportSAUV(self, f, auto_groups=0):
1593         self.mesh.ExportSAUV(f, auto_groups)
1594
1595     ## Exports the mesh in a file in DAT format
1596     #  @param f the file name
1597     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1598     #  @ingroup l2_impexp
1599     def ExportDAT(self, f, meshPart=None):
1600         if meshPart:
1601             if isinstance( meshPart, list ):
1602                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1603             self.mesh.ExportPartToDAT( meshPart, f )
1604         else:
1605             self.mesh.ExportDAT(f)
1606
1607     ## Exports the mesh in a file in UNV format
1608     #  @param f the file name
1609     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1610     #  @ingroup l2_impexp
1611     def ExportUNV(self, f, meshPart=None):
1612         if meshPart:
1613             if isinstance( meshPart, list ):
1614                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1615             self.mesh.ExportPartToUNV( meshPart, f )
1616         else:
1617             self.mesh.ExportUNV(f)
1618
1619     ## Export the mesh in a file in STL format
1620     #  @param f the file name
1621     #  @param ascii defines the file encoding
1622     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1623     #  @ingroup l2_impexp
1624     def ExportSTL(self, f, ascii=1, meshPart=None):
1625         if meshPart:
1626             if isinstance( meshPart, list ):
1627                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1628             self.mesh.ExportPartToSTL( meshPart, f, ascii )
1629         else:
1630             self.mesh.ExportSTL(f, ascii)
1631
1632     ## Exports the mesh in a file in CGNS format
1633     #  @param f is the file name
1634     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1635     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1636     #  @ingroup l2_impexp
1637     def ExportCGNS(self, f, overwrite=1, meshPart=None):
1638         if isinstance( meshPart, list ):
1639             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1640         if isinstance( meshPart, Mesh ):
1641             meshPart = meshPart.mesh
1642         elif not meshPart:
1643             meshPart = self.mesh
1644         self.mesh.ExportCGNS(meshPart, f, overwrite)
1645
1646     ## Exports the mesh in a file in GMF format
1647     #  @param f is the file name
1648     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1649     #  @ingroup l2_impexp
1650     def ExportGMF(self, f, meshPart=None):
1651         if isinstance( meshPart, list ):
1652             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1653         if isinstance( meshPart, Mesh ):
1654             meshPart = meshPart.mesh
1655         elif not meshPart:
1656             meshPart = self.mesh
1657         self.mesh.ExportGMF(meshPart, f, True)
1658
1659     ## Deprecated, used only for compatibility! Please, use ExportToMEDX() method instead.
1660     #  Exports the mesh in a file in MED format and chooses the \a version of MED format
1661     ## allowing to overwrite the file if it exists or add the exported data to its contents
1662     #  @param f the file name
1663     #  @param version values are SMESH.MED_V2_1, SMESH.MED_V2_2
1664     #  @param opt boolean parameter for creating/not creating
1665     #         the groups Group_On_All_Nodes, Group_On_All_Faces, ...
1666     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1667     #  @ingroup l2_impexp
1668     def ExportToMED(self, f, version, opt=0, overwrite=1):
1669         self.mesh.ExportToMEDX(f, opt, version, overwrite)
1670
1671     # Operations with groups:
1672     # ----------------------
1673
1674     ## Creates an empty mesh group
1675     #  @param elementType the type of elements in the group
1676     #  @param name the name of the mesh group
1677     #  @return SMESH_Group
1678     #  @ingroup l2_grps_create
1679     def CreateEmptyGroup(self, elementType, name):
1680         return self.mesh.CreateGroup(elementType, name)
1681
1682     ## Creates a mesh group based on the geometric object \a grp
1683     #  and gives a \a name, \n if this parameter is not defined
1684     #  the name is the same as the geometric group name \n
1685     #  Note: Works like GroupOnGeom().
1686     #  @param grp  a geometric group, a vertex, an edge, a face or a solid
1687     #  @param name the name of the mesh group
1688     #  @return SMESH_GroupOnGeom
1689     #  @ingroup l2_grps_create
1690     def Group(self, grp, name=""):
1691         return self.GroupOnGeom(grp, name)
1692
1693     ## Creates a mesh group based on the geometrical object \a grp
1694     #  and gives a \a name, \n if this parameter is not defined
1695     #  the name is the same as the geometrical group name
1696     #  @param grp  a geometrical group, a vertex, an edge, a face or a solid
1697     #  @param name the name of the mesh group
1698     #  @param typ  the type of elements in the group. If not set, it is
1699     #              automatically detected by the type of the geometry
1700     #  @return SMESH_GroupOnGeom
1701     #  @ingroup l2_grps_create
1702     def GroupOnGeom(self, grp, name="", typ=None):
1703         AssureGeomPublished( self, grp, name )
1704         if name == "":
1705             name = grp.GetName()
1706         if not typ:
1707             typ = self._groupTypeFromShape( grp )
1708         return self.mesh.CreateGroupFromGEOM(typ, name, grp)
1709
1710     ## Pivate method to get a type of group on geometry
1711     def _groupTypeFromShape( self, shape ):
1712         tgeo = str(shape.GetShapeType())
1713         if tgeo == "VERTEX":
1714             typ = NODE
1715         elif tgeo == "EDGE":
1716             typ = EDGE
1717         elif tgeo == "FACE" or tgeo == "SHELL":
1718             typ = FACE
1719         elif tgeo == "SOLID" or tgeo == "COMPSOLID":
1720             typ = VOLUME
1721         elif tgeo == "COMPOUND":
1722             sub = self.geompyD.SubShapeAll( shape, self.geompyD.ShapeType["SHAPE"])
1723             if not sub:
1724                 raise ValueError,"_groupTypeFromShape(): empty geometric group or compound '%s'" % GetName(shape)
1725             return self._groupTypeFromShape( sub[0] )
1726         else:
1727             raise ValueError, \
1728                   "_groupTypeFromShape(): invalid geometry '%s'" % GetName(shape)
1729         return typ
1730
1731     ## Creates a mesh group with given \a name based on the \a filter which
1732     ## is a special type of group dynamically updating it's contents during
1733     ## mesh modification
1734     #  @param typ  the type of elements in the group
1735     #  @param name the name of the mesh group
1736     #  @param filter the filter defining group contents
1737     #  @return SMESH_GroupOnFilter
1738     #  @ingroup l2_grps_create
1739     def GroupOnFilter(self, typ, name, filter):
1740         return self.mesh.CreateGroupFromFilter(typ, name, filter)
1741
1742     ## Creates a mesh group by the given ids of elements
1743     #  @param groupName the name of the mesh group
1744     #  @param elementType the type of elements in the group
1745     #  @param elemIDs the list of ids
1746     #  @return SMESH_Group
1747     #  @ingroup l2_grps_create
1748     def MakeGroupByIds(self, groupName, elementType, elemIDs):
1749         group = self.mesh.CreateGroup(elementType, groupName)
1750         group.Add(elemIDs)
1751         return group
1752
1753     ## Creates a mesh group by the given conditions
1754     #  @param groupName the name of the mesh group
1755     #  @param elementType the type of elements in the group
1756     #  @param CritType the type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
1757     #  @param Compare belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
1758     #  @param Threshold the threshold value (range of id ids as string, shape, numeric)
1759     #  @param UnaryOp FT_LogicalNOT or FT_Undefined
1760     #  @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface,
1761     #         FT_LyingOnGeom, FT_CoplanarFaces criteria
1762     #  @return SMESH_Group
1763     #  @ingroup l2_grps_create
1764     def MakeGroup(self,
1765                   groupName,
1766                   elementType,
1767                   CritType=FT_Undefined,
1768                   Compare=FT_EqualTo,
1769                   Threshold="",
1770                   UnaryOp=FT_Undefined,
1771                   Tolerance=1e-07):
1772         aCriterion = self.smeshpyD.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
1773         group = self.MakeGroupByCriterion(groupName, aCriterion)
1774         return group
1775
1776     ## Creates a mesh group by the given criterion
1777     #  @param groupName the name of the mesh group
1778     #  @param Criterion the instance of Criterion class
1779     #  @return SMESH_Group
1780     #  @ingroup l2_grps_create
1781     def MakeGroupByCriterion(self, groupName, Criterion):
1782         aFilterMgr = self.smeshpyD.CreateFilterManager()
1783         aFilter = aFilterMgr.CreateFilter()
1784         aCriteria = []
1785         aCriteria.append(Criterion)
1786         aFilter.SetCriteria(aCriteria)
1787         group = self.MakeGroupByFilter(groupName, aFilter)
1788         aFilterMgr.UnRegister()
1789         return group
1790
1791     ## Creates a mesh group by the given criteria (list of criteria)
1792     #  @param groupName the name of the mesh group
1793     #  @param theCriteria the list of criteria
1794     #  @return SMESH_Group
1795     #  @ingroup l2_grps_create
1796     def MakeGroupByCriteria(self, groupName, theCriteria):
1797         aFilterMgr = self.smeshpyD.CreateFilterManager()
1798         aFilter = aFilterMgr.CreateFilter()
1799         aFilter.SetCriteria(theCriteria)
1800         group = self.MakeGroupByFilter(groupName, aFilter)
1801         aFilterMgr.UnRegister()
1802         return group
1803
1804     ## Creates a mesh group by the given filter
1805     #  @param groupName the name of the mesh group
1806     #  @param theFilter the instance of Filter class
1807     #  @return SMESH_Group
1808     #  @ingroup l2_grps_create
1809     def MakeGroupByFilter(self, groupName, theFilter):
1810         group = self.CreateEmptyGroup(theFilter.GetElementType(), groupName)
1811         theFilter.SetMesh( self.mesh )
1812         group.AddFrom( theFilter )
1813         return group
1814
1815     ## Removes a group
1816     #  @ingroup l2_grps_delete
1817     def RemoveGroup(self, group):
1818         self.mesh.RemoveGroup(group)
1819
1820     ## Removes a group with its contents
1821     #  @ingroup l2_grps_delete
1822     def RemoveGroupWithContents(self, group):
1823         self.mesh.RemoveGroupWithContents(group)
1824
1825     ## Gets the list of groups existing in the mesh
1826     #  @return a sequence of SMESH_GroupBase
1827     #  @ingroup l2_grps_create
1828     def GetGroups(self):
1829         return self.mesh.GetGroups()
1830
1831     ## Gets the number of groups existing in the mesh
1832     #  @return the quantity of groups as an integer value
1833     #  @ingroup l2_grps_create
1834     def NbGroups(self):
1835         return self.mesh.NbGroups()
1836
1837     ## Gets the list of names of groups existing in the mesh
1838     #  @return list of strings
1839     #  @ingroup l2_grps_create
1840     def GetGroupNames(self):
1841         groups = self.GetGroups()
1842         names = []
1843         for group in groups:
1844             names.append(group.GetName())
1845         return names
1846
1847     ## Produces a union of two groups
1848     #  A new group is created. All mesh elements that are
1849     #  present in the initial groups are added to the new one
1850     #  @return an instance of SMESH_Group
1851     #  @ingroup l2_grps_operon
1852     def UnionGroups(self, group1, group2, name):
1853         return self.mesh.UnionGroups(group1, group2, name)
1854
1855     ## Produces a union list of groups
1856     #  New group is created. All mesh elements that are present in
1857     #  initial groups are added to the new one
1858     #  @return an instance of SMESH_Group
1859     #  @ingroup l2_grps_operon
1860     def UnionListOfGroups(self, groups, name):
1861       return self.mesh.UnionListOfGroups(groups, name)
1862
1863     ## Prodices an intersection of two groups
1864     #  A new group is created. All mesh elements that are common
1865     #  for the two initial groups are added to the new one.
1866     #  @return an instance of SMESH_Group
1867     #  @ingroup l2_grps_operon
1868     def IntersectGroups(self, group1, group2, name):
1869         return self.mesh.IntersectGroups(group1, group2, name)
1870
1871     ## Produces an intersection of groups
1872     #  New group is created. All mesh elements that are present in all
1873     #  initial groups simultaneously are added to the new one
1874     #  @return an instance of SMESH_Group
1875     #  @ingroup l2_grps_operon
1876     def IntersectListOfGroups(self, groups, name):
1877       return self.mesh.IntersectListOfGroups(groups, name)
1878
1879     ## Produces a cut of two groups
1880     #  A new group is created. All mesh elements that are present in
1881     #  the main group but are not present in the tool group are added to the new one
1882     #  @return an instance of SMESH_Group
1883     #  @ingroup l2_grps_operon
1884     def CutGroups(self, main_group, tool_group, name):
1885         return self.mesh.CutGroups(main_group, tool_group, name)
1886
1887     ## Produces a cut of groups
1888     #  A new group is created. All mesh elements that are present in main groups
1889     #  but do not present in tool groups are added to the new one
1890     #  @return an instance of SMESH_Group
1891     #  @ingroup l2_grps_operon
1892     def CutListOfGroups(self, main_groups, tool_groups, name):
1893       return self.mesh.CutListOfGroups(main_groups, tool_groups, name)
1894
1895     ## Produces a group of elements of specified type using list of existing groups
1896     #  A new group is created. System
1897     #  1) extracts all nodes on which groups elements are built
1898     #  2) combines all elements of specified dimension laying on these nodes
1899     #  @return an instance of SMESH_Group
1900     #  @ingroup l2_grps_operon
1901     def CreateDimGroup(self, groups, elem_type, name):
1902       return self.mesh.CreateDimGroup(groups, elem_type, name)
1903
1904
1905     ## Convert group on geom into standalone group
1906     #  @ingroup l2_grps_delete
1907     def ConvertToStandalone(self, group):
1908         return self.mesh.ConvertToStandalone(group)
1909
1910     # Get some info about mesh:
1911     # ------------------------
1912
1913     ## Returns the log of nodes and elements added or removed
1914     #  since the previous clear of the log.
1915     #  @param clearAfterGet log is emptied after Get (safe if concurrents access)
1916     #  @return list of log_block structures:
1917     #                                        commandType
1918     #                                        number
1919     #                                        coords
1920     #                                        indexes
1921     #  @ingroup l1_auxiliary
1922     def GetLog(self, clearAfterGet):
1923         return self.mesh.GetLog(clearAfterGet)
1924
1925     ## Clears the log of nodes and elements added or removed since the previous
1926     #  clear. Must be used immediately after GetLog if clearAfterGet is false.
1927     #  @ingroup l1_auxiliary
1928     def ClearLog(self):
1929         self.mesh.ClearLog()
1930
1931     ## Toggles auto color mode on the object.
1932     #  @param theAutoColor the flag which toggles auto color mode.
1933     #  @ingroup l1_auxiliary
1934     def SetAutoColor(self, theAutoColor):
1935         self.mesh.SetAutoColor(theAutoColor)
1936
1937     ## Gets flag of object auto color mode.
1938     #  @return True or False
1939     #  @ingroup l1_auxiliary
1940     def GetAutoColor(self):
1941         return self.mesh.GetAutoColor()
1942
1943     ## Gets the internal ID
1944     #  @return integer value, which is the internal Id of the mesh
1945     #  @ingroup l1_auxiliary
1946     def GetId(self):
1947         return self.mesh.GetId()
1948
1949     ## Get the study Id
1950     #  @return integer value, which is the study Id of the mesh
1951     #  @ingroup l1_auxiliary
1952     def GetStudyId(self):
1953         return self.mesh.GetStudyId()
1954
1955     ## Checks the group names for duplications.
1956     #  Consider the maximum group name length stored in MED file.
1957     #  @return True or False
1958     #  @ingroup l1_auxiliary
1959     def HasDuplicatedGroupNamesMED(self):
1960         return self.mesh.HasDuplicatedGroupNamesMED()
1961
1962     ## Obtains the mesh editor tool
1963     #  @return an instance of SMESH_MeshEditor
1964     #  @ingroup l1_modifying
1965     def GetMeshEditor(self):
1966         return self.editor
1967
1968     ## Wrap a list of IDs of elements or nodes into SMESH_IDSource which
1969     #  can be passed as argument to a method accepting mesh, group or sub-mesh
1970     #  @return an instance of SMESH_IDSource
1971     #  @ingroup l1_auxiliary
1972     def GetIDSource(self, ids, elemType):
1973         return self.editor.MakeIDSource(ids, elemType)
1974
1975     ## Gets MED Mesh
1976     #  @return an instance of SALOME_MED::MESH
1977     #  @ingroup l1_auxiliary
1978     def GetMEDMesh(self):
1979         return self.mesh.GetMEDMesh()
1980
1981
1982     # Get informations about mesh contents:
1983     # ------------------------------------
1984
1985     ## Gets the mesh stattistic
1986     #  @return dictionary type element - count of elements
1987     #  @ingroup l1_meshinfo
1988     def GetMeshInfo(self, obj = None):
1989         if not obj: obj = self.mesh
1990         return self.smeshpyD.GetMeshInfo(obj)
1991
1992     ## Returns the number of nodes in the mesh
1993     #  @return an integer value
1994     #  @ingroup l1_meshinfo
1995     def NbNodes(self):
1996         return self.mesh.NbNodes()
1997
1998     ## Returns the number of elements in the mesh
1999     #  @return an integer value
2000     #  @ingroup l1_meshinfo
2001     def NbElements(self):
2002         return self.mesh.NbElements()
2003
2004     ## Returns the number of 0d elements in the mesh
2005     #  @return an integer value
2006     #  @ingroup l1_meshinfo
2007     def Nb0DElements(self):
2008         return self.mesh.Nb0DElements()
2009
2010     ## Returns the number of ball discrete elements in the mesh
2011     #  @return an integer value
2012     #  @ingroup l1_meshinfo
2013     def NbBalls(self):
2014         return self.mesh.NbBalls()
2015
2016     ## Returns the number of edges in the mesh
2017     #  @return an integer value
2018     #  @ingroup l1_meshinfo
2019     def NbEdges(self):
2020         return self.mesh.NbEdges()
2021
2022     ## Returns the number of edges with the given order in the mesh
2023     #  @param elementOrder the order of elements:
2024     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2025     #  @return an integer value
2026     #  @ingroup l1_meshinfo
2027     def NbEdgesOfOrder(self, elementOrder):
2028         return self.mesh.NbEdgesOfOrder(elementOrder)
2029
2030     ## Returns the number of faces in the mesh
2031     #  @return an integer value
2032     #  @ingroup l1_meshinfo
2033     def NbFaces(self):
2034         return self.mesh.NbFaces()
2035
2036     ## Returns the number of faces with the given order in the mesh
2037     #  @param elementOrder the order of elements:
2038     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2039     #  @return an integer value
2040     #  @ingroup l1_meshinfo
2041     def NbFacesOfOrder(self, elementOrder):
2042         return self.mesh.NbFacesOfOrder(elementOrder)
2043
2044     ## Returns the number of triangles in the mesh
2045     #  @return an integer value
2046     #  @ingroup l1_meshinfo
2047     def NbTriangles(self):
2048         return self.mesh.NbTriangles()
2049
2050     ## Returns the number of triangles with the given order in the mesh
2051     #  @param elementOrder is the order of elements:
2052     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2053     #  @return an integer value
2054     #  @ingroup l1_meshinfo
2055     def NbTrianglesOfOrder(self, elementOrder):
2056         return self.mesh.NbTrianglesOfOrder(elementOrder)
2057
2058     ## Returns the number of biquadratic triangles in the mesh
2059     #  @return an integer value
2060     #  @ingroup l1_meshinfo
2061     def NbBiQuadTriangles(self):
2062         return self.mesh.NbBiQuadTriangles()
2063
2064     ## Returns the number of quadrangles in the mesh
2065     #  @return an integer value
2066     #  @ingroup l1_meshinfo
2067     def NbQuadrangles(self):
2068         return self.mesh.NbQuadrangles()
2069
2070     ## Returns the number of quadrangles with the given order in the mesh
2071     #  @param elementOrder the order of elements:
2072     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2073     #  @return an integer value
2074     #  @ingroup l1_meshinfo
2075     def NbQuadranglesOfOrder(self, elementOrder):
2076         return self.mesh.NbQuadranglesOfOrder(elementOrder)
2077
2078     ## Returns the number of biquadratic quadrangles in the mesh
2079     #  @return an integer value
2080     #  @ingroup l1_meshinfo
2081     def NbBiQuadQuadrangles(self):
2082         return self.mesh.NbBiQuadQuadrangles()
2083
2084     ## Returns the number of polygons in the mesh
2085     #  @return an integer value
2086     #  @ingroup l1_meshinfo
2087     def NbPolygons(self):
2088         return self.mesh.NbPolygons()
2089
2090     ## Returns the number of volumes in the mesh
2091     #  @return an integer value
2092     #  @ingroup l1_meshinfo
2093     def NbVolumes(self):
2094         return self.mesh.NbVolumes()
2095
2096     ## Returns the number of volumes with the given order in the mesh
2097     #  @param elementOrder  the order of elements:
2098     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2099     #  @return an integer value
2100     #  @ingroup l1_meshinfo
2101     def NbVolumesOfOrder(self, elementOrder):
2102         return self.mesh.NbVolumesOfOrder(elementOrder)
2103
2104     ## Returns the number of tetrahedrons in the mesh
2105     #  @return an integer value
2106     #  @ingroup l1_meshinfo
2107     def NbTetras(self):
2108         return self.mesh.NbTetras()
2109
2110     ## Returns the number of tetrahedrons with the given order in the mesh
2111     #  @param elementOrder  the order of elements:
2112     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2113     #  @return an integer value
2114     #  @ingroup l1_meshinfo
2115     def NbTetrasOfOrder(self, elementOrder):
2116         return self.mesh.NbTetrasOfOrder(elementOrder)
2117
2118     ## Returns the number of hexahedrons in the mesh
2119     #  @return an integer value
2120     #  @ingroup l1_meshinfo
2121     def NbHexas(self):
2122         return self.mesh.NbHexas()
2123
2124     ## Returns the number of hexahedrons with the given order in the mesh
2125     #  @param elementOrder  the order of elements:
2126     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2127     #  @return an integer value
2128     #  @ingroup l1_meshinfo
2129     def NbHexasOfOrder(self, elementOrder):
2130         return self.mesh.NbHexasOfOrder(elementOrder)
2131
2132     ## Returns the number of triquadratic hexahedrons in the mesh
2133     #  @return an integer value
2134     #  @ingroup l1_meshinfo
2135     def NbTriQuadraticHexas(self):
2136         return self.mesh.NbTriQuadraticHexas()
2137
2138     ## Returns the number of pyramids in the mesh
2139     #  @return an integer value
2140     #  @ingroup l1_meshinfo
2141     def NbPyramids(self):
2142         return self.mesh.NbPyramids()
2143
2144     ## Returns the number of pyramids with the given order in the mesh
2145     #  @param elementOrder  the order of elements:
2146     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2147     #  @return an integer value
2148     #  @ingroup l1_meshinfo
2149     def NbPyramidsOfOrder(self, elementOrder):
2150         return self.mesh.NbPyramidsOfOrder(elementOrder)
2151
2152     ## Returns the number of prisms in the mesh
2153     #  @return an integer value
2154     #  @ingroup l1_meshinfo
2155     def NbPrisms(self):
2156         return self.mesh.NbPrisms()
2157
2158     ## Returns the number of prisms with the given order in the mesh
2159     #  @param elementOrder  the order of elements:
2160     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2161     #  @return an integer value
2162     #  @ingroup l1_meshinfo
2163     def NbPrismsOfOrder(self, elementOrder):
2164         return self.mesh.NbPrismsOfOrder(elementOrder)
2165
2166     ## Returns the number of hexagonal prisms in the mesh
2167     #  @return an integer value
2168     #  @ingroup l1_meshinfo
2169     def NbHexagonalPrisms(self):
2170         return self.mesh.NbHexagonalPrisms()
2171
2172     ## Returns the number of polyhedrons in the mesh
2173     #  @return an integer value
2174     #  @ingroup l1_meshinfo
2175     def NbPolyhedrons(self):
2176         return self.mesh.NbPolyhedrons()
2177
2178     ## Returns the number of submeshes in the mesh
2179     #  @return an integer value
2180     #  @ingroup l1_meshinfo
2181     def NbSubMesh(self):
2182         return self.mesh.NbSubMesh()
2183
2184     ## Returns the list of mesh elements IDs
2185     #  @return the list of integer values
2186     #  @ingroup l1_meshinfo
2187     def GetElementsId(self):
2188         return self.mesh.GetElementsId()
2189
2190     ## Returns the list of IDs of mesh elements with the given type
2191     #  @param elementType  the required type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2192     #  @return list of integer values
2193     #  @ingroup l1_meshinfo
2194     def GetElementsByType(self, elementType):
2195         return self.mesh.GetElementsByType(elementType)
2196
2197     ## Returns the list of mesh nodes IDs
2198     #  @return the list of integer values
2199     #  @ingroup l1_meshinfo
2200     def GetNodesId(self):
2201         return self.mesh.GetNodesId()
2202
2203     # Get the information about mesh elements:
2204     # ------------------------------------
2205
2206     ## Returns the type of mesh element
2207     #  @return the value from SMESH::ElementType enumeration
2208     #  @ingroup l1_meshinfo
2209     def GetElementType(self, id, iselem):
2210         return self.mesh.GetElementType(id, iselem)
2211
2212     ## Returns the geometric type of mesh element
2213     #  @return the value from SMESH::EntityType enumeration
2214     #  @ingroup l1_meshinfo
2215     def GetElementGeomType(self, id):
2216         return self.mesh.GetElementGeomType(id)
2217
2218     ## Returns the list of submesh elements IDs
2219     #  @param Shape a geom object(sub-shape) IOR
2220     #         Shape must be the sub-shape of a ShapeToMesh()
2221     #  @return the list of integer values
2222     #  @ingroup l1_meshinfo
2223     def GetSubMeshElementsId(self, Shape):
2224         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2225             ShapeID = Shape.GetSubShapeIndices()[0]
2226         else:
2227             ShapeID = Shape
2228         return self.mesh.GetSubMeshElementsId(ShapeID)
2229
2230     ## Returns the list of submesh nodes IDs
2231     #  @param Shape a geom object(sub-shape) IOR
2232     #         Shape must be the sub-shape of a ShapeToMesh()
2233     #  @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes
2234     #  @return the list of integer values
2235     #  @ingroup l1_meshinfo
2236     def GetSubMeshNodesId(self, Shape, all):
2237         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2238             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2239         else:
2240             ShapeID = Shape
2241         return self.mesh.GetSubMeshNodesId(ShapeID, all)
2242
2243     ## Returns type of elements on given shape
2244     #  @param Shape a geom object(sub-shape) IOR
2245     #         Shape must be a sub-shape of a ShapeToMesh()
2246     #  @return element type
2247     #  @ingroup l1_meshinfo
2248     def GetSubMeshElementType(self, Shape):
2249         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2250             ShapeID = Shape.GetSubShapeIndices()[0]
2251         else:
2252             ShapeID = Shape
2253         return self.mesh.GetSubMeshElementType(ShapeID)
2254
2255     ## Gets the mesh description
2256     #  @return string value
2257     #  @ingroup l1_meshinfo
2258     def Dump(self):
2259         return self.mesh.Dump()
2260
2261
2262     # Get the information about nodes and elements of a mesh by its IDs:
2263     # -----------------------------------------------------------
2264
2265     ## Gets XYZ coordinates of a node
2266     #  \n If there is no nodes for the given ID - returns an empty list
2267     #  @return a list of double precision values
2268     #  @ingroup l1_meshinfo
2269     def GetNodeXYZ(self, id):
2270         return self.mesh.GetNodeXYZ(id)
2271
2272     ## Returns list of IDs of inverse elements for the given node
2273     #  \n If there is no node for the given ID - returns an empty list
2274     #  @return a list of integer values
2275     #  @ingroup l1_meshinfo
2276     def GetNodeInverseElements(self, id):
2277         return self.mesh.GetNodeInverseElements(id)
2278
2279     ## @brief Returns the position of a node on the shape
2280     #  @return SMESH::NodePosition
2281     #  @ingroup l1_meshinfo
2282     def GetNodePosition(self,NodeID):
2283         return self.mesh.GetNodePosition(NodeID)
2284
2285     ## @brief Returns the position of an element on the shape
2286     #  @return SMESH::ElementPosition
2287     #  @ingroup l1_meshinfo
2288     def GetElementPosition(self,ElemID):
2289         return self.mesh.GetElementPosition(ElemID)
2290
2291     ## If the given element is a node, returns the ID of shape
2292     #  \n If there is no node for the given ID - returns -1
2293     #  @return an integer value
2294     #  @ingroup l1_meshinfo
2295     def GetShapeID(self, id):
2296         return self.mesh.GetShapeID(id)
2297
2298     ## Returns the ID of the result shape after
2299     #  FindShape() from SMESH_MeshEditor for the given element
2300     #  \n If there is no element for the given ID - returns -1
2301     #  @return an integer value
2302     #  @ingroup l1_meshinfo
2303     def GetShapeIDForElem(self,id):
2304         return self.mesh.GetShapeIDForElem(id)
2305
2306     ## Returns the number of nodes for the given element
2307     #  \n If there is no element for the given ID - returns -1
2308     #  @return an integer value
2309     #  @ingroup l1_meshinfo
2310     def GetElemNbNodes(self, id):
2311         return self.mesh.GetElemNbNodes(id)
2312
2313     ## Returns the node ID the given (zero based) index for the given element
2314     #  \n If there is no element for the given ID - returns -1
2315     #  \n If there is no node for the given index - returns -2
2316     #  @return an integer value
2317     #  @ingroup l1_meshinfo
2318     def GetElemNode(self, id, index):
2319         return self.mesh.GetElemNode(id, index)
2320
2321     ## Returns the IDs of nodes of the given element
2322     #  @return a list of integer values
2323     #  @ingroup l1_meshinfo
2324     def GetElemNodes(self, id):
2325         return self.mesh.GetElemNodes(id)
2326
2327     ## Returns true if the given node is the medium node in the given quadratic element
2328     #  @ingroup l1_meshinfo
2329     def IsMediumNode(self, elementID, nodeID):
2330         return self.mesh.IsMediumNode(elementID, nodeID)
2331
2332     ## Returns true if the given node is the medium node in one of quadratic elements
2333     #  @ingroup l1_meshinfo
2334     def IsMediumNodeOfAnyElem(self, nodeID, elementType):
2335         return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType)
2336
2337     ## Returns the number of edges for the given element
2338     #  @ingroup l1_meshinfo
2339     def ElemNbEdges(self, id):
2340         return self.mesh.ElemNbEdges(id)
2341
2342     ## Returns the number of faces for the given element
2343     #  @ingroup l1_meshinfo
2344     def ElemNbFaces(self, id):
2345         return self.mesh.ElemNbFaces(id)
2346
2347     ## Returns nodes of given face (counted from zero) for given volumic element.
2348     #  @ingroup l1_meshinfo
2349     def GetElemFaceNodes(self,elemId, faceIndex):
2350         return self.mesh.GetElemFaceNodes(elemId, faceIndex)
2351
2352     ## Returns an element based on all given nodes.
2353     #  @ingroup l1_meshinfo
2354     def FindElementByNodes(self,nodes):
2355         return self.mesh.FindElementByNodes(nodes)
2356
2357     ## Returns true if the given element is a polygon
2358     #  @ingroup l1_meshinfo
2359     def IsPoly(self, id):
2360         return self.mesh.IsPoly(id)
2361
2362     ## Returns true if the given element is quadratic
2363     #  @ingroup l1_meshinfo
2364     def IsQuadratic(self, id):
2365         return self.mesh.IsQuadratic(id)
2366
2367     ## Returns diameter of a ball discrete element or zero in case of an invalid \a id
2368     #  @ingroup l1_meshinfo
2369     def GetBallDiameter(self, id):
2370         return self.mesh.GetBallDiameter(id)
2371
2372     ## Returns XYZ coordinates of the barycenter of the given element
2373     #  \n If there is no element for the given ID - returns an empty list
2374     #  @return a list of three double values
2375     #  @ingroup l1_meshinfo
2376     def BaryCenter(self, id):
2377         return self.mesh.BaryCenter(id)
2378
2379     ## Passes mesh elements through the given filter and return IDs of fitting elements
2380     #  @param theFilter SMESH_Filter
2381     #  @return a list of ids
2382     #  @ingroup l1_controls
2383     def GetIdsFromFilter(self, theFilter):
2384         theFilter.SetMesh( self.mesh )
2385         return theFilter.GetIDs()
2386
2387     ## Verifies whether a 2D mesh element has free edges (edges connected to one face only)\n
2388     #  Returns a list of special structures (borders).
2389     #  @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes.
2390     #  @ingroup l1_controls
2391     def GetFreeBorders(self):
2392         aFilterMgr = self.smeshpyD.CreateFilterManager()
2393         aPredicate = aFilterMgr.CreateFreeEdges()
2394         aPredicate.SetMesh(self.mesh)
2395         aBorders = aPredicate.GetBorders()
2396         aFilterMgr.UnRegister()
2397         return aBorders
2398
2399
2400     # Get mesh measurements information:
2401     # ------------------------------------
2402
2403     ## Get minimum distance between two nodes, elements or distance to the origin
2404     #  @param id1 first node/element id
2405     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2406     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2407     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2408     #  @return minimum distance value
2409     #  @sa GetMinDistance()
2410     def MinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2411         aMeasure = self.GetMinDistance(id1, id2, isElem1, isElem2)
2412         return aMeasure.value
2413
2414     ## Get measure structure specifying minimum distance data between two objects
2415     #  @param id1 first node/element id
2416     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2417     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2418     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2419     #  @return Measure structure
2420     #  @sa MinDistance()
2421     def GetMinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2422         if isElem1:
2423             id1 = self.editor.MakeIDSource([id1], SMESH.FACE)
2424         else:
2425             id1 = self.editor.MakeIDSource([id1], SMESH.NODE)
2426         if id2 != 0:
2427             if isElem2:
2428                 id2 = self.editor.MakeIDSource([id2], SMESH.FACE)
2429             else:
2430                 id2 = self.editor.MakeIDSource([id2], SMESH.NODE)
2431             pass
2432         else:
2433             id2 = None
2434
2435         aMeasurements = self.smeshpyD.CreateMeasurements()
2436         aMeasure = aMeasurements.MinDistance(id1, id2)
2437         aMeasurements.UnRegister()
2438         return aMeasure
2439
2440     ## Get bounding box of the specified object(s)
2441     #  @param objects single source object or list of source objects or list of nodes/elements IDs
2442     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2443     #  @c False specifies that @a objects are nodes
2444     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
2445     #  @sa GetBoundingBox()
2446     def BoundingBox(self, objects=None, isElem=False):
2447         result = self.GetBoundingBox(objects, isElem)
2448         if result is None:
2449             result = (0.0,)*6
2450         else:
2451             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
2452         return result
2453
2454     ## Get measure structure specifying bounding box data of the specified object(s)
2455     #  @param IDs single source object or list of source objects or list of nodes/elements IDs
2456     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2457     #  @c False specifies that @a objects are nodes
2458     #  @return Measure structure
2459     #  @sa BoundingBox()
2460     def GetBoundingBox(self, IDs=None, isElem=False):
2461         if IDs is None:
2462             IDs = [self.mesh]
2463         elif isinstance(IDs, tuple):
2464             IDs = list(IDs)
2465         if not isinstance(IDs, list):
2466             IDs = [IDs]
2467         if len(IDs) > 0 and isinstance(IDs[0], int):
2468             IDs = [IDs]
2469         srclist = []
2470         for o in IDs:
2471             if isinstance(o, Mesh):
2472                 srclist.append(o.mesh)
2473             elif hasattr(o, "_narrow"):
2474                 src = o._narrow(SMESH.SMESH_IDSource)
2475                 if src: srclist.append(src)
2476                 pass
2477             elif isinstance(o, list):
2478                 if isElem:
2479                     srclist.append(self.editor.MakeIDSource(o, SMESH.FACE))
2480                 else:
2481                     srclist.append(self.editor.MakeIDSource(o, SMESH.NODE))
2482                 pass
2483             pass
2484         aMeasurements = self.smeshpyD.CreateMeasurements()
2485         aMeasure = aMeasurements.BoundingBox(srclist)
2486         aMeasurements.UnRegister()
2487         return aMeasure
2488
2489     # Mesh edition (SMESH_MeshEditor functionality):
2490     # ---------------------------------------------
2491
2492     ## Removes the elements from the mesh by ids
2493     #  @param IDsOfElements is a list of ids of elements to remove
2494     #  @return True or False
2495     #  @ingroup l2_modif_del
2496     def RemoveElements(self, IDsOfElements):
2497         return self.editor.RemoveElements(IDsOfElements)
2498
2499     ## Removes nodes from mesh by ids
2500     #  @param IDsOfNodes is a list of ids of nodes to remove
2501     #  @return True or False
2502     #  @ingroup l2_modif_del
2503     def RemoveNodes(self, IDsOfNodes):
2504         return self.editor.RemoveNodes(IDsOfNodes)
2505
2506     ## Removes all orphan (free) nodes from mesh
2507     #  @return number of the removed nodes
2508     #  @ingroup l2_modif_del
2509     def RemoveOrphanNodes(self):
2510         return self.editor.RemoveOrphanNodes()
2511
2512     ## Add a node to the mesh by coordinates
2513     #  @return Id of the new node
2514     #  @ingroup l2_modif_add
2515     def AddNode(self, x, y, z):
2516         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2517         if hasVars: self.mesh.SetParameters(Parameters)
2518         return self.editor.AddNode( x, y, z)
2519
2520     ## Creates a 0D element on a node with given number.
2521     #  @param IDOfNode the ID of node for creation of the element.
2522     #  @return the Id of the new 0D element
2523     #  @ingroup l2_modif_add
2524     def Add0DElement(self, IDOfNode):
2525         return self.editor.Add0DElement(IDOfNode)
2526
2527     ## Create 0D elements on all nodes of the given elements except those
2528     #  nodes on which a 0D element already exists.
2529     #  @param theObject an object on whose nodes 0D elements will be created.
2530     #         It can be mesh, sub-mesh, group, list of element IDs or a holder
2531     #         of nodes IDs created by calling mesh.GetIDSource( nodes, SMESH.NODE )
2532     #  @param theGroupName optional name of a group to add 0D elements created
2533     #         and/or found on nodes of \a theObject.
2534     #  @return an object (a new group or a temporary SMESH_IDSource) holding
2535     #          IDs of new and/or found 0D elements. IDs of 0D elements
2536     #          can be retrieved from the returned object by calling GetIDs()
2537     #  @ingroup l2_modif_add
2538     def Add0DElementsToAllNodes(self, theObject, theGroupName=""):
2539         if isinstance( theObject, Mesh ):
2540             theObject = theObject.GetMesh()
2541         if isinstance( theObject, list ):
2542             theObject = self.GetIDSource( theObject, SMESH.ALL )
2543         return self.editor.Create0DElementsOnAllNodes( theObject, theGroupName )
2544
2545     ## Creates a ball element on a node with given ID.
2546     #  @param IDOfNode the ID of node for creation of the element.
2547     #  @param diameter the bal diameter.
2548     #  @return the Id of the new ball element
2549     #  @ingroup l2_modif_add
2550     def AddBall(self, IDOfNode, diameter):
2551         return self.editor.AddBall( IDOfNode, diameter )
2552
2553     ## Creates a linear or quadratic edge (this is determined
2554     #  by the number of given nodes).
2555     #  @param IDsOfNodes the list of node IDs for creation of the element.
2556     #  The order of nodes in this list should correspond to the description
2557     #  of MED. \n This description is located by the following link:
2558     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2559     #  @return the Id of the new edge
2560     #  @ingroup l2_modif_add
2561     def AddEdge(self, IDsOfNodes):
2562         return self.editor.AddEdge(IDsOfNodes)
2563
2564     ## Creates a linear or quadratic face (this is determined
2565     #  by the number of given nodes).
2566     #  @param IDsOfNodes the list of node IDs for creation of the element.
2567     #  The order of nodes in this list should correspond to the description
2568     #  of MED. \n This description is located by the following link:
2569     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2570     #  @return the Id of the new face
2571     #  @ingroup l2_modif_add
2572     def AddFace(self, IDsOfNodes):
2573         return self.editor.AddFace(IDsOfNodes)
2574
2575     ## Adds a polygonal face to the mesh by the list of node IDs
2576     #  @param IdsOfNodes the list of node IDs for creation of the element.
2577     #  @return the Id of the new face
2578     #  @ingroup l2_modif_add
2579     def AddPolygonalFace(self, IdsOfNodes):
2580         return self.editor.AddPolygonalFace(IdsOfNodes)
2581
2582     ## Creates both simple and quadratic volume (this is determined
2583     #  by the number of given nodes).
2584     #  @param IDsOfNodes the list of node IDs for creation of the element.
2585     #  The order of nodes in this list should correspond to the description
2586     #  of MED. \n This description is located by the following link:
2587     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2588     #  @return the Id of the new volumic element
2589     #  @ingroup l2_modif_add
2590     def AddVolume(self, IDsOfNodes):
2591         return self.editor.AddVolume(IDsOfNodes)
2592
2593     ## Creates a volume of many faces, giving nodes for each face.
2594     #  @param IdsOfNodes the list of node IDs for volume creation face by face.
2595     #  @param Quantities the list of integer values, Quantities[i]
2596     #         gives the quantity of nodes in face number i.
2597     #  @return the Id of the new volumic element
2598     #  @ingroup l2_modif_add
2599     def AddPolyhedralVolume (self, IdsOfNodes, Quantities):
2600         return self.editor.AddPolyhedralVolume(IdsOfNodes, Quantities)
2601
2602     ## Creates a volume of many faces, giving the IDs of the existing faces.
2603     #  @param IdsOfFaces the list of face IDs for volume creation.
2604     #
2605     #  Note:  The created volume will refer only to the nodes
2606     #         of the given faces, not to the faces themselves.
2607     #  @return the Id of the new volumic element
2608     #  @ingroup l2_modif_add
2609     def AddPolyhedralVolumeByFaces (self, IdsOfFaces):
2610         return self.editor.AddPolyhedralVolumeByFaces(IdsOfFaces)
2611
2612
2613     ## @brief Binds a node to a vertex
2614     #  @param NodeID a node ID
2615     #  @param Vertex a vertex or vertex ID
2616     #  @return True if succeed else raises an exception
2617     #  @ingroup l2_modif_add
2618     def SetNodeOnVertex(self, NodeID, Vertex):
2619         if ( isinstance( Vertex, geomBuilder.GEOM._objref_GEOM_Object)):
2620             VertexID = Vertex.GetSubShapeIndices()[0]
2621         else:
2622             VertexID = Vertex
2623         try:
2624             self.editor.SetNodeOnVertex(NodeID, VertexID)
2625         except SALOME.SALOME_Exception, inst:
2626             raise ValueError, inst.details.text
2627         return True
2628
2629
2630     ## @brief Stores the node position on an edge
2631     #  @param NodeID a node ID
2632     #  @param Edge an edge or edge ID
2633     #  @param paramOnEdge a parameter on the edge where the node is located
2634     #  @return True if succeed else raises an exception
2635     #  @ingroup l2_modif_add
2636     def SetNodeOnEdge(self, NodeID, Edge, paramOnEdge):
2637         if ( isinstance( Edge, geomBuilder.GEOM._objref_GEOM_Object)):
2638             EdgeID = Edge.GetSubShapeIndices()[0]
2639         else:
2640             EdgeID = Edge
2641         try:
2642             self.editor.SetNodeOnEdge(NodeID, EdgeID, paramOnEdge)
2643         except SALOME.SALOME_Exception, inst:
2644             raise ValueError, inst.details.text
2645         return True
2646
2647     ## @brief Stores node position on a face
2648     #  @param NodeID a node ID
2649     #  @param Face a face or face ID
2650     #  @param u U parameter on the face where the node is located
2651     #  @param v V parameter on the face where the node is located
2652     #  @return True if succeed else raises an exception
2653     #  @ingroup l2_modif_add
2654     def SetNodeOnFace(self, NodeID, Face, u, v):
2655         if ( isinstance( Face, geomBuilder.GEOM._objref_GEOM_Object)):
2656             FaceID = Face.GetSubShapeIndices()[0]
2657         else:
2658             FaceID = Face
2659         try:
2660             self.editor.SetNodeOnFace(NodeID, FaceID, u, v)
2661         except SALOME.SALOME_Exception, inst:
2662             raise ValueError, inst.details.text
2663         return True
2664
2665     ## @brief Binds a node to a solid
2666     #  @param NodeID a node ID
2667     #  @param Solid  a solid or solid ID
2668     #  @return True if succeed else raises an exception
2669     #  @ingroup l2_modif_add
2670     def SetNodeInVolume(self, NodeID, Solid):
2671         if ( isinstance( Solid, geomBuilder.GEOM._objref_GEOM_Object)):
2672             SolidID = Solid.GetSubShapeIndices()[0]
2673         else:
2674             SolidID = Solid
2675         try:
2676             self.editor.SetNodeInVolume(NodeID, SolidID)
2677         except SALOME.SALOME_Exception, inst:
2678             raise ValueError, inst.details.text
2679         return True
2680
2681     ## @brief Bind an element to a shape
2682     #  @param ElementID an element ID
2683     #  @param Shape a shape or shape ID
2684     #  @return True if succeed else raises an exception
2685     #  @ingroup l2_modif_add
2686     def SetMeshElementOnShape(self, ElementID, Shape):
2687         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2688             ShapeID = Shape.GetSubShapeIndices()[0]
2689         else:
2690             ShapeID = Shape
2691         try:
2692             self.editor.SetMeshElementOnShape(ElementID, ShapeID)
2693         except SALOME.SALOME_Exception, inst:
2694             raise ValueError, inst.details.text
2695         return True
2696
2697
2698     ## Moves the node with the given id
2699     #  @param NodeID the id of the node
2700     #  @param x  a new X coordinate
2701     #  @param y  a new Y coordinate
2702     #  @param z  a new Z coordinate
2703     #  @return True if succeed else False
2704     #  @ingroup l2_modif_movenode
2705     def MoveNode(self, NodeID, x, y, z):
2706         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2707         if hasVars: self.mesh.SetParameters(Parameters)
2708         return self.editor.MoveNode(NodeID, x, y, z)
2709
2710     ## Finds the node closest to a point and moves it to a point location
2711     #  @param x  the X coordinate of a point
2712     #  @param y  the Y coordinate of a point
2713     #  @param z  the Z coordinate of a point
2714     #  @param NodeID if specified (>0), the node with this ID is moved,
2715     #  otherwise, the node closest to point (@a x,@a y,@a z) is moved
2716     #  @return the ID of a node
2717     #  @ingroup l2_modif_throughp
2718     def MoveClosestNodeToPoint(self, x, y, z, NodeID):
2719         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2720         if hasVars: self.mesh.SetParameters(Parameters)
2721         return self.editor.MoveClosestNodeToPoint(x, y, z, NodeID)
2722
2723     ## Finds the node closest to a point
2724     #  @param x  the X coordinate of a point
2725     #  @param y  the Y coordinate of a point
2726     #  @param z  the Z coordinate of a point
2727     #  @return the ID of a node
2728     #  @ingroup l2_modif_throughp
2729     def FindNodeClosestTo(self, x, y, z):
2730         #preview = self.mesh.GetMeshEditPreviewer()
2731         #return preview.MoveClosestNodeToPoint(x, y, z, -1)
2732         return self.editor.FindNodeClosestTo(x, y, z)
2733
2734     ## Finds the elements where a point lays IN or ON
2735     #  @param x  the X coordinate of a point
2736     #  @param y  the Y coordinate of a point
2737     #  @param z  the Z coordinate of a point
2738     #  @param elementType type of elements to find (SMESH.ALL type
2739     #         means elements of any type excluding nodes, discrete and 0D elements)
2740     #  @param meshPart a part of mesh (group, sub-mesh) to search within
2741     #  @return list of IDs of found elements
2742     #  @ingroup l2_modif_throughp
2743     def FindElementsByPoint(self, x, y, z, elementType = SMESH.ALL, meshPart=None):
2744         if meshPart:
2745             return self.editor.FindAmongElementsByPoint( meshPart, x, y, z, elementType );
2746         else:
2747             return self.editor.FindElementsByPoint(x, y, z, elementType)
2748
2749     # Return point state in a closed 2D mesh in terms of TopAbs_State enumeration:
2750     # 0-IN, 1-OUT, 2-ON, 3-UNKNOWN
2751     # TopAbs_UNKNOWN state means that either mesh is wrong or the analysis fails.
2752
2753     def GetPointState(self, x, y, z):
2754         return self.editor.GetPointState(x, y, z)
2755
2756     ## Finds the node closest to a point and moves it to a point location
2757     #  @param x  the X coordinate of a point
2758     #  @param y  the Y coordinate of a point
2759     #  @param z  the Z coordinate of a point
2760     #  @return the ID of a moved node
2761     #  @ingroup l2_modif_throughp
2762     def MeshToPassThroughAPoint(self, x, y, z):
2763         return self.editor.MoveClosestNodeToPoint(x, y, z, -1)
2764
2765     ## Replaces two neighbour triangles sharing Node1-Node2 link
2766     #  with the triangles built on the same 4 nodes but having other common link.
2767     #  @param NodeID1  the ID of the first node
2768     #  @param NodeID2  the ID of the second node
2769     #  @return false if proper faces were not found
2770     #  @ingroup l2_modif_invdiag
2771     def InverseDiag(self, NodeID1, NodeID2):
2772         return self.editor.InverseDiag(NodeID1, NodeID2)
2773
2774     ## Replaces two neighbour triangles sharing Node1-Node2 link
2775     #  with a quadrangle built on the same 4 nodes.
2776     #  @param NodeID1  the ID of the first node
2777     #  @param NodeID2  the ID of the second node
2778     #  @return false if proper faces were not found
2779     #  @ingroup l2_modif_unitetri
2780     def DeleteDiag(self, NodeID1, NodeID2):
2781         return self.editor.DeleteDiag(NodeID1, NodeID2)
2782
2783     ## Reorients elements by ids
2784     #  @param IDsOfElements if undefined reorients all mesh elements
2785     #  @return True if succeed else False
2786     #  @ingroup l2_modif_changori
2787     def Reorient(self, IDsOfElements=None):
2788         if IDsOfElements == None:
2789             IDsOfElements = self.GetElementsId()
2790         return self.editor.Reorient(IDsOfElements)
2791
2792     ## Reorients all elements of the object
2793     #  @param theObject mesh, submesh or group
2794     #  @return True if succeed else False
2795     #  @ingroup l2_modif_changori
2796     def ReorientObject(self, theObject):
2797         if ( isinstance( theObject, Mesh )):
2798             theObject = theObject.GetMesh()
2799         return self.editor.ReorientObject(theObject)
2800
2801     ## Reorient faces contained in \a the2DObject.
2802     #  @param the2DObject is a mesh, sub-mesh, group or list of IDs of 2D elements
2803     #  @param theDirection is a desired direction of normal of \a theFace.
2804     #         It can be either a GEOM vector or a list of coordinates [x,y,z].
2805     #  @param theFaceOrPoint defines a face of \a the2DObject whose normal will be
2806     #         compared with theDirection. It can be either ID of face or a point
2807     #         by which the face will be found. The point can be given as either
2808     #         a GEOM vertex or a list of point coordinates.
2809     #  @return number of reoriented faces
2810     #  @ingroup l2_modif_changori
2811     def Reorient2D(self, the2DObject, theDirection, theFaceOrPoint ):
2812         # check the2DObject
2813         if isinstance( the2DObject, Mesh ):
2814             the2DObject = the2DObject.GetMesh()
2815         if isinstance( the2DObject, list ):
2816             the2DObject = self.GetIDSource( the2DObject, SMESH.FACE )
2817         # check theDirection
2818         if isinstance( theDirection, geomBuilder.GEOM._objref_GEOM_Object):
2819             theDirection = self.smeshpyD.GetDirStruct( theDirection )
2820         if isinstance( theDirection, list ):
2821             theDirection = self.smeshpyD.MakeDirStruct( *theDirection  )
2822         # prepare theFace and thePoint
2823         theFace = theFaceOrPoint
2824         thePoint = PointStruct(0,0,0)
2825         if isinstance( theFaceOrPoint, geomBuilder.GEOM._objref_GEOM_Object):
2826             thePoint = self.smeshpyD.GetPointStruct( theFaceOrPoint )
2827             theFace = -1
2828         if isinstance( theFaceOrPoint, list ):
2829             thePoint = PointStruct( *theFaceOrPoint )
2830             theFace = -1
2831         if isinstance( theFaceOrPoint, PointStruct ):
2832             thePoint = theFaceOrPoint
2833             theFace = -1
2834         return self.editor.Reorient2D( the2DObject, theDirection, theFace, thePoint )
2835
2836     ## Fuses the neighbouring triangles into quadrangles.
2837     #  @param IDsOfElements The triangles to be fused,
2838     #  @param theCriterion  is a numerical functor, in terms of enum SMESH.FunctorType, used to
2839     #                       choose a neighbour to fuse with.
2840     #  @param MaxAngle      is the maximum angle between element normals at which the fusion
2841     #                       is still performed; theMaxAngle is mesured in radians.
2842     #                       Also it could be a name of variable which defines angle in degrees.
2843     #  @return TRUE in case of success, FALSE otherwise.
2844     #  @ingroup l2_modif_unitetri
2845     def TriToQuad(self, IDsOfElements, theCriterion, MaxAngle):
2846         MaxAngle,Parameters,hasVars = ParseAngles(MaxAngle)
2847         self.mesh.SetParameters(Parameters)
2848         if not IDsOfElements:
2849             IDsOfElements = self.GetElementsId()
2850         Functor = self.smeshpyD.GetFunctor(theCriterion)
2851         return self.editor.TriToQuad(IDsOfElements, Functor, MaxAngle)
2852
2853     ## Fuses the neighbouring triangles of the object into quadrangles
2854     #  @param theObject is mesh, submesh or group
2855     #  @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to
2856     #         choose a neighbour to fuse with.
2857     #  @param MaxAngle   a max angle between element normals at which the fusion
2858     #                   is still performed; theMaxAngle is mesured in radians.
2859     #  @return TRUE in case of success, FALSE otherwise.
2860     #  @ingroup l2_modif_unitetri
2861     def TriToQuadObject (self, theObject, theCriterion, MaxAngle):
2862         MaxAngle,Parameters,hasVars = ParseAngles(MaxAngle)
2863         self.mesh.SetParameters(Parameters)
2864         if isinstance( theObject, Mesh ):
2865             theObject = theObject.GetMesh()
2866         Functor = self.smeshpyD.GetFunctor(theCriterion)
2867         return self.editor.TriToQuadObject(theObject, Functor, MaxAngle)
2868
2869     ## Splits quadrangles into triangles.
2870     #  @param IDsOfElements the faces to be splitted.
2871     #  @param theCriterion   is a numerical functor, in terms of enum SMESH.FunctorType, used to
2872     #         choose a diagonal for splitting. If @a theCriterion is None, which is a default
2873     #         value, then quadrangles will be split by the smallest diagonal.
2874     #  @return TRUE in case of success, FALSE otherwise.
2875     #  @ingroup l2_modif_cutquadr
2876     def QuadToTri (self, IDsOfElements, theCriterion = None):
2877         if IDsOfElements == []:
2878             IDsOfElements = self.GetElementsId()
2879         if theCriterion is None:
2880             theCriterion = FT_MaxElementLength2D
2881         Functor = self.smeshpyD.GetFunctor(theCriterion)
2882         return self.editor.QuadToTri(IDsOfElements, Functor)
2883
2884     ## Splits quadrangles into triangles.
2885     #  @param theObject the object from which the list of elements is taken,
2886     #         this is mesh, submesh or group
2887     #  @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to
2888     #         choose a diagonal for splitting. If @a theCriterion is None, which is a default
2889     #         value, then quadrangles will be split by the smallest diagonal.
2890     #  @return TRUE in case of success, FALSE otherwise.
2891     #  @ingroup l2_modif_cutquadr
2892     def QuadToTriObject (self, theObject, theCriterion = None):
2893         if ( isinstance( theObject, Mesh )):
2894             theObject = theObject.GetMesh()
2895         if theCriterion is None:
2896             theCriterion = FT_MaxElementLength2D
2897         Functor = self.smeshpyD.GetFunctor(theCriterion)
2898         return self.editor.QuadToTriObject(theObject, Functor)
2899
2900     ## Splits each of given quadrangles into 4 triangles. A node is added at the center of
2901     #  a quadrangle.
2902     #  @param theElements the faces to be splitted. This can be either mesh, sub-mesh,
2903     #         group or a list of face IDs. By default all quadrangles are split
2904     #  @ingroup l2_modif_cutquadr
2905     def QuadTo4Tri (self, theElements=[]):
2906         if isinstance( theElements, Mesh ):
2907             theElements = theElements.mesh
2908         elif not theElements:
2909             theElements = self.mesh
2910         elif isinstance( theElements, list ):
2911             theElements = self.GetIDSource( theElements, SMESH.FACE )
2912         return self.editor.QuadTo4Tri( theElements )
2913
2914     ## Splits quadrangles into triangles.
2915     #  @param IDsOfElements the faces to be splitted
2916     #  @param Diag13        is used to choose a diagonal for splitting.
2917     #  @return TRUE in case of success, FALSE otherwise.
2918     #  @ingroup l2_modif_cutquadr
2919     def SplitQuad (self, IDsOfElements, Diag13):
2920         if IDsOfElements == []:
2921             IDsOfElements = self.GetElementsId()
2922         return self.editor.SplitQuad(IDsOfElements, Diag13)
2923
2924     ## Splits quadrangles into triangles.
2925     #  @param theObject the object from which the list of elements is taken,
2926     #         this is mesh, submesh or group
2927     #  @param Diag13    is used to choose a diagonal for splitting.
2928     #  @return TRUE in case of success, FALSE otherwise.
2929     #  @ingroup l2_modif_cutquadr
2930     def SplitQuadObject (self, theObject, Diag13):
2931         if ( isinstance( theObject, Mesh )):
2932             theObject = theObject.GetMesh()
2933         return self.editor.SplitQuadObject(theObject, Diag13)
2934
2935     ## Finds a better splitting of the given quadrangle.
2936     #  @param IDOfQuad   the ID of the quadrangle to be splitted.
2937     #  @param theCriterion  is a numerical functor, in terms of enum SMESH.FunctorType, used to
2938     #         choose a diagonal for splitting.
2939     #  @return 1 if 1-3 diagonal is better, 2 if 2-4
2940     #          diagonal is better, 0 if error occurs.
2941     #  @ingroup l2_modif_cutquadr
2942     def BestSplit (self, IDOfQuad, theCriterion):
2943         return self.editor.BestSplit(IDOfQuad, self.smeshpyD.GetFunctor(theCriterion))
2944
2945     ## Splits volumic elements into tetrahedrons
2946     #  @param elemIDs either list of elements or mesh or group or submesh
2947     #  @param method  flags passing splitting method: Hex_5Tet, Hex_6Tet, Hex_24Tet
2948     #         Hex_5Tet - split the hexahedron into 5 tetrahedrons, etc
2949     #  @ingroup l2_modif_cutquadr
2950     def SplitVolumesIntoTetra(self, elemIDs, method=smeshBuilder.Hex_5Tet ):
2951         if isinstance( elemIDs, Mesh ):
2952             elemIDs = elemIDs.GetMesh()
2953         if ( isinstance( elemIDs, list )):
2954             elemIDs = self.editor.MakeIDSource(elemIDs, SMESH.VOLUME)
2955         self.editor.SplitVolumesIntoTetra(elemIDs, method)
2956
2957     ## Splits quadrangle faces near triangular facets of volumes
2958     #
2959     #  @ingroup l1_auxiliary
2960     def SplitQuadsNearTriangularFacets(self):
2961         faces_array = self.GetElementsByType(SMESH.FACE)
2962         for face_id in faces_array:
2963             if self.GetElemNbNodes(face_id) == 4: # quadrangle
2964                 quad_nodes = self.mesh.GetElemNodes(face_id)
2965                 node1_elems = self.GetNodeInverseElements(quad_nodes[1 -1])
2966                 isVolumeFound = False
2967                 for node1_elem in node1_elems:
2968                     if not isVolumeFound:
2969                         if self.GetElementType(node1_elem, True) == SMESH.VOLUME:
2970                             nb_nodes = self.GetElemNbNodes(node1_elem)
2971                             if 3 < nb_nodes and nb_nodes < 7: # tetra or penta, or prism
2972                                 volume_elem = node1_elem
2973                                 volume_nodes = self.mesh.GetElemNodes(volume_elem)
2974                                 if volume_nodes.count(quad_nodes[2 -1]) > 0: # 1,2
2975                                     if volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,2,4
2976                                         isVolumeFound = True
2977                                         if volume_nodes.count(quad_nodes[3 -1]) == 0: # 1,2,4 & !3
2978                                             self.SplitQuad([face_id], False) # diagonal 2-4
2979                                     elif volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,2,3 & !4
2980                                         isVolumeFound = True
2981                                         self.SplitQuad([face_id], True) # diagonal 1-3
2982                                 elif volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,4 & !2
2983                                     if volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,4,3 & !2
2984                                         isVolumeFound = True
2985                                         self.SplitQuad([face_id], True) # diagonal 1-3
2986
2987     ## @brief Splits hexahedrons into tetrahedrons.
2988     #
2989     #  This operation uses pattern mapping functionality for splitting.
2990     #  @param theObject the object from which the list of hexahedrons is taken; this is mesh, submesh or group.
2991     #  @param theNode000,theNode001 within the range [0,7]; gives the orientation of the
2992     #         pattern relatively each hexahedron: the (0,0,0) key-point of the pattern
2993     #         will be mapped into <VAR>theNode000</VAR>-th node of each volume, the (0,0,1)
2994     #         key-point will be mapped into <VAR>theNode001</VAR>-th node of each volume.
2995     #         The (0,0,0) key-point of the used pattern corresponds to a non-split corner.
2996     #  @return TRUE in case of success, FALSE otherwise.
2997     #  @ingroup l1_auxiliary
2998     def SplitHexaToTetras (self, theObject, theNode000, theNode001):
2999         # Pattern:     5.---------.6
3000         #              /|#*      /|
3001         #             / | #*    / |
3002         #            /  |  # * /  |
3003         #           /   |   # /*  |
3004         # (0,0,1) 4.---------.7 * |
3005         #          |#*  |1   | # *|
3006         #          | # *.----|---#.2
3007         #          |  #/ *   |   /
3008         #          |  /#  *  |  /
3009         #          | /   # * | /
3010         #          |/      #*|/
3011         # (0,0,0) 0.---------.3
3012         pattern_tetra = "!!! Nb of points: \n 8 \n\
3013         !!! Points: \n\
3014         0 0 0  !- 0 \n\
3015         0 1 0  !- 1 \n\
3016         1 1 0  !- 2 \n\
3017         1 0 0  !- 3 \n\
3018         0 0 1  !- 4 \n\
3019         0 1 1  !- 5 \n\
3020         1 1 1  !- 6 \n\
3021         1 0 1  !- 7 \n\
3022         !!! Indices of points of 6 tetras: \n\
3023         0 3 4 1 \n\
3024         7 4 3 1 \n\
3025         4 7 5 1 \n\
3026         6 2 5 7 \n\
3027         1 5 2 7 \n\
3028         2 3 1 7 \n"
3029
3030         pattern = self.smeshpyD.GetPattern()
3031         isDone  = pattern.LoadFromFile(pattern_tetra)
3032         if not isDone:
3033             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
3034             return isDone
3035
3036         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
3037         isDone = pattern.MakeMesh(self.mesh, False, False)
3038         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
3039
3040         # split quafrangle faces near triangular facets of volumes
3041         self.SplitQuadsNearTriangularFacets()
3042
3043         return isDone
3044
3045     ## @brief Split hexahedrons into prisms.
3046     #
3047     #  Uses the pattern mapping functionality for splitting.
3048     #  @param theObject the object (mesh, submesh or group) from where the list of hexahedrons is taken;
3049     #  @param theNode000,theNode001 (within the range [0,7]) gives the orientation of the
3050     #         pattern relatively each hexahedron: keypoint (0,0,0) of the pattern
3051     #         will be mapped into the <VAR>theNode000</VAR>-th node of each volume, keypoint (0,0,1)
3052     #         will be mapped into the <VAR>theNode001</VAR>-th node of each volume.
3053     #         Edge (0,0,0)-(0,0,1) of used pattern connects two not split corners.
3054     #  @return TRUE in case of success, FALSE otherwise.
3055     #  @ingroup l1_auxiliary
3056     def SplitHexaToPrisms (self, theObject, theNode000, theNode001):
3057         # Pattern:     5.---------.6
3058         #              /|#       /|
3059         #             / | #     / |
3060         #            /  |  #   /  |
3061         #           /   |   # /   |
3062         # (0,0,1) 4.---------.7   |
3063         #          |    |    |    |
3064         #          |   1.----|----.2
3065         #          |   / *   |   /
3066         #          |  /   *  |  /
3067         #          | /     * | /
3068         #          |/       *|/
3069         # (0,0,0) 0.---------.3
3070         pattern_prism = "!!! Nb of points: \n 8 \n\
3071         !!! Points: \n\
3072         0 0 0  !- 0 \n\
3073         0 1 0  !- 1 \n\
3074         1 1 0  !- 2 \n\
3075         1 0 0  !- 3 \n\
3076         0 0 1  !- 4 \n\
3077         0 1 1  !- 5 \n\
3078         1 1 1  !- 6 \n\
3079         1 0 1  !- 7 \n\
3080         !!! Indices of points of 2 prisms: \n\
3081         0 1 3 4 5 7 \n\
3082         2 3 1 6 7 5 \n"
3083
3084         pattern = self.smeshpyD.GetPattern()
3085         isDone  = pattern.LoadFromFile(pattern_prism)
3086         if not isDone:
3087             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
3088             return isDone
3089
3090         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
3091         isDone = pattern.MakeMesh(self.mesh, False, False)
3092         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
3093
3094         # Splits quafrangle faces near triangular facets of volumes
3095         self.SplitQuadsNearTriangularFacets()
3096
3097         return isDone
3098
3099     ## Smoothes elements
3100     #  @param IDsOfElements the list if ids of elements to smooth
3101     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3102     #  Note that nodes built on edges and boundary nodes are always fixed.
3103     #  @param MaxNbOfIterations the maximum number of iterations
3104     #  @param MaxAspectRatio varies in range [1.0, inf]
3105     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3106     #  @return TRUE in case of success, FALSE otherwise.
3107     #  @ingroup l2_modif_smooth
3108     def Smooth(self, IDsOfElements, IDsOfFixedNodes,
3109                MaxNbOfIterations, MaxAspectRatio, Method):
3110         if IDsOfElements == []:
3111             IDsOfElements = self.GetElementsId()
3112         MaxNbOfIterations,MaxAspectRatio,Parameters,hasVars = ParseParameters(MaxNbOfIterations,MaxAspectRatio)
3113         self.mesh.SetParameters(Parameters)
3114         return self.editor.Smooth(IDsOfElements, IDsOfFixedNodes,
3115                                   MaxNbOfIterations, MaxAspectRatio, Method)
3116
3117     ## Smoothes elements which belong to the given object
3118     #  @param theObject the object to smooth
3119     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3120     #  Note that nodes built on edges and boundary nodes are always fixed.
3121     #  @param MaxNbOfIterations the maximum number of iterations
3122     #  @param MaxAspectRatio varies in range [1.0, inf]
3123     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3124     #  @return TRUE in case of success, FALSE otherwise.
3125     #  @ingroup l2_modif_smooth
3126     def SmoothObject(self, theObject, IDsOfFixedNodes,
3127                      MaxNbOfIterations, MaxAspectRatio, Method):
3128         if ( isinstance( theObject, Mesh )):
3129             theObject = theObject.GetMesh()
3130         return self.editor.SmoothObject(theObject, IDsOfFixedNodes,
3131                                         MaxNbOfIterations, MaxAspectRatio, Method)
3132
3133     ## Parametrically smoothes the given elements
3134     #  @param IDsOfElements the list if ids of elements to smooth
3135     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3136     #  Note that nodes built on edges and boundary nodes are always fixed.
3137     #  @param MaxNbOfIterations the maximum number of iterations
3138     #  @param MaxAspectRatio varies in range [1.0, inf]
3139     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3140     #  @return TRUE in case of success, FALSE otherwise.
3141     #  @ingroup l2_modif_smooth
3142     def SmoothParametric(self, IDsOfElements, IDsOfFixedNodes,
3143                          MaxNbOfIterations, MaxAspectRatio, Method):
3144         if IDsOfElements == []:
3145             IDsOfElements = self.GetElementsId()
3146         MaxNbOfIterations,MaxAspectRatio,Parameters,hasVars = ParseParameters(MaxNbOfIterations,MaxAspectRatio)
3147         self.mesh.SetParameters(Parameters)
3148         return self.editor.SmoothParametric(IDsOfElements, IDsOfFixedNodes,
3149                                             MaxNbOfIterations, MaxAspectRatio, Method)
3150
3151     ## Parametrically smoothes the elements which belong to the given object
3152     #  @param theObject the object to smooth
3153     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3154     #  Note that nodes built on edges and boundary nodes are always fixed.
3155     #  @param MaxNbOfIterations the maximum number of iterations
3156     #  @param MaxAspectRatio varies in range [1.0, inf]
3157     #  @param Method Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3158     #  @return TRUE in case of success, FALSE otherwise.
3159     #  @ingroup l2_modif_smooth
3160     def SmoothParametricObject(self, theObject, IDsOfFixedNodes,
3161                                MaxNbOfIterations, MaxAspectRatio, Method):
3162         if ( isinstance( theObject, Mesh )):
3163             theObject = theObject.GetMesh()
3164         return self.editor.SmoothParametricObject(theObject, IDsOfFixedNodes,
3165                                                   MaxNbOfIterations, MaxAspectRatio, Method)
3166
3167     ## Converts the mesh to quadratic or bi-quadratic, deletes old elements, replacing
3168     #  them with quadratic with the same id.
3169     #  @param theForce3d new node creation method:
3170     #         0 - the medium node lies at the geometrical entity from which the mesh element is built
3171     #         1 - the medium node lies at the middle of the line segments connecting start and end node of a mesh element
3172     #  @param theSubMesh a group or a sub-mesh to convert; WARNING: in this case the mesh can become not conformal
3173     #  @param theToBiQuad If True, converts the mesh to bi-quadratic
3174     #  @ingroup l2_modif_tofromqu
3175     def ConvertToQuadratic(self, theForce3d, theSubMesh=None, theToBiQuad=False):
3176         if isinstance( theSubMesh, Mesh ):
3177             theSubMesh = theSubMesh.mesh
3178         if theToBiQuad:
3179             self.editor.ConvertToBiQuadratic(theForce3d,theSubMesh)
3180         else:
3181             if theSubMesh:
3182                 self.editor.ConvertToQuadraticObject(theForce3d,theSubMesh)
3183             else:
3184                 self.editor.ConvertToQuadratic(theForce3d)
3185         error = self.editor.GetLastError()
3186         if error and error.comment:
3187             print error.comment
3188
3189     ## Converts the mesh from quadratic to ordinary,
3190     #  deletes old quadratic elements, \n replacing
3191     #  them with ordinary mesh elements with the same id.
3192     #  @param theSubMesh a group or a sub-mesh to convert; WARNING: in this case the mesh can become not conformal
3193     #  @ingroup l2_modif_tofromqu
3194     def ConvertFromQuadratic(self, theSubMesh=None):
3195         if theSubMesh:
3196             self.editor.ConvertFromQuadraticObject(theSubMesh)
3197         else:
3198             return self.editor.ConvertFromQuadratic()
3199
3200     ## Creates 2D mesh as skin on boundary faces of a 3D mesh
3201     #  @return TRUE if operation has been completed successfully, FALSE otherwise
3202     #  @ingroup l2_modif_edit
3203     def  Make2DMeshFrom3D(self):
3204         return self.editor. Make2DMeshFrom3D()
3205
3206     ## Creates missing boundary elements
3207     #  @param elements - elements whose boundary is to be checked:
3208     #                    mesh, group, sub-mesh or list of elements
3209     #   if elements is mesh, it must be the mesh whose MakeBoundaryMesh() is called
3210     #  @param dimension - defines type of boundary elements to create:
3211     #                     SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D
3212     #    SMESH.BND_1DFROM3D creates mesh edges on all borders of free facets of 3D cells
3213     #  @param groupName - a name of group to store created boundary elements in,
3214     #                     "" means not to create the group
3215     #  @param meshName - a name of new mesh to store created boundary elements in,
3216     #                     "" means not to create the new mesh
3217     #  @param toCopyElements - if true, the checked elements will be copied into
3218     #     the new mesh else only boundary elements will be copied into the new mesh
3219     #  @param toCopyExistingBondary - if true, not only new but also pre-existing
3220     #     boundary elements will be copied into the new mesh
3221     #  @return tuple (mesh, group) where bondary elements were added to
3222     #  @ingroup l2_modif_edit
3223     def MakeBoundaryMesh(self, elements, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="",
3224                          toCopyElements=False, toCopyExistingBondary=False):
3225         if isinstance( elements, Mesh ):
3226             elements = elements.GetMesh()
3227         if ( isinstance( elements, list )):
3228             elemType = SMESH.ALL
3229             if elements: elemType = self.GetElementType( elements[0], iselem=True)
3230             elements = self.editor.MakeIDSource(elements, elemType)
3231         mesh, group = self.editor.MakeBoundaryMesh(elements,dimension,groupName,meshName,
3232                                                    toCopyElements,toCopyExistingBondary)
3233         if mesh: mesh = self.smeshpyD.Mesh(mesh)
3234         return mesh, group
3235
3236     ##
3237     # @brief Creates missing boundary elements around either the whole mesh or
3238     #    groups of 2D elements
3239     #  @param dimension - defines type of boundary elements to create
3240     #  @param groupName - a name of group to store all boundary elements in,
3241     #    "" means not to create the group
3242     #  @param meshName - a name of a new mesh, which is a copy of the initial
3243     #    mesh + created boundary elements; "" means not to create the new mesh
3244     #  @param toCopyAll - if true, the whole initial mesh will be copied into
3245     #    the new mesh else only boundary elements will be copied into the new mesh
3246     #  @param groups - groups of 2D elements to make boundary around
3247     #  @retval tuple( long, mesh, groups )
3248     #                 long - number of added boundary elements
3249     #                 mesh - the mesh where elements were added to
3250     #                 group - the group of boundary elements or None
3251     #
3252     def MakeBoundaryElements(self, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="",
3253                              toCopyAll=False, groups=[]):
3254         nb, mesh, group = self.editor.MakeBoundaryElements(dimension,groupName,meshName,
3255                                                            toCopyAll,groups)
3256         if mesh: mesh = self.smeshpyD.Mesh(mesh)
3257         return nb, mesh, group
3258
3259     ## Renumber mesh nodes
3260     #  @ingroup l2_modif_renumber
3261     def RenumberNodes(self):
3262         self.editor.RenumberNodes()
3263
3264     ## Renumber mesh elements
3265     #  @ingroup l2_modif_renumber
3266     def RenumberElements(self):
3267         self.editor.RenumberElements()
3268
3269     ## Generates new elements by rotation of the elements around the axis
3270     #  @param IDsOfElements the list of ids of elements to sweep
3271     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3272     #  @param AngleInRadians the angle of Rotation (in radians) or a name of variable which defines angle in degrees
3273     #  @param NbOfSteps the number of steps
3274     #  @param Tolerance tolerance
3275     #  @param MakeGroups forces the generation of new groups from existing ones
3276     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3277     #                    of all steps, else - size of each step
3278     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3279     #  @ingroup l2_modif_extrurev
3280     def RotationSweep(self, IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance,
3281                       MakeGroups=False, TotalAngle=False):
3282         if IDsOfElements == []:
3283             IDsOfElements = self.GetElementsId()
3284         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3285             Axis = self.smeshpyD.GetAxisStruct(Axis)
3286         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3287         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3288         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3289         self.mesh.SetParameters(Parameters)
3290         if TotalAngle and NbOfSteps:
3291             AngleInRadians /= NbOfSteps
3292         if MakeGroups:
3293             return self.editor.RotationSweepMakeGroups(IDsOfElements, Axis,
3294                                                        AngleInRadians, NbOfSteps, Tolerance)
3295         self.editor.RotationSweep(IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance)
3296         return []
3297
3298     ## Generates new elements by rotation of the elements of object around the axis
3299     #  @param theObject object which elements should be sweeped.
3300     #                   It can be a mesh, a sub mesh or a group.
3301     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3302     #  @param AngleInRadians the angle of Rotation
3303     #  @param NbOfSteps number of steps
3304     #  @param Tolerance tolerance
3305     #  @param MakeGroups forces the generation of new groups from existing ones
3306     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3307     #                    of all steps, else - size of each step
3308     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3309     #  @ingroup l2_modif_extrurev
3310     def RotationSweepObject(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
3311                             MakeGroups=False, TotalAngle=False):
3312         if ( isinstance( theObject, Mesh )):
3313             theObject = theObject.GetMesh()
3314         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3315             Axis = self.smeshpyD.GetAxisStruct(Axis)
3316         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3317         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3318         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3319         self.mesh.SetParameters(Parameters)
3320         if TotalAngle and NbOfSteps:
3321             AngleInRadians /= NbOfSteps
3322         if MakeGroups:
3323             return self.editor.RotationSweepObjectMakeGroups(theObject, Axis, AngleInRadians,
3324                                                              NbOfSteps, Tolerance)
3325         self.editor.RotationSweepObject(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
3326         return []
3327
3328     ## Generates new elements by rotation of the elements of object around the axis
3329     #  @param theObject object which elements should be sweeped.
3330     #                   It can be a mesh, a sub mesh or a group.
3331     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3332     #  @param AngleInRadians the angle of Rotation
3333     #  @param NbOfSteps number of steps
3334     #  @param Tolerance tolerance
3335     #  @param MakeGroups forces the generation of new groups from existing ones
3336     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3337     #                    of all steps, else - size of each step
3338     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3339     #  @ingroup l2_modif_extrurev
3340     def RotationSweepObject1D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
3341                               MakeGroups=False, TotalAngle=False):
3342         if ( isinstance( theObject, Mesh )):
3343             theObject = theObject.GetMesh()
3344         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3345             Axis = self.smeshpyD.GetAxisStruct(Axis)
3346         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3347         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3348         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3349         self.mesh.SetParameters(Parameters)
3350         if TotalAngle and NbOfSteps:
3351             AngleInRadians /= NbOfSteps
3352         if MakeGroups:
3353             return self.editor.RotationSweepObject1DMakeGroups(theObject, Axis, AngleInRadians,
3354                                                                NbOfSteps, Tolerance)
3355         self.editor.RotationSweepObject1D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
3356         return []
3357
3358     ## Generates new elements by rotation of the elements of object around the axis
3359     #  @param theObject object which elements should be sweeped.
3360     #                   It can be a mesh, a sub mesh or a group.
3361     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3362     #  @param AngleInRadians the angle of Rotation
3363     #  @param NbOfSteps number of steps
3364     #  @param Tolerance tolerance
3365     #  @param MakeGroups forces the generation of new groups from existing ones
3366     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3367     #                    of all steps, else - size of each step
3368     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3369     #  @ingroup l2_modif_extrurev
3370     def RotationSweepObject2D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
3371                               MakeGroups=False, TotalAngle=False):
3372         if ( isinstance( theObject, Mesh )):
3373             theObject = theObject.GetMesh()
3374         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3375             Axis = self.smeshpyD.GetAxisStruct(Axis)
3376         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3377         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3378         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3379         self.mesh.SetParameters(Parameters)
3380         if TotalAngle and NbOfSteps:
3381             AngleInRadians /= NbOfSteps
3382         if MakeGroups:
3383             return self.editor.RotationSweepObject2DMakeGroups(theObject, Axis, AngleInRadians,
3384                                                              NbOfSteps, Tolerance)
3385         self.editor.RotationSweepObject2D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
3386         return []
3387
3388     ## Generates new elements by extrusion of the elements with given ids
3389     #  @param IDsOfElements the list of elements ids for extrusion
3390     #  @param StepVector vector or DirStruct or 3 vector components, defining
3391     #         the direction and value of extrusion for one step (the total extrusion
3392     #         length will be NbOfSteps * ||StepVector||)
3393     #  @param NbOfSteps the number of steps
3394     #  @param MakeGroups forces the generation of new groups from existing ones
3395     #  @param IsNodes is True if elements with given ids are nodes
3396     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3397     #  @ingroup l2_modif_extrurev
3398     def ExtrusionSweep(self, IDsOfElements, StepVector, NbOfSteps, MakeGroups=False, IsNodes = False):
3399         if IDsOfElements == []:
3400             IDsOfElements = self.GetElementsId()
3401         if isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object):
3402             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3403         if isinstance( StepVector, list ):
3404             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3405         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3406         Parameters = StepVector.PS.parameters + var_separator + Parameters
3407         self.mesh.SetParameters(Parameters)
3408         if MakeGroups:
3409             if(IsNodes):
3410                 return self.editor.ExtrusionSweepMakeGroups0D(IDsOfElements, StepVector, NbOfSteps)
3411             else:
3412                 return self.editor.ExtrusionSweepMakeGroups(IDsOfElements, StepVector, NbOfSteps)
3413         if(IsNodes):
3414             self.editor.ExtrusionSweep0D(IDsOfElements, StepVector, NbOfSteps)
3415         else:
3416             self.editor.ExtrusionSweep(IDsOfElements, StepVector, NbOfSteps)
3417         return []
3418
3419     ## Generates new elements by extrusion of the elements with given ids
3420     #  @param IDsOfElements is ids of elements
3421     #  @param StepVector vector or DirStruct or 3 vector components, defining
3422     #         the direction and value of extrusion for one step (the total extrusion
3423     #         length will be NbOfSteps * ||StepVector||)
3424     #  @param NbOfSteps the number of steps
3425     #  @param ExtrFlags sets flags for extrusion
3426     #  @param SewTolerance uses for comparing locations of nodes if flag
3427     #         EXTRUSION_FLAG_SEW is set
3428     #  @param MakeGroups forces the generation of new groups from existing ones
3429     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3430     #  @ingroup l2_modif_extrurev
3431     def AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps,
3432                           ExtrFlags, SewTolerance, MakeGroups=False):
3433         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3434             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3435         if isinstance( StepVector, list ):
3436             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3437         if MakeGroups:
3438             return self.editor.AdvancedExtrusionMakeGroups(IDsOfElements, StepVector, NbOfSteps,
3439                                                            ExtrFlags, SewTolerance)
3440         self.editor.AdvancedExtrusion(IDsOfElements, StepVector, NbOfSteps,
3441                                       ExtrFlags, SewTolerance)
3442         return []
3443
3444     ## Generates new elements by extrusion of the elements which belong to the object
3445     #  @param theObject the object which elements should be processed.
3446     #                   It can be a mesh, a sub mesh or a group.
3447     #  @param StepVector vector or DirStruct or 3 vector components, defining
3448     #         the direction and value of extrusion for one step (the total extrusion
3449     #         length will be NbOfSteps * ||StepVector||)
3450     #  @param NbOfSteps the number of steps
3451     #  @param MakeGroups forces the generation of new groups from existing ones
3452     #  @param  IsNodes is True if elements which belong to the object are nodes
3453     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3454     #  @ingroup l2_modif_extrurev
3455     def ExtrusionSweepObject(self, theObject, StepVector, NbOfSteps, MakeGroups=False, IsNodes=False):
3456         if ( isinstance( theObject, Mesh )):
3457             theObject = theObject.GetMesh()
3458         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3459             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3460         if isinstance( StepVector, list ):
3461             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3462         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3463         Parameters = StepVector.PS.parameters + var_separator + Parameters
3464         self.mesh.SetParameters(Parameters)
3465         if MakeGroups:
3466             if(IsNodes):
3467                 return self.editor.ExtrusionSweepObject0DMakeGroups(theObject, StepVector, NbOfSteps)
3468             else:
3469                 return self.editor.ExtrusionSweepObjectMakeGroups(theObject, StepVector, NbOfSteps)
3470         if(IsNodes):
3471             self.editor.ExtrusionSweepObject0D(theObject, StepVector, NbOfSteps)
3472         else:
3473             self.editor.ExtrusionSweepObject(theObject, StepVector, NbOfSteps)
3474         return []
3475
3476     ## Generates new elements by extrusion of the elements which belong to the object
3477     #  @param theObject object which elements should be processed.
3478     #                   It can be a mesh, a sub mesh or a group.
3479     #  @param StepVector vector or DirStruct or 3 vector components, defining
3480     #         the direction and value of extrusion for one step (the total extrusion
3481     #         length will be NbOfSteps * ||StepVector||)
3482     #  @param NbOfSteps the number of steps
3483     #  @param MakeGroups to generate new groups from existing ones
3484     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3485     #  @ingroup l2_modif_extrurev
3486     def ExtrusionSweepObject1D(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
3487         if ( isinstance( theObject, Mesh )):
3488             theObject = theObject.GetMesh()
3489         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3490             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3491         if isinstance( StepVector, list ):
3492             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3493         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3494         Parameters = StepVector.PS.parameters + var_separator + Parameters
3495         self.mesh.SetParameters(Parameters)
3496         if MakeGroups:
3497             return self.editor.ExtrusionSweepObject1DMakeGroups(theObject, StepVector, NbOfSteps)
3498         self.editor.ExtrusionSweepObject1D(theObject, StepVector, NbOfSteps)
3499         return []
3500
3501     ## Generates new elements by extrusion of the elements which belong to the object
3502     #  @param theObject object which elements should be processed.
3503     #                   It can be a mesh, a sub mesh or a group.
3504     #  @param StepVector vector or DirStruct or 3 vector components, defining
3505     #         the direction and value of extrusion for one step (the total extrusion
3506     #         length will be NbOfSteps * ||StepVector||)
3507     #  @param NbOfSteps the number of steps
3508     #  @param MakeGroups forces the generation of new groups from existing ones
3509     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3510     #  @ingroup l2_modif_extrurev
3511     def ExtrusionSweepObject2D(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
3512         if ( isinstance( theObject, Mesh )):
3513             theObject = theObject.GetMesh()
3514         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3515             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3516         if isinstance( StepVector, list ):
3517             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3518         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3519         Parameters = StepVector.PS.parameters + var_separator + Parameters
3520         self.mesh.SetParameters(Parameters)
3521         if MakeGroups:
3522             return self.editor.ExtrusionSweepObject2DMakeGroups(theObject, StepVector, NbOfSteps)
3523         self.editor.ExtrusionSweepObject2D(theObject, StepVector, NbOfSteps)
3524         return []
3525
3526
3527
3528     ## Generates new elements by extrusion of the given elements
3529     #  The path of extrusion must be a meshed edge.
3530     #  @param Base mesh or group, or submesh, or list of ids of elements for extrusion
3531     #  @param Path - 1D mesh or 1D sub-mesh, along which proceeds the extrusion
3532     #  @param NodeStart the start node from Path. Defines the direction of extrusion
3533     #  @param HasAngles allows the shape to be rotated around the path
3534     #                   to get the resulting mesh in a helical fashion
3535     #  @param Angles list of angles in radians
3536     #  @param LinearVariation forces the computation of rotation angles as linear
3537     #                         variation of the given Angles along path steps
3538     #  @param HasRefPoint allows using the reference point
3539     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3540     #         The User can specify any point as the Reference Point.
3541     #  @param MakeGroups forces the generation of new groups from existing ones
3542     #  @param ElemType type of elements for extrusion (if param Base is a mesh)
3543     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3544     #          only SMESH::Extrusion_Error otherwise
3545     #  @ingroup l2_modif_extrurev
3546     def ExtrusionAlongPathX(self, Base, Path, NodeStart,
3547                             HasAngles, Angles, LinearVariation,
3548                             HasRefPoint, RefPoint, MakeGroups, ElemType):
3549         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3550             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3551             pass
3552         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3553         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3554         self.mesh.SetParameters(Parameters)
3555
3556         if (isinstance(Path, Mesh)): Path = Path.GetMesh()
3557
3558         if isinstance(Base, list):
3559             IDsOfElements = []
3560             if Base == []: IDsOfElements = self.GetElementsId()
3561             else: IDsOfElements = Base
3562             return self.editor.ExtrusionAlongPathX(IDsOfElements, Path, NodeStart,
3563                                                    HasAngles, Angles, LinearVariation,
3564                                                    HasRefPoint, RefPoint, MakeGroups, ElemType)
3565         else:
3566             if isinstance(Base, Mesh): Base = Base.GetMesh()
3567             if isinstance(Base, SMESH._objref_SMESH_Mesh) or isinstance(Base, SMESH._objref_SMESH_Group) or isinstance(Base, SMESH._objref_SMESH_subMesh):
3568                 return self.editor.ExtrusionAlongPathObjX(Base, Path, NodeStart,
3569                                                           HasAngles, Angles, LinearVariation,
3570                                                           HasRefPoint, RefPoint, MakeGroups, ElemType)
3571             else:
3572                 raise RuntimeError, "Invalid Base for ExtrusionAlongPathX"
3573
3574
3575     ## Generates new elements by extrusion of the given elements
3576     #  The path of extrusion must be a meshed edge.
3577     #  @param IDsOfElements ids of elements
3578     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which proceeds the extrusion
3579     #  @param PathShape shape(edge) defines the sub-mesh for the path
3580     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3581     #  @param HasAngles allows the shape to be rotated around the path
3582     #                   to get the resulting mesh in a helical fashion
3583     #  @param Angles list of angles in radians
3584     #  @param HasRefPoint allows using the reference point
3585     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3586     #         The User can specify any point as the Reference Point.
3587     #  @param MakeGroups forces the generation of new groups from existing ones
3588     #  @param LinearVariation forces the computation of rotation angles as linear
3589     #                         variation of the given Angles along path steps
3590     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3591     #          only SMESH::Extrusion_Error otherwise
3592     #  @ingroup l2_modif_extrurev
3593     def ExtrusionAlongPath(self, IDsOfElements, PathMesh, PathShape, NodeStart,
3594                            HasAngles, Angles, HasRefPoint, RefPoint,
3595                            MakeGroups=False, LinearVariation=False):
3596         if IDsOfElements == []:
3597             IDsOfElements = self.GetElementsId()
3598         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3599             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3600             pass
3601         if ( isinstance( PathMesh, Mesh )):
3602             PathMesh = PathMesh.GetMesh()
3603         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3604         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3605         self.mesh.SetParameters(Parameters)
3606         if HasAngles and Angles and LinearVariation:
3607             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3608             pass
3609         if MakeGroups:
3610             return self.editor.ExtrusionAlongPathMakeGroups(IDsOfElements, PathMesh,
3611                                                             PathShape, NodeStart, HasAngles,
3612                                                             Angles, HasRefPoint, RefPoint)
3613         return self.editor.ExtrusionAlongPath(IDsOfElements, PathMesh, PathShape,
3614                                               NodeStart, HasAngles, Angles, HasRefPoint, RefPoint)
3615
3616     ## Generates new elements by extrusion of the elements which belong to the object
3617     #  The path of extrusion must be a meshed edge.
3618     #  @param theObject the object which elements should be processed.
3619     #                   It can be a mesh, a sub mesh or a group.
3620     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds
3621     #  @param PathShape shape(edge) defines the sub-mesh for the path
3622     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3623     #  @param HasAngles allows the shape to be rotated around the path
3624     #                   to get the resulting mesh in a helical fashion
3625     #  @param Angles list of angles
3626     #  @param HasRefPoint allows using the reference point
3627     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3628     #         The User can specify any point as the Reference Point.
3629     #  @param MakeGroups forces the generation of new groups from existing ones
3630     #  @param LinearVariation forces the computation of rotation angles as linear
3631     #                         variation of the given Angles along path steps
3632     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3633     #          only SMESH::Extrusion_Error otherwise
3634     #  @ingroup l2_modif_extrurev
3635     def ExtrusionAlongPathObject(self, theObject, PathMesh, PathShape, NodeStart,
3636                                  HasAngles, Angles, HasRefPoint, RefPoint,
3637                                  MakeGroups=False, LinearVariation=False):
3638         if ( isinstance( theObject, Mesh )):
3639             theObject = theObject.GetMesh()
3640         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3641             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3642         if ( isinstance( PathMesh, Mesh )):
3643             PathMesh = PathMesh.GetMesh()
3644         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3645         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3646         self.mesh.SetParameters(Parameters)
3647         if HasAngles and Angles and LinearVariation:
3648             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3649             pass
3650         if MakeGroups:
3651             return self.editor.ExtrusionAlongPathObjectMakeGroups(theObject, PathMesh,
3652                                                                   PathShape, NodeStart, HasAngles,
3653                                                                   Angles, HasRefPoint, RefPoint)
3654         return self.editor.ExtrusionAlongPathObject(theObject, PathMesh, PathShape,
3655                                                     NodeStart, HasAngles, Angles, HasRefPoint,
3656                                                     RefPoint)
3657
3658     ## Generates new elements by extrusion of the elements which belong to the object
3659     #  The path of extrusion must be a meshed edge.
3660     #  @param theObject the object which elements should be processed.
3661     #                   It can be a mesh, a sub mesh or a group.
3662     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds
3663     #  @param PathShape shape(edge) defines the sub-mesh for the path
3664     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3665     #  @param HasAngles allows the shape to be rotated around the path
3666     #                   to get the resulting mesh in a helical fashion
3667     #  @param Angles list of angles
3668     #  @param HasRefPoint allows using the reference point
3669     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3670     #         The User can specify any point as the Reference Point.
3671     #  @param MakeGroups forces the generation of new groups from existing ones
3672     #  @param LinearVariation forces the computation of rotation angles as linear
3673     #                         variation of the given Angles along path steps
3674     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3675     #          only SMESH::Extrusion_Error otherwise
3676     #  @ingroup l2_modif_extrurev
3677     def ExtrusionAlongPathObject1D(self, theObject, PathMesh, PathShape, NodeStart,
3678                                    HasAngles, Angles, HasRefPoint, RefPoint,
3679                                    MakeGroups=False, LinearVariation=False):
3680         if ( isinstance( theObject, Mesh )):
3681             theObject = theObject.GetMesh()
3682         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3683             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3684         if ( isinstance( PathMesh, Mesh )):
3685             PathMesh = PathMesh.GetMesh()
3686         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3687         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3688         self.mesh.SetParameters(Parameters)
3689         if HasAngles and Angles and LinearVariation:
3690             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3691             pass
3692         if MakeGroups:
3693             return self.editor.ExtrusionAlongPathObject1DMakeGroups(theObject, PathMesh,
3694                                                                     PathShape, NodeStart, HasAngles,
3695                                                                     Angles, HasRefPoint, RefPoint)
3696         return self.editor.ExtrusionAlongPathObject1D(theObject, PathMesh, PathShape,
3697                                                       NodeStart, HasAngles, Angles, HasRefPoint,
3698                                                       RefPoint)
3699
3700     ## Generates new elements by extrusion of the elements which belong to the object
3701     #  The path of extrusion must be a meshed edge.
3702     #  @param theObject the object which elements should be processed.
3703     #                   It can be a mesh, a sub mesh or a group.
3704     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds
3705     #  @param PathShape shape(edge) defines the sub-mesh for the path
3706     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3707     #  @param HasAngles allows the shape to be rotated around the path
3708     #                   to get the resulting mesh in a helical fashion
3709     #  @param Angles list of angles
3710     #  @param HasRefPoint allows using the reference point
3711     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3712     #         The User can specify any point as the Reference Point.
3713     #  @param MakeGroups forces the generation of new groups from existing ones
3714     #  @param LinearVariation forces the computation of rotation angles as linear
3715     #                         variation of the given Angles along path steps
3716     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3717     #          only SMESH::Extrusion_Error otherwise
3718     #  @ingroup l2_modif_extrurev
3719     def ExtrusionAlongPathObject2D(self, theObject, PathMesh, PathShape, NodeStart,
3720                                    HasAngles, Angles, HasRefPoint, RefPoint,
3721                                    MakeGroups=False, LinearVariation=False):
3722         if ( isinstance( theObject, Mesh )):
3723             theObject = theObject.GetMesh()
3724         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3725             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3726         if ( isinstance( PathMesh, Mesh )):
3727             PathMesh = PathMesh.GetMesh()
3728         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3729         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3730         self.mesh.SetParameters(Parameters)
3731         if HasAngles and Angles and LinearVariation:
3732             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3733             pass
3734         if MakeGroups:
3735             return self.editor.ExtrusionAlongPathObject2DMakeGroups(theObject, PathMesh,
3736                                                                     PathShape, NodeStart, HasAngles,
3737                                                                     Angles, HasRefPoint, RefPoint)
3738         return self.editor.ExtrusionAlongPathObject2D(theObject, PathMesh, PathShape,
3739                                                       NodeStart, HasAngles, Angles, HasRefPoint,
3740                                                       RefPoint)
3741
3742     ## Creates a symmetrical copy of mesh elements
3743     #  @param IDsOfElements list of elements ids
3744     #  @param Mirror is AxisStruct or geom object(point, line, plane)
3745     #  @param theMirrorType is  POINT, AXIS or PLANE
3746     #  If the Mirror is a geom object this parameter is unnecessary
3747     #  @param Copy allows to copy element (Copy is 1) or to replace with its mirroring (Copy is 0)
3748     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3749     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3750     #  @ingroup l2_modif_trsf
3751     def Mirror(self, IDsOfElements, Mirror, theMirrorType, Copy=0, MakeGroups=False):
3752         if IDsOfElements == []:
3753             IDsOfElements = self.GetElementsId()
3754         if ( isinstance( Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3755             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3756         self.mesh.SetParameters(Mirror.parameters)
3757         if Copy and MakeGroups:
3758             return self.editor.MirrorMakeGroups(IDsOfElements, Mirror, theMirrorType)
3759         self.editor.Mirror(IDsOfElements, Mirror, theMirrorType, Copy)
3760         return []
3761
3762     ## Creates a new mesh by a symmetrical copy of mesh elements
3763     #  @param IDsOfElements the list of elements ids
3764     #  @param Mirror is AxisStruct or geom object (point, line, plane)
3765     #  @param theMirrorType is  POINT, AXIS or PLANE
3766     #  If the Mirror is a geom object this parameter is unnecessary
3767     #  @param MakeGroups to generate new groups from existing ones
3768     #  @param NewMeshName a name of the new mesh to create
3769     #  @return instance of Mesh class
3770     #  @ingroup l2_modif_trsf
3771     def MirrorMakeMesh(self, IDsOfElements, Mirror, theMirrorType, MakeGroups=0, NewMeshName=""):
3772         if IDsOfElements == []:
3773             IDsOfElements = self.GetElementsId()
3774         if ( isinstance( Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3775             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3776         self.mesh.SetParameters(Mirror.parameters)
3777         mesh = self.editor.MirrorMakeMesh(IDsOfElements, Mirror, theMirrorType,
3778                                           MakeGroups, NewMeshName)
3779         return Mesh(self.smeshpyD,self.geompyD,mesh)
3780
3781     ## Creates a symmetrical copy of the object
3782     #  @param theObject mesh, submesh or group
3783     #  @param Mirror AxisStruct or geom object (point, line, plane)
3784     #  @param theMirrorType is  POINT, AXIS or PLANE
3785     #  If the Mirror is a geom object this parameter is unnecessary
3786     #  @param Copy allows copying the element (Copy is 1) or replacing it with its mirror (Copy is 0)
3787     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3788     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3789     #  @ingroup l2_modif_trsf
3790     def MirrorObject (self, theObject, Mirror, theMirrorType, Copy=0, MakeGroups=False):
3791         if ( isinstance( theObject, Mesh )):
3792             theObject = theObject.GetMesh()
3793         if ( isinstance( Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3794             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3795         self.mesh.SetParameters(Mirror.parameters)
3796         if Copy and MakeGroups:
3797             return self.editor.MirrorObjectMakeGroups(theObject, Mirror, theMirrorType)
3798         self.editor.MirrorObject(theObject, Mirror, theMirrorType, Copy)
3799         return []
3800
3801     ## Creates a new mesh by a symmetrical copy of the object
3802     #  @param theObject mesh, submesh or group
3803     #  @param Mirror AxisStruct or geom object (point, line, plane)
3804     #  @param theMirrorType POINT, AXIS or PLANE
3805     #  If the Mirror is a geom object this parameter is unnecessary
3806     #  @param MakeGroups forces the generation of new groups from existing ones
3807     #  @param NewMeshName the name of the new mesh to create
3808     #  @return instance of Mesh class
3809     #  @ingroup l2_modif_trsf
3810     def MirrorObjectMakeMesh (self, theObject, Mirror, theMirrorType,MakeGroups=0, NewMeshName=""):
3811         if ( isinstance( theObject, Mesh )):
3812             theObject = theObject.GetMesh()
3813         if (isinstance(Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3814             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3815         self.mesh.SetParameters(Mirror.parameters)
3816         mesh = self.editor.MirrorObjectMakeMesh(theObject, Mirror, theMirrorType,
3817                                                 MakeGroups, NewMeshName)
3818         return Mesh( self.smeshpyD,self.geompyD,mesh )
3819
3820     ## Translates the elements
3821     #  @param IDsOfElements list of elements ids
3822     #  @param Vector the direction of translation (DirStruct or vector or 3 vector components)
3823     #  @param Copy allows copying the translated elements
3824     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3825     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3826     #  @ingroup l2_modif_trsf
3827     def Translate(self, IDsOfElements, Vector, Copy, MakeGroups=False):
3828         if IDsOfElements == []:
3829             IDsOfElements = self.GetElementsId()
3830         if ( isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object)):
3831             Vector = self.smeshpyD.GetDirStruct(Vector)
3832         if isinstance( Vector, list ):
3833             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3834         self.mesh.SetParameters(Vector.PS.parameters)
3835         if Copy and MakeGroups:
3836             return self.editor.TranslateMakeGroups(IDsOfElements, Vector)
3837         self.editor.Translate(IDsOfElements, Vector, Copy)
3838         return []
3839
3840     ## Creates a new mesh of translated elements
3841     #  @param IDsOfElements list of elements ids
3842     #  @param Vector the direction of translation (DirStruct or vector or 3 vector components)
3843     #  @param MakeGroups forces the generation of new groups from existing ones
3844     #  @param NewMeshName the name of the newly created mesh
3845     #  @return instance of Mesh class
3846     #  @ingroup l2_modif_trsf
3847     def TranslateMakeMesh(self, IDsOfElements, Vector, MakeGroups=False, NewMeshName=""):
3848         if IDsOfElements == []:
3849             IDsOfElements = self.GetElementsId()
3850         if ( isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object)):
3851             Vector = self.smeshpyD.GetDirStruct(Vector)
3852         if isinstance( Vector, list ):
3853             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3854         self.mesh.SetParameters(Vector.PS.parameters)
3855         mesh = self.editor.TranslateMakeMesh(IDsOfElements, Vector, MakeGroups, NewMeshName)
3856         return Mesh ( self.smeshpyD, self.geompyD, mesh )
3857
3858     ## Translates the object
3859     #  @param theObject the object to translate (mesh, submesh, or group)
3860     #  @param Vector direction of translation (DirStruct or geom vector or 3 vector components)
3861     #  @param Copy allows copying the translated elements
3862     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3863     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3864     #  @ingroup l2_modif_trsf
3865     def TranslateObject(self, theObject, Vector, Copy, MakeGroups=False):
3866         if ( isinstance( theObject, Mesh )):
3867             theObject = theObject.GetMesh()
3868         if ( isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object)):
3869             Vector = self.smeshpyD.GetDirStruct(Vector)
3870         if isinstance( Vector, list ):
3871             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3872         self.mesh.SetParameters(Vector.PS.parameters)
3873         if Copy and MakeGroups:
3874             return self.editor.TranslateObjectMakeGroups(theObject, Vector)
3875         self.editor.TranslateObject(theObject, Vector, Copy)
3876         return []
3877
3878     ## Creates a new mesh from the translated object
3879     #  @param theObject the object to translate (mesh, submesh, or group)
3880     #  @param Vector the direction of translation (DirStruct or geom vector or 3 vector components)
3881     #  @param MakeGroups forces the generation of new groups from existing ones
3882     #  @param NewMeshName the name of the newly created mesh
3883     #  @return instance of Mesh class
3884     #  @ingroup l2_modif_trsf
3885     def TranslateObjectMakeMesh(self, theObject, Vector, MakeGroups=False, NewMeshName=""):
3886         if isinstance( theObject, Mesh ):
3887             theObject = theObject.GetMesh()
3888         if isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object ):
3889             Vector = self.smeshpyD.GetDirStruct(Vector)
3890         if isinstance( Vector, list ):
3891             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3892         self.mesh.SetParameters(Vector.PS.parameters)
3893         mesh = self.editor.TranslateObjectMakeMesh(theObject, Vector, MakeGroups, NewMeshName)
3894         return Mesh( self.smeshpyD, self.geompyD, mesh )
3895
3896
3897
3898     ## Scales the object
3899     #  @param theObject - the object to translate (mesh, submesh, or group)
3900     #  @param thePoint - base point for scale
3901     #  @param theScaleFact - list of 1-3 scale factors for axises
3902     #  @param Copy - allows copying the translated elements
3903     #  @param MakeGroups - forces the generation of new groups from existing
3904     #                      ones (if Copy)
3905     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True,
3906     #          empty list otherwise
3907     def Scale(self, theObject, thePoint, theScaleFact, Copy, MakeGroups=False):
3908         if ( isinstance( theObject, Mesh )):
3909             theObject = theObject.GetMesh()
3910         if ( isinstance( theObject, list )):
3911             theObject = self.GetIDSource(theObject, SMESH.ALL)
3912         if ( isinstance( theScaleFact, float )):
3913              theScaleFact = [theScaleFact]
3914         if ( isinstance( theScaleFact, int )):
3915              theScaleFact = [ float(theScaleFact)]
3916
3917         self.mesh.SetParameters(thePoint.parameters)
3918
3919         if Copy and MakeGroups:
3920             return self.editor.ScaleMakeGroups(theObject, thePoint, theScaleFact)
3921         self.editor.Scale(theObject, thePoint, theScaleFact, Copy)
3922         return []
3923
3924     ## Creates a new mesh from the translated object
3925     #  @param theObject - the object to translate (mesh, submesh, or group)
3926     #  @param thePoint - base point for scale
3927     #  @param theScaleFact - list of 1-3 scale factors for axises
3928     #  @param MakeGroups - forces the generation of new groups from existing ones
3929     #  @param NewMeshName - the name of the newly created mesh
3930     #  @return instance of Mesh class
3931     def ScaleMakeMesh(self, theObject, thePoint, theScaleFact, MakeGroups=False, NewMeshName=""):
3932         if (isinstance(theObject, Mesh)):
3933             theObject = theObject.GetMesh()
3934         if ( isinstance( theObject, list )):
3935             theObject = self.GetIDSource(theObject,SMESH.ALL)
3936         if ( isinstance( theScaleFact, float )):
3937              theScaleFact = [theScaleFact]
3938         if ( isinstance( theScaleFact, int )):
3939              theScaleFact = [ float(theScaleFact)]
3940
3941         self.mesh.SetParameters(thePoint.parameters)
3942         mesh = self.editor.ScaleMakeMesh(theObject, thePoint, theScaleFact,
3943                                          MakeGroups, NewMeshName)
3944         return Mesh( self.smeshpyD, self.geompyD, mesh )
3945
3946
3947
3948     ## Rotates the elements
3949     #  @param IDsOfElements list of elements ids
3950     #  @param Axis the axis of rotation (AxisStruct or geom line)
3951     #  @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees
3952     #  @param Copy allows copying the rotated elements
3953     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3954     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3955     #  @ingroup l2_modif_trsf
3956     def Rotate (self, IDsOfElements, Axis, AngleInRadians, Copy, MakeGroups=False):
3957         if IDsOfElements == []:
3958             IDsOfElements = self.GetElementsId()
3959         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3960             Axis = self.smeshpyD.GetAxisStruct(Axis)
3961         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
3962         Parameters = Axis.parameters + var_separator + Parameters
3963         self.mesh.SetParameters(Parameters)
3964         if Copy and MakeGroups:
3965             return self.editor.RotateMakeGroups(IDsOfElements, Axis, AngleInRadians)
3966         self.editor.Rotate(IDsOfElements, Axis, AngleInRadians, Copy)
3967         return []
3968
3969     ## Creates a new mesh of rotated elements
3970     #  @param IDsOfElements list of element ids
3971     #  @param Axis the axis of rotation (AxisStruct or geom line)
3972     #  @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees
3973     #  @param MakeGroups forces the generation of new groups from existing ones
3974     #  @param NewMeshName the name of the newly created mesh
3975     #  @return instance of Mesh class
3976     #  @ingroup l2_modif_trsf
3977     def RotateMakeMesh (self, IDsOfElements, Axis, AngleInRadians, MakeGroups=0, NewMeshName=""):
3978         if IDsOfElements == []:
3979             IDsOfElements = self.GetElementsId()
3980         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3981             Axis = self.smeshpyD.GetAxisStruct(Axis)
3982         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
3983         Parameters = Axis.parameters + var_separator + Parameters
3984         self.mesh.SetParameters(Parameters)
3985         mesh = self.editor.RotateMakeMesh(IDsOfElements, Axis, AngleInRadians,
3986                                           MakeGroups, NewMeshName)
3987         return Mesh( self.smeshpyD, self.geompyD, mesh )
3988
3989     ## Rotates the object
3990     #  @param theObject the object to rotate( mesh, submesh, or group)
3991     #  @param Axis the axis of rotation (AxisStruct or geom line)
3992     #  @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees
3993     #  @param Copy allows copying the rotated elements
3994     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3995     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3996     #  @ingroup l2_modif_trsf
3997     def RotateObject (self, theObject, Axis, AngleInRadians, Copy, MakeGroups=False):
3998         if (isinstance(theObject, Mesh)):
3999             theObject = theObject.GetMesh()
4000         if (isinstance(Axis, geomBuilder.GEOM._objref_GEOM_Object)):
4001             Axis = self.smeshpyD.GetAxisStruct(Axis)
4002         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
4003         Parameters = Axis.parameters + ":" + Parameters
4004         self.mesh.SetParameters(Parameters)
4005         if Copy and MakeGroups:
4006             return self.editor.RotateObjectMakeGroups(theObject, Axis, AngleInRadians)
4007         self.editor.RotateObject(theObject, Axis, AngleInRadians, Copy)
4008         return []
4009
4010     ## Creates a new mesh from the rotated object
4011     #  @param theObject the object to rotate (mesh, submesh, or group)
4012     #  @param Axis the axis of rotation (AxisStruct or geom line)
4013     #  @param AngleInRadians the angle of rotation (in radians)  or a name of variable which defines angle in degrees
4014     #  @param MakeGroups forces the generation of new groups from existing ones
4015     #  @param NewMeshName the name of the newly created mesh
4016     #  @return instance of Mesh class
4017     #  @ingroup l2_modif_trsf
4018     def RotateObjectMakeMesh(self, theObject, Axis, AngleInRadians, MakeGroups=0,NewMeshName=""):
4019         if (isinstance( theObject, Mesh )):
4020             theObject = theObject.GetMesh()
4021         if (isinstance(Axis, geomBuilder.GEOM._objref_GEOM_Object)):
4022             Axis = self.smeshpyD.GetAxisStruct(Axis)
4023         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
4024         Parameters = Axis.parameters + ":" + Parameters
4025         mesh = self.editor.RotateObjectMakeMesh(theObject, Axis, AngleInRadians,
4026                                                        MakeGroups, NewMeshName)
4027         self.mesh.SetParameters(Parameters)
4028         return Mesh( self.smeshpyD, self.geompyD, mesh )
4029
4030     ## Finds groups of ajacent nodes within Tolerance.
4031     #  @param Tolerance the value of tolerance
4032     #  @return the list of groups of nodes
4033     #  @ingroup l2_modif_trsf
4034     def FindCoincidentNodes (self, Tolerance):
4035         return self.editor.FindCoincidentNodes(Tolerance)
4036
4037     ## Finds groups of ajacent nodes within Tolerance.
4038     #  @param Tolerance the value of tolerance
4039     #  @param SubMeshOrGroup SubMesh or Group
4040     #  @param exceptNodes list of either SubMeshes, Groups or node IDs to exclude from search
4041     #  @return the list of groups of nodes
4042     #  @ingroup l2_modif_trsf
4043     def FindCoincidentNodesOnPart (self, SubMeshOrGroup, Tolerance, exceptNodes=[]):
4044         if (isinstance( SubMeshOrGroup, Mesh )):
4045             SubMeshOrGroup = SubMeshOrGroup.GetMesh()
4046         if not isinstance( exceptNodes, list):
4047             exceptNodes = [ exceptNodes ]
4048         if exceptNodes and isinstance( exceptNodes[0], int):
4049             exceptNodes = [ self.GetIDSource( exceptNodes, SMESH.NODE)]
4050         return self.editor.FindCoincidentNodesOnPartBut(SubMeshOrGroup, Tolerance,exceptNodes)
4051
4052     ## Merges nodes
4053     #  @param GroupsOfNodes the list of groups of nodes
4054     #  @ingroup l2_modif_trsf
4055     def MergeNodes (self, GroupsOfNodes):
4056         self.editor.MergeNodes(GroupsOfNodes)
4057
4058     ## Finds the elements built on the same nodes.
4059     #  @param MeshOrSubMeshOrGroup Mesh or SubMesh, or Group of elements for searching
4060     #  @return a list of groups of equal elements
4061     #  @ingroup l2_modif_trsf
4062     def FindEqualElements (self, MeshOrSubMeshOrGroup):
4063         if ( isinstance( MeshOrSubMeshOrGroup, Mesh )):
4064             MeshOrSubMeshOrGroup = MeshOrSubMeshOrGroup.GetMesh()
4065         return self.editor.FindEqualElements(MeshOrSubMeshOrGroup)
4066
4067     ## Merges elements in each given group.
4068     #  @param GroupsOfElementsID groups of elements for merging
4069     #  @ingroup l2_modif_trsf
4070     def MergeElements(self, GroupsOfElementsID):
4071         self.editor.MergeElements(GroupsOfElementsID)
4072
4073     ## Leaves one element and removes all other elements built on the same nodes.
4074     #  @ingroup l2_modif_trsf
4075     def MergeEqualElements(self):
4076         self.editor.MergeEqualElements()
4077
4078     ## Sews free borders
4079     #  @return SMESH::Sew_Error
4080     #  @ingroup l2_modif_trsf
4081     def SewFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1,
4082                         FirstNodeID2, SecondNodeID2, LastNodeID2,
4083                         CreatePolygons, CreatePolyedrs):
4084         return self.editor.SewFreeBorders(FirstNodeID1, SecondNodeID1, LastNodeID1,
4085                                           FirstNodeID2, SecondNodeID2, LastNodeID2,
4086                                           CreatePolygons, CreatePolyedrs)
4087
4088     ## Sews conform free borders
4089     #  @return SMESH::Sew_Error
4090     #  @ingroup l2_modif_trsf
4091     def SewConformFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1,
4092                                FirstNodeID2, SecondNodeID2):
4093         return self.editor.SewConformFreeBorders(FirstNodeID1, SecondNodeID1, LastNodeID1,
4094                                                  FirstNodeID2, SecondNodeID2)
4095
4096     ## Sews border to side
4097     #  @return SMESH::Sew_Error
4098     #  @ingroup l2_modif_trsf
4099     def SewBorderToSide (self, FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder,
4100                          FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs):
4101         return self.editor.SewBorderToSide(FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder,
4102                                            FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs)
4103
4104     ## Sews two sides of a mesh. The nodes belonging to Side1 are
4105     #  merged with the nodes of elements of Side2.
4106     #  The number of elements in theSide1 and in theSide2 must be
4107     #  equal and they should have similar nodal connectivity.
4108     #  The nodes to merge should belong to side borders and
4109     #  the first node should be linked to the second.
4110     #  @return SMESH::Sew_Error
4111     #  @ingroup l2_modif_trsf
4112     def SewSideElements (self, IDsOfSide1Elements, IDsOfSide2Elements,
4113                          NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge,
4114                          NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge):
4115         return self.editor.SewSideElements(IDsOfSide1Elements, IDsOfSide2Elements,
4116                                            NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge,
4117                                            NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge)
4118
4119     ## Sets new nodes for the given element.
4120     #  @param ide the element id
4121     #  @param newIDs nodes ids
4122     #  @return If the number of nodes does not correspond to the type of element - returns false
4123     #  @ingroup l2_modif_edit
4124     def ChangeElemNodes(self, ide, newIDs):
4125         return self.editor.ChangeElemNodes(ide, newIDs)
4126
4127     ## If during the last operation of MeshEditor some nodes were
4128     #  created, this method returns the list of their IDs, \n
4129     #  if new nodes were not created - returns empty list
4130     #  @return the list of integer values (can be empty)
4131     #  @ingroup l1_auxiliary
4132     def GetLastCreatedNodes(self):
4133         return self.editor.GetLastCreatedNodes()
4134
4135     ## If during the last operation of MeshEditor some elements were
4136     #  created this method returns the list of their IDs, \n
4137     #  if new elements were not created - returns empty list
4138     #  @return the list of integer values (can be empty)
4139     #  @ingroup l1_auxiliary
4140     def GetLastCreatedElems(self):
4141         return self.editor.GetLastCreatedElems()
4142
4143     ## Clears sequences of nodes and elements created by mesh edition oparations
4144     #  @ingroup l1_auxiliary
4145     def ClearLastCreated(self):
4146         self.editor.ClearLastCreated()
4147
4148     ## Creates Duplicates given elements, i.e. creates new elements based on the
4149     #  same nodes as the given ones.
4150     #  @param theElements - container of elements to duplicate. It can be a Mesh,
4151     #         sub-mesh, group, filter or a list of element IDs.
4152     # @param theGroupName - a name of group to contain the generated elements.
4153     #                    If a group with such a name already exists, the new elements
4154     #                    are added to the existng group, else a new group is created.
4155     #                    If \a theGroupName is empty, new elements are not added
4156     #                    in any group.
4157     # @return a group where the new elements are added. None if theGroupName == "".
4158     #  @ingroup l2_modif_edit
4159     def DoubleElements(self, theElements, theGroupName=""):
4160         if isinstance( theElements, Mesh ):
4161             theElements = theElements.mesh
4162         elif isinstance( theElements, list ):
4163             theElements = self.GetIDSource( theElements, SMESH.ALL )
4164         return self.editor.DoubleElements(theElements, theGroupName)
4165
4166     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4167     #  @param theNodes identifiers of nodes to be doubled
4168     #  @param theModifiedElems identifiers of elements to be updated by the new (doubled)
4169     #         nodes. If list of element identifiers is empty then nodes are doubled but
4170     #         they not assigned to elements
4171     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4172     #  @ingroup l2_modif_edit
4173     def DoubleNodes(self, theNodes, theModifiedElems):
4174         return self.editor.DoubleNodes(theNodes, theModifiedElems)
4175
4176     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4177     #  This method provided for convenience works as DoubleNodes() described above.
4178     #  @param theNodeId identifiers of node to be doubled
4179     #  @param theModifiedElems identifiers of elements to be updated
4180     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4181     #  @ingroup l2_modif_edit
4182     def DoubleNode(self, theNodeId, theModifiedElems):
4183         return self.editor.DoubleNode(theNodeId, theModifiedElems)
4184
4185     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4186     #  This method provided for convenience works as DoubleNodes() described above.
4187     #  @param theNodes group of nodes to be doubled
4188     #  @param theModifiedElems group of elements to be updated.
4189     #  @param theMakeGroup forces the generation of a group containing new nodes.
4190     #  @return TRUE or a created group if operation has been completed successfully,
4191     #          FALSE or None otherwise
4192     #  @ingroup l2_modif_edit
4193     def DoubleNodeGroup(self, theNodes, theModifiedElems, theMakeGroup=False):
4194         if theMakeGroup:
4195             return self.editor.DoubleNodeGroupNew(theNodes, theModifiedElems)
4196         return self.editor.DoubleNodeGroup(theNodes, theModifiedElems)
4197
4198     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4199     #  This method provided for convenience works as DoubleNodes() described above.
4200     #  @param theNodes list of groups of nodes to be doubled
4201     #  @param theModifiedElems list of groups of elements to be updated.
4202     #  @param theMakeGroup forces the generation of a group containing new nodes.
4203     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4204     #  @ingroup l2_modif_edit
4205     def DoubleNodeGroups(self, theNodes, theModifiedElems, theMakeGroup=False):
4206         if theMakeGroup:
4207             return self.editor.DoubleNodeGroupsNew(theNodes, theModifiedElems)
4208         return self.editor.DoubleNodeGroups(theNodes, theModifiedElems)
4209
4210     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4211     #  @param theElems - the list of elements (edges or faces) to be replicated
4212     #         The nodes for duplication could be found from these elements
4213     #  @param theNodesNot - list of nodes to NOT replicate
4214     #  @param theAffectedElems - the list of elements (cells and edges) to which the
4215     #         replicated nodes should be associated to.
4216     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4217     #  @ingroup l2_modif_edit
4218     def DoubleNodeElem(self, theElems, theNodesNot, theAffectedElems):
4219         return self.editor.DoubleNodeElem(theElems, theNodesNot, theAffectedElems)
4220
4221     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4222     #  @param theElems - the list of elements (edges or faces) to be replicated
4223     #         The nodes for duplication could be found from these elements
4224     #  @param theNodesNot - list of nodes to NOT replicate
4225     #  @param theShape - shape to detect affected elements (element which geometric center
4226     #         located on or inside shape).
4227     #         The replicated nodes should be associated to affected elements.
4228     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4229     #  @ingroup l2_modif_edit
4230     def DoubleNodeElemInRegion(self, theElems, theNodesNot, theShape):
4231         return self.editor.DoubleNodeElemInRegion(theElems, theNodesNot, theShape)
4232
4233     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4234     #  This method provided for convenience works as DoubleNodes() described above.
4235     #  @param theElems - group of of elements (edges or faces) to be replicated
4236     #  @param theNodesNot - group of nodes not to replicated
4237     #  @param theAffectedElems - group of elements to which the replicated nodes
4238     #         should be associated to.
4239     #  @param theMakeGroup forces the generation of a group containing new elements.
4240     #  @param theMakeNodeGroup forces the generation of a group containing new nodes.
4241     #  @return TRUE or created groups (one or two) if operation has been completed successfully,
4242     #          FALSE or None otherwise
4243     #  @ingroup l2_modif_edit
4244     def DoubleNodeElemGroup(self, theElems, theNodesNot, theAffectedElems,
4245                              theMakeGroup=False, theMakeNodeGroup=False):
4246         if theMakeGroup or theMakeNodeGroup:
4247             twoGroups = self.editor.DoubleNodeElemGroup2New(theElems, theNodesNot,
4248                                                             theAffectedElems,
4249                                                             theMakeGroup, theMakeNodeGroup)
4250             if theMakeGroup and theMakeNodeGroup:
4251                 return twoGroups
4252             else:
4253                 return twoGroups[ int(theMakeNodeGroup) ]
4254         return self.editor.DoubleNodeElemGroup(theElems, theNodesNot, theAffectedElems)
4255
4256     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4257     #  This method provided for convenience works as DoubleNodes() described above.
4258     #  @param theElems - group of of elements (edges or faces) to be replicated
4259     #  @param theNodesNot - group of nodes not to replicated
4260     #  @param theShape - shape to detect affected elements (element which geometric center
4261     #         located on or inside shape).
4262     #         The replicated nodes should be associated to affected elements.
4263     #  @ingroup l2_modif_edit
4264     def DoubleNodeElemGroupInRegion(self, theElems, theNodesNot, theShape):
4265         return self.editor.DoubleNodeElemGroupInRegion(theElems, theNodesNot, theShape)
4266
4267     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4268     #  This method provided for convenience works as DoubleNodes() described above.
4269     #  @param theElems - list of groups of elements (edges or faces) to be replicated
4270     #  @param theNodesNot - list of groups of nodes not to replicated
4271     #  @param theAffectedElems - group of elements to which the replicated nodes
4272     #         should be associated to.
4273     #  @param theMakeGroup forces the generation of a group containing new elements.
4274     #  @param theMakeNodeGroup forces the generation of a group containing new nodes.
4275     #  @return TRUE or created groups (one or two) if operation has been completed successfully,
4276     #          FALSE or None otherwise
4277     #  @ingroup l2_modif_edit
4278     def DoubleNodeElemGroups(self, theElems, theNodesNot, theAffectedElems,
4279                              theMakeGroup=False, theMakeNodeGroup=False):
4280         if theMakeGroup or theMakeNodeGroup:
4281             twoGroups = self.editor.DoubleNodeElemGroups2New(theElems, theNodesNot,
4282                                                              theAffectedElems,
4283                                                              theMakeGroup, theMakeNodeGroup)
4284             if theMakeGroup and theMakeNodeGroup:
4285                 return twoGroups
4286             else:
4287                 return twoGroups[ int(theMakeNodeGroup) ]
4288         return self.editor.DoubleNodeElemGroups(theElems, theNodesNot, theAffectedElems)
4289
4290     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4291     #  This method provided for convenience works as DoubleNodes() described above.
4292     #  @param theElems - list of groups of elements (edges or faces) to be replicated
4293     #  @param theNodesNot - list of groups of nodes not to replicated
4294     #  @param theShape - shape to detect affected elements (element which geometric center
4295     #         located on or inside shape).
4296     #         The replicated nodes should be associated to affected elements.
4297     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4298     #  @ingroup l2_modif_edit
4299     def DoubleNodeElemGroupsInRegion(self, theElems, theNodesNot, theShape):
4300         return self.editor.DoubleNodeElemGroupsInRegion(theElems, theNodesNot, theShape)
4301
4302     ## Identify the elements that will be affected by node duplication (actual duplication is not performed.
4303     #  This method is the first step of DoubleNodeElemGroupsInRegion.
4304     #  @param theElems - list of groups of elements (edges or faces) to be replicated
4305     #  @param theNodesNot - list of groups of nodes not to replicated
4306     #  @param theShape - shape to detect affected elements (element which geometric center
4307     #         located on or inside shape).
4308     #         The replicated nodes should be associated to affected elements.
4309     #  @return groups of affected elements
4310     #  @ingroup l2_modif_edit
4311     def AffectedElemGroupsInRegion(self, theElems, theNodesNot, theShape):
4312         return self.editor.AffectedElemGroupsInRegion(theElems, theNodesNot, theShape)
4313
4314     ## Double nodes on shared faces between groups of volumes and create flat elements on demand.
4315     # The list of groups must describe a partition of the mesh volumes.
4316     # The nodes of the internal faces at the boundaries of the groups are doubled.
4317     # In option, the internal faces are replaced by flat elements.
4318     # Triangles are transformed in prisms, and quadrangles in hexahedrons.
4319     # @param theDomains - list of groups of volumes
4320     # @param createJointElems - if TRUE, create the elements
4321     # @return TRUE if operation has been completed successfully, FALSE otherwise
4322     def DoubleNodesOnGroupBoundaries(self, theDomains, createJointElems ):
4323        return self.editor.DoubleNodesOnGroupBoundaries( theDomains, createJointElems )
4324
4325     ## Double nodes on some external faces and create flat elements.
4326     # Flat elements are mainly used by some types of mechanic calculations.
4327     #
4328     # Each group of the list must be constituted of faces.
4329     # Triangles are transformed in prisms, and quadrangles in hexahedrons.
4330     # @param theGroupsOfFaces - list of groups of faces
4331     # @return TRUE if operation has been completed successfully, FALSE otherwise
4332     def CreateFlatElementsOnFacesGroups(self, theGroupsOfFaces ):
4333         return self.editor.CreateFlatElementsOnFacesGroups( theGroupsOfFaces )
4334
4335     ## identify all the elements around a geom shape, get the faces delimiting the hole
4336     #
4337     def CreateHoleSkin(self, radius, theShape, groupName, theNodesCoords):
4338         return self.editor.CreateHoleSkin( radius, theShape, groupName, theNodesCoords )
4339
4340     def _getFunctor(self, funcType ):
4341         fn = self.functors[ funcType._v ]
4342         if not fn:
4343             fn = self.smeshpyD.GetFunctor(funcType)
4344             fn.SetMesh(self.mesh)
4345             self.functors[ funcType._v ] = fn
4346         return fn
4347
4348     def _valueFromFunctor(self, funcType, elemId):
4349         fn = self._getFunctor( funcType )
4350         if fn.GetElementType() == self.GetElementType(elemId, True):
4351             val = fn.GetValue(elemId)
4352         else:
4353             val = 0
4354         return val
4355
4356     ## Get length of 1D element.
4357     #  @param elemId mesh element ID
4358     #  @return element's length value
4359     #  @ingroup l1_measurements
4360     def GetLength(self, elemId):
4361         return self._valueFromFunctor(SMESH.FT_Length, elemId)
4362
4363     ## Get area of 2D element.
4364     #  @param elemId mesh element ID
4365     #  @return element's area value
4366     #  @ingroup l1_measurements
4367     def GetArea(self, elemId):
4368         return self._valueFromFunctor(SMESH.FT_Area, elemId)
4369
4370     ## Get volume of 3D element.
4371     #  @param elemId mesh element ID
4372     #  @return element's volume value
4373     #  @ingroup l1_measurements
4374     def GetVolume(self, elemId):
4375         return self._valueFromFunctor(SMESH.FT_Volume3D, elemId)
4376
4377     ## Get maximum element length.
4378     #  @param elemId mesh element ID
4379     #  @return element's maximum length value
4380     #  @ingroup l1_measurements
4381     def GetMaxElementLength(self, elemId):
4382         if self.GetElementType(elemId, True) == SMESH.VOLUME:
4383             ftype = SMESH.FT_MaxElementLength3D
4384         else:
4385             ftype = SMESH.FT_MaxElementLength2D
4386         return self._valueFromFunctor(ftype, elemId)
4387
4388     ## Get aspect ratio of 2D or 3D element.
4389     #  @param elemId mesh element ID
4390     #  @return element's aspect ratio value
4391     #  @ingroup l1_measurements
4392     def GetAspectRatio(self, elemId):
4393         if self.GetElementType(elemId, True) == SMESH.VOLUME:
4394             ftype = SMESH.FT_AspectRatio3D
4395         else:
4396             ftype = SMESH.FT_AspectRatio
4397         return self._valueFromFunctor(ftype, elemId)
4398
4399     ## Get warping angle of 2D element.
4400     #  @param elemId mesh element ID
4401     #  @return element's warping angle value
4402     #  @ingroup l1_measurements
4403     def GetWarping(self, elemId):
4404         return self._valueFromFunctor(SMESH.FT_Warping, elemId)
4405
4406     ## Get minimum angle of 2D element.
4407     #  @param elemId mesh element ID
4408     #  @return element's minimum angle value
4409     #  @ingroup l1_measurements
4410     def GetMinimumAngle(self, elemId):
4411         return self._valueFromFunctor(SMESH.FT_MinimumAngle, elemId)
4412
4413     ## Get taper of 2D element.
4414     #  @param elemId mesh element ID
4415     #  @return element's taper value
4416     #  @ingroup l1_measurements
4417     def GetTaper(self, elemId):
4418         return self._valueFromFunctor(SMESH.FT_Taper, elemId)
4419
4420     ## Get skew of 2D element.
4421     #  @param elemId mesh element ID
4422     #  @return element's skew value
4423     #  @ingroup l1_measurements
4424     def GetSkew(self, elemId):
4425         return self._valueFromFunctor(SMESH.FT_Skew, elemId)
4426
4427     pass # end of Mesh class
4428
4429 ## Helper class for wrapping of SMESH.SMESH_Pattern CORBA class
4430 #
4431 class Pattern(SMESH._objref_SMESH_Pattern):
4432
4433     def ApplyToMeshFaces(self, theMesh, theFacesIDs, theNodeIndexOnKeyPoint1, theReverse):
4434         decrFun = lambda i: i-1
4435         theNodeIndexOnKeyPoint1,Parameters,hasVars = ParseParameters(theNodeIndexOnKeyPoint1, decrFun)
4436         theMesh.SetParameters(Parameters)
4437         return SMESH._objref_SMESH_Pattern.ApplyToMeshFaces( self, theMesh, theFacesIDs, theNodeIndexOnKeyPoint1, theReverse )
4438
4439     def ApplyToHexahedrons(self, theMesh, theVolumesIDs, theNode000Index, theNode001Index):
4440         decrFun = lambda i: i-1
4441         theNode000Index,theNode001Index,Parameters,hasVars = ParseParameters(theNode000Index,theNode001Index, decrFun)
4442         theMesh.SetParameters(Parameters)
4443         return SMESH._objref_SMESH_Pattern.ApplyToHexahedrons( self, theMesh, theVolumesIDs, theNode000Index, theNode001Index )
4444
4445 # Registering the new proxy for Pattern
4446 omniORB.registerObjref(SMESH._objref_SMESH_Pattern._NP_RepositoryId, Pattern)
4447
4448 ## Private class used to bind methods creating algorithms to the class Mesh
4449 #
4450 class algoCreator:
4451     def __init__(self):
4452         self.mesh = None
4453         self.defaultAlgoType = ""
4454         self.algoTypeToClass = {}
4455
4456     # Stores a python class of algorithm
4457     def add(self, algoClass):
4458         if type( algoClass ).__name__ == 'classobj' and \
4459            hasattr( algoClass, "algoType"):
4460             self.algoTypeToClass[ algoClass.algoType ] = algoClass
4461             if not self.defaultAlgoType and \
4462                hasattr( algoClass, "isDefault") and algoClass.isDefault:
4463                 self.defaultAlgoType = algoClass.algoType
4464             #print "Add",algoClass.algoType, "dflt",self.defaultAlgoType
4465
4466     # creates a copy of self and assign mesh to the copy
4467     def copy(self, mesh):
4468         other = algoCreator()
4469         other.defaultAlgoType = self.defaultAlgoType
4470         other.algoTypeToClass  = self.algoTypeToClass
4471         other.mesh = mesh
4472         return other
4473
4474     # creates an instance of algorithm
4475     def __call__(self,algo="",geom=0,*args):
4476         algoType = self.defaultAlgoType
4477         for arg in args + (algo,geom):
4478             if isinstance( arg, geomBuilder.GEOM._objref_GEOM_Object ):
4479                 geom = arg
4480             if isinstance( arg, str ) and arg:
4481                 algoType = arg
4482         if not algoType and self.algoTypeToClass:
4483             algoType = self.algoTypeToClass.keys()[0]
4484         if self.algoTypeToClass.has_key( algoType ):
4485             #print "Create algo",algoType
4486             return self.algoTypeToClass[ algoType ]( self.mesh, geom )
4487         raise RuntimeError, "No class found for algo type %s" % algoType
4488         return None
4489
4490 # Private class used to substitute and store variable parameters of hypotheses.
4491 #
4492 class hypMethodWrapper:
4493     def __init__(self, hyp, method):
4494         self.hyp    = hyp
4495         self.method = method
4496         #print "REBIND:", method.__name__
4497         return
4498
4499     # call a method of hypothesis with calling SetVarParameter() before
4500     def __call__(self,*args):
4501         if not args:
4502             return self.method( self.hyp, *args ) # hypothesis method with no args
4503
4504         #print "MethWrapper.__call__",self.method.__name__, args
4505         try:
4506             parsed = ParseParameters(*args)     # replace variables with their values
4507             self.hyp.SetVarParameter( parsed[-2], self.method.__name__ )
4508             result = self.method( self.hyp, *parsed[:-2] ) # call hypothesis method
4509         except omniORB.CORBA.BAD_PARAM: # raised by hypothesis method call
4510             # maybe there is a replaced string arg which is not variable
4511             result = self.method( self.hyp, *args )
4512         except ValueError, detail: # raised by ParseParameters()
4513             try:
4514                 result = self.method( self.hyp, *args )
4515             except omniORB.CORBA.BAD_PARAM:
4516                 raise ValueError, detail # wrong variable name
4517
4518         return result
4519
4520 for pluginName in os.environ[ "SMESH_MeshersList" ].split( ":" ):
4521     #
4522     #print "pluginName: ", pluginName
4523     pluginBuilderName = pluginName + "Builder"
4524     try:
4525         exec( "from salome.%s.%s import *" % (pluginName, pluginBuilderName))
4526     except Exception, e:
4527         print "Exception while loading %s: %s" % ( pluginBuilderName, e )
4528         continue
4529     exec( "from salome.%s import %s" % (pluginName, pluginBuilderName))
4530     plugin = eval( pluginBuilderName )
4531     #print "  plugin:" , str(plugin)
4532
4533     # add methods creating algorithms to Mesh
4534     for k in dir( plugin ):
4535         if k[0] == '_': continue
4536         algo = getattr( plugin, k )
4537         #print "             algo:", str(algo)
4538         if type( algo ).__name__ == 'classobj' and hasattr( algo, "meshMethod" ):
4539             #print "                     meshMethod:" , str(algo.meshMethod)
4540             if not hasattr( Mesh, algo.meshMethod ):
4541                 setattr( Mesh, algo.meshMethod, algoCreator() )
4542                 pass
4543             getattr( Mesh, algo.meshMethod ).add( algo )
4544             pass
4545         pass
4546     pass
4547 del pluginName