idl/BLSURFPlugin_Algorithm.idl

   1 // Copyright (C) 2007-2019  CEA/DEN, EDF R&D
   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, or (at your option) any later version.
   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
  20 // ---
  21 // File    : BLSURFPlugin_Algorithm.idl
  22 // Authors : Francis KLOSS (OCC) & Patrick LAUG (INRIA) & Lioka RAZAFINDRAZAKA (CEA)
  23 //           Size maps developement: Nicolas GEIMER (OCC) & Gilles DAVID (EURIWARE)
  24 // ---
  25 //
  26 #ifndef _SMESH_BLSURFALGORITHM_IDL_
  27 #define _SMESH_BLSURFALGORITHM_IDL_
  28
  29 #include "SMESH_Hypothesis.idl"
  30 #include "GEOM_Gen.idl"
  31 #include "SALOME_Exception.idl"
  32
  33 /*!
  34  * BLSURFPlugin: interfaces to BLSURF related hypotheses and algorithms
  35  */
  36 module BLSURFPlugin
  37 {
  38   typedef sequence<string> string_array;
  39
  40   // Enforced vertex name
  41   typedef string TEnfName;
  42   // Entry
  43   typedef string TEntry;
  44   typedef sequence<TEntry> TEntryList;
  45   // Group name
  46   typedef string TEnfGroupName;
  47
  48   // Coordinates of enforced vertex
  49   typedef sequence<double,3> TEnfVertexCoords;
  50   // List of coords
  51   typedef sequence<TEnfVertexCoords> TEnfVertexCoordsList;
  52
  53   // Enforced vertex
  54   struct TEnfVertex {
  55     TEnfName name;
  56     TEntry geomEntry;
  57     TEnfVertexCoords coords;
  58     TEnfGroupName grpName;
  59     TEntryList faceEntries;
  60   };
  61   // List of enforced vertices
  62   typedef sequence<TEnfVertex> TEnfVertexList;
  63
  64   // Map Face Entry / List of enforced vertices
  65   struct TFaceEntryEnfVertexListMapElement {
  66     TEntry faceEntry;
  67     TEnfVertexList enfVertexList;
  68   };
  69   typedef sequence<TFaceEntryEnfVertexListMapElement> TFaceEntryEnfVertexListMap;
  70
  71   // Map Face Entry / List of coords
  72   struct TFaceEntryCoordsListMapElement {
  73     TEntry faceEntry;
  74     TEnfVertexCoordsList coordsList;
  75   };
  76   typedef sequence<TFaceEntryCoordsListMapElement> TFaceEntryCoordsListMap;
  77
  78   // Map Face Entry / List of enf vertex entries
  79   struct TFaceEntryEnfVertexEntryListMapElement {
  80     TEntry faceEntry;
  81     TEntryList enfVertexEntryList;
  82   };
  83   typedef sequence<TFaceEntryEnfVertexEntryListMapElement> TFaceEntryEnfVertexEntryListMap;
  84
  85   // Map Coords / Enforced vertex
  86   struct TCoordsEnfVertexElement {
  87     TEnfVertexCoords coords;
  88     TEnfVertex enfVertex;
  89   };
  90   typedef sequence<TCoordsEnfVertexElement> TCoordsEnfVertexMap;
  91
  92   // Map Enf Vertex Entry / Enforced vertex
  93   struct TEnfVertexEntryEnfVertexElement {
  94     TEntry enfVertexEntry;
  95     TEnfVertex enfVertex;
  96   };
  97   typedef sequence<TEnfVertexEntryEnfVertexElement> TEnfVertexEntryEnfVertexMap;
  98
  99   // List of Face Entry with internal enforced vertices activated
 100   typedef sequence<TEntry> TFaceEntryInternalVerticesList;
 101
 102   // Attractors
 103   struct TAttractorParams {
 104     string faceEntry;
 105     string attEntry;
 106     double startSize;
 107     double endSize;
 108     double infDist;
 109     double constDist;
 110   };
 111   typedef sequence<TAttractorParams> TAttParamsMap;
 112
 113   // Periodicity
 114   struct TPreCadPeriodicity {
 115     TEntry shape1Entry;
 116     TEntry shape2Entry;
 117     TEntryList theSourceVerticesEntries;
 118     TEntryList theTargetVerticesEntries;
 119   };
 120
 121   typedef sequence<TPreCadPeriodicity> TPeriodicityList;
 122
 123   // Hyper-patches
 124   typedef sequence<long> THyperPatch;
 125   typedef sequence<THyperPatch> THyperPatchList;
 126
 127   /*!
 128    * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
 129    */
 130   interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
 131   {
 132   };
 133
 134   /*!
 135    * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
 136    */
 137   interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
 138   {
 139
 140     /*!
 141      *Set a way to define size of mesh elements to generate
 142      * 0 - size is defined automatically
 143      * 1 - size is set by SetPhySize() method
 144      * 2 - size is set by SetPhySize() method. A sizemap is defined.
 145      */
 146     void SetPhysicalMesh(in long isCustom);
 147     long GetPhysicalMesh();
 148
 149     /*!
 150      *Set a way to define maximum angular deflection of mesh from CAD model
 151      * 0 - deflection is defined automatically
 152      * 1 - deflection is set by SetAngleMesh() method
 153      * 2 - deflection is set by SetAngleMesh() method. A sizemap is defined (TODO).
 154      */
 155     void SetGeometricMesh(in long isCustom);
 156     long GetGeometricMesh();
 157
 158     /*!
 159      *Set size of mesh elements to generate
 160      */
 161     void SetPhySize(in double size);
 162     void SetPhySizeRel(in double size);
 163     double GetPhySize();
 164     boolean IsPhySizeRel();
 165
 166     /*!
 167      *Set lower boundary of mesh element size
 168      */
 169     void SetMinSize(in double theMinSize);
 170     void SetMinSizeRel(in double theMinSize);
 171     double GetMinSize();
 172     boolean IsMinSizeRel();
 173
 174     /*!
 175      *Set upper boundary of mesh element size
 176      */
 177     void SetMaxSize(in double theMaxSize);
 178     void SetMaxSizeRel(in double theMaxSize);
 179     double GetMaxSize();
 180     boolean IsMaxSizeRel();
 181
 182     /*!
 183      *Set maximal allowed ratio between the lengths of two adjacent edges
 184      */
 185     void SetUseGradation(in boolean toUse);
 186     boolean GetUseGradation();
 187     void SetGradation(in double ratio);
 188     double GetGradation();
 189
 190     /*!
 191      *Set maximal allowed ratio between the lengths of two adjacent edges in 3D mesh
 192      */
 193     void SetUseVolumeGradation(in boolean toUse);
 194     boolean GetUseVolumeGradation();
 195     void SetVolumeGradation(in double ratio);
 196     double GetVolumeGradation();
 197
 198     /*!
 199      *Set to create quadrilateral elements or not
 200      */
 201     void SetQuadAllowed(in boolean allowed);
 202     void SetElementType(in long elementType);
 203     long GetElementType();
 204
 205     /*!
 206      *Set angular deflection (in degrees) of a mesh face and edge from CAD surface
 207      */
 208     void SetAngleMesh(in double angle);
 209     double GetAngleMesh();
 210
 211     /*!
 212      *Set the maximum desired distance between a triangle and its supporting CAD surface
 213      */
 214     void SetChordalError(in double distance);
 215     double GetChordalError();
 216
 217     /*!
 218      * Determines whether the generated mesh will be isotropic or anisotropic
 219      */
 220     void SetAnisotropic(in boolean anisotropic);
 221     boolean GetAnisotropic();
 222
 223     /*!
 224      * Defines the maximum anisotropic ratio of the metric governing the anisotropic process.
 225      * The default value of 0 means that the metric (and thus the generated elements)
 226      * can be arbitrarily stretched.
 227      */
 228     void SetAnisotropicRatio(in double ratio);
 229     double GetAnisotropicRatio();
 230
 231     /*!
 232      * This patch-independent correction option can be activated to remove the tiny
 233      * (nano) edges from the generated mesh, without taking into account the tags
 234      * (attributes) specifications.
 235      */
 236     void SetRemoveTinyEdges(in boolean remove);
 237     boolean GetRemoveTinyEdges();
 238
 239     /*!
 240      * Defines the minimal length under which an edge is considered to be a tiny one
 241      */
 242     void SetTinyEdgeLength(in double length);
 243     double GetTinyEdgeLength();
 244
 245     /*!
 246      *  This patch-independent correction option can be activated to remove the tiny
 247      * edges (defined by the option tiny edge optimisation length) from the generated
 248      * mesh when it improves the local mesh quality, without taking into account the
 249      * tags (attributes) specifications.
 250      */
 251     void SetOptimiseTinyEdges(in boolean toOptimise);
 252     boolean GetOptimiseTinyEdges();
 253
 254     /*!
 255      * Defines the minimal length under which an edge is considered to be a tiny one
 256      * to be optimised out by the optimise tiny edges option
 257      */
 258     void SetTinyEdgeOptimisationLength(in double length);
 259     double GetTinyEdgeOptimisationLength();
 260
 261     /*!
 262      * Activate correction of all surface intersections
 263      */
 264     void SetCorrectSurfaceIntersection(in boolean toCorrect);
 265     boolean GetCorrectSurfaceIntersection();
 266
 267     /*!
 268      * Defines the time the user is ready to spend in the intersection prevention process.
 269      * For example, maxCost = 3 means that MeshGems-CADSurf will not spend more time
 270      * in the intersection removal process than 3 times the time required to mesh
 271      * without processing the intersections.
 272      */
 273     void SetCorrectSurfaceIntersectionMaxCost(in double maxCost);
 274     double GetCorrectSurfaceIntersectionMaxCost();
 275
 276     /*!
 277      * This patch independent correction option can be activated to remove the bad
 278      * elements (often called slivers) from the generated mesh, without taking into account
 279      * the tags (attributes) specification.
 280      */
 281     void SetBadElementRemoval(in boolean remove);
 282     boolean GetBadElementRemoval();
 283
 284     /*!
 285      * This parameter defines the aspect ratio triggering the "bad element"
 286      * classification for the force bad surface element removal option.
 287      */
 288     void SetBadElementAspectRatio(in double ratio);
 289     double GetBadElementAspectRatio();
 290
 291     /*!
 292      * If this option is activated, MeshGems-CADSurf will optimize the mesh in order to
 293      * get better shaped elements, during a process which respects the patch independent options.
 294      * This optimisation cannot be fully performed when correct_surface_intersections = 1.
 295      */
 296     void SetOptimizeMesh(in boolean optimize);
 297     boolean GetOptimizeMesh();
 298
 299     /*!
 300      * Determines the order of mesh elements to be generated (linear or quadratic)
 301      */
 302     void SetQuadraticMesh(in boolean quadratic);
 303     boolean GetQuadraticMesh();
 304
 305     /*!
 306      *Set topology usage way defining how mesh conformity is assured
 307      * value=0 - mesh conformity is assured by conformity of a shape
 308      * value=1,2 - mesh conformity is assured by pre-processing a CAD model (OBSOLETE)
 309      * value=3 - mesh conformity is assured by pre-processing a CAD model with Pre-CAD
 310      */
 311     void SetTopology(in long way);
 312     long GetTopology();
 313
 314
 315     /*!
 316      *  Activate/deactivate surface proximity computation
 317      */
 318     void SetSurfaceProximity( in boolean toUse );
 319     boolean GetSurfaceProximity();
 320
 321     /*!
 322      * Set number of surface element layers to be generated due to surface proximity
 323      */
 324     void SetNbSurfaceProximityLayers( in short nbLayers );
 325     short GetNbSurfaceProximityLayers();
 326
 327     /*!
 328      * Set coefficient by which size of element refined due to surface proximity is increased
 329      */
 330     void SetSurfaceProximityRatio( in double ratio );
 331     double GetSurfaceProximityRatio();
 332
 333     /*!
 334      *  Activate/deactivate volume proximity computation
 335      */
 336     void SetVolumeProximity( in boolean toUse );
 337     boolean GetVolumeProximity();
 338
 339     /*!
 340      * Set number of surface element layers to be generated due to volume proximity
 341      */
 342     void SetNbVolumeProximityLayers( in short nbLayers );
 343     short GetNbVolumeProximityLayers();
 344
 345     /*!
 346      * Set coefficient by which size of element refined due to volume proximity is increased
 347      */
 348     void SetVolumeProximityRatio( in double ratio );
 349     double GetVolumeProximityRatio();
 350
 351     /*!
 352      *Set verbosity level in the range 0 to 100.
 353      */
 354     void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
 355     short GetVerbosity();
 356
 357     /*!
 358      * Set enforce_cad_edge_sizes parameter
 359      *
 360      * Relaxes the given sizemap constraint around CAD edges to allow a better
 361      * element quality and a better geometric approximation. It is only useful in
 362      * combination with the gradation option.
 363      */
 364     void SetEnforceCadEdgesSize( in boolean toEnforce );
 365     boolean GetEnforceCadEdgesSize();
 366
 367     /*!
 368      * Set jacobian_rectification_respect_geometry parameter
 369      *
 370      * While making the mesh quadratic, allows to lose the CAD-mesh associativity in order
 371      * to correct elements with nagative Jacobian
 372      */
 373     void SetJacobianRectificationRespectGeometry( in boolean allowRectification );
 374     boolean GetJacobianRectificationRespectGeometry();
 375
 376     /*!
 377      * Set rectify_jacobian parameter
 378      *
 379      * While making the mesh quadratic, allow to fix nagative Jacobian surface elements
 380      */
 381     void SetJacobianRectification( in boolean allowRectification );
 382     boolean GetJacobianRectification();
 383
 384     /*!
 385      * Set use_deprecated_patch_mesher parameter (compatibility with older versions of Meshgems)
 386      *
 387      * the use_deprecated_patch_mesher parameter allows to keep the same behaviour than
 388      * in salome < 8.3 (meshgems 2.1.11 instead of meshgems >= 2.4.5)
 389      */
 390     void SetUseDeprecatedPatchMesher( in boolean useDeprecatedPatchMesher );
 391     boolean GetUseDeprecatedPatchMesher();
 392
 393     /*!
 394      * Set max_number_of_points_per_patch parameter
 395      *
 396      * This parameter controls the maximum amount of points MeshGems-CADSurf is allowed
 397      * to generate on a single CAD patch. For an automatic gestion of the memory, one
 398      * can set this parameter to 0
 399      */
 400     void SetMaxNumberOfPointsPerPatch( in long nb ) raises (SALOME::SALOME_Exception);
 401     long GetMaxNumberOfPointsPerPatch();
 402
 403
 404     /*!
 405      * Set max_number_of_threads parameter
 406      *
 407      * Set the maximum of threads to use for multithreading mesh computation.
 408      */
 409     void SetMaxNumberOfThreads( in long nb ) raises (SALOME::SALOME_Exception);
 410     long GetMaxNumberOfThreads();
 411
 412     /*!
 413      * Set respect_geometry parameter
 414      *
 415      *  This patch independent option can be deactivated to allow MeshGems-CADSurf
 416      * to lower the geometry accuracy in its patch independent process.
 417      */
 418     void SetRespectGeometry( in boolean toRespect );
 419     boolean GetRespectGeometry();
 420
 421     /*!
 422      * Set tiny_edges_avoid_surface_intersections parameter
 423      *
 424      * This option defines the priority between the tiny feature
 425      * suppression and the surface intersection prevention.
 426      */
 427     void SetTinyEdgesAvoidSurfaceIntersections( in boolean toAvoidIntersection );
 428     boolean GetTinyEdgesAvoidSurfaceIntersections();
 429
 430     /*!
 431      * Set closed_geometry parameter parameter
 432      *
 433      *  Describes whether the geometry is expected to be closed or not.
 434      * When activated, this option helps MeshGems-PreCAD to treat the dirtiest geometries.
 435      */
 436     void SetClosedGeometry( in boolean isClosed );
 437     boolean GetClosedGeometry();
 438
 439     /*!
 440      * Set debug parameter
 441      *
 442      * Make MeshGems-CADSurf will be very verbose and will output some intermediate
 443      * files in the working directory. This option is mainly meant for Distene support issues.
 444      */
 445     void SetDebug( in boolean isDebug );
 446     boolean GetDebug();
 447
 448     /*!
 449      * Set periodic_tolerance parameter
 450      *
 451      *  This parameter defines the maximum size difference between two periodic edges
 452      * and also the maximum distance error between two periodic entities.
 453      */
 454     void SetPeriodicTolerance( in double tol ) raises (SALOME::SALOME_Exception);
 455     double GetPeriodicTolerance() raises (SALOME::SALOME_Exception);
 456
 457     /*!
 458      * Set required_entities parameter
 459      *
 460      * The required entities control the correction operations.
 461      * Accepted values for this parameter are :
 462      * - "respect" : MeshGems-CADSurf is not allowed to alter any required entity,
 463      *             even for correction purposes,
 464      * - "ignore" : MeshGems-CADSurf will ignore the required entities in its processing,
 465      * - "clear" : MeshGems-CADSurf will clear any required status for the entities.
 466      *           There will not be any entity marked as required in the generated mesh.
 467      */
 468     void SetRequiredEntities( in string howToTreat ) raises (SALOME::SALOME_Exception);
 469     string GetRequiredEntities();
 470
 471     /*!
 472      * Set sewing_tolerance parameter
 473      *
 474      * This parameter is the tolerance of the assembly.
 475      */
 476     void SetSewingTolerance( in double tol ) raises (SALOME::SALOME_Exception);
 477     double GetSewingTolerance() raises (SALOME::SALOME_Exception);
 478
 479     /*!
 480      * Set tags parameter
 481      *
 482      *  The tag (attribute) system controls the optimisation process.
 483      *  Accepted values for this parameter are :
 484      * - "respect"  : the CAD tags will be preserved and unaltered by the optimisation operations,
 485      * - "ignore" : the CAD tags will be ignored by the optimisation operations
 486      *              but they will still be present in the output mesh,
 487      * - "clear" : MeshGems-CADSurf will clear any tag on any entity and optimise accordingly.
 488      *             There will not be any tag in the generated mesh.
 489      */
 490     void SetTags( in string howToTreat ) raises (SALOME::SALOME_Exception);
 491     string GetTags();
 492
 493     /*!
 494      * Set hyper-patches
 495      */
 496     void SetHyperPatches(in THyperPatchList hpl);
 497     THyperPatchList GetHyperPatches();
 498
 499     /*!
 500      * To merges edges.
 501      */
 502     void SetPreCADMergeEdges(in boolean toMergeEdges);
 503     boolean GetPreCADMergeEdges();
 504
 505     /*!
 506      * To remove duplicate CAD faces.
 507      */
 508     void SetPreCADRemoveDuplicateCADFaces(in boolean toRemoveDuplicateCADFaces);
 509     boolean GetPreCADRemoveDuplicateCADFaces();
 510
 511     /*!
 512      * To process 3D topology.
 513      */
 514     void SetPreCADProcess3DTopology(in boolean toProcess);
 515     boolean GetPreCADProcess3DTopology();
 516
 517
 518     /*!
 519      * To compute topology from scratch
 520      */
 521     void SetPreCADDiscardInput(in boolean toDiscardInput);
 522     boolean GetPreCADDiscardInput();
 523
 524     /*!
 525      *Set advanced option value
 526      */
 527     void SetOptionValue(in string optionName,
 528                         in string optionValue) raises (SALOME::SALOME_Exception);
 529     void SetPreCADOptionValue(in string optionName,
 530                         in string optionValue) raises (SALOME::SALOME_Exception);
 531     string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
 532     string GetPreCADOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
 533     /*!
 534      * Unsets advanced option
 535      */
 536     void UnsetOption(in string optionName);
 537     void UnsetPreCADOption(in string optionName);
 538
 539     /*!
 540      * Adds custom advanced option and its value
 541      */
 542     void SetAdvancedOption(in string optionsAndValues) // in a form "option_1 v1 option_2 v2'"
 543       raises (SALOME::SALOME_Exception);
 544     void AddOption(in string optionName, in string optionValue);
 545     void AddPreCADOption(in string optionName, in string optionValue);
 546     string GetOption(in string optionName);
 547     string GetPreCADOption(in string optionName);
 548
 549     /*!
 550      * Return array of strings each of which is option name concatenated
 551      * with option value devided by semicolon - "option_name:option_value:option_type".
 552      * Option value is empty if an option is not set.
 553      * option_type: 1 if user-define, 0 if default
 554      * Note: the method is mostly for interaction with GUI.
 555      */
 556     string_array GetOptionValues();
 557     string_array GetPreCADOptionValues();
 558     string_array GetAdvancedOptionValues();
 559
 560     /*!
 561      * Set option values each in the form "option_name[:option_value][:option_type]".
 562      * Note: the method is mostly for interaction with GUI.
 563      */
 564     void SetOptionValues(in string_array options) raises (SALOME::SALOME_Exception);
 565     void SetPreCADOptionValues(in string_array options) raises (SALOME::SALOME_Exception);
 566     void SetAdvancedOptionValues(in string_array options);
 567
 568     /*!
 569      * SizeMap
 570      */
 571     void SetSizeMapEntries(in string_array sizeMaps) raises (SALOME::SALOME_Exception);
 572     void ClearSizeMaps();
 573
 574     void UnsetEntry(in string entry);
 575
 576     /*!
 577      * Set/unset a SizeMap on geom object
 578      */
 579     void         SetSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap) raises (SALOME::SALOME_Exception);
 580     void         SetConstantSizeMap(in GEOM::GEOM_Object GeomObj, in double sizeMap);
 581     void         UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
 582
 583     /*!
 584      * Set a SizeMap on geom object given by entry
 585      */
 586     void         SetSizeMapEntry(in string entry, in string sizeMap) raises (SALOME::SALOME_Exception);
 587     void         SetConstantSizeMapEntry(in string entry, in GEOM::shape_type shapeType, in double sizeMap) raises (SALOME::SALOME_Exception);
 588     string       GetSizeMapEntry(in string entry) raises (SALOME::SALOME_Exception);
 589     string_array GetSizeMapEntries();
 590
 591     /*!
 592      * Set/unset an attractor on geom object
 593      */
 594     void         SetAttractor(in GEOM::GEOM_Object GeomObj, in string attractor);
 595     void         UnsetAttractor(in GEOM::GEOM_Object GeomObj);
 596
 597     /*!
 598      * Set an attractor on geom object given by entry
 599      */
 600     void         SetAttractorEntry(in string entry, in string attractor) raises (SALOME::SALOME_Exception);
 601     string       GetAttractorEntry(in string entry) raises (SALOME::SALOME_Exception);
 602     string_array GetAttractorEntries();
 603
 604     /*!
 605      * Set/unset an attractor given as geom object on another geom object
 606      */
 607     void         SetAttractorGeom(in GEOM::GEOM_Object GeomObj, in GEOM::GEOM_Object AttractorShape, in double StartSize, in double EndSize, in double ActionRadius, in double ConstantRadius);
 608     void         UnsetAttractorGeom(in GEOM::GEOM_Object GeomObj, in GEOM::GEOM_Object AttractorShape);
 609     void         UnsetAttractorEntry(in string entry, in string attractor);
 610
 611     /*!
 612      * Set an attractor given by entry on a geom object given by entry
 613      */
 614     void         SetClassAttractorEntry(in string entry, in string att_entry, in double StartSize, in double EndSize, in double ActionRadius, in double ConstantRadius ) raises (SALOME::SALOME_Exception);
 615     BLSURFPlugin::TAttParamsMap GetAttractorParams();
 616
 617 /*
 618     void         SetCustomSizeMapEntry(in string entry, in string sizeMap);
 619     string       GetCustomSizeMapEntry(in string entry);
 620     void         SetCustomSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
 621     void         UnsetCustomSizeMap(in GEOM::GEOM_Object GeomObj);
 622     string_array GetCustomSizeMapEntries();
 623 */
 624     ///////////////////////
 625     // ENFORCED VERTEXES //
 626     ///////////////////////
 627
 628     TFaceEntryEnfVertexListMap      GetAllEnforcedVerticesByFace();
 629     TEnfVertexList                  GetAllEnforcedVertices();
 630
 631     TFaceEntryCoordsListMap         GetAllCoordsByFace();
 632     TCoordsEnfVertexMap             GetAllEnforcedVerticesByCoords();
 633
 634     TFaceEntryEnfVertexEntryListMap GetAllEnfVertexEntriesByFace();
 635     TEnfVertexEntryEnfVertexMap     GetAllEnforcedVerticesByEnfVertexEntry();
 636
 637     void                            ClearAllEnforcedVertices();
 638
 639    /*!
 640     * Set/get/unset an enforced vertex on geom face
 641     */
 642     // OBSOLETE
 643     boolean SetEnforcedVertex(in GEOM::GEOM_Object theFace, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 644     boolean SetEnforcedVertexNamed(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 645     boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 646     boolean SetEnforcedVertexWithGroup(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 647     boolean SetEnforcedVertexNamedWithGroup(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfName theVertexName, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 648     boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 649
 650     TEnfVertexList GetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 651     boolean UnsetEnforcedVertex(in GEOM::GEOM_Object theFace, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 652     boolean UnsetEnforcedVertexGeom(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 653     boolean UnsetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 654
 655     // NEW - no face
 656     boolean AddEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 657     boolean AddEnforcedVertexNamed(in double x, in double y, in double z, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 658     boolean AddEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 659     boolean AddEnforcedVertexWithGroup(in double x, in double y, in double z, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 660     boolean AddEnforcedVertexNamedWithGroup(in double x, in double y, in double z, in TEnfName theVertexName, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 661     boolean AddEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theVertex, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 662
 663     boolean RemoveEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 664     boolean RemoveEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 665     boolean RemoveEnforcedVertices() raises (SALOME::SALOME_Exception);
 666
 667     /*!
 668      * Set/get/unset an enforced vertex on geom face given by entry
 669      */
 670     boolean SetEnforcedVertexEntry(in TEntry theFaceEntry, in double x, in double y, in double z,
 671                                    in TEnfName theVertexName, in TEntry theVertexEntry, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 672
 673     TEnfVertexList GetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 674     boolean UnsetEnforcedVertexEntry(in TEntry theFaceEntry, in double x, in double y, in double z, in TEntry theVertexEntry) raises (SALOME::SALOME_Exception);
 675 //    boolean UnsetEnforcedVertexEntryGeom(in TEntry theFaceEntry, in TEntry theVertexEntry) raises (SALOME::SALOME_Exception);
 676     boolean UnsetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 677
 678     /*!
 679      * To get/set internal vertices as enforced vertices
 680      */
 681     void          SetInternalEnforcedVertexAllFaces(in boolean toEnforceInternalVertices);
 682     boolean       GetInternalEnforcedVertexAllFaces();
 683     void          SetInternalEnforcedVertexAllFacesGroup(in TEnfGroupName groupName);
 684     TEnfGroupName GetInternalEnforcedVertexAllFacesGroup();
 685
 686 //  Enable internal enforced vertices on specific face if requested by user
 687 //    void          SetInternalEnforcedVertex(in GEOM::GEOM_Object theFace,in boolean toEnforceInternalVertices) raises (SALOME::SALOME_Exception);
 688 //    void          SetInternalEnforcedVertexWithGroup(in GEOM::GEOM_Object theFace, in boolean toEnforceInternalVertices, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 689 //    void          SetInternalEnforcedVertexEntry(in TEntry theFaceEntry, in boolean toEnforceInternalVertices, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 690 //    boolean       GetInternalEnforcedVertex(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 691 //    boolean       GetInternalEnforcedVertexEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 692 //    TFaceEntryInternalVerticesList GetAllInternalEnforcedVerticesFaces();
 693     ///////////////////////
 694
 695
 696     ///////////////////////
 697     // PERIODICITY       //
 698     ///////////////////////
 699
 700     void ClearPreCadPeriodicityVectors();
 701     void AddPreCadFacesPeriodicity(in GEOM::GEOM_Object theFace1, in GEOM::GEOM_Object theFace2) raises (SALOME::SALOME_Exception);
 702     void AddPreCadFacesPeriodicityWithVertices(in GEOM::GEOM_Object theFace1, in GEOM::GEOM_Object theFace2, in GEOM::ListOfGO theSourceVertices, in GEOM::ListOfGO theTargetVertices) raises (SALOME::SALOME_Exception);
 703     void AddPreCadFacesPeriodicityEntry(in TEntry theFace1, in TEntry theFace2, in TEntryList theSourceVertices, in TEntryList theTargetVertices)  raises (SALOME::SALOME_Exception);
 704     void AddPreCadEdgesPeriodicity(in GEOM::GEOM_Object theEdge1, in GEOM::GEOM_Object theEdge2) raises (SALOME::SALOME_Exception);
 705     void AddPreCadEdgesPeriodicityWithVertices(in GEOM::GEOM_Object theEdge1, in GEOM::GEOM_Object theEdge2, in GEOM::ListOfGO theSourceVertices, in GEOM::ListOfGO theTargetVertices) raises (SALOME::SALOME_Exception);
 706     void AddPreCadEdgesPeriodicityEntry(in TEntry theEdge1, in TEntry theEdge2, in TEntryList theSourceVertices, in TEntryList theTargetVertices)  raises (SALOME::SALOME_Exception);
 707     TPeriodicityList GetPreCadFacesPeriodicityVector();
 708     TPeriodicityList GetPreCadEdgesPeriodicityVector();
 709     ///////////////////////
 710
 711     /*!
 712      *Set the file for export resulting mesh in GMF format
 713      */
 714     void SetGMFFile(in string theFileName);
 715     string GetGMFFile();
 716   };
 717 };
 718
 719 #endif