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
1976     # Get informations about mesh contents:
1977     # ------------------------------------
1978
1979     ## Gets the mesh stattistic
1980     #  @return dictionary type element - count of elements
1981     #  @ingroup l1_meshinfo
1982     def GetMeshInfo(self, obj = None):
1983         if not obj: obj = self.mesh
1984         return self.smeshpyD.GetMeshInfo(obj)
1985
1986     ## Returns the number of nodes in the mesh
1987     #  @return an integer value
1988     #  @ingroup l1_meshinfo
1989     def NbNodes(self):
1990         return self.mesh.NbNodes()
1991
1992     ## Returns the number of elements in the mesh
1993     #  @return an integer value
1994     #  @ingroup l1_meshinfo
1995     def NbElements(self):
1996         return self.mesh.NbElements()
1997
1998     ## Returns the number of 0d elements in the mesh
1999     #  @return an integer value
2000     #  @ingroup l1_meshinfo
2001     def Nb0DElements(self):
2002         return self.mesh.Nb0DElements()
2003
2004     ## Returns the number of ball discrete elements in the mesh
2005     #  @return an integer value
2006     #  @ingroup l1_meshinfo
2007     def NbBalls(self):
2008         return self.mesh.NbBalls()
2009
2010     ## Returns the number of edges in the mesh
2011     #  @return an integer value
2012     #  @ingroup l1_meshinfo
2013     def NbEdges(self):
2014         return self.mesh.NbEdges()
2015
2016     ## Returns the number of edges with the given order in the mesh
2017     #  @param elementOrder the order of elements:
2018     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2019     #  @return an integer value
2020     #  @ingroup l1_meshinfo
2021     def NbEdgesOfOrder(self, elementOrder):
2022         return self.mesh.NbEdgesOfOrder(elementOrder)
2023
2024     ## Returns the number of faces in the mesh
2025     #  @return an integer value
2026     #  @ingroup l1_meshinfo
2027     def NbFaces(self):
2028         return self.mesh.NbFaces()
2029
2030     ## Returns the number of faces with the given order in the mesh
2031     #  @param elementOrder the order of elements:
2032     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2033     #  @return an integer value
2034     #  @ingroup l1_meshinfo
2035     def NbFacesOfOrder(self, elementOrder):
2036         return self.mesh.NbFacesOfOrder(elementOrder)
2037
2038     ## Returns the number of triangles in the mesh
2039     #  @return an integer value
2040     #  @ingroup l1_meshinfo
2041     def NbTriangles(self):
2042         return self.mesh.NbTriangles()
2043
2044     ## Returns the number of triangles with the given order in the mesh
2045     #  @param elementOrder is the order of elements:
2046     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2047     #  @return an integer value
2048     #  @ingroup l1_meshinfo
2049     def NbTrianglesOfOrder(self, elementOrder):
2050         return self.mesh.NbTrianglesOfOrder(elementOrder)
2051
2052     ## Returns the number of biquadratic triangles in the mesh
2053     #  @return an integer value
2054     #  @ingroup l1_meshinfo
2055     def NbBiQuadTriangles(self):
2056         return self.mesh.NbBiQuadTriangles()
2057
2058     ## Returns the number of quadrangles in the mesh
2059     #  @return an integer value
2060     #  @ingroup l1_meshinfo
2061     def NbQuadrangles(self):
2062         return self.mesh.NbQuadrangles()
2063
2064     ## Returns the number of quadrangles with the given order in the mesh
2065     #  @param elementOrder the order of elements:
2066     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2067     #  @return an integer value
2068     #  @ingroup l1_meshinfo
2069     def NbQuadranglesOfOrder(self, elementOrder):
2070         return self.mesh.NbQuadranglesOfOrder(elementOrder)
2071
2072     ## Returns the number of biquadratic quadrangles in the mesh
2073     #  @return an integer value
2074     #  @ingroup l1_meshinfo
2075     def NbBiQuadQuadrangles(self):
2076         return self.mesh.NbBiQuadQuadrangles()
2077
2078     ## Returns the number of polygons in the mesh
2079     #  @return an integer value
2080     #  @ingroup l1_meshinfo
2081     def NbPolygons(self):
2082         return self.mesh.NbPolygons()
2083
2084     ## Returns the number of volumes in the mesh
2085     #  @return an integer value
2086     #  @ingroup l1_meshinfo
2087     def NbVolumes(self):
2088         return self.mesh.NbVolumes()
2089
2090     ## Returns the number of volumes with the given order in the mesh
2091     #  @param elementOrder  the order of elements:
2092     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2093     #  @return an integer value
2094     #  @ingroup l1_meshinfo
2095     def NbVolumesOfOrder(self, elementOrder):
2096         return self.mesh.NbVolumesOfOrder(elementOrder)
2097
2098     ## Returns the number of tetrahedrons in the mesh
2099     #  @return an integer value
2100     #  @ingroup l1_meshinfo
2101     def NbTetras(self):
2102         return self.mesh.NbTetras()
2103
2104     ## Returns the number of tetrahedrons with the given order in the mesh
2105     #  @param elementOrder  the order of elements:
2106     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2107     #  @return an integer value
2108     #  @ingroup l1_meshinfo
2109     def NbTetrasOfOrder(self, elementOrder):
2110         return self.mesh.NbTetrasOfOrder(elementOrder)
2111
2112     ## Returns the number of hexahedrons in the mesh
2113     #  @return an integer value
2114     #  @ingroup l1_meshinfo
2115     def NbHexas(self):
2116         return self.mesh.NbHexas()
2117
2118     ## Returns the number of hexahedrons with the given order in the mesh
2119     #  @param elementOrder  the order of elements:
2120     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2121     #  @return an integer value
2122     #  @ingroup l1_meshinfo
2123     def NbHexasOfOrder(self, elementOrder):
2124         return self.mesh.NbHexasOfOrder(elementOrder)
2125
2126     ## Returns the number of triquadratic hexahedrons in the mesh
2127     #  @return an integer value
2128     #  @ingroup l1_meshinfo
2129     def NbTriQuadraticHexas(self):
2130         return self.mesh.NbTriQuadraticHexas()
2131
2132     ## Returns the number of pyramids in the mesh
2133     #  @return an integer value
2134     #  @ingroup l1_meshinfo
2135     def NbPyramids(self):
2136         return self.mesh.NbPyramids()
2137
2138     ## Returns the number of pyramids with the given order in the mesh
2139     #  @param elementOrder  the order of elements:
2140     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2141     #  @return an integer value
2142     #  @ingroup l1_meshinfo
2143     def NbPyramidsOfOrder(self, elementOrder):
2144         return self.mesh.NbPyramidsOfOrder(elementOrder)
2145
2146     ## Returns the number of prisms in the mesh
2147     #  @return an integer value
2148     #  @ingroup l1_meshinfo
2149     def NbPrisms(self):
2150         return self.mesh.NbPrisms()
2151
2152     ## Returns the number of prisms with the given order in the mesh
2153     #  @param elementOrder  the order of elements:
2154     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2155     #  @return an integer value
2156     #  @ingroup l1_meshinfo
2157     def NbPrismsOfOrder(self, elementOrder):
2158         return self.mesh.NbPrismsOfOrder(elementOrder)
2159
2160     ## Returns the number of hexagonal prisms in the mesh
2161     #  @return an integer value
2162     #  @ingroup l1_meshinfo
2163     def NbHexagonalPrisms(self):
2164         return self.mesh.NbHexagonalPrisms()
2165
2166     ## Returns the number of polyhedrons in the mesh
2167     #  @return an integer value
2168     #  @ingroup l1_meshinfo
2169     def NbPolyhedrons(self):
2170         return self.mesh.NbPolyhedrons()
2171
2172     ## Returns the number of submeshes in the mesh
2173     #  @return an integer value
2174     #  @ingroup l1_meshinfo
2175     def NbSubMesh(self):
2176         return self.mesh.NbSubMesh()
2177
2178     ## Returns the list of mesh elements IDs
2179     #  @return the list of integer values
2180     #  @ingroup l1_meshinfo
2181     def GetElementsId(self):
2182         return self.mesh.GetElementsId()
2183
2184     ## Returns the list of IDs of mesh elements with the given type
2185     #  @param elementType  the required type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2186     #  @return list of integer values
2187     #  @ingroup l1_meshinfo
2188     def GetElementsByType(self, elementType):
2189         return self.mesh.GetElementsByType(elementType)
2190
2191     ## Returns the list of mesh nodes IDs
2192     #  @return the list of integer values
2193     #  @ingroup l1_meshinfo
2194     def GetNodesId(self):
2195         return self.mesh.GetNodesId()
2196
2197     # Get the information about mesh elements:
2198     # ------------------------------------
2199
2200     ## Returns the type of mesh element
2201     #  @return the value from SMESH::ElementType enumeration
2202     #  @ingroup l1_meshinfo
2203     def GetElementType(self, id, iselem):
2204         return self.mesh.GetElementType(id, iselem)
2205
2206     ## Returns the geometric type of mesh element
2207     #  @return the value from SMESH::EntityType enumeration
2208     #  @ingroup l1_meshinfo
2209     def GetElementGeomType(self, id):
2210         return self.mesh.GetElementGeomType(id)
2211
2212     ## Returns the list of submesh elements IDs
2213     #  @param Shape a geom object(sub-shape) IOR
2214     #         Shape must be the sub-shape of a ShapeToMesh()
2215     #  @return the list of integer values
2216     #  @ingroup l1_meshinfo
2217     def GetSubMeshElementsId(self, Shape):
2218         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2219             ShapeID = Shape.GetSubShapeIndices()[0]
2220         else:
2221             ShapeID = Shape
2222         return self.mesh.GetSubMeshElementsId(ShapeID)
2223
2224     ## Returns the list of submesh nodes IDs
2225     #  @param Shape a geom object(sub-shape) IOR
2226     #         Shape must be the sub-shape of a ShapeToMesh()
2227     #  @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes
2228     #  @return the list of integer values
2229     #  @ingroup l1_meshinfo
2230     def GetSubMeshNodesId(self, Shape, all):
2231         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2232             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2233         else:
2234             ShapeID = Shape
2235         return self.mesh.GetSubMeshNodesId(ShapeID, all)
2236
2237     ## Returns type of elements on given shape
2238     #  @param Shape a geom object(sub-shape) IOR
2239     #         Shape must be a sub-shape of a ShapeToMesh()
2240     #  @return element type
2241     #  @ingroup l1_meshinfo
2242     def GetSubMeshElementType(self, Shape):
2243         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2244             ShapeID = Shape.GetSubShapeIndices()[0]
2245         else:
2246             ShapeID = Shape
2247         return self.mesh.GetSubMeshElementType(ShapeID)
2248
2249     ## Gets the mesh description
2250     #  @return string value
2251     #  @ingroup l1_meshinfo
2252     def Dump(self):
2253         return self.mesh.Dump()
2254
2255
2256     # Get the information about nodes and elements of a mesh by its IDs:
2257     # -----------------------------------------------------------
2258
2259     ## Gets XYZ coordinates of a node
2260     #  \n If there is no nodes for the given ID - returns an empty list
2261     #  @return a list of double precision values
2262     #  @ingroup l1_meshinfo
2263     def GetNodeXYZ(self, id):
2264         return self.mesh.GetNodeXYZ(id)
2265
2266     ## Returns list of IDs of inverse elements for the given node
2267     #  \n If there is no node for the given ID - returns an empty list
2268     #  @return a list of integer values
2269     #  @ingroup l1_meshinfo
2270     def GetNodeInverseElements(self, id):
2271         return self.mesh.GetNodeInverseElements(id)
2272
2273     ## @brief Returns the position of a node on the shape
2274     #  @return SMESH::NodePosition
2275     #  @ingroup l1_meshinfo
2276     def GetNodePosition(self,NodeID):
2277         return self.mesh.GetNodePosition(NodeID)
2278
2279     ## @brief Returns the position of an element on the shape
2280     #  @return SMESH::ElementPosition
2281     #  @ingroup l1_meshinfo
2282     def GetElementPosition(self,ElemID):
2283         return self.mesh.GetElementPosition(ElemID)
2284
2285     ## If the given element is a node, returns the ID of shape
2286     #  \n If there is no node for the given ID - returns -1
2287     #  @return an integer value
2288     #  @ingroup l1_meshinfo
2289     def GetShapeID(self, id):
2290         return self.mesh.GetShapeID(id)
2291
2292     ## Returns the ID of the result shape after
2293     #  FindShape() from SMESH_MeshEditor for the given element
2294     #  \n If there is no element for the given ID - returns -1
2295     #  @return an integer value
2296     #  @ingroup l1_meshinfo
2297     def GetShapeIDForElem(self,id):
2298         return self.mesh.GetShapeIDForElem(id)
2299
2300     ## Returns the number of nodes for the given element
2301     #  \n If there is no element for the given ID - returns -1
2302     #  @return an integer value
2303     #  @ingroup l1_meshinfo
2304     def GetElemNbNodes(self, id):
2305         return self.mesh.GetElemNbNodes(id)
2306
2307     ## Returns the node ID the given (zero based) index for the given element
2308     #  \n If there is no element for the given ID - returns -1
2309     #  \n If there is no node for the given index - returns -2
2310     #  @return an integer value
2311     #  @ingroup l1_meshinfo
2312     def GetElemNode(self, id, index):
2313         return self.mesh.GetElemNode(id, index)
2314
2315     ## Returns the IDs of nodes of the given element
2316     #  @return a list of integer values
2317     #  @ingroup l1_meshinfo
2318     def GetElemNodes(self, id):
2319         return self.mesh.GetElemNodes(id)
2320
2321     ## Returns true if the given node is the medium node in the given quadratic element
2322     #  @ingroup l1_meshinfo
2323     def IsMediumNode(self, elementID, nodeID):
2324         return self.mesh.IsMediumNode(elementID, nodeID)
2325
2326     ## Returns true if the given node is the medium node in one of quadratic elements
2327     #  @ingroup l1_meshinfo
2328     def IsMediumNodeOfAnyElem(self, nodeID, elementType):
2329         return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType)
2330
2331     ## Returns the number of edges for the given element
2332     #  @ingroup l1_meshinfo
2333     def ElemNbEdges(self, id):
2334         return self.mesh.ElemNbEdges(id)
2335
2336     ## Returns the number of faces for the given element
2337     #  @ingroup l1_meshinfo
2338     def ElemNbFaces(self, id):
2339         return self.mesh.ElemNbFaces(id)
2340
2341     ## Returns nodes of given face (counted from zero) for given volumic element.
2342     #  @ingroup l1_meshinfo
2343     def GetElemFaceNodes(self,elemId, faceIndex):
2344         return self.mesh.GetElemFaceNodes(elemId, faceIndex)
2345
2346     ## Returns an element based on all given nodes.
2347     #  @ingroup l1_meshinfo
2348     def FindElementByNodes(self,nodes):
2349         return self.mesh.FindElementByNodes(nodes)
2350
2351     ## Returns true if the given element is a polygon
2352     #  @ingroup l1_meshinfo
2353     def IsPoly(self, id):
2354         return self.mesh.IsPoly(id)
2355
2356     ## Returns true if the given element is quadratic
2357     #  @ingroup l1_meshinfo
2358     def IsQuadratic(self, id):
2359         return self.mesh.IsQuadratic(id)
2360
2361     ## Returns diameter of a ball discrete element or zero in case of an invalid \a id
2362     #  @ingroup l1_meshinfo
2363     def GetBallDiameter(self, id):
2364         return self.mesh.GetBallDiameter(id)
2365
2366     ## Returns XYZ coordinates of the barycenter of the given element
2367     #  \n If there is no element for the given ID - returns an empty list
2368     #  @return a list of three double values
2369     #  @ingroup l1_meshinfo
2370     def BaryCenter(self, id):
2371         return self.mesh.BaryCenter(id)
2372
2373     ## Passes mesh elements through the given filter and return IDs of fitting elements
2374     #  @param theFilter SMESH_Filter
2375     #  @return a list of ids
2376     #  @ingroup l1_controls
2377     def GetIdsFromFilter(self, theFilter):
2378         theFilter.SetMesh( self.mesh )
2379         return theFilter.GetIDs()
2380
2381     ## Verifies whether a 2D mesh element has free edges (edges connected to one face only)\n
2382     #  Returns a list of special structures (borders).
2383     #  @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes.
2384     #  @ingroup l1_controls
2385     def GetFreeBorders(self):
2386         aFilterMgr = self.smeshpyD.CreateFilterManager()
2387         aPredicate = aFilterMgr.CreateFreeEdges()
2388         aPredicate.SetMesh(self.mesh)
2389         aBorders = aPredicate.GetBorders()
2390         aFilterMgr.UnRegister()
2391         return aBorders
2392
2393
2394     # Get mesh measurements information:
2395     # ------------------------------------
2396
2397     ## Get minimum distance between two nodes, elements or distance to the origin
2398     #  @param id1 first node/element id
2399     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2400     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2401     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2402     #  @return minimum distance value
2403     #  @sa GetMinDistance()
2404     def MinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2405         aMeasure = self.GetMinDistance(id1, id2, isElem1, isElem2)
2406         return aMeasure.value
2407
2408     ## Get measure structure specifying minimum distance data between two objects
2409     #  @param id1 first node/element id
2410     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2411     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2412     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2413     #  @return Measure structure
2414     #  @sa MinDistance()
2415     def GetMinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2416         if isElem1:
2417             id1 = self.editor.MakeIDSource([id1], SMESH.FACE)
2418         else:
2419             id1 = self.editor.MakeIDSource([id1], SMESH.NODE)
2420         if id2 != 0:
2421             if isElem2:
2422                 id2 = self.editor.MakeIDSource([id2], SMESH.FACE)
2423             else:
2424                 id2 = self.editor.MakeIDSource([id2], SMESH.NODE)
2425             pass
2426         else:
2427             id2 = None
2428
2429         aMeasurements = self.smeshpyD.CreateMeasurements()
2430         aMeasure = aMeasurements.MinDistance(id1, id2)
2431         aMeasurements.UnRegister()
2432         return aMeasure
2433
2434     ## Get bounding box of the specified object(s)
2435     #  @param objects single source object or list of source objects or list of nodes/elements IDs
2436     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2437     #  @c False specifies that @a objects are nodes
2438     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
2439     #  @sa GetBoundingBox()
2440     def BoundingBox(self, objects=None, isElem=False):
2441         result = self.GetBoundingBox(objects, isElem)
2442         if result is None:
2443             result = (0.0,)*6
2444         else:
2445             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
2446         return result
2447
2448     ## Get measure structure specifying bounding box data of the specified object(s)
2449     #  @param IDs single source object or list of source objects or list of nodes/elements IDs
2450     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2451     #  @c False specifies that @a objects are nodes
2452     #  @return Measure structure
2453     #  @sa BoundingBox()
2454     def GetBoundingBox(self, IDs=None, isElem=False):
2455         if IDs is None:
2456             IDs = [self.mesh]
2457         elif isinstance(IDs, tuple):
2458             IDs = list(IDs)
2459         if not isinstance(IDs, list):
2460             IDs = [IDs]
2461         if len(IDs) > 0 and isinstance(IDs[0], int):
2462             IDs = [IDs]
2463         srclist = []
2464         for o in IDs:
2465             if isinstance(o, Mesh):
2466                 srclist.append(o.mesh)
2467             elif hasattr(o, "_narrow"):
2468                 src = o._narrow(SMESH.SMESH_IDSource)
2469                 if src: srclist.append(src)
2470                 pass
2471             elif isinstance(o, list):
2472                 if isElem:
2473                     srclist.append(self.editor.MakeIDSource(o, SMESH.FACE))
2474                 else:
2475                     srclist.append(self.editor.MakeIDSource(o, SMESH.NODE))
2476                 pass
2477             pass
2478         aMeasurements = self.smeshpyD.CreateMeasurements()
2479         aMeasure = aMeasurements.BoundingBox(srclist)
2480         aMeasurements.UnRegister()
2481         return aMeasure
2482
2483     # Mesh edition (SMESH_MeshEditor functionality):
2484     # ---------------------------------------------
2485
2486     ## Removes the elements from the mesh by ids
2487     #  @param IDsOfElements is a list of ids of elements to remove
2488     #  @return True or False
2489     #  @ingroup l2_modif_del
2490     def RemoveElements(self, IDsOfElements):
2491         return self.editor.RemoveElements(IDsOfElements)
2492
2493     ## Removes nodes from mesh by ids
2494     #  @param IDsOfNodes is a list of ids of nodes to remove
2495     #  @return True or False
2496     #  @ingroup l2_modif_del
2497     def RemoveNodes(self, IDsOfNodes):
2498         return self.editor.RemoveNodes(IDsOfNodes)
2499
2500     ## Removes all orphan (free) nodes from mesh
2501     #  @return number of the removed nodes
2502     #  @ingroup l2_modif_del
2503     def RemoveOrphanNodes(self):
2504         return self.editor.RemoveOrphanNodes()
2505
2506     ## Add a node to the mesh by coordinates
2507     #  @return Id of the new node
2508     #  @ingroup l2_modif_add
2509     def AddNode(self, x, y, z):
2510         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2511         if hasVars: self.mesh.SetParameters(Parameters)
2512         return self.editor.AddNode( x, y, z)
2513
2514     ## Creates a 0D element on a node with given number.
2515     #  @param IDOfNode the ID of node for creation of the element.
2516     #  @return the Id of the new 0D element
2517     #  @ingroup l2_modif_add
2518     def Add0DElement(self, IDOfNode):
2519         return self.editor.Add0DElement(IDOfNode)
2520
2521     ## Create 0D elements on all nodes of the given elements except those
2522     #  nodes on which a 0D element already exists.
2523     #  @param theObject an object on whose nodes 0D elements will be created.
2524     #         It can be mesh, sub-mesh, group, list of element IDs or a holder
2525     #         of nodes IDs created by calling mesh.GetIDSource( nodes, SMESH.NODE )
2526     #  @param theGroupName optional name of a group to add 0D elements created
2527     #         and/or found on nodes of \a theObject.
2528     #  @return an object (a new group or a temporary SMESH_IDSource) holding
2529     #          IDs of new and/or found 0D elements. IDs of 0D elements
2530     #          can be retrieved from the returned object by calling GetIDs()
2531     #  @ingroup l2_modif_add
2532     def Add0DElementsToAllNodes(self, theObject, theGroupName=""):
2533         if isinstance( theObject, Mesh ):
2534             theObject = theObject.GetMesh()
2535         if isinstance( theObject, list ):
2536             theObject = self.GetIDSource( theObject, SMESH.ALL )
2537         return self.editor.Create0DElementsOnAllNodes( theObject, theGroupName )
2538
2539     ## Creates a ball element on a node with given ID.
2540     #  @param IDOfNode the ID of node for creation of the element.
2541     #  @param diameter the bal diameter.
2542     #  @return the Id of the new ball element
2543     #  @ingroup l2_modif_add
2544     def AddBall(self, IDOfNode, diameter):
2545         return self.editor.AddBall( IDOfNode, diameter )
2546
2547     ## Creates a linear or quadratic edge (this is determined
2548     #  by the number of given nodes).
2549     #  @param IDsOfNodes the list of node IDs for creation of the element.
2550     #  The order of nodes in this list should correspond to the description
2551     #  of MED. \n This description is located by the following link:
2552     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2553     #  @return the Id of the new edge
2554     #  @ingroup l2_modif_add
2555     def AddEdge(self, IDsOfNodes):
2556         return self.editor.AddEdge(IDsOfNodes)
2557
2558     ## Creates a linear or quadratic face (this is determined
2559     #  by the number of given nodes).
2560     #  @param IDsOfNodes the list of node IDs for creation of the element.
2561     #  The order of nodes in this list should correspond to the description
2562     #  of MED. \n This description is located by the following link:
2563     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2564     #  @return the Id of the new face
2565     #  @ingroup l2_modif_add
2566     def AddFace(self, IDsOfNodes):
2567         return self.editor.AddFace(IDsOfNodes)
2568
2569     ## Adds a polygonal face to the mesh by the list of node IDs
2570     #  @param IdsOfNodes the list of node IDs for creation of the element.
2571     #  @return the Id of the new face
2572     #  @ingroup l2_modif_add
2573     def AddPolygonalFace(self, IdsOfNodes):
2574         return self.editor.AddPolygonalFace(IdsOfNodes)
2575
2576     ## Creates both simple and quadratic volume (this is determined
2577     #  by the number of given nodes).
2578     #  @param IDsOfNodes the list of node IDs for creation of the element.
2579     #  The order of nodes in this list should correspond to the description
2580     #  of MED. \n This description is located by the following link:
2581     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2582     #  @return the Id of the new volumic element
2583     #  @ingroup l2_modif_add
2584     def AddVolume(self, IDsOfNodes):
2585         return self.editor.AddVolume(IDsOfNodes)
2586
2587     ## Creates a volume of many faces, giving nodes for each face.
2588     #  @param IdsOfNodes the list of node IDs for volume creation face by face.
2589     #  @param Quantities the list of integer values, Quantities[i]
2590     #         gives the quantity of nodes in face number i.
2591     #  @return the Id of the new volumic element
2592     #  @ingroup l2_modif_add
2593     def AddPolyhedralVolume (self, IdsOfNodes, Quantities):
2594         return self.editor.AddPolyhedralVolume(IdsOfNodes, Quantities)
2595
2596     ## Creates a volume of many faces, giving the IDs of the existing faces.
2597     #  @param IdsOfFaces the list of face IDs for volume creation.
2598     #
2599     #  Note:  The created volume will refer only to the nodes
2600     #         of the given faces, not to the faces themselves.
2601     #  @return the Id of the new volumic element
2602     #  @ingroup l2_modif_add
2603     def AddPolyhedralVolumeByFaces (self, IdsOfFaces):
2604         return self.editor.AddPolyhedralVolumeByFaces(IdsOfFaces)
2605
2606
2607     ## @brief Binds a node to a vertex
2608     #  @param NodeID a node ID
2609     #  @param Vertex a vertex or vertex ID
2610     #  @return True if succeed else raises an exception
2611     #  @ingroup l2_modif_add
2612     def SetNodeOnVertex(self, NodeID, Vertex):
2613         if ( isinstance( Vertex, geomBuilder.GEOM._objref_GEOM_Object)):
2614             VertexID = Vertex.GetSubShapeIndices()[0]
2615         else:
2616             VertexID = Vertex
2617         try:
2618             self.editor.SetNodeOnVertex(NodeID, VertexID)
2619         except SALOME.SALOME_Exception, inst:
2620             raise ValueError, inst.details.text
2621         return True
2622
2623
2624     ## @brief Stores the node position on an edge
2625     #  @param NodeID a node ID
2626     #  @param Edge an edge or edge ID
2627     #  @param paramOnEdge a parameter on the edge where the node is located
2628     #  @return True if succeed else raises an exception
2629     #  @ingroup l2_modif_add
2630     def SetNodeOnEdge(self, NodeID, Edge, paramOnEdge):
2631         if ( isinstance( Edge, geomBuilder.GEOM._objref_GEOM_Object)):
2632             EdgeID = Edge.GetSubShapeIndices()[0]
2633         else:
2634             EdgeID = Edge
2635         try:
2636             self.editor.SetNodeOnEdge(NodeID, EdgeID, paramOnEdge)
2637         except SALOME.SALOME_Exception, inst:
2638             raise ValueError, inst.details.text
2639         return True
2640
2641     ## @brief Stores node position on a face
2642     #  @param NodeID a node ID
2643     #  @param Face a face or face ID
2644     #  @param u U parameter on the face where the node is located
2645     #  @param v V parameter on the face where the node is located
2646     #  @return True if succeed else raises an exception
2647     #  @ingroup l2_modif_add
2648     def SetNodeOnFace(self, NodeID, Face, u, v):
2649         if ( isinstance( Face, geomBuilder.GEOM._objref_GEOM_Object)):
2650             FaceID = Face.GetSubShapeIndices()[0]
2651         else:
2652             FaceID = Face
2653         try:
2654             self.editor.SetNodeOnFace(NodeID, FaceID, u, v)
2655         except SALOME.SALOME_Exception, inst:
2656             raise ValueError, inst.details.text
2657         return True
2658
2659     ## @brief Binds a node to a solid
2660     #  @param NodeID a node ID
2661     #  @param Solid  a solid or solid ID
2662     #  @return True if succeed else raises an exception
2663     #  @ingroup l2_modif_add
2664     def SetNodeInVolume(self, NodeID, Solid):
2665         if ( isinstance( Solid, geomBuilder.GEOM._objref_GEOM_Object)):
2666             SolidID = Solid.GetSubShapeIndices()[0]
2667         else:
2668             SolidID = Solid
2669         try:
2670             self.editor.SetNodeInVolume(NodeID, SolidID)
2671         except SALOME.SALOME_Exception, inst:
2672             raise ValueError, inst.details.text
2673         return True
2674
2675     ## @brief Bind an element to a shape
2676     #  @param ElementID an element ID
2677     #  @param Shape a shape or shape ID
2678     #  @return True if succeed else raises an exception
2679     #  @ingroup l2_modif_add
2680     def SetMeshElementOnShape(self, ElementID, Shape):
2681         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2682             ShapeID = Shape.GetSubShapeIndices()[0]
2683         else:
2684             ShapeID = Shape
2685         try:
2686             self.editor.SetMeshElementOnShape(ElementID, ShapeID)
2687         except SALOME.SALOME_Exception, inst:
2688             raise ValueError, inst.details.text
2689         return True
2690
2691
2692     ## Moves the node with the given id
2693     #  @param NodeID the id of the node
2694     #  @param x  a new X coordinate
2695     #  @param y  a new Y coordinate
2696     #  @param z  a new Z coordinate
2697     #  @return True if succeed else False
2698     #  @ingroup l2_modif_movenode
2699     def MoveNode(self, NodeID, x, y, z):
2700         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2701         if hasVars: self.mesh.SetParameters(Parameters)
2702         return self.editor.MoveNode(NodeID, x, y, z)
2703
2704     ## Finds the node closest to a point and moves it to a point location
2705     #  @param x  the X coordinate of a point
2706     #  @param y  the Y coordinate of a point
2707     #  @param z  the Z coordinate of a point
2708     #  @param NodeID if specified (>0), the node with this ID is moved,
2709     #  otherwise, the node closest to point (@a x,@a y,@a z) is moved
2710     #  @return the ID of a node
2711     #  @ingroup l2_modif_throughp
2712     def MoveClosestNodeToPoint(self, x, y, z, NodeID):
2713         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2714         if hasVars: self.mesh.SetParameters(Parameters)
2715         return self.editor.MoveClosestNodeToPoint(x, y, z, NodeID)
2716
2717     ## Finds the node closest to a point
2718     #  @param x  the X coordinate of a point
2719     #  @param y  the Y coordinate of a point
2720     #  @param z  the Z coordinate of a point
2721     #  @return the ID of a node
2722     #  @ingroup l2_modif_throughp
2723     def FindNodeClosestTo(self, x, y, z):
2724         #preview = self.mesh.GetMeshEditPreviewer()
2725         #return preview.MoveClosestNodeToPoint(x, y, z, -1)
2726         return self.editor.FindNodeClosestTo(x, y, z)
2727
2728     ## Finds the elements where a point lays IN or ON
2729     #  @param x  the X coordinate of a point
2730     #  @param y  the Y coordinate of a point
2731     #  @param z  the Z coordinate of a point
2732     #  @param elementType type of elements to find (SMESH.ALL type
2733     #         means elements of any type excluding nodes, discrete and 0D elements)
2734     #  @param meshPart a part of mesh (group, sub-mesh) to search within
2735     #  @return list of IDs of found elements
2736     #  @ingroup l2_modif_throughp
2737     def FindElementsByPoint(self, x, y, z, elementType = SMESH.ALL, meshPart=None):
2738         if meshPart:
2739             return self.editor.FindAmongElementsByPoint( meshPart, x, y, z, elementType );
2740         else:
2741             return self.editor.FindElementsByPoint(x, y, z, elementType)
2742
2743     # Return point state in a closed 2D mesh in terms of TopAbs_State enumeration:
2744     # 0-IN, 1-OUT, 2-ON, 3-UNKNOWN
2745     # TopAbs_UNKNOWN state means that either mesh is wrong or the analysis fails.
2746
2747     def GetPointState(self, x, y, z):
2748         return self.editor.GetPointState(x, y, z)
2749
2750     ## Finds the node closest to a point and moves it to a point location
2751     #  @param x  the X coordinate of a point
2752     #  @param y  the Y coordinate of a point
2753     #  @param z  the Z coordinate of a point
2754     #  @return the ID of a moved node
2755     #  @ingroup l2_modif_throughp
2756     def MeshToPassThroughAPoint(self, x, y, z):
2757         return self.editor.MoveClosestNodeToPoint(x, y, z, -1)
2758
2759     ## Replaces two neighbour triangles sharing Node1-Node2 link
2760     #  with the triangles built on the same 4 nodes but having other common link.
2761     #  @param NodeID1  the ID of the first node
2762     #  @param NodeID2  the ID of the second node
2763     #  @return false if proper faces were not found
2764     #  @ingroup l2_modif_invdiag
2765     def InverseDiag(self, NodeID1, NodeID2):
2766         return self.editor.InverseDiag(NodeID1, NodeID2)
2767
2768     ## Replaces two neighbour triangles sharing Node1-Node2 link
2769     #  with a quadrangle built on the same 4 nodes.
2770     #  @param NodeID1  the ID of the first node
2771     #  @param NodeID2  the ID of the second node
2772     #  @return false if proper faces were not found
2773     #  @ingroup l2_modif_unitetri
2774     def DeleteDiag(self, NodeID1, NodeID2):
2775         return self.editor.DeleteDiag(NodeID1, NodeID2)
2776
2777     ## Reorients elements by ids
2778     #  @param IDsOfElements if undefined reorients all mesh elements
2779     #  @return True if succeed else False
2780     #  @ingroup l2_modif_changori
2781     def Reorient(self, IDsOfElements=None):
2782         if IDsOfElements == None:
2783             IDsOfElements = self.GetElementsId()
2784         return self.editor.Reorient(IDsOfElements)
2785
2786     ## Reorients all elements of the object
2787     #  @param theObject mesh, submesh or group
2788     #  @return True if succeed else False
2789     #  @ingroup l2_modif_changori
2790     def ReorientObject(self, theObject):
2791         if ( isinstance( theObject, Mesh )):
2792             theObject = theObject.GetMesh()
2793         return self.editor.ReorientObject(theObject)
2794
2795     ## Reorient faces contained in \a the2DObject.
2796     #  @param the2DObject is a mesh, sub-mesh, group or list of IDs of 2D elements
2797     #  @param theDirection is a desired direction of normal of \a theFace.
2798     #         It can be either a GEOM vector or a list of coordinates [x,y,z].
2799     #  @param theFaceOrPoint defines a face of \a the2DObject whose normal will be
2800     #         compared with theDirection. It can be either ID of face or a point
2801     #         by which the face will be found. The point can be given as either
2802     #         a GEOM vertex or a list of point coordinates.
2803     #  @return number of reoriented faces
2804     #  @ingroup l2_modif_changori
2805     def Reorient2D(self, the2DObject, theDirection, theFaceOrPoint ):
2806         # check the2DObject
2807         if isinstance( the2DObject, Mesh ):
2808             the2DObject = the2DObject.GetMesh()
2809         if isinstance( the2DObject, list ):
2810             the2DObject = self.GetIDSource( the2DObject, SMESH.FACE )
2811         # check theDirection
2812         if isinstance( theDirection, geomBuilder.GEOM._objref_GEOM_Object):
2813             theDirection = self.smeshpyD.GetDirStruct( theDirection )
2814         if isinstance( theDirection, list ):
2815             theDirection = self.smeshpyD.MakeDirStruct( *theDirection  )
2816         # prepare theFace and thePoint
2817         theFace = theFaceOrPoint
2818         thePoint = PointStruct(0,0,0)
2819         if isinstance( theFaceOrPoint, geomBuilder.GEOM._objref_GEOM_Object):
2820             thePoint = self.smeshpyD.GetPointStruct( theFaceOrPoint )
2821             theFace = -1
2822         if isinstance( theFaceOrPoint, list ):
2823             thePoint = PointStruct( *theFaceOrPoint )
2824             theFace = -1
2825         if isinstance( theFaceOrPoint, PointStruct ):
2826             thePoint = theFaceOrPoint
2827             theFace = -1
2828         return self.editor.Reorient2D( the2DObject, theDirection, theFace, thePoint )
2829
2830     ## Fuses the neighbouring triangles into quadrangles.
2831     #  @param IDsOfElements The triangles to be fused,
2832     #  @param theCriterion  is a numerical functor, in terms of enum SMESH.FunctorType, used to
2833     #                       choose a neighbour to fuse with.
2834     #  @param MaxAngle      is the maximum angle between element normals at which the fusion
2835     #                       is still performed; theMaxAngle is mesured in radians.
2836     #                       Also it could be a name of variable which defines angle in degrees.
2837     #  @return TRUE in case of success, FALSE otherwise.
2838     #  @ingroup l2_modif_unitetri
2839     def TriToQuad(self, IDsOfElements, theCriterion, MaxAngle):
2840         MaxAngle,Parameters,hasVars = ParseAngles(MaxAngle)
2841         self.mesh.SetParameters(Parameters)
2842         if not IDsOfElements:
2843             IDsOfElements = self.GetElementsId()
2844         Functor = self.smeshpyD.GetFunctor(theCriterion)
2845         return self.editor.TriToQuad(IDsOfElements, Functor, MaxAngle)
2846
2847     ## Fuses the neighbouring triangles of the object into quadrangles
2848     #  @param theObject is mesh, submesh or group
2849     #  @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to
2850     #         choose a neighbour to fuse with.
2851     #  @param MaxAngle   a max angle between element normals at which the fusion
2852     #                   is still performed; theMaxAngle is mesured in radians.
2853     #  @return TRUE in case of success, FALSE otherwise.
2854     #  @ingroup l2_modif_unitetri
2855     def TriToQuadObject (self, theObject, theCriterion, MaxAngle):
2856         MaxAngle,Parameters,hasVars = ParseAngles(MaxAngle)
2857         self.mesh.SetParameters(Parameters)
2858         if isinstance( theObject, Mesh ):
2859             theObject = theObject.GetMesh()
2860         Functor = self.smeshpyD.GetFunctor(theCriterion)
2861         return self.editor.TriToQuadObject(theObject, Functor, MaxAngle)
2862
2863     ## Splits quadrangles into triangles.
2864     #  @param IDsOfElements the faces to be splitted.
2865     #  @param theCriterion   is a numerical functor, in terms of enum SMESH.FunctorType, used to
2866     #         choose a diagonal for splitting. If @a theCriterion is None, which is a default
2867     #         value, then quadrangles will be split by the smallest diagonal.
2868     #  @return TRUE in case of success, FALSE otherwise.
2869     #  @ingroup l2_modif_cutquadr
2870     def QuadToTri (self, IDsOfElements, theCriterion = None):
2871         if IDsOfElements == []:
2872             IDsOfElements = self.GetElementsId()
2873         if theCriterion is None:
2874             theCriterion = FT_MaxElementLength2D
2875         Functor = self.smeshpyD.GetFunctor(theCriterion)
2876         return self.editor.QuadToTri(IDsOfElements, Functor)
2877
2878     ## Splits quadrangles into triangles.
2879     #  @param theObject the object from which the list of elements is taken,
2880     #         this is mesh, submesh or group
2881     #  @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to
2882     #         choose a diagonal for splitting. If @a theCriterion is None, which is a default
2883     #         value, then quadrangles will be split by the smallest diagonal.
2884     #  @return TRUE in case of success, FALSE otherwise.
2885     #  @ingroup l2_modif_cutquadr
2886     def QuadToTriObject (self, theObject, theCriterion = None):
2887         if ( isinstance( theObject, Mesh )):
2888             theObject = theObject.GetMesh()
2889         if theCriterion is None:
2890             theCriterion = FT_MaxElementLength2D
2891         Functor = self.smeshpyD.GetFunctor(theCriterion)
2892         return self.editor.QuadToTriObject(theObject, Functor)
2893
2894     ## Splits each of given quadrangles into 4 triangles. A node is added at the center of
2895     #  a quadrangle.
2896     #  @param theElements the faces to be splitted. This can be either mesh, sub-mesh,
2897     #         group or a list of face IDs. By default all quadrangles are split
2898     #  @ingroup l2_modif_cutquadr
2899     def QuadTo4Tri (self, theElements=[]):
2900         if isinstance( theElements, Mesh ):
2901             theElements = theElements.mesh
2902         elif not theElements:
2903             theElements = self.mesh
2904         elif isinstance( theElements, list ):
2905             theElements = self.GetIDSource( theElements, SMESH.FACE )
2906         return self.editor.QuadTo4Tri( theElements )
2907
2908     ## Splits quadrangles into triangles.
2909     #  @param IDsOfElements the faces to be splitted
2910     #  @param Diag13        is used to choose a diagonal for splitting.
2911     #  @return TRUE in case of success, FALSE otherwise.
2912     #  @ingroup l2_modif_cutquadr
2913     def SplitQuad (self, IDsOfElements, Diag13):
2914         if IDsOfElements == []:
2915             IDsOfElements = self.GetElementsId()
2916         return self.editor.SplitQuad(IDsOfElements, Diag13)
2917
2918     ## Splits quadrangles into triangles.
2919     #  @param theObject the object from which the list of elements is taken,
2920     #         this is mesh, submesh or group
2921     #  @param Diag13    is used to choose a diagonal for splitting.
2922     #  @return TRUE in case of success, FALSE otherwise.
2923     #  @ingroup l2_modif_cutquadr
2924     def SplitQuadObject (self, theObject, Diag13):
2925         if ( isinstance( theObject, Mesh )):
2926             theObject = theObject.GetMesh()
2927         return self.editor.SplitQuadObject(theObject, Diag13)
2928
2929     ## Finds a better splitting of the given quadrangle.
2930     #  @param IDOfQuad   the ID of the quadrangle to be splitted.
2931     #  @param theCriterion  is a numerical functor, in terms of enum SMESH.FunctorType, used to
2932     #         choose a diagonal for splitting.
2933     #  @return 1 if 1-3 diagonal is better, 2 if 2-4
2934     #          diagonal is better, 0 if error occurs.
2935     #  @ingroup l2_modif_cutquadr
2936     def BestSplit (self, IDOfQuad, theCriterion):
2937         return self.editor.BestSplit(IDOfQuad, self.smeshpyD.GetFunctor(theCriterion))
2938
2939     ## Splits volumic elements into tetrahedrons
2940     #  @param elemIDs either list of elements or mesh or group or submesh
2941     #  @param method  flags passing splitting method: Hex_5Tet, Hex_6Tet, Hex_24Tet
2942     #         Hex_5Tet - split the hexahedron into 5 tetrahedrons, etc
2943     #  @ingroup l2_modif_cutquadr
2944     def SplitVolumesIntoTetra(self, elemIDs, method=smeshBuilder.Hex_5Tet ):
2945         if isinstance( elemIDs, Mesh ):
2946             elemIDs = elemIDs.GetMesh()
2947         if ( isinstance( elemIDs, list )):
2948             elemIDs = self.editor.MakeIDSource(elemIDs, SMESH.VOLUME)
2949         self.editor.SplitVolumesIntoTetra(elemIDs, method)
2950
2951     ## Splits quadrangle faces near triangular facets of volumes
2952     #
2953     #  @ingroup l1_auxiliary
2954     def SplitQuadsNearTriangularFacets(self):
2955         faces_array = self.GetElementsByType(SMESH.FACE)
2956         for face_id in faces_array:
2957             if self.GetElemNbNodes(face_id) == 4: # quadrangle
2958                 quad_nodes = self.mesh.GetElemNodes(face_id)
2959                 node1_elems = self.GetNodeInverseElements(quad_nodes[1 -1])
2960                 isVolumeFound = False
2961                 for node1_elem in node1_elems:
2962                     if not isVolumeFound:
2963                         if self.GetElementType(node1_elem, True) == SMESH.VOLUME:
2964                             nb_nodes = self.GetElemNbNodes(node1_elem)
2965                             if 3 < nb_nodes and nb_nodes < 7: # tetra or penta, or prism
2966                                 volume_elem = node1_elem
2967                                 volume_nodes = self.mesh.GetElemNodes(volume_elem)
2968                                 if volume_nodes.count(quad_nodes[2 -1]) > 0: # 1,2
2969                                     if volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,2,4
2970                                         isVolumeFound = True
2971                                         if volume_nodes.count(quad_nodes[3 -1]) == 0: # 1,2,4 & !3
2972                                             self.SplitQuad([face_id], False) # diagonal 2-4
2973                                     elif volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,2,3 & !4
2974                                         isVolumeFound = True
2975                                         self.SplitQuad([face_id], True) # diagonal 1-3
2976                                 elif volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,4 & !2
2977                                     if volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,4,3 & !2
2978                                         isVolumeFound = True
2979                                         self.SplitQuad([face_id], True) # diagonal 1-3
2980
2981     ## @brief Splits hexahedrons into tetrahedrons.
2982     #
2983     #  This operation uses pattern mapping functionality for splitting.
2984     #  @param theObject the object from which the list of hexahedrons is taken; this is mesh, submesh or group.
2985     #  @param theNode000,theNode001 within the range [0,7]; gives the orientation of the
2986     #         pattern relatively each hexahedron: the (0,0,0) key-point of the pattern
2987     #         will be mapped into <VAR>theNode000</VAR>-th node of each volume, the (0,0,1)
2988     #         key-point will be mapped into <VAR>theNode001</VAR>-th node of each volume.
2989     #         The (0,0,0) key-point of the used pattern corresponds to a non-split corner.
2990     #  @return TRUE in case of success, FALSE otherwise.
2991     #  @ingroup l1_auxiliary
2992     def SplitHexaToTetras (self, theObject, theNode000, theNode001):
2993         # Pattern:     5.---------.6
2994         #              /|#*      /|
2995         #             / | #*    / |
2996         #            /  |  # * /  |
2997         #           /   |   # /*  |
2998         # (0,0,1) 4.---------.7 * |
2999         #          |#*  |1   | # *|
3000         #          | # *.----|---#.2
3001         #          |  #/ *   |   /
3002         #          |  /#  *  |  /
3003         #          | /   # * | /
3004         #          |/      #*|/
3005         # (0,0,0) 0.---------.3
3006         pattern_tetra = "!!! Nb of points: \n 8 \n\
3007         !!! Points: \n\
3008         0 0 0  !- 0 \n\
3009         0 1 0  !- 1 \n\
3010         1 1 0  !- 2 \n\
3011         1 0 0  !- 3 \n\
3012         0 0 1  !- 4 \n\
3013         0 1 1  !- 5 \n\
3014         1 1 1  !- 6 \n\
3015         1 0 1  !- 7 \n\
3016         !!! Indices of points of 6 tetras: \n\
3017         0 3 4 1 \n\
3018         7 4 3 1 \n\
3019         4 7 5 1 \n\
3020         6 2 5 7 \n\
3021         1 5 2 7 \n\
3022         2 3 1 7 \n"
3023
3024         pattern = self.smeshpyD.GetPattern()
3025         isDone  = pattern.LoadFromFile(pattern_tetra)
3026         if not isDone:
3027             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
3028             return isDone
3029
3030         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
3031         isDone = pattern.MakeMesh(self.mesh, False, False)
3032         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
3033
3034         # split quafrangle faces near triangular facets of volumes
3035         self.SplitQuadsNearTriangularFacets()
3036
3037         return isDone
3038
3039     ## @brief Split hexahedrons into prisms.
3040     #
3041     #  Uses the pattern mapping functionality for splitting.
3042     #  @param theObject the object (mesh, submesh or group) from where the list of hexahedrons is taken;
3043     #  @param theNode000,theNode001 (within the range [0,7]) gives the orientation of the
3044     #         pattern relatively each hexahedron: keypoint (0,0,0) of the pattern
3045     #         will be mapped into the <VAR>theNode000</VAR>-th node of each volume, keypoint (0,0,1)
3046     #         will be mapped into the <VAR>theNode001</VAR>-th node of each volume.
3047     #         Edge (0,0,0)-(0,0,1) of used pattern connects two not split corners.
3048     #  @return TRUE in case of success, FALSE otherwise.
3049     #  @ingroup l1_auxiliary
3050     def SplitHexaToPrisms (self, theObject, theNode000, theNode001):
3051         # Pattern:     5.---------.6
3052         #              /|#       /|
3053         #             / | #     / |
3054         #            /  |  #   /  |
3055         #           /   |   # /   |
3056         # (0,0,1) 4.---------.7   |
3057         #          |    |    |    |
3058         #          |   1.----|----.2
3059         #          |   / *   |   /
3060         #          |  /   *  |  /
3061         #          | /     * | /
3062         #          |/       *|/
3063         # (0,0,0) 0.---------.3
3064         pattern_prism = "!!! Nb of points: \n 8 \n\
3065         !!! Points: \n\
3066         0 0 0  !- 0 \n\
3067         0 1 0  !- 1 \n\
3068         1 1 0  !- 2 \n\
3069         1 0 0  !- 3 \n\
3070         0 0 1  !- 4 \n\
3071         0 1 1  !- 5 \n\
3072         1 1 1  !- 6 \n\
3073         1 0 1  !- 7 \n\
3074         !!! Indices of points of 2 prisms: \n\
3075         0 1 3 4 5 7 \n\
3076         2 3 1 6 7 5 \n"
3077
3078         pattern = self.smeshpyD.GetPattern()
3079         isDone  = pattern.LoadFromFile(pattern_prism)
3080         if not isDone:
3081             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
3082             return isDone
3083
3084         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
3085         isDone = pattern.MakeMesh(self.mesh, False, False)
3086         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
3087
3088         # Splits quafrangle faces near triangular facets of volumes
3089         self.SplitQuadsNearTriangularFacets()
3090
3091         return isDone
3092
3093     ## Smoothes elements
3094     #  @param IDsOfElements the list if ids of elements to smooth
3095     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3096     #  Note that nodes built on edges and boundary nodes are always fixed.
3097     #  @param MaxNbOfIterations the maximum number of iterations
3098     #  @param MaxAspectRatio varies in range [1.0, inf]
3099     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3100     #  @return TRUE in case of success, FALSE otherwise.
3101     #  @ingroup l2_modif_smooth
3102     def Smooth(self, IDsOfElements, IDsOfFixedNodes,
3103                MaxNbOfIterations, MaxAspectRatio, Method):
3104         if IDsOfElements == []:
3105             IDsOfElements = self.GetElementsId()
3106         MaxNbOfIterations,MaxAspectRatio,Parameters,hasVars = ParseParameters(MaxNbOfIterations,MaxAspectRatio)
3107         self.mesh.SetParameters(Parameters)
3108         return self.editor.Smooth(IDsOfElements, IDsOfFixedNodes,
3109                                   MaxNbOfIterations, MaxAspectRatio, Method)
3110
3111     ## Smoothes elements which belong to the given object
3112     #  @param theObject the object to smooth
3113     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3114     #  Note that nodes built on edges and boundary nodes are always fixed.
3115     #  @param MaxNbOfIterations the maximum number of iterations
3116     #  @param MaxAspectRatio varies in range [1.0, inf]
3117     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3118     #  @return TRUE in case of success, FALSE otherwise.
3119     #  @ingroup l2_modif_smooth
3120     def SmoothObject(self, theObject, IDsOfFixedNodes,
3121                      MaxNbOfIterations, MaxAspectRatio, Method):
3122         if ( isinstance( theObject, Mesh )):
3123             theObject = theObject.GetMesh()
3124         return self.editor.SmoothObject(theObject, IDsOfFixedNodes,
3125                                         MaxNbOfIterations, MaxAspectRatio, Method)
3126
3127     ## Parametrically smoothes the given elements
3128     #  @param IDsOfElements the list if ids of elements to smooth
3129     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3130     #  Note that nodes built on edges and boundary nodes are always fixed.
3131     #  @param MaxNbOfIterations the maximum number of iterations
3132     #  @param MaxAspectRatio varies in range [1.0, inf]
3133     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3134     #  @return TRUE in case of success, FALSE otherwise.
3135     #  @ingroup l2_modif_smooth
3136     def SmoothParametric(self, IDsOfElements, IDsOfFixedNodes,
3137                          MaxNbOfIterations, MaxAspectRatio, Method):
3138         if IDsOfElements == []:
3139             IDsOfElements = self.GetElementsId()
3140         MaxNbOfIterations,MaxAspectRatio,Parameters,hasVars = ParseParameters(MaxNbOfIterations,MaxAspectRatio)
3141         self.mesh.SetParameters(Parameters)
3142         return self.editor.SmoothParametric(IDsOfElements, IDsOfFixedNodes,
3143                                             MaxNbOfIterations, MaxAspectRatio, Method)
3144
3145     ## Parametrically smoothes the elements which belong to the given object
3146     #  @param theObject the object to smooth
3147     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
3148     #  Note that nodes built on edges and boundary nodes are always fixed.
3149     #  @param MaxNbOfIterations the maximum number of iterations
3150     #  @param MaxAspectRatio varies in range [1.0, inf]
3151     #  @param Method Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
3152     #  @return TRUE in case of success, FALSE otherwise.
3153     #  @ingroup l2_modif_smooth
3154     def SmoothParametricObject(self, theObject, IDsOfFixedNodes,
3155                                MaxNbOfIterations, MaxAspectRatio, Method):
3156         if ( isinstance( theObject, Mesh )):
3157             theObject = theObject.GetMesh()
3158         return self.editor.SmoothParametricObject(theObject, IDsOfFixedNodes,
3159                                                   MaxNbOfIterations, MaxAspectRatio, Method)
3160
3161     ## Converts the mesh to quadratic or bi-quadratic, deletes old elements, replacing
3162     #  them with quadratic with the same id.
3163     #  @param theForce3d new node creation method:
3164     #         0 - the medium node lies at the geometrical entity from which the mesh element is built
3165     #         1 - the medium node lies at the middle of the line segments connecting start and end node of a mesh element
3166     #  @param theSubMesh a group or a sub-mesh to convert; WARNING: in this case the mesh can become not conformal
3167     #  @param theToBiQuad If True, converts the mesh to bi-quadratic
3168     #  @ingroup l2_modif_tofromqu
3169     def ConvertToQuadratic(self, theForce3d, theSubMesh=None, theToBiQuad=False):
3170         if isinstance( theSubMesh, Mesh ):
3171             theSubMesh = theSubMesh.mesh
3172         if theToBiQuad:
3173             self.editor.ConvertToBiQuadratic(theForce3d,theSubMesh)
3174         else:
3175             if theSubMesh:
3176                 self.editor.ConvertToQuadraticObject(theForce3d,theSubMesh)
3177             else:
3178                 self.editor.ConvertToQuadratic(theForce3d)
3179         error = self.editor.GetLastError()
3180         if error and error.comment:
3181             print error.comment
3182
3183     ## Converts the mesh from quadratic to ordinary,
3184     #  deletes old quadratic elements, \n replacing
3185     #  them with ordinary mesh elements with the same id.
3186     #  @param theSubMesh a group or a sub-mesh to convert; WARNING: in this case the mesh can become not conformal
3187     #  @ingroup l2_modif_tofromqu
3188     def ConvertFromQuadratic(self, theSubMesh=None):
3189         if theSubMesh:
3190             self.editor.ConvertFromQuadraticObject(theSubMesh)
3191         else:
3192             return self.editor.ConvertFromQuadratic()
3193
3194     ## Creates 2D mesh as skin on boundary faces of a 3D mesh
3195     #  @return TRUE if operation has been completed successfully, FALSE otherwise
3196     #  @ingroup l2_modif_edit
3197     def  Make2DMeshFrom3D(self):
3198         return self.editor. Make2DMeshFrom3D()
3199
3200     ## Creates missing boundary elements
3201     #  @param elements - elements whose boundary is to be checked:
3202     #                    mesh, group, sub-mesh or list of elements
3203     #   if elements is mesh, it must be the mesh whose MakeBoundaryMesh() is called
3204     #  @param dimension - defines type of boundary elements to create:
3205     #                     SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D
3206     #    SMESH.BND_1DFROM3D creates mesh edges on all borders of free facets of 3D cells
3207     #  @param groupName - a name of group to store created boundary elements in,
3208     #                     "" means not to create the group
3209     #  @param meshName - a name of new mesh to store created boundary elements in,
3210     #                     "" means not to create the new mesh
3211     #  @param toCopyElements - if true, the checked elements will be copied into
3212     #     the new mesh else only boundary elements will be copied into the new mesh
3213     #  @param toCopyExistingBondary - if true, not only new but also pre-existing
3214     #     boundary elements will be copied into the new mesh
3215     #  @return tuple (mesh, group) where bondary elements were added to
3216     #  @ingroup l2_modif_edit
3217     def MakeBoundaryMesh(self, elements, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="",
3218                          toCopyElements=False, toCopyExistingBondary=False):
3219         if isinstance( elements, Mesh ):
3220             elements = elements.GetMesh()
3221         if ( isinstance( elements, list )):
3222             elemType = SMESH.ALL
3223             if elements: elemType = self.GetElementType( elements[0], iselem=True)
3224             elements = self.editor.MakeIDSource(elements, elemType)
3225         mesh, group = self.editor.MakeBoundaryMesh(elements,dimension,groupName,meshName,
3226                                                    toCopyElements,toCopyExistingBondary)
3227         if mesh: mesh = self.smeshpyD.Mesh(mesh)
3228         return mesh, group
3229
3230     ##
3231     # @brief Creates missing boundary elements around either the whole mesh or
3232     #    groups of 2D elements
3233     #  @param dimension - defines type of boundary elements to create
3234     #  @param groupName - a name of group to store all boundary elements in,
3235     #    "" means not to create the group
3236     #  @param meshName - a name of a new mesh, which is a copy of the initial
3237     #    mesh + created boundary elements; "" means not to create the new mesh
3238     #  @param toCopyAll - if true, the whole initial mesh will be copied into
3239     #    the new mesh else only boundary elements will be copied into the new mesh
3240     #  @param groups - groups of 2D elements to make boundary around
3241     #  @retval tuple( long, mesh, groups )
3242     #                 long - number of added boundary elements
3243     #                 mesh - the mesh where elements were added to
3244     #                 group - the group of boundary elements or None
3245     #
3246     def MakeBoundaryElements(self, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="",
3247                              toCopyAll=False, groups=[]):
3248         nb, mesh, group = self.editor.MakeBoundaryElements(dimension,groupName,meshName,
3249                                                            toCopyAll,groups)
3250         if mesh: mesh = self.smeshpyD.Mesh(mesh)
3251         return nb, mesh, group
3252
3253     ## Renumber mesh nodes
3254     #  @ingroup l2_modif_renumber
3255     def RenumberNodes(self):
3256         self.editor.RenumberNodes()
3257
3258     ## Renumber mesh elements
3259     #  @ingroup l2_modif_renumber
3260     def RenumberElements(self):
3261         self.editor.RenumberElements()
3262
3263     ## Generates new elements by rotation of the elements around the axis
3264     #  @param IDsOfElements the list of ids of elements to sweep
3265     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3266     #  @param AngleInRadians the angle of Rotation (in radians) or a name of variable which defines angle in degrees
3267     #  @param NbOfSteps the number of steps
3268     #  @param Tolerance tolerance
3269     #  @param MakeGroups forces the generation of new groups from existing ones
3270     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3271     #                    of all steps, else - size of each step
3272     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3273     #  @ingroup l2_modif_extrurev
3274     def RotationSweep(self, IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance,
3275                       MakeGroups=False, TotalAngle=False):
3276         if IDsOfElements == []:
3277             IDsOfElements = self.GetElementsId()
3278         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3279             Axis = self.smeshpyD.GetAxisStruct(Axis)
3280         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3281         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3282         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3283         self.mesh.SetParameters(Parameters)
3284         if TotalAngle and NbOfSteps:
3285             AngleInRadians /= NbOfSteps
3286         if MakeGroups:
3287             return self.editor.RotationSweepMakeGroups(IDsOfElements, Axis,
3288                                                        AngleInRadians, NbOfSteps, Tolerance)
3289         self.editor.RotationSweep(IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance)
3290         return []
3291
3292     ## Generates new elements by rotation of the elements of object around the axis
3293     #  @param theObject object which elements should be sweeped.
3294     #                   It can be a mesh, a sub mesh or a group.
3295     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3296     #  @param AngleInRadians the angle of Rotation
3297     #  @param NbOfSteps number of steps
3298     #  @param Tolerance tolerance
3299     #  @param MakeGroups forces the generation of new groups from existing ones
3300     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3301     #                    of all steps, else - size of each step
3302     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3303     #  @ingroup l2_modif_extrurev
3304     def RotationSweepObject(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
3305                             MakeGroups=False, TotalAngle=False):
3306         if ( isinstance( theObject, Mesh )):
3307             theObject = theObject.GetMesh()
3308         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3309             Axis = self.smeshpyD.GetAxisStruct(Axis)
3310         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3311         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3312         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3313         self.mesh.SetParameters(Parameters)
3314         if TotalAngle and NbOfSteps:
3315             AngleInRadians /= NbOfSteps
3316         if MakeGroups:
3317             return self.editor.RotationSweepObjectMakeGroups(theObject, Axis, AngleInRadians,
3318                                                              NbOfSteps, Tolerance)
3319         self.editor.RotationSweepObject(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
3320         return []
3321
3322     ## Generates new elements by rotation of the elements of object around the axis
3323     #  @param theObject object which elements should be sweeped.
3324     #                   It can be a mesh, a sub mesh or a group.
3325     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3326     #  @param AngleInRadians the angle of Rotation
3327     #  @param NbOfSteps number of steps
3328     #  @param Tolerance tolerance
3329     #  @param MakeGroups forces the generation of new groups from existing ones
3330     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3331     #                    of all steps, else - size of each step
3332     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3333     #  @ingroup l2_modif_extrurev
3334     def RotationSweepObject1D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
3335                               MakeGroups=False, TotalAngle=False):
3336         if ( isinstance( theObject, Mesh )):
3337             theObject = theObject.GetMesh()
3338         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3339             Axis = self.smeshpyD.GetAxisStruct(Axis)
3340         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3341         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3342         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3343         self.mesh.SetParameters(Parameters)
3344         if TotalAngle and NbOfSteps:
3345             AngleInRadians /= NbOfSteps
3346         if MakeGroups:
3347             return self.editor.RotationSweepObject1DMakeGroups(theObject, Axis, AngleInRadians,
3348                                                                NbOfSteps, Tolerance)
3349         self.editor.RotationSweepObject1D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
3350         return []
3351
3352     ## Generates new elements by rotation of the elements of object around the axis
3353     #  @param theObject object which elements should be sweeped.
3354     #                   It can be a mesh, a sub mesh or a group.
3355     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
3356     #  @param AngleInRadians the angle of Rotation
3357     #  @param NbOfSteps number of steps
3358     #  @param Tolerance tolerance
3359     #  @param MakeGroups forces the generation of new groups from existing ones
3360     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
3361     #                    of all steps, else - size of each step
3362     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3363     #  @ingroup l2_modif_extrurev
3364     def RotationSweepObject2D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
3365                               MakeGroups=False, TotalAngle=False):
3366         if ( isinstance( theObject, Mesh )):
3367             theObject = theObject.GetMesh()
3368         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3369             Axis = self.smeshpyD.GetAxisStruct(Axis)
3370         AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians)
3371         NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance)
3372         Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters
3373         self.mesh.SetParameters(Parameters)
3374         if TotalAngle and NbOfSteps:
3375             AngleInRadians /= NbOfSteps
3376         if MakeGroups:
3377             return self.editor.RotationSweepObject2DMakeGroups(theObject, Axis, AngleInRadians,
3378                                                              NbOfSteps, Tolerance)
3379         self.editor.RotationSweepObject2D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
3380         return []
3381
3382     ## Generates new elements by extrusion of the elements with given ids
3383     #  @param IDsOfElements the list of elements ids for extrusion
3384     #  @param StepVector vector or DirStruct or 3 vector components, defining
3385     #         the direction and value of extrusion for one step (the total extrusion
3386     #         length will be NbOfSteps * ||StepVector||)
3387     #  @param NbOfSteps the number of steps
3388     #  @param MakeGroups forces the generation of new groups from existing ones
3389     #  @param IsNodes is True if elements with given ids are nodes
3390     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3391     #  @ingroup l2_modif_extrurev
3392     def ExtrusionSweep(self, IDsOfElements, StepVector, NbOfSteps, MakeGroups=False, IsNodes = False):
3393         if IDsOfElements == []:
3394             IDsOfElements = self.GetElementsId()
3395         if isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object):
3396             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3397         if isinstance( StepVector, list ):
3398             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3399         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3400         Parameters = StepVector.PS.parameters + var_separator + Parameters
3401         self.mesh.SetParameters(Parameters)
3402         if MakeGroups:
3403             if(IsNodes):
3404                 return self.editor.ExtrusionSweepMakeGroups0D(IDsOfElements, StepVector, NbOfSteps)
3405             else:
3406                 return self.editor.ExtrusionSweepMakeGroups(IDsOfElements, StepVector, NbOfSteps)
3407         if(IsNodes):
3408             self.editor.ExtrusionSweep0D(IDsOfElements, StepVector, NbOfSteps)
3409         else:
3410             self.editor.ExtrusionSweep(IDsOfElements, StepVector, NbOfSteps)
3411         return []
3412
3413     ## Generates new elements by extrusion of the elements with given ids
3414     #  @param IDsOfElements is ids of elements
3415     #  @param StepVector vector or DirStruct or 3 vector components, defining
3416     #         the direction and value of extrusion for one step (the total extrusion
3417     #         length will be NbOfSteps * ||StepVector||)
3418     #  @param NbOfSteps the number of steps
3419     #  @param ExtrFlags sets flags for extrusion
3420     #  @param SewTolerance uses for comparing locations of nodes if flag
3421     #         EXTRUSION_FLAG_SEW is set
3422     #  @param MakeGroups forces the generation of new groups from existing ones
3423     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3424     #  @ingroup l2_modif_extrurev
3425     def AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps,
3426                           ExtrFlags, SewTolerance, MakeGroups=False):
3427         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3428             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3429         if isinstance( StepVector, list ):
3430             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3431         if MakeGroups:
3432             return self.editor.AdvancedExtrusionMakeGroups(IDsOfElements, StepVector, NbOfSteps,
3433                                                            ExtrFlags, SewTolerance)
3434         self.editor.AdvancedExtrusion(IDsOfElements, StepVector, NbOfSteps,
3435                                       ExtrFlags, SewTolerance)
3436         return []
3437
3438     ## Generates new elements by extrusion of the elements which belong to the object
3439     #  @param theObject the object which elements should be processed.
3440     #                   It can be a mesh, a sub mesh or a group.
3441     #  @param StepVector vector or DirStruct or 3 vector components, defining
3442     #         the direction and value of extrusion for one step (the total extrusion
3443     #         length will be NbOfSteps * ||StepVector||)
3444     #  @param NbOfSteps the number of steps
3445     #  @param MakeGroups forces the generation of new groups from existing ones
3446     #  @param  IsNodes is True if elements which belong to the object are nodes
3447     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3448     #  @ingroup l2_modif_extrurev
3449     def ExtrusionSweepObject(self, theObject, StepVector, NbOfSteps, MakeGroups=False, IsNodes=False):
3450         if ( isinstance( theObject, Mesh )):
3451             theObject = theObject.GetMesh()
3452         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3453             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3454         if isinstance( StepVector, list ):
3455             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3456         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3457         Parameters = StepVector.PS.parameters + var_separator + Parameters
3458         self.mesh.SetParameters(Parameters)
3459         if MakeGroups:
3460             if(IsNodes):
3461                 return self.editor.ExtrusionSweepObject0DMakeGroups(theObject, StepVector, NbOfSteps)
3462             else:
3463                 return self.editor.ExtrusionSweepObjectMakeGroups(theObject, StepVector, NbOfSteps)
3464         if(IsNodes):
3465             self.editor.ExtrusionSweepObject0D(theObject, StepVector, NbOfSteps)
3466         else:
3467             self.editor.ExtrusionSweepObject(theObject, StepVector, NbOfSteps)
3468         return []
3469
3470     ## Generates new elements by extrusion of the elements which belong to the object
3471     #  @param theObject object which elements should be processed.
3472     #                   It can be a mesh, a sub mesh or a group.
3473     #  @param StepVector vector or DirStruct or 3 vector components, defining
3474     #         the direction and value of extrusion for one step (the total extrusion
3475     #         length will be NbOfSteps * ||StepVector||)
3476     #  @param NbOfSteps the number of steps
3477     #  @param MakeGroups to generate new groups from existing ones
3478     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3479     #  @ingroup l2_modif_extrurev
3480     def ExtrusionSweepObject1D(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
3481         if ( isinstance( theObject, Mesh )):
3482             theObject = theObject.GetMesh()
3483         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3484             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3485         if isinstance( StepVector, list ):
3486             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3487         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3488         Parameters = StepVector.PS.parameters + var_separator + Parameters
3489         self.mesh.SetParameters(Parameters)
3490         if MakeGroups:
3491             return self.editor.ExtrusionSweepObject1DMakeGroups(theObject, StepVector, NbOfSteps)
3492         self.editor.ExtrusionSweepObject1D(theObject, StepVector, NbOfSteps)
3493         return []
3494
3495     ## Generates new elements by extrusion of the elements which belong to the object
3496     #  @param theObject object which elements should be processed.
3497     #                   It can be a mesh, a sub mesh or a group.
3498     #  @param StepVector vector or DirStruct or 3 vector components, defining
3499     #         the direction and value of extrusion for one step (the total extrusion
3500     #         length will be NbOfSteps * ||StepVector||)
3501     #  @param NbOfSteps the number of steps
3502     #  @param MakeGroups forces the generation of new groups from existing ones
3503     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3504     #  @ingroup l2_modif_extrurev
3505     def ExtrusionSweepObject2D(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
3506         if ( isinstance( theObject, Mesh )):
3507             theObject = theObject.GetMesh()
3508         if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)):
3509             StepVector = self.smeshpyD.GetDirStruct(StepVector)
3510         if isinstance( StepVector, list ):
3511             StepVector = self.smeshpyD.MakeDirStruct(*StepVector)
3512         NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps)
3513         Parameters = StepVector.PS.parameters + var_separator + Parameters
3514         self.mesh.SetParameters(Parameters)
3515         if MakeGroups:
3516             return self.editor.ExtrusionSweepObject2DMakeGroups(theObject, StepVector, NbOfSteps)
3517         self.editor.ExtrusionSweepObject2D(theObject, StepVector, NbOfSteps)
3518         return []
3519
3520
3521
3522     ## Generates new elements by extrusion of the given elements
3523     #  The path of extrusion must be a meshed edge.
3524     #  @param Base mesh or group, or submesh, or list of ids of elements for extrusion
3525     #  @param Path - 1D mesh or 1D sub-mesh, along which proceeds the extrusion
3526     #  @param NodeStart the start node from Path. Defines the direction of extrusion
3527     #  @param HasAngles allows the shape to be rotated around the path
3528     #                   to get the resulting mesh in a helical fashion
3529     #  @param Angles list of angles in radians
3530     #  @param LinearVariation forces the computation of rotation angles as linear
3531     #                         variation of the given Angles along path steps
3532     #  @param HasRefPoint allows using the reference point
3533     #  @param RefPoint the point around which the elements are rotated (the mass
3534     #         center of the elements by default).
3535     #         The User can specify any point as the Reference Point.
3536     #         RefPoint can be either GEOM Vertex, [x,y,z] or SMESH.PointStruct
3537     #  @param MakeGroups forces the generation of new groups from existing ones
3538     #  @param ElemType type of elements for extrusion (if param Base is a mesh)
3539     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3540     #          only SMESH::Extrusion_Error otherwise
3541     #  @ingroup l2_modif_extrurev
3542     def ExtrusionAlongPathX(self, Base, Path, NodeStart,
3543                             HasAngles, Angles, LinearVariation,
3544                             HasRefPoint, RefPoint, MakeGroups, ElemType):
3545         if isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object):
3546             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3547             pass
3548         elif isinstance( RefPoint, list ):
3549             RefPoint = PointStruct(*RefPoint)
3550             pass
3551         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3552         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3553         self.mesh.SetParameters(Parameters)
3554
3555         if (isinstance(Path, Mesh)): Path = Path.GetMesh()
3556
3557         if isinstance(Base, list):
3558             IDsOfElements = []
3559             if Base == []: IDsOfElements = self.GetElementsId()
3560             else: IDsOfElements = Base
3561             return self.editor.ExtrusionAlongPathX(IDsOfElements, Path, NodeStart,
3562                                                    HasAngles, Angles, LinearVariation,
3563                                                    HasRefPoint, RefPoint, MakeGroups, ElemType)
3564         else:
3565             if isinstance(Base, Mesh): Base = Base.GetMesh()
3566             if isinstance(Base, SMESH._objref_SMESH_Mesh) or isinstance(Base, SMESH._objref_SMESH_Group) or isinstance(Base, SMESH._objref_SMESH_subMesh):
3567                 return self.editor.ExtrusionAlongPathObjX(Base, Path, NodeStart,
3568                                                           HasAngles, Angles, LinearVariation,
3569                                                           HasRefPoint, RefPoint, MakeGroups, ElemType)
3570             else:
3571                 raise RuntimeError, "Invalid Base for ExtrusionAlongPathX"
3572
3573
3574     ## Generates new elements by extrusion of the given elements
3575     #  The path of extrusion must be a meshed edge.
3576     #  @param IDsOfElements ids of elements
3577     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which proceeds the extrusion
3578     #  @param PathShape shape(edge) defines the sub-mesh for the path
3579     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3580     #  @param HasAngles allows the shape to be rotated around the path
3581     #                   to get the resulting mesh in a helical fashion
3582     #  @param Angles list of angles in radians
3583     #  @param HasRefPoint allows using the reference point
3584     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3585     #         The User can specify any point as the Reference Point.
3586     #  @param MakeGroups forces the generation of new groups from existing ones
3587     #  @param LinearVariation forces the computation of rotation angles as linear
3588     #                         variation of the given Angles along path steps
3589     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3590     #          only SMESH::Extrusion_Error otherwise
3591     #  @ingroup l2_modif_extrurev
3592     def ExtrusionAlongPath(self, IDsOfElements, PathMesh, PathShape, NodeStart,
3593                            HasAngles, Angles, HasRefPoint, RefPoint,
3594                            MakeGroups=False, LinearVariation=False):
3595         if IDsOfElements == []:
3596             IDsOfElements = self.GetElementsId()
3597         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3598             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3599             pass
3600         if ( isinstance( PathMesh, Mesh )):
3601             PathMesh = PathMesh.GetMesh()
3602         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3603         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3604         self.mesh.SetParameters(Parameters)
3605         if HasAngles and Angles and LinearVariation:
3606             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3607             pass
3608         if MakeGroups:
3609             return self.editor.ExtrusionAlongPathMakeGroups(IDsOfElements, PathMesh,
3610                                                             PathShape, NodeStart, HasAngles,
3611                                                             Angles, HasRefPoint, RefPoint)
3612         return self.editor.ExtrusionAlongPath(IDsOfElements, PathMesh, PathShape,
3613                                               NodeStart, HasAngles, Angles, HasRefPoint, RefPoint)
3614
3615     ## Generates new elements by extrusion of the elements which belong to the object
3616     #  The path of extrusion must be a meshed edge.
3617     #  @param theObject the object which elements should be processed.
3618     #                   It can be a mesh, a sub mesh or a group.
3619     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds
3620     #  @param PathShape shape(edge) defines the sub-mesh for the path
3621     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3622     #  @param HasAngles allows the shape to be rotated around the path
3623     #                   to get the resulting mesh in a helical fashion
3624     #  @param Angles list of angles
3625     #  @param HasRefPoint allows using the reference point
3626     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3627     #         The User can specify any point as the Reference Point.
3628     #  @param MakeGroups forces the generation of new groups from existing ones
3629     #  @param LinearVariation forces the computation of rotation angles as linear
3630     #                         variation of the given Angles along path steps
3631     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3632     #          only SMESH::Extrusion_Error otherwise
3633     #  @ingroup l2_modif_extrurev
3634     def ExtrusionAlongPathObject(self, theObject, PathMesh, PathShape, NodeStart,
3635                                  HasAngles, Angles, HasRefPoint, RefPoint,
3636                                  MakeGroups=False, LinearVariation=False):
3637         if ( isinstance( theObject, Mesh )):
3638             theObject = theObject.GetMesh()
3639         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3640             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3641         if ( isinstance( PathMesh, Mesh )):
3642             PathMesh = PathMesh.GetMesh()
3643         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3644         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3645         self.mesh.SetParameters(Parameters)
3646         if HasAngles and Angles and LinearVariation:
3647             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3648             pass
3649         if MakeGroups:
3650             return self.editor.ExtrusionAlongPathObjectMakeGroups(theObject, PathMesh,
3651                                                                   PathShape, NodeStart, HasAngles,
3652                                                                   Angles, HasRefPoint, RefPoint)
3653         return self.editor.ExtrusionAlongPathObject(theObject, PathMesh, PathShape,
3654                                                     NodeStart, HasAngles, Angles, HasRefPoint,
3655                                                     RefPoint)
3656
3657     ## Generates new elements by extrusion of the elements which belong to the object
3658     #  The path of extrusion must be a meshed edge.
3659     #  @param theObject the object which elements should be processed.
3660     #                   It can be a mesh, a sub mesh or a group.
3661     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds
3662     #  @param PathShape shape(edge) defines the sub-mesh for the path
3663     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3664     #  @param HasAngles allows the shape to be rotated around the path
3665     #                   to get the resulting mesh in a helical fashion
3666     #  @param Angles list of angles
3667     #  @param HasRefPoint allows using the reference point
3668     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3669     #         The User can specify any point as the Reference Point.
3670     #  @param MakeGroups forces the generation of new groups from existing ones
3671     #  @param LinearVariation forces the computation of rotation angles as linear
3672     #                         variation of the given Angles along path steps
3673     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3674     #          only SMESH::Extrusion_Error otherwise
3675     #  @ingroup l2_modif_extrurev
3676     def ExtrusionAlongPathObject1D(self, theObject, PathMesh, PathShape, NodeStart,
3677                                    HasAngles, Angles, HasRefPoint, RefPoint,
3678                                    MakeGroups=False, LinearVariation=False):
3679         if ( isinstance( theObject, Mesh )):
3680             theObject = theObject.GetMesh()
3681         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3682             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3683         if ( isinstance( PathMesh, Mesh )):
3684             PathMesh = PathMesh.GetMesh()
3685         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3686         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3687         self.mesh.SetParameters(Parameters)
3688         if HasAngles and Angles and LinearVariation:
3689             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3690             pass
3691         if MakeGroups:
3692             return self.editor.ExtrusionAlongPathObject1DMakeGroups(theObject, PathMesh,
3693                                                                     PathShape, NodeStart, HasAngles,
3694                                                                     Angles, HasRefPoint, RefPoint)
3695         return self.editor.ExtrusionAlongPathObject1D(theObject, PathMesh, PathShape,
3696                                                       NodeStart, HasAngles, Angles, HasRefPoint,
3697                                                       RefPoint)
3698
3699     ## Generates new elements by extrusion of the elements which belong to the object
3700     #  The path of extrusion must be a meshed edge.
3701     #  @param theObject the object which elements should be processed.
3702     #                   It can be a mesh, a sub mesh or a group.
3703     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds
3704     #  @param PathShape shape(edge) defines the sub-mesh for the path
3705     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
3706     #  @param HasAngles allows the shape to be rotated around the path
3707     #                   to get the resulting mesh in a helical fashion
3708     #  @param Angles list of angles
3709     #  @param HasRefPoint allows using the reference point
3710     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
3711     #         The User can specify any point as the Reference Point.
3712     #  @param MakeGroups forces the generation of new groups from existing ones
3713     #  @param LinearVariation forces the computation of rotation angles as linear
3714     #                         variation of the given Angles along path steps
3715     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
3716     #          only SMESH::Extrusion_Error otherwise
3717     #  @ingroup l2_modif_extrurev
3718     def ExtrusionAlongPathObject2D(self, theObject, PathMesh, PathShape, NodeStart,
3719                                    HasAngles, Angles, HasRefPoint, RefPoint,
3720                                    MakeGroups=False, LinearVariation=False):
3721         if ( isinstance( theObject, Mesh )):
3722             theObject = theObject.GetMesh()
3723         if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)):
3724             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
3725         if ( isinstance( PathMesh, Mesh )):
3726             PathMesh = PathMesh.GetMesh()
3727         Angles,AnglesParameters,hasVars = ParseAngles(Angles)
3728         Parameters = AnglesParameters + var_separator + RefPoint.parameters
3729         self.mesh.SetParameters(Parameters)
3730         if HasAngles and Angles and LinearVariation:
3731             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
3732             pass
3733         if MakeGroups:
3734             return self.editor.ExtrusionAlongPathObject2DMakeGroups(theObject, PathMesh,
3735                                                                     PathShape, NodeStart, HasAngles,
3736                                                                     Angles, HasRefPoint, RefPoint)
3737         return self.editor.ExtrusionAlongPathObject2D(theObject, PathMesh, PathShape,
3738                                                       NodeStart, HasAngles, Angles, HasRefPoint,
3739                                                       RefPoint)
3740
3741     ## Creates a symmetrical copy of mesh elements
3742     #  @param IDsOfElements list of elements ids
3743     #  @param Mirror is AxisStruct or geom object(point, line, plane)
3744     #  @param theMirrorType is  POINT, AXIS or PLANE
3745     #  If the Mirror is a geom object this parameter is unnecessary
3746     #  @param Copy allows to copy element (Copy is 1) or to replace with its mirroring (Copy is 0)
3747     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3748     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3749     #  @ingroup l2_modif_trsf
3750     def Mirror(self, IDsOfElements, Mirror, theMirrorType, Copy=0, MakeGroups=False):
3751         if IDsOfElements == []:
3752             IDsOfElements = self.GetElementsId()
3753         if ( isinstance( Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3754             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3755         self.mesh.SetParameters(Mirror.parameters)
3756         if Copy and MakeGroups:
3757             return self.editor.MirrorMakeGroups(IDsOfElements, Mirror, theMirrorType)
3758         self.editor.Mirror(IDsOfElements, Mirror, theMirrorType, Copy)
3759         return []
3760
3761     ## Creates a new mesh by a symmetrical copy of mesh elements
3762     #  @param IDsOfElements the list of elements ids
3763     #  @param Mirror is AxisStruct or geom object (point, line, plane)
3764     #  @param theMirrorType is  POINT, AXIS or PLANE
3765     #  If the Mirror is a geom object this parameter is unnecessary
3766     #  @param MakeGroups to generate new groups from existing ones
3767     #  @param NewMeshName a name of the new mesh to create
3768     #  @return instance of Mesh class
3769     #  @ingroup l2_modif_trsf
3770     def MirrorMakeMesh(self, IDsOfElements, Mirror, theMirrorType, MakeGroups=0, NewMeshName=""):
3771         if IDsOfElements == []:
3772             IDsOfElements = self.GetElementsId()
3773         if ( isinstance( Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3774             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3775         self.mesh.SetParameters(Mirror.parameters)
3776         mesh = self.editor.MirrorMakeMesh(IDsOfElements, Mirror, theMirrorType,
3777                                           MakeGroups, NewMeshName)
3778         return Mesh(self.smeshpyD,self.geompyD,mesh)
3779
3780     ## Creates a symmetrical copy of the object
3781     #  @param theObject mesh, submesh or group
3782     #  @param Mirror AxisStruct or geom object (point, line, plane)
3783     #  @param theMirrorType is  POINT, AXIS or PLANE
3784     #  If the Mirror is a geom object this parameter is unnecessary
3785     #  @param Copy allows copying the element (Copy is 1) or replacing it with its mirror (Copy is 0)
3786     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3787     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3788     #  @ingroup l2_modif_trsf
3789     def MirrorObject (self, theObject, Mirror, theMirrorType, Copy=0, MakeGroups=False):
3790         if ( isinstance( theObject, Mesh )):
3791             theObject = theObject.GetMesh()
3792         if ( isinstance( Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3793             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3794         self.mesh.SetParameters(Mirror.parameters)
3795         if Copy and MakeGroups:
3796             return self.editor.MirrorObjectMakeGroups(theObject, Mirror, theMirrorType)
3797         self.editor.MirrorObject(theObject, Mirror, theMirrorType, Copy)
3798         return []
3799
3800     ## Creates a new mesh by a symmetrical copy of the object
3801     #  @param theObject mesh, submesh or group
3802     #  @param Mirror AxisStruct or geom object (point, line, plane)
3803     #  @param theMirrorType POINT, AXIS or PLANE
3804     #  If the Mirror is a geom object this parameter is unnecessary
3805     #  @param MakeGroups forces the generation of new groups from existing ones
3806     #  @param NewMeshName the name of the new mesh to create
3807     #  @return instance of Mesh class
3808     #  @ingroup l2_modif_trsf
3809     def MirrorObjectMakeMesh (self, theObject, Mirror, theMirrorType,MakeGroups=0, NewMeshName=""):
3810         if ( isinstance( theObject, Mesh )):
3811             theObject = theObject.GetMesh()
3812         if (isinstance(Mirror, geomBuilder.GEOM._objref_GEOM_Object)):
3813             Mirror = self.smeshpyD.GetAxisStruct(Mirror)
3814         self.mesh.SetParameters(Mirror.parameters)
3815         mesh = self.editor.MirrorObjectMakeMesh(theObject, Mirror, theMirrorType,
3816                                                 MakeGroups, NewMeshName)
3817         return Mesh( self.smeshpyD,self.geompyD,mesh )
3818
3819     ## Translates the elements
3820     #  @param IDsOfElements list of elements ids
3821     #  @param Vector the direction of translation (DirStruct or vector or 3 vector components)
3822     #  @param Copy allows copying the translated elements
3823     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3824     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3825     #  @ingroup l2_modif_trsf
3826     def Translate(self, IDsOfElements, Vector, Copy, MakeGroups=False):
3827         if IDsOfElements == []:
3828             IDsOfElements = self.GetElementsId()
3829         if ( isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object)):
3830             Vector = self.smeshpyD.GetDirStruct(Vector)
3831         if isinstance( Vector, list ):
3832             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3833         self.mesh.SetParameters(Vector.PS.parameters)
3834         if Copy and MakeGroups:
3835             return self.editor.TranslateMakeGroups(IDsOfElements, Vector)
3836         self.editor.Translate(IDsOfElements, Vector, Copy)
3837         return []
3838
3839     ## Creates a new mesh of translated elements
3840     #  @param IDsOfElements list of elements ids
3841     #  @param Vector the direction of translation (DirStruct or vector or 3 vector components)
3842     #  @param MakeGroups forces the generation of new groups from existing ones
3843     #  @param NewMeshName the name of the newly created mesh
3844     #  @return instance of Mesh class
3845     #  @ingroup l2_modif_trsf
3846     def TranslateMakeMesh(self, IDsOfElements, Vector, MakeGroups=False, NewMeshName=""):
3847         if IDsOfElements == []:
3848             IDsOfElements = self.GetElementsId()
3849         if ( isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object)):
3850             Vector = self.smeshpyD.GetDirStruct(Vector)
3851         if isinstance( Vector, list ):
3852             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3853         self.mesh.SetParameters(Vector.PS.parameters)
3854         mesh = self.editor.TranslateMakeMesh(IDsOfElements, Vector, MakeGroups, NewMeshName)
3855         return Mesh ( self.smeshpyD, self.geompyD, mesh )
3856
3857     ## Translates the object
3858     #  @param theObject the object to translate (mesh, submesh, or group)
3859     #  @param Vector direction of translation (DirStruct or geom vector or 3 vector components)
3860     #  @param Copy allows copying the translated elements
3861     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3862     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3863     #  @ingroup l2_modif_trsf
3864     def TranslateObject(self, theObject, Vector, Copy, MakeGroups=False):
3865         if ( isinstance( theObject, Mesh )):
3866             theObject = theObject.GetMesh()
3867         if ( isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object)):
3868             Vector = self.smeshpyD.GetDirStruct(Vector)
3869         if isinstance( Vector, list ):
3870             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3871         self.mesh.SetParameters(Vector.PS.parameters)
3872         if Copy and MakeGroups:
3873             return self.editor.TranslateObjectMakeGroups(theObject, Vector)
3874         self.editor.TranslateObject(theObject, Vector, Copy)
3875         return []
3876
3877     ## Creates a new mesh from the translated object
3878     #  @param theObject the object to translate (mesh, submesh, or group)
3879     #  @param Vector the direction of translation (DirStruct or geom vector or 3 vector components)
3880     #  @param MakeGroups forces the generation of new groups from existing ones
3881     #  @param NewMeshName the name of the newly created mesh
3882     #  @return instance of Mesh class
3883     #  @ingroup l2_modif_trsf
3884     def TranslateObjectMakeMesh(self, theObject, Vector, MakeGroups=False, NewMeshName=""):
3885         if isinstance( theObject, Mesh ):
3886             theObject = theObject.GetMesh()
3887         if isinstance( Vector, geomBuilder.GEOM._objref_GEOM_Object ):
3888             Vector = self.smeshpyD.GetDirStruct(Vector)
3889         if isinstance( Vector, list ):
3890             Vector = self.smeshpyD.MakeDirStruct(*Vector)
3891         self.mesh.SetParameters(Vector.PS.parameters)
3892         mesh = self.editor.TranslateObjectMakeMesh(theObject, Vector, MakeGroups, NewMeshName)
3893         return Mesh( self.smeshpyD, self.geompyD, mesh )
3894
3895
3896
3897     ## Scales the object
3898     #  @param theObject - the object to translate (mesh, submesh, or group)
3899     #  @param thePoint - base point for scale
3900     #  @param theScaleFact - list of 1-3 scale factors for axises
3901     #  @param Copy - allows copying the translated elements
3902     #  @param MakeGroups - forces the generation of new groups from existing
3903     #                      ones (if Copy)
3904     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True,
3905     #          empty list otherwise
3906     def Scale(self, theObject, thePoint, theScaleFact, Copy, MakeGroups=False):
3907         if ( isinstance( theObject, Mesh )):
3908             theObject = theObject.GetMesh()
3909         if ( isinstance( theObject, list )):
3910             theObject = self.GetIDSource(theObject, SMESH.ALL)
3911         if ( isinstance( theScaleFact, float )):
3912              theScaleFact = [theScaleFact]
3913         if ( isinstance( theScaleFact, int )):
3914              theScaleFact = [ float(theScaleFact)]
3915
3916         self.mesh.SetParameters(thePoint.parameters)
3917
3918         if Copy and MakeGroups:
3919             return self.editor.ScaleMakeGroups(theObject, thePoint, theScaleFact)
3920         self.editor.Scale(theObject, thePoint, theScaleFact, Copy)
3921         return []
3922
3923     ## Creates a new mesh from the translated object
3924     #  @param theObject - the object to translate (mesh, submesh, or group)
3925     #  @param thePoint - base point for scale
3926     #  @param theScaleFact - list of 1-3 scale factors for axises
3927     #  @param MakeGroups - forces the generation of new groups from existing ones
3928     #  @param NewMeshName - the name of the newly created mesh
3929     #  @return instance of Mesh class
3930     def ScaleMakeMesh(self, theObject, thePoint, theScaleFact, MakeGroups=False, NewMeshName=""):
3931         if (isinstance(theObject, Mesh)):
3932             theObject = theObject.GetMesh()
3933         if ( isinstance( theObject, list )):
3934             theObject = self.GetIDSource(theObject,SMESH.ALL)
3935         if ( isinstance( theScaleFact, float )):
3936              theScaleFact = [theScaleFact]
3937         if ( isinstance( theScaleFact, int )):
3938              theScaleFact = [ float(theScaleFact)]
3939
3940         self.mesh.SetParameters(thePoint.parameters)
3941         mesh = self.editor.ScaleMakeMesh(theObject, thePoint, theScaleFact,
3942                                          MakeGroups, NewMeshName)
3943         return Mesh( self.smeshpyD, self.geompyD, mesh )
3944
3945
3946
3947     ## Rotates the elements
3948     #  @param IDsOfElements list of elements ids
3949     #  @param Axis the axis of rotation (AxisStruct or geom line)
3950     #  @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees
3951     #  @param Copy allows copying the rotated elements
3952     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3953     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3954     #  @ingroup l2_modif_trsf
3955     def Rotate (self, IDsOfElements, Axis, AngleInRadians, Copy, MakeGroups=False):
3956         if IDsOfElements == []:
3957             IDsOfElements = self.GetElementsId()
3958         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3959             Axis = self.smeshpyD.GetAxisStruct(Axis)
3960         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
3961         Parameters = Axis.parameters + var_separator + Parameters
3962         self.mesh.SetParameters(Parameters)
3963         if Copy and MakeGroups:
3964             return self.editor.RotateMakeGroups(IDsOfElements, Axis, AngleInRadians)
3965         self.editor.Rotate(IDsOfElements, Axis, AngleInRadians, Copy)
3966         return []
3967
3968     ## Creates a new mesh of rotated elements
3969     #  @param IDsOfElements list of element ids
3970     #  @param Axis the axis of rotation (AxisStruct or geom line)
3971     #  @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees
3972     #  @param MakeGroups forces the generation of new groups from existing ones
3973     #  @param NewMeshName the name of the newly created mesh
3974     #  @return instance of Mesh class
3975     #  @ingroup l2_modif_trsf
3976     def RotateMakeMesh (self, IDsOfElements, Axis, AngleInRadians, MakeGroups=0, NewMeshName=""):
3977         if IDsOfElements == []:
3978             IDsOfElements = self.GetElementsId()
3979         if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)):
3980             Axis = self.smeshpyD.GetAxisStruct(Axis)
3981         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
3982         Parameters = Axis.parameters + var_separator + Parameters
3983         self.mesh.SetParameters(Parameters)
3984         mesh = self.editor.RotateMakeMesh(IDsOfElements, Axis, AngleInRadians,
3985                                           MakeGroups, NewMeshName)
3986         return Mesh( self.smeshpyD, self.geompyD, mesh )
3987
3988     ## Rotates the object
3989     #  @param theObject the object to rotate( mesh, submesh, or group)
3990     #  @param Axis the axis of rotation (AxisStruct or geom line)
3991     #  @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees
3992     #  @param Copy allows copying the rotated elements
3993     #  @param MakeGroups forces the generation of new groups from existing ones (if Copy)
3994     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
3995     #  @ingroup l2_modif_trsf
3996     def RotateObject (self, theObject, Axis, AngleInRadians, Copy, MakeGroups=False):
3997         if (isinstance(theObject, Mesh)):
3998             theObject = theObject.GetMesh()
3999         if (isinstance(Axis, geomBuilder.GEOM._objref_GEOM_Object)):
4000             Axis = self.smeshpyD.GetAxisStruct(Axis)
4001         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
4002         Parameters = Axis.parameters + ":" + Parameters
4003         self.mesh.SetParameters(Parameters)
4004         if Copy and MakeGroups:
4005             return self.editor.RotateObjectMakeGroups(theObject, Axis, AngleInRadians)
4006         self.editor.RotateObject(theObject, Axis, AngleInRadians, Copy)
4007         return []
4008
4009     ## Creates a new mesh from the rotated object
4010     #  @param theObject the object to rotate (mesh, submesh, or group)
4011     #  @param Axis the axis of rotation (AxisStruct or geom line)
4012     #  @param AngleInRadians the angle of rotation (in radians)  or a name of variable which defines angle in degrees
4013     #  @param MakeGroups forces the generation of new groups from existing ones
4014     #  @param NewMeshName the name of the newly created mesh
4015     #  @return instance of Mesh class
4016     #  @ingroup l2_modif_trsf
4017     def RotateObjectMakeMesh(self, theObject, Axis, AngleInRadians, MakeGroups=0,NewMeshName=""):
4018         if (isinstance( theObject, Mesh )):
4019             theObject = theObject.GetMesh()
4020         if (isinstance(Axis, geomBuilder.GEOM._objref_GEOM_Object)):
4021             Axis = self.smeshpyD.GetAxisStruct(Axis)
4022         AngleInRadians,Parameters,hasVars = ParseAngles(AngleInRadians)
4023         Parameters = Axis.parameters + ":" + Parameters
4024         mesh = self.editor.RotateObjectMakeMesh(theObject, Axis, AngleInRadians,
4025                                                        MakeGroups, NewMeshName)
4026         self.mesh.SetParameters(Parameters)
4027         return Mesh( self.smeshpyD, self.geompyD, mesh )
4028
4029     ## Finds groups of ajacent nodes within Tolerance.
4030     #  @param Tolerance the value of tolerance
4031     #  @return the list of groups of nodes
4032     #  @ingroup l2_modif_trsf
4033     def FindCoincidentNodes (self, Tolerance):
4034         return self.editor.FindCoincidentNodes(Tolerance)
4035
4036     ## Finds groups of ajacent nodes within Tolerance.
4037     #  @param Tolerance the value of tolerance
4038     #  @param SubMeshOrGroup SubMesh or Group
4039     #  @param exceptNodes list of either SubMeshes, Groups or node IDs to exclude from search
4040     #  @return the list of groups of nodes
4041     #  @ingroup l2_modif_trsf
4042     def FindCoincidentNodesOnPart (self, SubMeshOrGroup, Tolerance, exceptNodes=[]):
4043         if (isinstance( SubMeshOrGroup, Mesh )):
4044             SubMeshOrGroup = SubMeshOrGroup.GetMesh()
4045         if not isinstance( exceptNodes, list):
4046             exceptNodes = [ exceptNodes ]
4047         if exceptNodes and isinstance( exceptNodes[0], int):
4048             exceptNodes = [ self.GetIDSource( exceptNodes, SMESH.NODE)]
4049         return self.editor.FindCoincidentNodesOnPartBut(SubMeshOrGroup, Tolerance,exceptNodes)
4050
4051     ## Merges nodes
4052     #  @param GroupsOfNodes the list of groups of nodes
4053     #  @ingroup l2_modif_trsf
4054     def MergeNodes (self, GroupsOfNodes):
4055         self.editor.MergeNodes(GroupsOfNodes)
4056
4057     ## Finds the elements built on the same nodes.
4058     #  @param MeshOrSubMeshOrGroup Mesh or SubMesh, or Group of elements for searching
4059     #  @return a list of groups of equal elements
4060     #  @ingroup l2_modif_trsf
4061     def FindEqualElements (self, MeshOrSubMeshOrGroup):
4062         if ( isinstance( MeshOrSubMeshOrGroup, Mesh )):
4063             MeshOrSubMeshOrGroup = MeshOrSubMeshOrGroup.GetMesh()
4064         return self.editor.FindEqualElements(MeshOrSubMeshOrGroup)
4065
4066     ## Merges elements in each given group.
4067     #  @param GroupsOfElementsID groups of elements for merging
4068     #  @ingroup l2_modif_trsf
4069     def MergeElements(self, GroupsOfElementsID):
4070         self.editor.MergeElements(GroupsOfElementsID)
4071
4072     ## Leaves one element and removes all other elements built on the same nodes.
4073     #  @ingroup l2_modif_trsf
4074     def MergeEqualElements(self):
4075         self.editor.MergeEqualElements()
4076
4077     ## Sews free borders
4078     #  @return SMESH::Sew_Error
4079     #  @ingroup l2_modif_trsf
4080     def SewFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1,
4081                         FirstNodeID2, SecondNodeID2, LastNodeID2,
4082                         CreatePolygons, CreatePolyedrs):
4083         return self.editor.SewFreeBorders(FirstNodeID1, SecondNodeID1, LastNodeID1,
4084                                           FirstNodeID2, SecondNodeID2, LastNodeID2,
4085                                           CreatePolygons, CreatePolyedrs)
4086
4087     ## Sews conform free borders
4088     #  @return SMESH::Sew_Error
4089     #  @ingroup l2_modif_trsf
4090     def SewConformFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1,
4091                                FirstNodeID2, SecondNodeID2):
4092         return self.editor.SewConformFreeBorders(FirstNodeID1, SecondNodeID1, LastNodeID1,
4093                                                  FirstNodeID2, SecondNodeID2)
4094
4095     ## Sews border to side
4096     #  @return SMESH::Sew_Error
4097     #  @ingroup l2_modif_trsf
4098     def SewBorderToSide (self, FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder,
4099                          FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs):
4100         return self.editor.SewBorderToSide(FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder,
4101                                            FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs)
4102
4103     ## Sews two sides of a mesh. The nodes belonging to Side1 are
4104     #  merged with the nodes of elements of Side2.
4105     #  The number of elements in theSide1 and in theSide2 must be
4106     #  equal and they should have similar nodal connectivity.
4107     #  The nodes to merge should belong to side borders and
4108     #  the first node should be linked to the second.
4109     #  @return SMESH::Sew_Error
4110     #  @ingroup l2_modif_trsf
4111     def SewSideElements (self, IDsOfSide1Elements, IDsOfSide2Elements,
4112                          NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge,
4113                          NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge):
4114         return self.editor.SewSideElements(IDsOfSide1Elements, IDsOfSide2Elements,
4115                                            NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge,
4116                                            NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge)
4117
4118     ## Sets new nodes for the given element.
4119     #  @param ide the element id
4120     #  @param newIDs nodes ids
4121     #  @return If the number of nodes does not correspond to the type of element - returns false
4122     #  @ingroup l2_modif_edit
4123     def ChangeElemNodes(self, ide, newIDs):
4124         return self.editor.ChangeElemNodes(ide, newIDs)
4125
4126     ## If during the last operation of MeshEditor some nodes were
4127     #  created, this method returns the list of their IDs, \n
4128     #  if new nodes were not created - returns empty list
4129     #  @return the list of integer values (can be empty)
4130     #  @ingroup l1_auxiliary
4131     def GetLastCreatedNodes(self):
4132         return self.editor.GetLastCreatedNodes()
4133
4134     ## If during the last operation of MeshEditor some elements were
4135     #  created this method returns the list of their IDs, \n
4136     #  if new elements were not created - returns empty list
4137     #  @return the list of integer values (can be empty)
4138     #  @ingroup l1_auxiliary
4139     def GetLastCreatedElems(self):
4140         return self.editor.GetLastCreatedElems()
4141
4142     ## Clears sequences of nodes and elements created by mesh edition oparations
4143     #  @ingroup l1_auxiliary
4144     def ClearLastCreated(self):
4145         self.editor.ClearLastCreated()
4146
4147     ## Creates Duplicates given elements, i.e. creates new elements based on the
4148     #  same nodes as the given ones.
4149     #  @param theElements - container of elements to duplicate. It can be a Mesh,
4150     #         sub-mesh, group, filter or a list of element IDs.
4151     # @param theGroupName - a name of group to contain the generated elements.
4152     #                    If a group with such a name already exists, the new elements
4153     #                    are added to the existng group, else a new group is created.
4154     #                    If \a theGroupName is empty, new elements are not added
4155     #                    in any group.
4156     # @return a group where the new elements are added. None if theGroupName == "".
4157     #  @ingroup l2_modif_edit
4158     def DoubleElements(self, theElements, theGroupName=""):
4159         if isinstance( theElements, Mesh ):
4160             theElements = theElements.mesh
4161         elif isinstance( theElements, list ):
4162             theElements = self.GetIDSource( theElements, SMESH.ALL )
4163         return self.editor.DoubleElements(theElements, theGroupName)
4164
4165     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4166     #  @param theNodes identifiers of nodes to be doubled
4167     #  @param theModifiedElems identifiers of elements to be updated by the new (doubled)
4168     #         nodes. If list of element identifiers is empty then nodes are doubled but
4169     #         they not assigned to elements
4170     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4171     #  @ingroup l2_modif_edit
4172     def DoubleNodes(self, theNodes, theModifiedElems):
4173         return self.editor.DoubleNodes(theNodes, theModifiedElems)
4174
4175     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4176     #  This method provided for convenience works as DoubleNodes() described above.
4177     #  @param theNodeId identifiers of node to be doubled
4178     #  @param theModifiedElems identifiers of elements to be updated
4179     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4180     #  @ingroup l2_modif_edit
4181     def DoubleNode(self, theNodeId, theModifiedElems):
4182         return self.editor.DoubleNode(theNodeId, theModifiedElems)
4183
4184     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4185     #  This method provided for convenience works as DoubleNodes() described above.
4186     #  @param theNodes group of nodes to be doubled
4187     #  @param theModifiedElems group of elements to be updated.
4188     #  @param theMakeGroup forces the generation of a group containing new nodes.
4189     #  @return TRUE or a created group if operation has been completed successfully,
4190     #          FALSE or None otherwise
4191     #  @ingroup l2_modif_edit
4192     def DoubleNodeGroup(self, theNodes, theModifiedElems, theMakeGroup=False):
4193         if theMakeGroup:
4194             return self.editor.DoubleNodeGroupNew(theNodes, theModifiedElems)
4195         return self.editor.DoubleNodeGroup(theNodes, theModifiedElems)
4196
4197     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4198     #  This method provided for convenience works as DoubleNodes() described above.
4199     #  @param theNodes list of groups of nodes to be doubled
4200     #  @param theModifiedElems list of groups of elements to be updated.
4201     #  @param theMakeGroup forces the generation of a group containing new nodes.
4202     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4203     #  @ingroup l2_modif_edit
4204     def DoubleNodeGroups(self, theNodes, theModifiedElems, theMakeGroup=False):
4205         if theMakeGroup:
4206             return self.editor.DoubleNodeGroupsNew(theNodes, theModifiedElems)
4207         return self.editor.DoubleNodeGroups(theNodes, theModifiedElems)
4208
4209     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4210     #  @param theElems - the list of elements (edges or faces) to be replicated
4211     #         The nodes for duplication could be found from these elements
4212     #  @param theNodesNot - list of nodes to NOT replicate
4213     #  @param theAffectedElems - the list of elements (cells and edges) to which the
4214     #         replicated nodes should be associated to.
4215     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4216     #  @ingroup l2_modif_edit
4217     def DoubleNodeElem(self, theElems, theNodesNot, theAffectedElems):
4218         return self.editor.DoubleNodeElem(theElems, theNodesNot, theAffectedElems)
4219
4220     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4221     #  @param theElems - the list of elements (edges or faces) to be replicated
4222     #         The nodes for duplication could be found from these elements
4223     #  @param theNodesNot - list of nodes to NOT replicate
4224     #  @param theShape - shape to detect affected elements (element which geometric center
4225     #         located on or inside shape).
4226     #         The replicated nodes should be associated to affected elements.
4227     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4228     #  @ingroup l2_modif_edit
4229     def DoubleNodeElemInRegion(self, theElems, theNodesNot, theShape):
4230         return self.editor.DoubleNodeElemInRegion(theElems, theNodesNot, theShape)
4231
4232     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4233     #  This method provided for convenience works as DoubleNodes() described above.
4234     #  @param theElems - group of of elements (edges or faces) to be replicated
4235     #  @param theNodesNot - group of nodes not to replicated
4236     #  @param theAffectedElems - group of elements to which the replicated nodes
4237     #         should be associated to.
4238     #  @param theMakeGroup forces the generation of a group containing new elements.
4239     #  @param theMakeNodeGroup forces the generation of a group containing new nodes.
4240     #  @return TRUE or created groups (one or two) if operation has been completed successfully,
4241     #          FALSE or None otherwise
4242     #  @ingroup l2_modif_edit
4243     def DoubleNodeElemGroup(self, theElems, theNodesNot, theAffectedElems,
4244                              theMakeGroup=False, theMakeNodeGroup=False):
4245         if theMakeGroup or theMakeNodeGroup:
4246             twoGroups = self.editor.DoubleNodeElemGroup2New(theElems, theNodesNot,
4247                                                             theAffectedElems,
4248                                                             theMakeGroup, theMakeNodeGroup)
4249             if theMakeGroup and theMakeNodeGroup:
4250                 return twoGroups
4251             else:
4252                 return twoGroups[ int(theMakeNodeGroup) ]
4253         return self.editor.DoubleNodeElemGroup(theElems, theNodesNot, theAffectedElems)
4254
4255     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4256     #  This method provided for convenience works as DoubleNodes() described above.
4257     #  @param theElems - group of of elements (edges or faces) to be replicated
4258     #  @param theNodesNot - group of nodes not to replicated
4259     #  @param theShape - shape to detect affected elements (element which geometric center
4260     #         located on or inside shape).
4261     #         The replicated nodes should be associated to affected elements.
4262     #  @ingroup l2_modif_edit
4263     def DoubleNodeElemGroupInRegion(self, theElems, theNodesNot, theShape):
4264         return self.editor.DoubleNodeElemGroupInRegion(theElems, theNodesNot, theShape)
4265
4266     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4267     #  This method provided for convenience works as DoubleNodes() described above.
4268     #  @param theElems - list of groups of elements (edges or faces) to be replicated
4269     #  @param theNodesNot - list of groups of nodes not to replicated
4270     #  @param theAffectedElems - group of elements to which the replicated nodes
4271     #         should be associated to.
4272     #  @param theMakeGroup forces the generation of a group containing new elements.
4273     #  @param theMakeNodeGroup forces the generation of a group containing new nodes.
4274     #  @return TRUE or created groups (one or two) if operation has been completed successfully,
4275     #          FALSE or None otherwise
4276     #  @ingroup l2_modif_edit
4277     def DoubleNodeElemGroups(self, theElems, theNodesNot, theAffectedElems,
4278                              theMakeGroup=False, theMakeNodeGroup=False):
4279         if theMakeGroup or theMakeNodeGroup:
4280             twoGroups = self.editor.DoubleNodeElemGroups2New(theElems, theNodesNot,
4281                                                              theAffectedElems,
4282                                                              theMakeGroup, theMakeNodeGroup)
4283             if theMakeGroup and theMakeNodeGroup:
4284                 return twoGroups
4285             else:
4286                 return twoGroups[ int(theMakeNodeGroup) ]
4287         return self.editor.DoubleNodeElemGroups(theElems, theNodesNot, theAffectedElems)
4288
4289     ## Creates a hole in a mesh by doubling the nodes of some particular elements
4290     #  This method provided for convenience works as DoubleNodes() described above.
4291     #  @param theElems - list of groups of elements (edges or faces) to be replicated
4292     #  @param theNodesNot - list of groups of nodes not to replicated
4293     #  @param theShape - shape to detect affected elements (element which geometric center
4294     #         located on or inside shape).
4295     #         The replicated nodes should be associated to affected elements.
4296     #  @return TRUE if operation has been completed successfully, FALSE otherwise
4297     #  @ingroup l2_modif_edit
4298     def DoubleNodeElemGroupsInRegion(self, theElems, theNodesNot, theShape):
4299         return self.editor.DoubleNodeElemGroupsInRegion(theElems, theNodesNot, theShape)
4300
4301     ## Identify the elements that will be affected by node duplication (actual duplication is not performed.
4302     #  This method is the first step of DoubleNodeElemGroupsInRegion.
4303     #  @param theElems - list of groups of elements (edges or faces) to be replicated
4304     #  @param theNodesNot - list of groups of nodes not to replicated
4305     #  @param theShape - shape to detect affected elements (element which geometric center
4306     #         located on or inside shape).
4307     #         The replicated nodes should be associated to affected elements.
4308     #  @return groups of affected elements
4309     #  @ingroup l2_modif_edit
4310     def AffectedElemGroupsInRegion(self, theElems, theNodesNot, theShape):
4311         return self.editor.AffectedElemGroupsInRegion(theElems, theNodesNot, theShape)
4312
4313     ## Double nodes on shared faces between groups of volumes and create flat elements on demand.
4314     # The list of groups must describe a partition of the mesh volumes.
4315     # The nodes of the internal faces at the boundaries of the groups are doubled.
4316     # In option, the internal faces are replaced by flat elements.
4317     # Triangles are transformed in prisms, and quadrangles in hexahedrons.
4318     # @param theDomains - list of groups of volumes
4319     # @param createJointElems - if TRUE, create the elements
4320     # @return TRUE if operation has been completed successfully, FALSE otherwise
4321     def DoubleNodesOnGroupBoundaries(self, theDomains, createJointElems ):
4322        return self.editor.DoubleNodesOnGroupBoundaries( theDomains, createJointElems )
4323
4324     ## Double nodes on some external faces and create flat elements.
4325     # Flat elements are mainly used by some types of mechanic calculations.
4326     #
4327     # Each group of the list must be constituted of faces.
4328     # Triangles are transformed in prisms, and quadrangles in hexahedrons.
4329     # @param theGroupsOfFaces - list of groups of faces
4330     # @return TRUE if operation has been completed successfully, FALSE otherwise
4331     def CreateFlatElementsOnFacesGroups(self, theGroupsOfFaces ):
4332         return self.editor.CreateFlatElementsOnFacesGroups( theGroupsOfFaces )
4333
4334     ## identify all the elements around a geom shape, get the faces delimiting the hole
4335     #
4336     def CreateHoleSkin(self, radius, theShape, groupName, theNodesCoords):
4337         return self.editor.CreateHoleSkin( radius, theShape, groupName, theNodesCoords )
4338
4339     def _getFunctor(self, funcType ):
4340         fn = self.functors[ funcType._v ]
4341         if not fn:
4342             fn = self.smeshpyD.GetFunctor(funcType)
4343             fn.SetMesh(self.mesh)
4344             self.functors[ funcType._v ] = fn
4345         return fn
4346
4347     def _valueFromFunctor(self, funcType, elemId):
4348         fn = self._getFunctor( funcType )
4349         if fn.GetElementType() == self.GetElementType(elemId, True):
4350             val = fn.GetValue(elemId)
4351         else:
4352             val = 0
4353         return val
4354
4355     ## Get length of 1D element.
4356     #  @param elemId mesh element ID
4357     #  @return element's length value
4358     #  @ingroup l1_measurements
4359     def GetLength(self, elemId):
4360         return self._valueFromFunctor(SMESH.FT_Length, elemId)
4361
4362     ## Get area of 2D element.
4363     #  @param elemId mesh element ID
4364     #  @return element's area value
4365     #  @ingroup l1_measurements
4366     def GetArea(self, elemId):
4367         return self._valueFromFunctor(SMESH.FT_Area, elemId)
4368
4369     ## Get volume of 3D element.
4370     #  @param elemId mesh element ID
4371     #  @return element's volume value
4372     #  @ingroup l1_measurements
4373     def GetVolume(self, elemId):
4374         return self._valueFromFunctor(SMESH.FT_Volume3D, elemId)
4375
4376     ## Get maximum element length.
4377     #  @param elemId mesh element ID
4378     #  @return element's maximum length value
4379     #  @ingroup l1_measurements
4380     def GetMaxElementLength(self, elemId):
4381         if self.GetElementType(elemId, True) == SMESH.VOLUME:
4382             ftype = SMESH.FT_MaxElementLength3D
4383         else:
4384             ftype = SMESH.FT_MaxElementLength2D
4385         return self._valueFromFunctor(ftype, elemId)
4386
4387     ## Get aspect ratio of 2D or 3D element.
4388     #  @param elemId mesh element ID
4389     #  @return element's aspect ratio value
4390     #  @ingroup l1_measurements
4391     def GetAspectRatio(self, elemId):
4392         if self.GetElementType(elemId, True) == SMESH.VOLUME:
4393             ftype = SMESH.FT_AspectRatio3D
4394         else:
4395             ftype = SMESH.FT_AspectRatio
4396         return self._valueFromFunctor(ftype, elemId)
4397
4398     ## Get warping angle of 2D element.
4399     #  @param elemId mesh element ID
4400     #  @return element's warping angle value
4401     #  @ingroup l1_measurements
4402     def GetWarping(self, elemId):
4403         return self._valueFromFunctor(SMESH.FT_Warping, elemId)
4404
4405     ## Get minimum angle of 2D element.
4406     #  @param elemId mesh element ID
4407     #  @return element's minimum angle value
4408     #  @ingroup l1_measurements
4409     def GetMinimumAngle(self, elemId):
4410         return self._valueFromFunctor(SMESH.FT_MinimumAngle, elemId)
4411
4412     ## Get taper of 2D element.
4413     #  @param elemId mesh element ID
4414     #  @return element's taper value
4415     #  @ingroup l1_measurements
4416     def GetTaper(self, elemId):
4417         return self._valueFromFunctor(SMESH.FT_Taper, elemId)
4418
4419     ## Get skew of 2D element.
4420     #  @param elemId mesh element ID
4421     #  @return element's skew value
4422     #  @ingroup l1_measurements
4423     def GetSkew(self, elemId):
4424         return self._valueFromFunctor(SMESH.FT_Skew, elemId)
4425
4426     pass # end of Mesh class
4427
4428 ## Helper class for wrapping of SMESH.SMESH_Pattern CORBA class
4429 #
4430 class Pattern(SMESH._objref_SMESH_Pattern):
4431
4432     def ApplyToMeshFaces(self, theMesh, theFacesIDs, theNodeIndexOnKeyPoint1, theReverse):
4433         decrFun = lambda i: i-1
4434         theNodeIndexOnKeyPoint1,Parameters,hasVars = ParseParameters(theNodeIndexOnKeyPoint1, decrFun)
4435         theMesh.SetParameters(Parameters)
4436         return SMESH._objref_SMESH_Pattern.ApplyToMeshFaces( self, theMesh, theFacesIDs, theNodeIndexOnKeyPoint1, theReverse )
4437
4438     def ApplyToHexahedrons(self, theMesh, theVolumesIDs, theNode000Index, theNode001Index):
4439         decrFun = lambda i: i-1
4440         theNode000Index,theNode001Index,Parameters,hasVars = ParseParameters(theNode000Index,theNode001Index, decrFun)
4441         theMesh.SetParameters(Parameters)
4442         return SMESH._objref_SMESH_Pattern.ApplyToHexahedrons( self, theMesh, theVolumesIDs, theNode000Index, theNode001Index )
4443
4444 # Registering the new proxy for Pattern
4445 omniORB.registerObjref(SMESH._objref_SMESH_Pattern._NP_RepositoryId, Pattern)
4446
4447 ## Private class used to bind methods creating algorithms to the class Mesh
4448 #
4449 class algoCreator:
4450     def __init__(self):
4451         self.mesh = None
4452         self.defaultAlgoType = ""
4453         self.algoTypeToClass = {}
4454
4455     # Stores a python class of algorithm
4456     def add(self, algoClass):
4457         if type( algoClass ).__name__ == 'classobj' and \
4458            hasattr( algoClass, "algoType"):
4459             self.algoTypeToClass[ algoClass.algoType ] = algoClass
4460             if not self.defaultAlgoType and \
4461                hasattr( algoClass, "isDefault") and algoClass.isDefault:
4462                 self.defaultAlgoType = algoClass.algoType
4463             #print "Add",algoClass.algoType, "dflt",self.defaultAlgoType
4464
4465     # creates a copy of self and assign mesh to the copy
4466     def copy(self, mesh):
4467         other = algoCreator()
4468         other.defaultAlgoType = self.defaultAlgoType
4469         other.algoTypeToClass  = self.algoTypeToClass
4470         other.mesh = mesh
4471         return other
4472
4473     # creates an instance of algorithm
4474     def __call__(self,algo="",geom=0,*args):
4475         algoType = self.defaultAlgoType
4476         for arg in args + (algo,geom):
4477             if isinstance( arg, geomBuilder.GEOM._objref_GEOM_Object ):
4478                 geom = arg
4479             if isinstance( arg, str ) and arg:
4480                 algoType = arg
4481         if not algoType and self.algoTypeToClass:
4482             algoType = self.algoTypeToClass.keys()[0]
4483         if self.algoTypeToClass.has_key( algoType ):
4484             #print "Create algo",algoType
4485             return self.algoTypeToClass[ algoType ]( self.mesh, geom )
4486         raise RuntimeError, "No class found for algo type %s" % algoType
4487         return None
4488
4489 # Private class used to substitute and store variable parameters of hypotheses.
4490 #
4491 class hypMethodWrapper:
4492     def __init__(self, hyp, method):
4493         self.hyp    = hyp
4494         self.method = method
4495         #print "REBIND:", method.__name__
4496         return
4497
4498     # call a method of hypothesis with calling SetVarParameter() before
4499     def __call__(self,*args):
4500         if not args:
4501             return self.method( self.hyp, *args ) # hypothesis method with no args
4502
4503         #print "MethWrapper.__call__",self.method.__name__, args
4504         try:
4505             parsed = ParseParameters(*args)     # replace variables with their values
4506             self.hyp.SetVarParameter( parsed[-2], self.method.__name__ )
4507             result = self.method( self.hyp, *parsed[:-2] ) # call hypothesis method
4508         except omniORB.CORBA.BAD_PARAM: # raised by hypothesis method call
4509             # maybe there is a replaced string arg which is not variable
4510             result = self.method( self.hyp, *args )
4511         except ValueError, detail: # raised by ParseParameters()
4512             try:
4513                 result = self.method( self.hyp, *args )
4514             except omniORB.CORBA.BAD_PARAM:
4515                 raise ValueError, detail # wrong variable name
4516
4517         return result
4518
4519 for pluginName in os.environ[ "SMESH_MeshersList" ].split( ":" ):
4520     #
4521     #print "pluginName: ", pluginName
4522     pluginBuilderName = pluginName + "Builder"
4523     try:
4524         exec( "from salome.%s.%s import *" % (pluginName, pluginBuilderName))
4525     except Exception, e:
4526         print "Exception while loading %s: %s" % ( pluginBuilderName, e )
4527         continue
4528     exec( "from salome.%s import %s" % (pluginName, pluginBuilderName))
4529     plugin = eval( pluginBuilderName )
4530     #print "  plugin:" , str(plugin)
4531
4532     # add methods creating algorithms to Mesh
4533     for k in dir( plugin ):
4534         if k[0] == '_': continue
4535         algo = getattr( plugin, k )
4536         #print "             algo:", str(algo)
4537         if type( algo ).__name__ == 'classobj' and hasattr( algo, "meshMethod" ):
4538             #print "                     meshMethod:" , str(algo.meshMethod)
4539             if not hasattr( Mesh, algo.meshMethod ):
4540                 setattr( Mesh, algo.meshMethod, algoCreator() )
4541                 pass
4542             getattr( Mesh, algo.meshMethod ).add( algo )
4543             pass
4544         pass
4545     pass
4546 del pluginName