]> SALOME platform Git repositories - modules/geom.git/blob - idl/GEOM_Superv.idl
Salome HOME
*** empty log message ***
[modules/geom.git] / idl / GEOM_Superv.idl
1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
3 // 
4 //  This library is free software; you can redistribute it and/or 
5 //  modify it under the terms of the GNU Lesser General Public 
6 //  License as published by the Free Software Foundation; either 
7 //  version 2.1 of the License. 
8 // 
9 //  This library is distributed in the hope that it will be useful, 
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of 
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
12 //  Lesser General Public License for more details. 
13 // 
14 //  You should have received a copy of the GNU Lesser General Public 
15 //  License along with this library; if not, write to the Free Software 
16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
17 // 
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 //
20 //
21 //
22 //  File   : GEOM_Superv.idl
23 //  Author : Lucien PIGNOLONI
24
25 #ifndef __GEOM_SUPERV__
26 #define __GEOM_SUPERV__
27
28 #include "GEOM_Gen.idl"
29
30 module GEOM
31 {
32   interface GEOM_List
33   { };
34
35   interface GEOM_Superv : Engines::Component,SALOMEDS::Driver
36   {
37     //-----------------------------------------------------------//
38     // Set current study ID                                      // 
39     //-----------------------------------------------------------//
40     void SetStudyID (in long theStudyID) ;
41     
42     //-----------------------------------------------------------//
43     // Create ListOfGO and add items to it                       // 
44     //-----------------------------------------------------------//
45     GEOM_List CreateListOfGO();
46     void AddItemToListOfGO( inout GEOM_List theList, 
47                             in GEOM_Object theObject);
48
49     //-----------------------------------------------------------//
50     // Create ListOfLong and add items to it                     // 
51     //-----------------------------------------------------------//
52     GEOM_List CreateListOfLong();
53     void AddItemToListOfLong( inout GEOM_List theList, 
54                               in long theObject);
55
56     //-----------------------------------------------------------//
57     // Create ListOfDouble and add items to it                   // 
58     //-----------------------------------------------------------//
59     GEOM_List CreateListOfDouble();
60     void AddItemToListOfDouble( inout GEOM_List theList, 
61                                 in double theObject);
62
63     //-----------------------------------------------------------//
64     // Primitives Construction : BasicOperations                 // 
65     //-----------------------------------------------------------//
66     GEOM_Object MakePointXYZ (in double theX,
67                               in double theY,
68                               in double theZ) ;
69     GEOM_Object MakePointWithReference (in GEOM_Object theReference,
70                                         in double theX, 
71                                         in double theY, 
72                                         in double theZ) ;
73     GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
74                                   in double theParameter) ;
75
76     GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
77                                      in double theParameter);
78
79     GEOM_Object MakeVectorDXDYDZ (in double theDX,
80                                   in double theDY,
81                                   in double theDZ) ;
82     GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1,
83                                   in GEOM_Object thePnt2) ;
84     GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1,
85                                 in GEOM_Object thePnt2) ;
86     GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
87                                    in GEOM_Object thePnt2,
88                                    in GEOM_Object thePnt3,
89                                    in double theTrimSize) ;
90     GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
91                                  in GEOM_Object theVec,
92                                  in double      theTrimSize) ;
93     GEOM_Object MakePlaneFace (in GEOM_Object theFace,
94                                in double      theTrimSize) ;
95     GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
96                             in double theXDX, in double theXDY, in double theXDZ,
97                             in double theYDX, in double theYDY, in double theYDZ) ;
98
99     /*!
100      *  Create a tangent plane to specified face in the point with specified parameters.
101      *  Values of parameters should be between 0. and 1.0
102      *  \param theFace - face for which tangent plane shuold be built. 
103      *  \param theParameterU - value of parameter by U
104      *  \param theParameterV - value of parameter Vthe
105      *  \param theTrimSize - defines sizes of created face
106      *  \return New GEOM_Object, containing the face built on tangent plane.
107      */
108     GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
109                                        in double theParameterU,
110                                        in double theParameterV,
111                                        in double theTrimSize);
112
113     //-----------------------------------------------------------//
114     // Primitives Construction : 3DPrimOperations                //
115     //-----------------------------------------------------------//
116     GEOM_Object MakeBox (in double theX1,
117                          in double theY1,
118                          in double theZ1,
119                          in double theX2,
120                          in double theY2,
121                          in double theZ2) ; 
122     GEOM_Object MakeBoxDXDYDZ (in double theDX, 
123                                in double theDY, 
124                                in double theDZ) ;
125     GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, 
126                                in GEOM_Object thePnt2) ;
127     GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
128                                       in GEOM_Object theAxis,
129                                       in double      theRadius,
130                                       in double      theHeight) ;
131     GEOM_Object MakeCylinderRH (in double theR, 
132                                 in double theH) ;
133     GEOM_Object MakeSphere (in double theX,
134                             in double theY,
135                             in double theZ,
136                             in double theRadius) ;
137     GEOM_Object MakeSphereR (in double theR) ;
138     GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, 
139                                 in double      theR) ;
140     GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
141                                    in GEOM_Object theVec,
142                                    in double      theRMajor,
143                                    in double      theRMinor) ;
144     GEOM_Object MakeTorusRR (in double theRMajor,
145                              in double theRMinor) ;
146     GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
147                                      in GEOM_Object theAxis,
148                                      in double      theR1,
149                                      in double      theR2,
150                                      in double      theHeight) ;
151     GEOM_Object MakeConeR1R2H (in double theR1, 
152                                in double theR2, 
153                                in double theHeight) ;
154     GEOM_Object MakePrismVecH (in GEOM_Object theBase,
155                                in GEOM_Object theVec,
156                                in double      theH) ;
157     GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
158                                  in GEOM_Object thePoint1,
159                                  in GEOM_Object thePoint2) ;
160     GEOM_Object MakePipe (in GEOM_Object theBase, 
161                           in GEOM_Object thePath) ;
162     GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
163                                          in GEOM_Object theAxis,
164                                          in double      theAngle) ;
165     GEOM_Object MakeFilling (in GEOM_Object theShape,
166                              in long theMinDeg, in long theMaxDeg,
167                              in double theTol2D, in double theTol3D,
168                              in long theNbIter) ;
169     GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
170                                  in boolean theModeSolid,
171                                  in double thePreci,
172                                  in boolean theRuled);
173
174     GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
175                                                in ListOfGO theLocations,
176                                                in GEOM_Object thePath,
177                                                in boolean theWithContact ,
178                                                in boolean theWithCorrection );
179     
180     GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
181                                            in ListOfGO theSeqSubBases,
182                                            in ListOfGO theLocations,
183                                            in GEOM_Object thePath,
184                                            in boolean theWithContact ,
185                                            in boolean theWithCorrection );
186     
187     GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
188                                            in ListOfGO theLocations );
189
190     //-----------------------------------------------------------//
191     // BooleanOperations                                         //
192     //-----------------------------------------------------------//
193     GEOM_Object MakeBoolean (in GEOM_Object theShape1,
194                              in GEOM_Object theShape2,
195                              in long        theOperation) ;
196     GEOM_Object MakeFuse (in GEOM_Object theShape1,
197                           in GEOM_Object theShape2) ;
198     GEOM_Object MakePartition (in GEOM_List   theShapes,
199                                in GEOM_List   theTools,
200                                in GEOM_List   theKeepInside,
201                                in GEOM_List   theRemoveInside,
202                                in short       theLimit,
203                                in boolean     theRemoveWebs,
204                                in GEOM_List   theMaterials,
205                                in short       theKeepNonlimitShapes);
206     GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
207                                    in GEOM_Object thePlane) ;
208
209     //-----------------------------------------------------------//
210     // InsertOperations                                          //
211     //-----------------------------------------------------------//
212     GEOM_Object MakeCopy (in GEOM_Object theOriginal) ;
213     void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName) ;
214     GEOM_Object Import (in string theFileName, in string theFormatName) ;
215     void ImportTranslators (out string_array theFormats,
216                             out string_array thePatterns) ;
217     void ExportTranslators (out string_array theFormats,
218                             out string_array thePatterns) ;
219
220     //-----------------------------------------------------------//
221     // TransformOperations                                       //
222     //-----------------------------------------------------------//
223     GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
224                                     in GEOM_Object thePoint1,
225                                     in GEOM_Object thePoint2) ;
226     GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
227                                         in GEOM_Object thePoint1,
228                                         in GEOM_Object thePoint2) ;
229     GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
230                                  in double      theDX, 
231                                  in double      theDY, 
232                                  in double      theDZ) ;
233     GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
234                                      in double      theDX, 
235                                      in double      theDY, 
236                                      in double      theDZ) ;
237     GEOM_Object TranslateVector (in GEOM_Object theObject,
238                                  in GEOM_Object theVector) ;
239     GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
240                                      in GEOM_Object theVector) ;
241     GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
242                                   in GEOM_Object theVector,
243                                   in double      theStep,
244                                   in long        theNbTimes) ;
245     GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
246                                   in GEOM_Object theVector1,
247                                   in double      theStep1,
248                                   in long        theNbTimes1,
249                                   in GEOM_Object theVector2,
250                                   in double      theStep2,
251                                   in long        theNbTimes2) ;
252     GEOM_Object Rotate (in GEOM_Object theObject,
253                         in GEOM_Object theAxis,
254                         in double      theAngle) ;
255     GEOM_Object RotateCopy (in GEOM_Object theObject,
256                             in GEOM_Object theAxis,
257                             in double      theAngle) ;
258     GEOM_Object RotateThreePoints (in GEOM_Object theObject,
259                                    in GEOM_Object theCentPoint,
260                                    in GEOM_Object thePoint1,
261                                    in GEOM_Object thePoint2);
262     GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
263                                        in GEOM_Object theCentPoint,
264                                        in GEOM_Object thePoint1,
265                                        in GEOM_Object thePoint2);
266     GEOM_Object MultiRotate1D (in GEOM_Object theObject,
267                                in GEOM_Object theAxis,
268                                in long        theNbTimes) ;
269     GEOM_Object MultiRotate2D (in GEOM_Object theObject,
270                                in GEOM_Object theAxis,
271                                in double      theAngle,
272                                in long        theNbTimes1,
273                                in double      theStep,
274                                in long        theNbTimes2) ;
275     GEOM_Object MirrorPlane (in GEOM_Object theObject, 
276                              in GEOM_Object thePlane) ;
277     GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, 
278                                  in GEOM_Object thePlane) ;
279     GEOM_Object MirrorAxis (in GEOM_Object theObject, 
280                             in GEOM_Object theAxis) ;
281     GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, 
282                                 in GEOM_Object theAxis) ;
283     GEOM_Object MirrorPoint (in GEOM_Object theObject, 
284                              in GEOM_Object thePoint) ;
285     GEOM_Object MirrorPointCopy (in GEOM_Object theObject, 
286                                  in GEOM_Object thePoint) ;
287     GEOM_Object OffsetShape (in GEOM_Object theObject, 
288                              in double      theOffset) ;
289     GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, 
290                                  in double      theOffset) ;
291     GEOM_Object ScaleShape (in GEOM_Object theObject, 
292                             in GEOM_Object thePoint,
293                             in double      theFactor) ;
294     GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, 
295                                 in GEOM_Object thePoint,
296                                 in double      theFactor) ;
297     GEOM_Object PositionShape (in GEOM_Object theObject,
298                                in GEOM_Object theStartLCS,
299                                in GEOM_Object theEndLCS) ;
300     GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
301                                    in GEOM_Object theStartLCS,
302                                    in GEOM_Object theEndLCS) ;
303
304     //-----------------------------------------------------------//
305     // ShapesOperations                                          //
306     //-----------------------------------------------------------//
307     GEOM_Object MakeEdge (in GEOM_Object thePnt1, 
308                           in GEOM_Object thePnt2) ;
309     GEOM_Object MakeWire (in GEOM_List theEdgesAndWires) ;
310     GEOM_Object MakeFace (in GEOM_Object theWire, 
311                           in boolean     isPlanarWanted) ;
312     GEOM_Object MakeFaceWires (in GEOM_List theWires, 
313                                in boolean   isPlanarWanted) ;
314     GEOM_Object MakeShell (in GEOM_List theFacesAndShells) ;
315     GEOM_Object MakeSolidShell (in GEOM_Object theShell) ;
316     GEOM_Object MakeSolidShells (in GEOM_List theShells) ;
317     GEOM_Object MakeCompound (in GEOM_List theShapes) ;
318     GEOM_Object MakeGlueFaces (in GEOM_Object theShape, 
319                                in double theTolerance,
320                                in boolean doKeepNonSolids);
321     GEOM_List GetGlueFaces (in GEOM_Object theShape, 
322                             in double theTolerance);
323     GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, 
324                                      in double theTolerance,
325                                      in ListOfGO theFaces,
326                                      in boolean doKeepNonSolids);
327     GEOM_List MakeExplode (in GEOM_Object theShape,
328                            in long        theShapeType,
329                            in boolean     isSorted) ;
330     long NumberOfFaces (in GEOM_Object theShape) ;
331     long NumberOfEdges (in GEOM_Object theShape) ;
332     GEOM_Object ChangeOrientation (in GEOM_Object theShape) ;
333
334     //-----------------------------------------------------------//
335     // BlocksOperations                                          //
336     //-----------------------------------------------------------//
337     GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
338                                    in GEOM_Object thePnt2,
339                                    in GEOM_Object thePnt3,
340                                    in GEOM_Object thePnt4) ;
341     GEOM_Object MakeQuad (in GEOM_Object theEdge1,
342                           in GEOM_Object theEdge2,
343                           in GEOM_Object theEdge3,
344                           in GEOM_Object theEdge4) ;
345     GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
346                                 in GEOM_Object theEdge2) ;
347     GEOM_Object MakeHexa (in GEOM_Object theFace1,
348                           in GEOM_Object theFace2,
349                           in GEOM_Object theFace3,
350                           in GEOM_Object theFace4,
351                           in GEOM_Object theFace5,
352                           in GEOM_Object theFace6) ;
353     GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
354                                 in GEOM_Object theFace2) ;
355     GEOM_Object GetPoint (in GEOM_Object theShape,
356                           in double      theX,
357                           in double      theY,
358                           in double      theZ,
359                           in double      theEpsilon) ;
360     GEOM_Object GetEdge (in GEOM_Object theShape,
361                          in GEOM_Object thePoint1,
362                          in GEOM_Object thePoint2) ;
363     GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
364                                   in GEOM_Object thePoint) ;
365     GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
366                                  in GEOM_Object thePoint1,
367                                  in GEOM_Object thePoint2,
368                                  in GEOM_Object thePoint3,
369                                  in GEOM_Object thePoint4) ;
370     GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
371                                 in GEOM_Object theEdge1,
372                                 in GEOM_Object theEdge2) ;
373     GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
374                                  in GEOM_Object theFace) ;
375     GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
376                                   in GEOM_Object thePoint) ;
377     GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
378                                   in GEOM_Object theVector) ;
379     boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
380                                 in long        theMinNbFaces,
381                                 in long        theMaxNbFaces,
382                                 out long       theNbBlocks) ;
383     boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
384                                    out GEOM_IBlocksOperations::BCErrors   theErrors) ;
385     string PrintBCErrors (in GEOM_Object theCompound,
386                           in GEOM_IBlocksOperations::BCErrors    theErrors) ;
387     GEOM_List ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
388                                        in long        theMinNbFaces,
389                                        in long        theMaxNbFaces) ;
390     GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
391                                    in GEOM_Object thePoint) ;
392     GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
393                                  in GEOM_List   theParts) ;
394     GEOM_List GetBlocksByParts (in GEOM_Object theCompound,
395                                 in GEOM_List   theParts) ;
396     GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
397                                            in long        theDirFace1,
398                                            in long        theDirFace2,
399                                            in long        theNbTimes) ;
400     GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
401                                            in long        theDirFace1U,
402                                            in long        theDirFace2U,
403                                            in long        theNbTimesU,
404                                            in long        theDirFace1V,
405                                            in long        theDirFace2V,
406                                            in long        theNbTimesV) ;
407
408     //-----------------------------------------------------------//
409     // CurvesOperations                                          //
410     //-----------------------------------------------------------//
411     GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
412                                    in GEOM_Object theVec,
413                                    in double      theR) ;
414     GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
415                                     in GEOM_Object thePnt2,
416                                     in GEOM_Object thePnt3) ;
417     GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
418                                       in GEOM_Object thePnt2,
419                                       in GEOM_Object thePnt3) ;
420     GEOM_Object MakeEllipse (in GEOM_Object thePnt,
421                              in GEOM_Object theVec,
422                              in double      theRMajor,
423                              in double      theRMinor) ;
424     GEOM_Object MakeArc (in GEOM_Object thePnt1,
425                          in GEOM_Object thePnt2,
426                          in GEOM_Object thePnt3) ;
427     GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
428                                in GEOM_Object thePnt1,
429                                in GEOM_Object thePnt2,
430                                in boolean theSense) ;
431     GEOM_Object MakePolyline (in GEOM_List thePoints) ;
432     GEOM_Object MakeSplineBezier (in GEOM_List thePoints) ;
433     GEOM_Object MakeSplineInterpolation (in GEOM_List thePoints) ;
434     GEOM_Object MakeSketcher (in string    theCommand, 
435                               in GEOM_List theWorkingPlane) ;
436     
437     //-----------------------------------------------------------//
438     // LocalOperations                                           //
439     //-----------------------------------------------------------//
440     GEOM_Object MakeFilletAll (in GEOM_Object theShape,
441                                in double      theR) ;
442     GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
443                                  in double      theR,
444                                  in GEOM_List   theEdges) ;
445     GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
446                                      in double      theR1,
447                                      in double      theR2,
448                                      in GEOM_List   theEdges) ;
449     GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
450                                  in double      theR,
451                                  in GEOM_List   theFaces) ;
452     GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
453                                      in double      theR1,
454                                      in double      theR2,
455                                      in GEOM_List   theFaces) ;
456     GEOM_Object MakeChamferAll (in GEOM_Object theShape,
457                                 in double      theD) ;
458     GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
459                                  in double theD1, in double theD2,
460                                  in long theFace1, in long theFace2) ;
461     GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
462                                    in double theD, in double theAngle,
463                                    in long theFace1, in long theFace2) ;
464     GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
465                                   in double theD1, in double theD2,
466                                   in GEOM_List theFaces) ;
467     GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
468                                     in double theD, in double theAngle,
469                                     in GEOM_List theFaces) ;
470     GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
471                                   in double theD1, in double theD2,
472                                   in GEOM_List theEdges) ;
473     GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
474                                     in double theD, in double theAngle,
475                                     in GEOM_List theEdges) ;
476     GEOM_Object MakeArchimede (in GEOM_Object theShape,
477                                in double      theWeight,
478                                in double      theWaterDensity,
479                                in double      theMeshDeflection) ;
480     long GetSubShapeIndex (in GEOM_Object theShape, 
481                            in GEOM_Object theSubShape) ;
482
483     //-----------------------------------------------------------//
484     // GroupOperations                                           //
485     //-----------------------------------------------------------//
486     GEOM_Object CreateGroup (in GEOM_Object theMainShape, 
487                              in long        theShapeType) ;
488     void AddObject (in GEOM_Object theGroup, 
489                     in long        theSubShapeId) ;
490     void RemoveObject (in GEOM_Object theGroup, 
491                        in long        theSubShapeId) ;
492     long GetType (in GEOM_Object theGroup) ;
493     GEOM_Object  GetMainShape(in GEOM_Object theGroup) ;
494     GEOM_List  GetObjects(in GEOM_Object theGroup) ;
495
496   };
497 };
498
499 #endif