1 // Copyright (C) 2007-2008 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
20 // File : BLSURFPlugin_Algorithm.idl
21 // Authors : Francis KLOSS (OCC) & Patrick LAUG (INRIA) & Lioka RAZAFINDRAZAKA (CEA)
22 // Size maps developement: Nicolas GEIMER (OCC) & Gilles DAVID (EURIWARE)
25 #ifndef _SMESH_BLSURFALGORITHM_IDL_
26 #define _SMESH_BLSURFALGORITHM_IDL_
28 #include "SMESH_Hypothesis.idl"
29 #include "GEOM_Gen.idl"
30 #include "SALOME_Exception.idl"
33 * BLSURFPlugin: interfaces to BLSURF related hypotheses and algorithms
37 typedef sequence<string> string_array;
38 typedef sequence<double,3> TEnforcedVertex;
39 typedef sequence<TEnforcedVertex> TEnforcedVertexList;
40 struct TEnforcedVertexMapElement {
42 TEnforcedVertexList vertexList;
44 typedef sequence<TEnforcedVertexMapElement> TEnforcedVertexMap;
47 * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
49 interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
54 * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
56 interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
59 * Sets topology usage way defining how mesh conformity is assured
60 * value=0 - mesh conformity is assured by conformity of a shape
61 * value=1,2 - mesh conformity is assured by pre-processing a CAD model
63 void SetTopology(in long way);
67 * Sets a way to define size of mesh elements to generate
68 * 0 - size is defined automatically
69 * 1 - size is set by SetPhySize() method
71 void SetPhysicalMesh(in long isCustom);
72 long GetPhysicalMesh();
75 * Sets size of mesh elements to generate
77 void SetPhySize(in double size);
81 * Sets lower boundary of mesh element size (PhySize)
83 void SetPhyMin(in double theMinSize);
87 * Sets upper boundary of mesh element size (PhySize)
89 void SetPhyMax(in double theMaxSize);
93 * Sets a way to define maximum angular deflection of mesh from CAD model
94 * 0 - deflection is defined automatically
95 * 1 - deflection is set by SetAngleMeshS() and SetAngleMeshC() methods
97 void SetGeometricMesh(in long isCustom);
98 long GetGeometricMesh();
101 * Sets angular deflection (in degrees) of a mesh face from CAD surface
103 void SetAngleMeshS(in double angle);
104 double GetAngleMeshS();
107 * Sets angular deflection (in degrees) of a mesh edge from CAD curve
109 void SetAngleMeshC(in double angle);
110 double GetAngleMeshC();
113 * Sets lower boundary of mesh element size computed to respect angular deflection
115 void SetGeoMin(in double theMinSize);
119 * Sets upper boundary of mesh element size computed to respect angular deflection
121 void SetGeoMax(in double theMaxSize);
125 * Sets maximal allowed ratio between the lengths of two adjacent edges
127 void SetGradation(in double ratio);
128 double GetGradation();
131 * Sets to create quadrilateral elements or not
133 void SetQuadAllowed(in boolean allowed);
134 boolean GetQuadAllowed();
137 * To respect geometrical edges or not
139 void SetDecimesh(in boolean toIgnoreEdges);
140 boolean GetDecimesh();
143 * Sets verbosity level in the range 0 to 100.
145 void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
146 short GetVerbosity();
149 * Sets advanced option value
151 void SetOptionValue(in string optionName,
152 in string optionValue) raises (SALOME::SALOME_Exception);
153 string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
155 * Unsets advanced option
157 void UnsetOption(in string optionName);
160 * Return array of strings each of which is option name concatenated
161 * with option value devided by semicolon - "option_name:option_value".
162 * Option value is empty if an option is not set.
163 * Note: the method is mostly for interaction with GUI.
165 string_array GetOptionValues();
168 * Set option values each in the form "option_name[:option_value]".
169 * Note: the method is mostly for interaction with GUI.
171 void SetOptionValues(in string_array options);
176 void SetSizeMapEntries(in string_array sizeMaps);
177 void ClearSizeMaps();
179 void UnsetEntry(in string entry);
182 * Set/unset a SizeMap on geom object
184 void SetSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
185 void UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
188 * Set a SizeMap on geom object given by entry
190 void SetSizeMapEntry(in string entry, in string sizeMap);
191 string GetSizeMapEntry(in string entry);
192 string_array GetSizeMapEntries();
195 * Set/unset an attractor on geom object
197 void SetAttractor(in GEOM::GEOM_Object GeomObj, in string attractor);
198 void UnsetAttractor(in GEOM::GEOM_Object GeomObj);
201 * Set an attractor on geom object given by entry
203 void SetAttractorEntry(in string entry, in string attractor);
204 string GetAttractorEntry(in string entry);
205 string_array GetAttractorEntries();
208 void SetCustomSizeMapEntry(in string entry, in string sizeMap);
209 string GetCustomSizeMapEntry(in string entry);
210 void SetCustomSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
211 void UnsetCustomSizeMap(in GEOM::GEOM_Object GeomObj);
212 string_array GetCustomSizeMapEntries();
214 ///////////////////////
215 // ENFORCED VERTEXES //
216 ///////////////////////
218 TEnforcedVertexMap GetAllEnforcedVerteces();
219 void ClearAllEnforcedVerteces();
222 * Set/get/unset an enforced vertex on geom object
224 void SetEnforcedVertex(in GEOM::GEOM_Object GeomObj, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
225 // void SetEnforcedVertexList(in GEOM::GEOM_Object GeomObj, in TEnforcedVertexList vertexList) raises (SALOME::SALOME_Exception);
227 TEnforcedVertexList GetEnforcedVerteces(in GEOM::GEOM_Object GeomObj) raises (SALOME::SALOME_Exception);
229 void UnsetEnforcedVertex(in GEOM::GEOM_Object GeomObj, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
230 // void UnsetEnforcedVertexList(in GEOM::GEOM_Object GeomObj, in TEnforcedVertexList vertexList) raises (SALOME::SALOME_Exception);
231 void UnsetEnforcedVerteces(in GEOM::GEOM_Object GeomObj) raises (SALOME::SALOME_Exception);
234 * Set/get/unset an enforced vertex on geom object given by entry
236 void SetEnforcedVertexEntry(in string entry, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
237 // void SetEnforcedVertexListEntry(in string entry, in TEnforcedVertexList vertexList) raises (SALOME::SALOME_Exception);
239 TEnforcedVertexList GetEnforcedVertecesEntry(in string entry) raises (SALOME::SALOME_Exception);
241 void UnsetEnforcedVertexEntry(in string entry, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
242 // void UnsetEnforcedVertexListEntry(in string entry, in TEnforcedVertexList vertexList) raises (SALOME::SALOME_Exception);
243 void UnsetEnforcedVertecesEntry(in string entry) raises (SALOME::SALOME_Exception);
245 ///////////////////////