1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
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)
26 #ifndef _SMESH_BLSURFALGORITHM_IDL_
27 #define _SMESH_BLSURFALGORITHM_IDL_
29 #include "SMESH_Hypothesis.idl"
30 #include "GEOM_Gen.idl"
31 #include "SALOME_Exception.idl"
34 * BLSURFPlugin: interfaces to BLSURF related hypotheses and algorithms
38 typedef sequence<string> string_array;
40 // Enforced vertex name
41 typedef string TEnfName;
43 typedef string TEntry;
44 typedef sequence<TEntry> TEntryList;
46 typedef string TEnfGroupName;
48 // Coordinates of enforced vertex
49 typedef sequence<double,3> TEnfVertexCoords;
51 typedef sequence<TEnfVertexCoords> TEnfVertexCoordsList;
57 TEnfVertexCoords coords;
58 TEnfGroupName grpName;
59 TEntryList faceEntries;
61 // List of enforced vertices
62 typedef sequence<TEnfVertex> TEnfVertexList;
64 // Map Face Entry / List of enforced vertices
65 struct TFaceEntryEnfVertexListMapElement {
67 TEnfVertexList enfVertexList;
69 typedef sequence<TFaceEntryEnfVertexListMapElement> TFaceEntryEnfVertexListMap;
71 // Map Face Entry / List of coords
72 struct TFaceEntryCoordsListMapElement {
74 TEnfVertexCoordsList coordsList;
76 typedef sequence<TFaceEntryCoordsListMapElement> TFaceEntryCoordsListMap;
78 // Map Face Entry / List of enf vertex entries
79 struct TFaceEntryEnfVertexEntryListMapElement {
81 TEntryList enfVertexEntryList;
83 typedef sequence<TFaceEntryEnfVertexEntryListMapElement> TFaceEntryEnfVertexEntryListMap;
85 // Map Coords / Enforced vertex
86 struct TCoordsEnfVertexElement {
87 TEnfVertexCoords coords;
90 typedef sequence<TCoordsEnfVertexElement> TCoordsEnfVertexMap;
92 // Map Enf Vertex Entry / Enforced vertex
93 struct TEnfVertexEntryEnfVertexElement {
94 TEntry enfVertexEntry;
97 typedef sequence<TEnfVertexEntryEnfVertexElement> TEnfVertexEntryEnfVertexMap;
100 struct TAttractorParams {
108 typedef sequence<TAttractorParams> TAttParamsMap;
111 * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
113 interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
118 * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
120 interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
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
127 void SetTopology(in long way);
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
135 void SetPhysicalMesh(in long isCustom);
136 long GetPhysicalMesh();
139 * Sets size of mesh elements to generate
141 void SetPhySize(in double size);
145 * Sets lower boundary of mesh element size (PhySize)
147 void SetPhyMin(in double theMinSize);
151 * Sets upper boundary of mesh element size (PhySize)
153 void SetPhyMax(in double theMaxSize);
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
161 void SetGeometricMesh(in long isCustom);
162 long GetGeometricMesh();
165 * Sets angular deflection (in degrees) of a mesh face from CAD surface
167 void SetAngleMeshS(in double angle);
168 double GetAngleMeshS();
171 * Sets angular deflection (in degrees) of a mesh edge from CAD curve
173 void SetAngleMeshC(in double angle);
174 double GetAngleMeshC();
177 * Sets lower boundary of mesh element size computed to respect angular deflection
179 void SetGeoMin(in double theMinSize);
183 * Sets upper boundary of mesh element size computed to respect angular deflection
185 void SetGeoMax(in double theMaxSize);
189 * Sets maximal allowed ratio between the lengths of two adjacent edges
191 void SetGradation(in double ratio);
192 double GetGradation();
195 * Sets to create quadrilateral elements or not
197 void SetQuadAllowed(in boolean allowed);
198 boolean GetQuadAllowed();
201 * To respect geometrical edges or not
203 void SetDecimesh(in boolean toIgnoreEdges);
204 boolean GetDecimesh();
207 * Sets verbosity level in the range 0 to 100.
209 void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
210 short GetVerbosity();
213 * Sets advanced option value
215 void SetOptionValue(in string optionName,
216 in string optionValue) raises (SALOME::SALOME_Exception);
217 string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
219 * Unsets advanced option
221 void UnsetOption(in string optionName);
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.
229 string_array GetOptionValues();
232 * Set option values each in the form "option_name[:option_value]".
233 * Note: the method is mostly for interaction with GUI.
235 void SetOptionValues(in string_array options);
240 void SetSizeMapEntries(in string_array sizeMaps);
241 void ClearSizeMaps();
243 void UnsetEntry(in string entry);
246 * Set/unset a SizeMap on geom object
248 void SetSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
249 void UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
252 * Set a SizeMap on geom object given by entry
254 void SetSizeMapEntry(in string entry, in string sizeMap);
255 string GetSizeMapEntry(in string entry);
256 string_array GetSizeMapEntries();
259 * Set/unset an attractor on geom object
261 void SetAttractor(in GEOM::GEOM_Object GeomObj, in string attractor);
262 void UnsetAttractor(in GEOM::GEOM_Object GeomObj);
265 * Set an attractor on geom object given by entry
267 void SetAttractorEntry(in string entry, in string attractor);
268 string GetAttractorEntry(in string entry);
269 string_array GetAttractorEntries();
272 * Set/unset an attractor given as geom object on another geom object
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);
278 * Set an attractor given by entry on a geom object given by entry
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();
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();
292 ///////////////////////
293 // ENFORCED VERTEXES //
294 ///////////////////////
296 TFaceEntryEnfVertexListMap GetAllEnforcedVerticesByFace();
297 TEnfVertexList GetAllEnforcedVertices();
299 TFaceEntryCoordsListMap GetAllCoordsByFace();
300 TCoordsEnfVertexMap GetAllEnforcedVerticesByCoords();
302 TFaceEntryEnfVertexEntryListMap GetAllEnfVertexEntriesByFace();
303 TEnfVertexEntryEnfVertexMap GetAllEnforcedVerticesByEnfVertexEntry();
305 void ClearAllEnforcedVertices();
308 * Set/get/unset an enforced vertex on geom face
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);
318 TEnfVertexList GetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
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);
325 * Set/get/unset an enforced vertex on geom face given by entry
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);
332 void SetEnforcedVertexEntryWithGroup(in string theFaceEntry, in double x, in double y, in double z, in TEnfGroupName groupName)
333 raises (SALOME::SALOME_Exception);
336 TEnfVertexList GetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
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);
343 * Set/get an enforced vertex on geom object and add it to a group
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);
351 ///////////////////////