idl/BLSURFPlugin_Algorithm.idl

   1 // Copyright (C) 2007-2011  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.
   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   // Attractors
 100   struct TAttractorParams {
 101     string faceEntry;
 102     string attEntry;
 103     double startSize;
 104     double endSize;
 105     double infDist;
 106     double constDist;
 107   };
 108   typedef sequence<TAttractorParams> TAttParamsMap;
 109
 110   /*!
 111    * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
 112    */
 113   interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
 114   {
 115   };
 116
 117   /*!
 118    * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
 119    */
 120   interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
 121   {
 122     /*!
 123      * Sets topology usage way defining how mesh conformity is assured
 124      * value=0 - mesh conformity is assured by conformity of a shape
 125      * value=1,2 - mesh conformity is assured by pre-processing a CAD model
 126      */
 127     void SetTopology(in long way);
 128     long GetTopology();
 129
 130     /*!
 131      * Sets a way to define size of mesh elements to generate
 132      * 0 - size is defined automatically
 133      * 1 - size is set by SetPhySize() method
 134      */
 135     void SetPhysicalMesh(in long isCustom);
 136     long GetPhysicalMesh();
 137
 138     /*!
 139      * Sets size of mesh elements to generate
 140      */
 141     void SetPhySize(in double size);
 142     double GetPhySize();
 143
 144     /*!
 145      * Sets lower boundary of mesh element size (PhySize)
 146      */
 147     void SetPhyMin(in double theMinSize);
 148     double GetPhyMin();
 149
 150     /*!
 151      * Sets upper boundary of mesh element size (PhySize)
 152      */
 153     void SetPhyMax(in double theMaxSize);
 154     double GetPhyMax();
 155
 156     /*!
 157      * Sets a way to define maximum angular deflection of mesh from CAD model
 158      * 0 - deflection is defined automatically
 159      * 1 - deflection is set by SetAngleMeshS() and SetAngleMeshC() methods
 160      */
 161     void SetGeometricMesh(in long isCustom);
 162     long GetGeometricMesh();
 163
 164     /*!
 165      * Sets angular deflection (in degrees) of a mesh face from CAD surface
 166      */
 167     void SetAngleMeshS(in double angle);
 168     double GetAngleMeshS();
 169
 170     /*!
 171      * Sets angular deflection (in degrees) of a mesh edge from CAD curve
 172      */
 173     void SetAngleMeshC(in double angle);
 174     double GetAngleMeshC();
 175
 176     /*!
 177      * Sets lower boundary of mesh element size computed to respect angular deflection
 178      */
 179     void SetGeoMin(in double theMinSize);
 180     double GetGeoMin();
 181
 182     /*!
 183      * Sets upper boundary of mesh element size computed to respect angular deflection
 184      */
 185     void SetGeoMax(in double theMaxSize);
 186     double GetGeoMax();
 187
 188     /*!
 189      * Sets maximal allowed ratio between the lengths of two adjacent edges
 190      */
 191     void SetGradation(in double ratio);
 192     double GetGradation();
 193
 194     /*!
 195      * Sets to create quadrilateral elements or not
 196      */
 197     void SetQuadAllowed(in boolean allowed);
 198     boolean GetQuadAllowed();
 199
 200     /*!
 201      * To respect geometrical edges or not
 202      */
 203     void SetDecimesh(in boolean toIgnoreEdges);
 204     boolean GetDecimesh();
 205
 206     /*!
 207      * Sets verbosity level in the range 0 to 100.
 208      */
 209     void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
 210     short GetVerbosity();
 211
 212     /*!
 213      * Sets advanced option value
 214      */
 215     void SetOptionValue(in string optionName,
 216                         in string optionValue) raises (SALOME::SALOME_Exception);
 217     string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
 218     /*!
 219      * Unsets advanced option
 220      */
 221     void UnsetOption(in string optionName);
 222
 223     /*!
 224      * Return array of strings each of which is option name concatenated
 225      * with option value devided by semicolon - "option_name:option_value".
 226      * Option value is empty if an option is not set.
 227      * Note: the method is mostly for interaction with GUI.
 228      */
 229     string_array GetOptionValues();
 230
 231     /*!
 232      * Set option values each in the form "option_name[:option_value]".
 233      * Note: the method is mostly for interaction with GUI.
 234      */
 235     void SetOptionValues(in string_array options);
 236
 237     /*!
 238      * SizeMap
 239      */
 240     void SetSizeMapEntries(in string_array sizeMaps);
 241     void ClearSizeMaps();
 242
 243     void UnsetEntry(in string entry);
 244
 245     /*!
 246      * Set/unset a SizeMap on geom object
 247      */
 248     void         SetSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
 249     void         UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
 250
 251     /*!
 252      * Set a SizeMap on geom object given by entry
 253      */
 254     void         SetSizeMapEntry(in string entry, in string sizeMap);
 255     string       GetSizeMapEntry(in string entry);
 256     string_array GetSizeMapEntries();
 257
 258     /*!
 259      * Set/unset an attractor on geom object
 260      */
 261     void         SetAttractor(in GEOM::GEOM_Object GeomObj, in string attractor);
 262     void         UnsetAttractor(in GEOM::GEOM_Object GeomObj);
 263
 264     /*!
 265      * Set an attractor on geom object given by entry
 266      */
 267     void         SetAttractorEntry(in string entry, in string attractor);
 268     string       GetAttractorEntry(in string entry);
 269     string_array GetAttractorEntries();
 270
 271     /*!
 272      * Set/unset an attractor given as geom object on another geom object
 273      */
 274     void         SetAttractorGeom(in GEOM::GEOM_Object GeomObj, in GEOM::GEOM_Object AttractorShape, in double StartSize, in double EndSize, in double ActionRadius, in double ConstantRadius);
 275     void         UnsetAttractorGeom(in GEOM::GEOM_Object GeomObj);
 276
 277     /*!
 278      * Set an attractor given by entry on a geom object given by entry
 279      */
 280     void         SetClassAttractorEntry(in string entry, in string att_entry, in double StartSize, in double EndSize, in double ActionRadius, in double ConstantRadius );
 281     BLSURFPlugin::TAttParamsMap GetAttractorParams();
 282
 283
 284
 285 /*
 286     void         SetCustomSizeMapEntry(in string entry, in string sizeMap);
 287     string       GetCustomSizeMapEntry(in string entry);
 288     void         SetCustomSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
 289     void         UnsetCustomSizeMap(in GEOM::GEOM_Object GeomObj);
 290     string_array GetCustomSizeMapEntries();
 291 */
 292     ///////////////////////
 293     // ENFORCED VERTEXES //
 294     ///////////////////////
 295
 296     TFaceEntryEnfVertexListMap      GetAllEnforcedVerticesByFace();
 297     TEnfVertexList                  GetAllEnforcedVertices();
 298
 299     TFaceEntryCoordsListMap         GetAllCoordsByFace();
 300     TCoordsEnfVertexMap             GetAllEnforcedVerticesByCoords();
 301
 302     TFaceEntryEnfVertexEntryListMap GetAllEnfVertexEntriesByFace();
 303     TEnfVertexEntryEnfVertexMap     GetAllEnforcedVerticesByEnfVertexEntry();
 304
 305     void                            ClearAllEnforcedVertices();
 306
 307    /*!
 308     * Set/get/unset an enforced vertex on geom face
 309     */
 310     boolean SetEnforcedVertex(in GEOM::GEOM_Object theFace, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 311     boolean SetEnforcedVertexNamed(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 312     boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 313     boolean SetEnforcedVertexWithGroup(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 314     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);
 315     boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 316
 317
 318     TEnfVertexList GetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 319
 320     boolean UnsetEnforcedVertex(in GEOM::GEOM_Object theFace, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 321     boolean UnsetEnforcedVertexGeom(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 322     boolean UnsetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 323
 324    /*!
 325     * Set/get/unset an enforced vertex on geom face given by entry
 326     */
 327     boolean SetEnforcedVertexEntry(in TEntry theFaceEntry, in double x, in double y, in double z,
 328                                    in TEnfName theVertexName, in TEntry theVertexEntry, in string groupName) raises (SALOME::SALOME_Exception);
 329 //    boolean SetEnforcedVertexEntryNamed(in TEntry theFaceEntry, in double x, in double y, in double z, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 330 //    boolean SetEnforcedVertexEntryGeom(in TEntry theFaceEntry, in TEntry theVertexEntry, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 331     /* TODO GROUPS
 332     void SetEnforcedVertexEntryWithGroup(in string theFaceEntry, in double x, in double y, in double z, in TEnfGroupName groupName)
 333         raises (SALOME::SALOME_Exception);
 334     */
 335 //
 336     TEnfVertexList GetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 337 //
 338     boolean UnsetEnforcedVertexEntry(in TEntry theFaceEntry, in double x, in double y, in double z, in TEntry theVertexEntry) raises (SALOME::SALOME_Exception);
 339 //    boolean UnsetEnforcedVertexEntryGeom(in TEntry theFaceEntry, in TEntry theVertexEntry) raises (SALOME::SALOME_Exception);
 340     boolean UnsetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 341
 342    /*!
 343      * Set/get an enforced vertex on geom object and add it to a group
 344     */
 345     /* TODO GROUPS
 346     void SetEnforcedVertexGroupName(in double x, in double y, in double z, in TEnfGroupName groupName)
 347         raises (SALOME::SALOME_Exception);
 348     string GetEnforcedVertexGroupName(in double x, in double y, in double z)
 349         raises (SALOME::SALOME_Exception);
 350     */
 351     ///////////////////////
 352
 353   };
 354 };
 355
 356 #endif