Salome HOME
NPAL15298: geompy.KindOfShape(aShape) first version implemented.
[modules/geom.git] / idl / GEOM_Gen.idl
1 // Copyright (C) 2005  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 //  File   : GEOM_Gen.idl
21 //  Author : Sergey RUIN
22
23 #ifndef __GEOM_GEN__
24 #define __GEOM_GEN__
25
26 #include "SALOME_Exception.idl"
27 #include "SALOME_Component.idl"
28 #include "SALOMEDS.idl"
29
30 #include "SALOME_GenericObj.idl"
31
32 module GEOM
33 {
34   /*!
35    *  Topological types of shapes (like Open Cascade types)
36    */
37   enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
38                     FACE, WIRE, EDGE, VERTEX, SHAPE };
39
40
41   /*!
42    *  State of shape relatively geometrical surface like plane, sphere or cylinder.
43    *  Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
44    */
45   enum shape_state
46   {
47     /*! Shape is on surface */
48     ST_ON,
49
50     /*!
51      *  Shape is in the direction defined by the normal and not on surface.
52      *  For plane it means above the plane,
53      *  For sphere and cylinder it means outside of volume, bounded by the surface.
54      */
55     ST_OUT,
56
57     /*!
58      *  Shape is in the direction defined by the normal and on surface.
59      *  ONOUT = ON || OUT
60      */
61     ST_ONOUT,
62
63     /*!
64      *  Complementary to ONOUT.
65      *  For plane it means below the plane,
66      *  For sphere and cylinder it means inside the volume, bounded by the surface
67      *  (beyond axis and surface for cylinder and beyond cented and surface for sphere).
68      */
69     ST_IN,
70
71     /*!
72      *  Complementary to OUT.
73      *  ONIN = ON || IN
74      */
75     ST_ONIN
76   };
77
78   typedef sequence<string>      string_array;
79   typedef sequence<short>       short_array;
80   typedef sequence<long>        ListOfLong;
81   typedef sequence<double>      ListOfDouble;
82
83   interface GEOM_Object;
84
85   typedef sequence<GEOM_Object> ListOfGO;
86
87   /*!
88    *  GEOM_Object: interface of geometric object
89    */
90   interface GEOM_Object : SALOME::GenericObj
91   {
92
93     /*!
94      *  Get an entry of the object in GEOM component.
95      */
96     string GetEntry();
97
98     /*!
99      *  Get ID of study, where the object is created.
100      */
101     long GetStudyID();
102
103     /*!
104      *  Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
105      */
106     long GetType();
107
108     /*!
109      *  Get a <VAR>shape_type</VAR> of the object value.
110      */
111     shape_type GetShapeType();
112
113     /*!
114      *  Set name of the object.
115      *  \param theName is a name which will be associated with this object.
116      */
117     void SetName (in string theName);
118
119     /*!
120      *  Get name of the object associated with this object.
121      */
122     string GetName();
123
124     /*!
125      *  Set a Study entry where this object was published.
126      */
127     void SetStudyEntry (in string theEntry);
128
129     /*!
130      *  Get a Study entry where this object was published.
131      */
132     string GetStudyEntry();
133
134     /*!
135      *  Get a list of all GEOM objects on which were the arguments
136      *  when this object was constructed and modified.
137      *  \note This method is supposed to be used by GUI only.
138      */
139     ListOfGO GetDependency();
140
141     /*!
142      *  Get a list of GEOM objects on which the last function that created or modified the object depends.
143      *  \note This method is supposed to be used by GUI only.
144      */
145     ListOfGO GetLastDependency();
146
147     /*!
148      *  Get the TopoDS_Shape, for colocated case only.
149      */
150     long long getShape();
151
152     /*!
153      ######################################################################
154      *  Internal methods (For sub shape identification)
155      ######################################################################
156      */
157
158     /*!
159      *  Get geometric shape of the object as a byte stream
160      */
161     SALOMEDS::TMPFile GetShapeStream();
162
163     /*
164      *  Returns True if this object is not a sub shape of another object.
165      */
166     boolean IsMainShape();
167
168     /*
169      *  Get a list of ID's of sub shapes in the main shape.
170      *  \note Internal method, suppopsed to be used only by GEOM_Client
171      */
172     ListOfLong GetSubShapeIndices();
173
174     /*
175      *  Get a main shape object to which this object is a sub shape
176      *  \note Internal method, suppopsed to be used only by GEOM_Client
177      */
178     GEOM_Object GetMainShape();
179
180     /*
181      *  Return true if geom object representes a shape.
182      *  For example, method return false for GEOM_MARKER
183      */
184      boolean IsShape();
185   };
186
187
188   /*!
189    *  GEOM_IOperations: basic methods of all geometric operations
190    */
191   interface GEOM_IOperations : SALOME::GenericObj
192   {
193     /*!
194      *  To know, if the operation was successfully performed
195      */
196     boolean IsDone();
197
198     /*!
199      *  Set the operation error code
200      *  \param theErrorID is a string describing the error occured
201      *  \note This method is supposed to be used only by interfaces inheriting from IOperations.
202      */
203     void SetErrorCode (in string theErrorID);
204
205     /*!
206      *  Get the operation error code
207      */
208     string GetErrorCode();
209
210     /*!
211      *  Get ID of study, where the operation is defined
212      */
213     long GetStudyID();
214
215     /*!
216      *  Opens a new transaction
217      */
218     void StartOperation();
219
220     /*!
221      *  Closes the previously opened trasaction
222      */
223     void FinishOperation();
224
225     /*!
226      *  Aborts the previously opened transaction
227      */
228     void AbortOperation();
229   };
230
231   /*!
232    *  GEOM_IBasicOperations: interface for basic geometry creation
233    *  (Point, Vector, Plane, Marker)
234    */
235   interface GEOM_IBasicOperations : GEOM_IOperations
236   {
237     /*!
238      *  Create point by three coordinates.
239      *  \param theX The X coordinate of the point.
240      *  \param theY The Y coordinate of the point.
241      *  \param theZ The Z coordinate of the point.
242      *  \return New GEOM_Object, containing the created point.
243      */
244     GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
245
246     /*!
247      *  Create a point, distant from the referenced point
248      *  on the given distances along the coordinate axes.
249      *  \param theReference The referenced point.
250      *  \param theX Displacement from the referenced point along OX axis.
251      *  \param theY Displacement from the referenced point along OY axis.
252      *  \param theZ Displacement from the referenced point along OZ axis.
253      *  \return New GEOM_Object, containing the created point.
254      */
255     GEOM_Object MakePointWithReference (in GEOM_Object theReference,
256                                         in double theX, in double theY, in double theZ);
257
258     /*!
259      *  Create a point, corresponding to the given parameter on the given curve.
260      *  \param theRefCurve The referenced curve.
261      *  \param theParameter Value of parameter on the referenced curve.
262      *  \return New GEOM_Object, containing the created point.
263      */
264     GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
265                                   in double theParameter);
266
267     
268      /*!
269      *  Create a vector, corresponding to tangent to the given parameter on the given curve.
270      *  \param theRefCurve The referenced curve.
271      *  \param theParameter Value of parameter on the referenced curve.This value should be have value
272      *  \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
273      *  \last parameter of curve. 
274      *  \return New GEOM_Object, containing the created point.
275      */
276      GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
277                                      in double theParameter);
278
279     /*!
280      *  Create a vector with the given components.
281      *  \param theDX X component of the vector.
282      *  \param theDY Y component of the vector.
283      *  \param theDZ Z component of the vector.
284      *  \return New GEOM_Object, containing the created vector.
285      */
286     GEOM_Object MakeVectorDXDYDZ (in double theDX,
287                                   in double theDY,
288                                   in double theDZ);
289
290     /*!
291      *  Create a vector between two points.
292      *  \param thePnt1 Start point for the vector.
293      *  \param thePnt2 End point for the vector.
294      *  \return New GEOM_Object, containing the created vector.
295      */
296     GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
297
298     /*!
299      *  Create a line, passing through the given point
300      *  and parrallel to the given direction
301      *  \param thePnt Point. The resulting line will pass through it.
302      *  \param theDir Direction. The resulting line will be parallel to it.
303      *  \return New GEOM_Object, containing the created line.
304      */
305     GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
306
307     /*!
308      *  Create a line, passing through the given points
309      *  \param thePnt1 First of two points, defining the line.
310      *  \param thePnt2 Second of two points, defining the line.
311      *  \return New GEOM_Object, containing the created line.
312      */
313     GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
314
315     /*!
316      *  Create a plane, passing through the three given points
317      *  \param thePnt1 First of three points, defining the plane.
318      *  \param thePnt2 Second of three points, defining the plane.
319      *  \param thePnt3 Fird of three points, defining the plane.
320      *  \param theTrimSize Half size of a side of quadrangle face, representing the plane.
321      *  \return New GEOM_Object, containing the created plane.
322      */
323     GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
324                                    in GEOM_Object thePnt2,
325                                    in GEOM_Object thePnt3,
326                                    in double theTrimSize);
327
328     /*!
329      *  Create a plane, passing through the given point
330      *  and normal to the given vector.
331      *  \param thePnt Point, the plane has to pass through.
332      *  \param theVec Vector, defining the plane normal direction.
333      *  \param theTrimSize Half size of a side of quadrangle face, representing the plane.
334      *  \return New GEOM_Object, containing the created plane.
335      */
336     GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
337                                  in GEOM_Object theVec,
338                                  in double theTrimSize);
339
340     /*!
341      *  Create a plane, similar to the existing one, but with another size of representing face.
342      *  \param theFace Referenced plane or LCS(Marker).
343      *  \param theTrimSize New half size of a side of quadrangle face, representing the plane.
344      *  \return New GEOM_Object, containing the created plane.
345      */
346     GEOM_Object MakePlaneFace (in GEOM_Object theFace,
347                                in double theTrimSize);
348
349     /*!
350      *  Create a local coordinate system.
351      *  \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
352      *  \param theXDX,theXDY,theXDZ Three components of OX direction
353      *  \param theYDX,theYDY,theYDZ Three components of OY direction
354      *  \return New GEOM_Object, containing the created coordinate system.
355      */
356     GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
357                             in double theXDX, in double theXDY, in double theXDZ,
358                             in double theYDX, in double theYDY, in double theYDZ);
359      
360     /*!
361      *  Create a tangent plane to specified face in the point with specified parameters.
362      *  Values of parameters should be between 0. and 1.0
363      *  \param theFace - face for which tangent plane shuold be built. 
364      *  \param theParameterU - value of parameter by U
365      *  \param theParameterV - value of parameter Vthe
366      *  \param theTrimSize - defines sizes of created face
367      *  \return New GEOM_Object, containing the face built on tangent plane.
368      */
369     GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
370                                        in double theParameterU,
371                                        in double theParameterV,
372                                        in double theTrimSize);
373   };
374
375   interface GEOM_ITransformOperations : GEOM_IOperations
376   {
377     /*!
378      *  Translate the given object along the vector, specified by its end points.
379      *  \param theObject The object to be translated.
380      *  \param thePoint1 Start point of translation vector.
381      *  \param thePoint2 End point of translation vector.
382      *  \return theObject.
383      */
384     GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
385                                     in GEOM_Object thePoint1,
386                                     in GEOM_Object thePoint2);
387
388     /*!
389      *  Translate the given object along the vector, specified
390      *  by its end points, creating its copy before the translation.
391      *  \param theObject The object to be translated.
392      *  \param thePoint1 Start point of translation vector.
393      *  \param thePoint2 End point of translation vector.
394      *  \return New GEOM_Object, containing the translated object.
395      */
396     GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
397                                         in GEOM_Object thePoint1,
398                                         in GEOM_Object thePoint2);
399
400     /*!
401      *  Translate the given object along the vector, specified by its components.
402      *  \param theObject The object to be translated.
403      *  \param theDX,theDY,theDZ Components of translation vector.
404      *  \return theObject.
405      */
406     GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
407                                  in double theDX, in double theDY, in double theDZ);
408
409     /*!
410      *  Translate the given object along the vector, specified
411      *  by its components, creating its copy before the translation.
412      *  \param theObject The object to be translated.
413      *  \param theDX,theDY,theDZ Components of translation vector.
414      *  \return New GEOM_Object, containing the translated object.
415      */
416     GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
417                                      in double theDX, in double theDY, in double theDZ);
418
419
420     /*!
421      *  Translate the given object along the given vector.
422      *  \param theObject The object to be translated.
423      *  \param theVector Translation vector, giving both direction and distance.
424      *  \return theObject.
425      */
426     GEOM_Object TranslateVector (in GEOM_Object theObject,
427                                  in GEOM_Object theVector);
428
429     /*!
430      *  Translate the given object along the given vector,
431      *  creating its copy before the translation.
432      *  \param theObject The object to be translated.
433      *  \param theVector Translation vector, giving both direction and distance.
434      *  \return New GEOM_Object, containing the translated object.
435      */
436     GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
437                                      in GEOM_Object theVector);
438
439     /*!
440      *  Translate the given object along the given vector a given number times
441      *  \param theObject The object to be translated.
442      *  \param theVector Direction of the translation.
443      *  \param theStep Distance to translate on.
444      *  \param theNbTimes Quantity of translations to be done.
445      *  \return New GEOM_Object, containing compound of all
446      *          the shapes, obtained after each translation.
447      */
448     GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
449                                   in GEOM_Object theVector,
450                                   in double theStep,
451                                   in long theNbTimes);
452
453     /*!
454      *  Conseqently apply two specified translations to theObject specified number of times.
455      *  \param theObject The object to be translated.
456      *  \param theVector1 Direction of the first translation.
457      *  \param theStep1 Step of the first translation.
458      *  \param theNbTimes1 Quantity of translations to be done along theVector1.
459      *  \param theVector2 Direction of the second translation.
460      *  \param theStep2 Step of the second translation.
461      *  \param theNbTimes2 Quantity of translations to be done along theVector2.
462      *  \return New GEOM_Object, containing compound of all
463      *          the shapes, obtained after each translation.
464      */
465     GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
466                                   in GEOM_Object theVector1,
467                                   in double theStep1,
468                                   in long theNbTimes1,
469                                   in GEOM_Object theVector2,
470                                   in double theStep2,
471                                   in long theNbTimes2);
472
473     /*!
474      *  Rotate given object around vector perpendicular to plane containing three points.
475      *  \param theObject The object to be rotated.
476      *  \param theCentPoint central point - the axis is the vector perpendicular to the plane
477      *  containing the three points.
478      *  \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
479      *  \return theObject.
480      */
481     GEOM_Object RotateThreePoints (in GEOM_Object theObject,
482                                    in GEOM_Object theCentPoint,
483                                    in GEOM_Object thePoint1,
484                                    in GEOM_Object thePoint2);
485
486
487     /*!
488      *  Rotate given object around vector perpendicular to plane containing three points.
489      *  Creating its copy before the rotatation.
490      *  \param theObject The object to be rotated.
491      *  \param theCentPoint central point - the axis is the vector perpendicular to the plane
492      *  containing the three points.
493      *  \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
494      *  \return New GEOM_Object, containing the rotated object.
495      */
496     GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
497                                        in GEOM_Object theCentPoint,
498                                        in GEOM_Object thePoint1,
499                                        in GEOM_Object thePoint2);
500
501     /*!
502      *  Rotate the given object around the given axis on the given angle.
503      *  \param theObject The object to be rotated.
504      *  \param theAxis Rotation axis.
505      *  \param theAngle Rotation angle in radians.
506      *  \return theObject.
507      */
508     GEOM_Object Rotate (in GEOM_Object theObject,
509                         in GEOM_Object theAxis,
510                         in double theAngle);
511
512
513     /*!
514      *  Rotate the given object around the given axis
515      *  on the given angle, creating its copy before the rotatation.
516      *  \param theObject The object to be rotated.
517      *  \param theAxis Rotation axis.
518      *  \param theAngle Rotation angle in radians.
519      *  \return New GEOM_Object, containing the rotated object.
520      */
521     GEOM_Object RotateCopy (in GEOM_Object theObject,
522                             in GEOM_Object theAxis,
523                             in double theAngle);
524
525
526     /*!
527      *  Rotate the given object around the given axis a given number times.
528      *  Rotation angle will be 2*PI/theNbTimes.
529      *  \param theObject The object to be rotated.
530      *  \param theAxis The rotation axis.
531      *  \param theNbTimes Quantity of rotations to be done.
532      *  \return New GEOM_Object, containing compound of all the
533      *          shapes, obtained after each rotation.
534      */
535     GEOM_Object MultiRotate1D (in GEOM_Object theObject,
536                                in GEOM_Object theAxis,
537                                in long theNbTimes);
538
539     /*!
540      *  Rotate the given object around the
541      *  given axis on the given angle a given number
542      *  times and multi-translate each rotation result.
543      *  Translation direction passes through center of gravity
544      *  of rotated shape and its projection on the rotation axis.
545      *  \param theObject The object to be rotated.
546      *  \param theAxis Rotation axis.
547      *  \param theAngle Rotation angle in graduces.
548      *  \param theNbTimes1 Quantity of rotations to be done.
549      *  \param theStep Translation distance.
550      *  \param theNbTimes2 Quantity of translations to be done.
551      *  \return New GEOM_Object, containing compound of all the
552      *          shapes, obtained after each transformation.
553      */
554     GEOM_Object MultiRotate2D (in GEOM_Object theObject,
555                                in GEOM_Object theAxis,
556                                in double theAngle,
557                                in long theNbTimes1,
558                                in double theStep,
559                                in long theNbTimes2);
560
561     /*!
562      *  Replace the given object by an object,
563      *  symmetrical to it relatively the given plane.
564      *  \param theObject The object to be mirrored.
565      *  \param thePlane Plane of symmetry.
566      */
567     GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
568
569     /*!
570      *  Create an object, symmetrical
571      *  to the given one relatively the given plane.
572      *  \param theObject The object to be mirrored.
573      *  \param thePlane Plane of symmetry.
574      *  \return New GEOM_Object, containing the mirrored shape.
575      */
576     GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
577
578     /*!
579      *  Replace the given object by an object,
580      *  symmetrical to it relatively the given axis.
581      *  \param theObject The object to be mirrored.
582      *  \param theAxis Axis of symmetry.
583      *  \return theObject.
584      */
585     GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
586
587     /*!
588      *  Create an object, symmetrical
589      *  to the given one relatively the given axis.
590      *  \param theObject The object to be mirrored.
591      *  \param theAxis Axis of symmetry.
592      *  \return New GEOM_Object, containing the mirrored object.
593      */
594     GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
595
596     /*!
597      *  Replace the given object by an object, symmetrical to it relatively the given point.
598      *  \param theObject The object to be mirrored.
599      *  \param thePoint Point of symmetry.
600      *  \return theObject.
601      */
602     GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
603
604     /*!
605      *  Create an object, symmetrical to the given one relatively the given point.
606      *  \param theObject The object to be mirrored.
607      *  \param thePoint Point of symmetry.
608      *  \return New GEOM_Object, containing the mirrored object.
609      */
610     GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
611
612     /*!
613      *  Replace the given object by its offset.
614      *  \param theObject The base object for the offset.
615      *  \param theOffset Offset value.
616      *  \return theObject.
617      */
618     GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
619
620     /*!
621      *  Create new object as offset of the given one.
622      *  \param theObject The base object for the offset.
623      *  \param theOffset Offset value.
624      *  \return New GEOM_Object, containing the offset object.
625      */
626     GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
627
628     /*!
629      *  Scale the given object by the factor.
630      *  \param theObject The object to be scaled.
631      *  \param thePoint Center point for scaling.
632      *  \param theFactor Scaling factor value.
633      *  \return theObject.
634      */
635     GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
636                             in double theFactor);
637
638     /*!
639      *  Scale the given object by the factor, creating its copy before the scaling.
640      *  \param theObject The object to be scaled.
641      *  \param thePoint Center point for scaling.
642      *  \param theFactor Scaling factor value.
643      *  \return New GEOM_Object, containing the scaled shape.
644      */
645     GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
646                                 in double theFactor);
647
648     /*!
649      *  Modify the Location of the given object by LCS.
650      *  \param theObject The object to be displaced.
651      *  \param theStartLCS Coordinate system to perform displacement from it.
652      *                     If \a theStartLCS is NULL, displacement
653      *                     will be performed from global CS.
654      *                     If \a theObject itself is used as \a theStartLCS,
655      *                     its location will be changed to \a theEndLCS.
656      *  \param theEndLCS Coordinate system to perform displacement to it.
657      *  \return theObject.
658      */
659     GEOM_Object PositionShape (in GEOM_Object theObject,
660                                in GEOM_Object theStartLCS,
661                                in GEOM_Object theEndLCS);
662
663     /*!
664      *  Modify the Location of the given object by LCS,
665      *  creating its copy before the setting.
666      *  \param theObject The object to be displaced.
667      *  \param theStartLCS Coordinate system to perform displacement from it.
668      *                     If \a theStartLCS is NULL, displacement
669      *                     will be performed from global CS.
670      *                     If \a theObject itself is used as \a theStartLCS,
671      *                     its location will be changed to \a theEndLCS.
672      *  \param theEndLCS Coordinate system to perform displacement to it.
673      *  \return New GEOM_Object, containing the displaced shape.
674      */
675     GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
676                                    in GEOM_Object theStartLCS,
677                                    in GEOM_Object theEndLCS);
678   };
679
680   /*!
681    *  GEOM_I3DPrimOperations: Interface for 3D primitives creation
682    *  Box, Cylinder, Cone, Sphere, Prism (extrusion),
683    *  Pipe (extrusion along contour), Revolution, Solid (from shell).
684    */
685   interface GEOM_I3DPrimOperations : GEOM_IOperations
686   {
687     /*!
688      *  Create a box with specified dimensions along the coordinate axes
689      *  and with edges, parallel to the coordinate axes.
690      *  Center of the box will be at point (DX/2, DY/2, DZ/2).
691      *  \param theDX Length of Box edges, parallel to OX axis.
692      *  \param theDY Length of Box edges, parallel to OY axis.
693      *  \param theDZ Length of Box edges, parallel to OZ axis.
694      *  \return New GEOM_Object, containing the created box.
695      */
696     GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
697
698     /*!
699      *  Create a box with two specified opposite vertices,
700      *  and with edges, parallel to the coordinate axes
701      *  \param thePnt1 First of two opposite vertices.
702      *  \param thePnt2 Second of two opposite vertices.
703      *  \return New GEOM_Object, containing the created box.
704      */
705     GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
706
707     /*!
708      *  Create a cylinder with given radius and height at
709      *  the origin of coordinate system. Axis of the cylinder
710      *  will be collinear to the OZ axis of the coordinate system.
711      *  \param theR Cylinder radius.
712      *  \param theH Cylinder height.
713      *  \return New GEOM_Object, containing the created cylinder.
714      */
715     GEOM_Object MakeCylinderRH (in double theR, in double theH);
716
717     /*!
718      *  Create a cylinder with given base point, axis, radius and height.
719      *  \param thePnt Central point of cylinder base.
720      *  \param theAxis Cylinder axis.
721      *  \param theR Cylinder radius.
722      *  \param theH Cylinder height.
723      *  \return New GEOM_Object, containing the created cylinder.
724      */
725     GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
726                                       in GEOM_Object theAxis,
727                                       in double      theR,
728                                       in double      theH);
729
730     /*!
731      *  Create a cone with given height and radiuses at
732      *  the origin of coordinate system. Axis of the cone will
733      *  be collinear to the OZ axis of the coordinate system.
734      *  \param theR1 Radius of the first cone base.
735      *  \param theR2 Radius of the second cone base.
736      *    \note If both radiuses are non-zero, the cone will be truncated.
737      *    \note If the radiuses are equal, a cylinder will be created instead.
738      *  \param theH Cone height.
739      *  \return New GEOM_Object, containing the created cone.
740      */
741     GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
742
743     /*!
744      *  Create a cone with given base point, axis, height and radiuses.
745      *  \param thePnt Central point of the first cone base.
746      *  \param theAxis Cone axis.
747      *  \param theR1 Radius of the first cone base.
748      *  \param theR2 Radius of the second cone base.
749      *    \note If both radiuses are non-zero, the cone will be truncated.
750      *    \note If the radiuses are equal, a cylinder will be created instead.
751      *  \param theH Cone height.
752      *  \return New GEOM_Object, containing the created cone.
753      */
754     GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
755                                      in GEOM_Object theAxis,
756                                      in double      theR1,
757                                      in double      theR2,
758                                      in double      theH);
759
760     /*!
761      *  Create a torus with given radiuses at the origin of coordinate system.
762      *  \param theRMajor Torus major radius.
763      *  \param theRMinor Torus minor radius.
764      *  \return New GEOM_Object, containing the created torus.
765      */
766     GEOM_Object MakeTorusRR (in double theRMajor,
767                              in double theRMinor);
768
769     /*!
770      *  Create a torus with given center, normal vector and radiuses.
771      *  \param thePnt Torus central point.
772      *  \param theVec Torus axis of symmetry.
773      *  \param theRMajor Torus major radius.
774      *  \param theRMinor Torus minor radius.
775      *  \return New GEOM_Object, containing the created torus.
776      */
777     GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
778                                    in GEOM_Object theVec,
779                                    in double theRMajor,
780                                    in double theRMinor);
781
782     /*!
783      *  Create a sphere with given radius at the origin of coordinate system.
784      *  \param theR Sphere radius.
785      *  \return New GEOM_Object, containing the created sphere.
786      */
787     GEOM_Object MakeSphereR (in double theR);
788
789     /*!
790      *  Create a sphere with given center and radius.
791      *  \param thePnt Sphere center.
792      *  \param theR Sphere radius.
793      *  \return New GEOM_Object, containing the created .
794      */
795     GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
796
797     /*!
798      *  Create a shape by extrusion of the base shape along the vector,
799      *  i.e. all the space, transfixed by the base shape during its translation
800      *  along the vector on the given distance.
801      *  \param theBase Base shape to be extruded.
802      *  \param theVec Direction of extrusion.
803      *  \param theH Prism dimension along theVec.
804      *  \return New GEOM_Object, containing the created prism.
805      */
806     GEOM_Object MakePrismVecH (in GEOM_Object theBase,
807                                in GEOM_Object theVec,
808                                in double      theH);
809
810     /*!
811      *  Create a shape by extrusion of the base shape along a vector, defined by two points.
812      *  \param theBase Base shape to be extruded.
813      *  \param thePoint1 First end of extrusion vector.
814      *  \param thePoint2 Second end of extrusion vector.
815      *  \return New GEOM_Object, containing the created prism.
816      */
817     GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
818                                  in GEOM_Object thePoint1,
819                                  in GEOM_Object thePoint2);
820
821     /*!
822      *  Create a shape by extrusion of the base shape along
823      *  the path shape. The path shape can be a wire or an edge.
824      *  \param theBase Base shape to be extruded.
825      *  \param thePath Path shape to extrude the base shape along it.
826      *  \return New GEOM_Object, containing the created pipe.
827      */
828     GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
829
830     /*!
831      *  Create a shape by revolution of the base shape around the axis
832      *  on the given angle, i.e. all the space, transfixed by the base
833      *  shape during its rotation around the axis on the given angle.
834      *  \param theBase Base shape to be rotated.
835      *  \param theAxis Rotation axis.
836      *  \param theAngle Rotation angle in radians.
837      *  \return New GEOM_Object, containing the created revolution.
838      */
839     GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
840                                          in GEOM_Object theAxis,
841                                          in double theAngle);
842
843     /*!
844      *  Create a filling from the given compound of contours.
845      *  \param theMinDeg a minimal degree
846      *  \param theMaxDeg a maximal degree
847      *  \param theTol2D a 2d tolerance
848      *  \param theTol3D a 3d tolerance
849      *  \param theNbIter a number of iteration
850      *  \return New GEOM_Object, containing the created filling surface.
851      */
852     GEOM_Object MakeFilling (in GEOM_Object theShape,
853                              in long theMinDeg, in long theMaxDeg,
854                              in double theTol2D, in double theTol3D,
855                              in long theNbIter);
856
857     /*!
858      *  Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
859      *  \param theSeqSections - set of specified sections.
860      *  \param theModeSolid - mode defining building solid or shell
861      *  \param thePreci - precision 3D used for smoothing by default 1.e-6
862      *  \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
863      *  \return New GEOM_Object, containing the created shell or solid.
864      */
865     GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
866                                  in boolean theModeSolid,
867                                  in double thePreci,
868                                  in boolean theRuled);
869
870       /*!
871      *  Create a shape by extrusion of the profile shape along
872      *  the path shape. The path shape can be a wire or an edge.
873      *  the several profiles can be specified in the several locations of path. 
874      *  \param theSeqBases - list of  Bases shape to be extruded.
875      *  \param theLocations - list of locations on the path corresponding
876      *                        specified list of the Bases shapes. Number of locations
877      *                        should be equal to number of bases or list of locations can be empty.
878      *  \param thePath - Path shape to extrude the base shape along it.
879      *  \param theWithContact - the mode defining that the section is translated to be in
880      *                          contact with the spine.
881      *  \param - WithCorrection - defining that the section is rotated to be
882      *                           orthogonal to the spine tangent in the correspondent point
883      *  \return New GEOM_Object, containing the created pipe.
884      */
885     GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
886                                                in ListOfGO theLocations,
887                                                in GEOM_Object thePath,
888                                                in boolean theWithContact ,
889                                                in boolean theWithCorrection );
890     
891   };
892
893   /*!
894    *  GEOM_IShapesOperations: Interface for Shapes creation:
895    *  Edge from two points, Wire from edges, Face from wire,
896    *  Shell from faces, Solid from shells, Compound from shapes
897    */
898   interface GEOM_IShapesOperations : GEOM_IOperations
899   {
900     /*!
901      *  Create a linear edge with specified ends.
902      *  \param thePnt1 Point for the first end of edge.
903      *  \param thePnt2 Point for the second end of edge.
904      *  \return New GEOM_Object, containing the created edge.
905      */
906     GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
907
908     /*!
909      *  Create a wire from the set of edges and wires.
910      *  \param theEdgesAndWires List of edge and/or wires.
911      *  \return New GEOM_Object, containing the created wire.
912      */
913     GEOM_Object MakeWire (in ListOfGO theEdgesAndWires);
914
915     /*!
916      *  Create a face on the given wire.
917      *  \param theWire closed Wire or Edge to build the face on.
918      *  \param isPlanarWanted If TRUE, only planar face will be built.
919      *                        If impossible, NULL object will be returned.
920      *  \return New GEOM_Object, containing the created face.
921      */
922     GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
923
924     /*!
925      *  Create a face on the given wires set.
926      *  \param theWires List of closed wires or edges to build the face on.
927      *  \param isPlanarWanted If TRUE, only planar face will be built.
928      *                        If impossible, NULL object will be returned.
929      *  \return New GEOM_Object, containing the created face.
930      */
931     GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
932
933     /*!
934      *  Create a shell from the set of faces and shells.
935      *  \param theFacesAndShells List of faces and/or shells.
936      *  \return New GEOM_Object, containing the created shell.
937      */
938     GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
939
940     /*!
941      *  Create a solid, bounded by the given shell.
942      *  \param theShell Bounding shell.
943      *  \return New GEOM_Object, containing the created solid.
944      */
945     GEOM_Object MakeSolidShell (in GEOM_Object theShell);
946
947     /*!
948      *  Create a solid, bounded by the given shells.
949      *  \param theShells Bounding shells.
950      *  \return New GEOM_Object, containing the created solid.
951      */
952     GEOM_Object MakeSolidShells (in ListOfGO theShells);
953
954     /*!
955      *  Create a compound of the given shapes.
956      *  \param theShapes List of shapes to put in compound.
957      *  \return New GEOM_Object, containing the created compound.
958      */
959     GEOM_Object MakeCompound (in ListOfGO theShapes);
960
961     /*!
962      *  Replace coincident faces in theShape by one face.
963      *  \param theShape Initial shape.
964      *  \param theTolerance Maximum distance between faces, which can be considered as coincident.
965      *  \return New GEOM_Object, containing a copy of theShape without coincident faces.
966      */
967     GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance);
968
969     /*!
970      *  Explode a shape on subshapes of a given type.
971      *  \param theShape Shape to be exploded.
972      *  \param theShapeType Type of sub-shapes to be retrieved.
973      *  \param isSorted If this parameter is TRUE, sub-shapes will be
974      *                  sorted by coordinates of their gravity centers.
975      *  \return List of sub-shapes of type theShapeType, contained in theShape.
976      */
977     ListOfGO MakeExplode (in GEOM_Object theShape,
978                           in long        theShapeType,
979                           in boolean     isSorted);
980
981     /*!
982      *  Explode a shape on subshapes of a given type.
983      *  Does the same, as the above method, but returns IDs of sub-shapes,
984      *  not GEOM_Objects. It works faster.
985      *  \param theShape Shape to be exploded.
986      *  \param theShapeType Type of sub-shapes to be retrieved.
987      *  \param isSorted If this parameter is TRUE, sub-shapes will be
988      *                  sorted by coordinates of their gravity centers.
989      *  \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
990      */
991     ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
992                                in long        theShapeType,
993                                in boolean     isSorted);
994
995     /*!
996      *  Get a sub shape defined by its unique ID inside \a theMainShape
997      *  \note The sub shape GEOM_Objects can has ONLY ONE function.
998      *        Don't try to apply modification operations on them.
999      */
1000     GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1001                              in long        theID);
1002
1003     /*!
1004      *  Get global index of \a theSubShape in \a theMainShape.
1005      *  \param theMainShape Main shape.
1006      *  \param theSubShape Sub-shape of the main shape.
1007      *  \return global index of \a theSubShape in \a theMainShape.
1008      */
1009     long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1010
1011     /*!
1012      *  Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1013      *  Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1014      *  to generate automatic names for sub-shapes, when publishing them in a study.
1015      *  \param theMainShape Main shape.
1016      *  \param theSubShape Sub-shape of the main shape.
1017      *  \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1018      */
1019     long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1020
1021     /*!
1022      *  \brief Get name of type of \a theShape.
1023      *
1024      *  Use wide type notation, taking into consideration both topology and geometry of the shape.
1025      *  Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1026      *  to generate automatic names for sub-shapes, when publishing them in a study.
1027      *  \param theShape The shape to get a type of.
1028      *  \return String, containing a type name of \a theShape.
1029      */
1030     string GetShapeTypeString (in GEOM_Object theShape);
1031
1032     /*!
1033      *  Count number of faces in the given shape.
1034      *  \param theShape Shape to count faces in.
1035      *  \return Number of faces in the given shape.
1036      */
1037     long NumberOfFaces (in GEOM_Object theShape);
1038
1039     /*!
1040      *  Count number of edges in the given shape.
1041      *  \param theShape Shape to count edges in.
1042      *  \return Number of edges in theShape.
1043      */
1044     long NumberOfEdges (in GEOM_Object theShape);
1045
1046     /*!
1047      *  Reverses an orientation the given shape.
1048      *  \param theShape Shape to be reversed.
1049      *  \return The reversed copy of theShape.
1050      */
1051     GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1052
1053     /*!
1054      *  Retrieve all free faces from the given shape.
1055      *  Free face is a face, which is not shared between two shells of the shape.
1056      *  \param theShape Shape to find free faces in.
1057      *  \return List of IDs of all free faces, contained in theShape.
1058      */
1059     ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1060
1061     /*!
1062      *  Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1063      *  \param theShape1 Shape to find sub-shapes in.
1064      *  \param theShape2 Shape to find shared sub-shapes with.
1065      *  \param theShapeType Type of sub-shapes to be retrieved.
1066      *  \return List of sub-shapes of theShape1, shared with theShape2.
1067      */
1068     ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1069                               in GEOM_Object theShape2,
1070                               in long        theShapeType);
1071
1072     /*!
1073      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1074      *  the specified plane by the certain way, defined through \a theState parameter.
1075      *  \param theShape Shape to find sub-shapes of.
1076      *  \param theShapeType Type of sub-shapes to be retrieved.
1077      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1078      *                direction and location of the plane to find shapes on.
1079      *  \param theState The state of the subshapes to find.
1080      *  \return List of all found sub-shapes.
1081      */
1082     ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1083                                in long        theShapeType,
1084                                in GEOM_Object theAx1,
1085                                in shape_state theState);
1086     /*!
1087      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1088      *  the specified plane by the certain way, defined through \a theState parameter.
1089      *  \param theShape Shape to find sub-shapes of.
1090      *  \param theShapeType Type of sub-shapes to be retrieved.
1091      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1092      *                direction of the plane to find shapes on.
1093      *  \param thePnt Point specifying location of the plane to find shapes on.
1094      *  \param theState The state of the subshapes to find.
1095      *  \return List of all found sub-shapes.
1096      */
1097     ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1098                                            in long        theShapeType,
1099                                            in GEOM_Object theAx1,
1100                                            in GEOM_Object thePnt,
1101                                            in shape_state theState);
1102
1103
1104
1105     /*!
1106      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1107      *  the specified cylinder by the certain way, defined through \a theState parameter.
1108      *  \param theShape Shape to find sub-shapes of.
1109      *  \param theShapeType Type of sub-shapes to be retrieved.
1110      *  \param theAxis Vector (or line, or linear edge), specifying
1111      *                 axis of the cylinder to find shapes on.
1112      *  \param theRadius Radius of the cylinder to find shapes on.
1113      *  \param theState The state of the subshapes to find.
1114      *  \return List of all found sub-shapes.
1115      */
1116     ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1117                                   in long        theShapeType,
1118                                   in GEOM_Object theAxis,
1119                                   in double      theRadius,
1120                                   in shape_state theState);
1121
1122     /*!
1123      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1124      *  the specified sphere by the certain way, defined through \a theState parameter.
1125      *  \param theShape Shape to find sub-shapes of.
1126      *  \param theShapeType Type of sub-shapes to be retrieved.
1127      *  \param theCenter Point, specifying center of the sphere to find shapes on.
1128      *  \param theRadius Radius of the sphere to find shapes on.
1129      *  \param theState The state of the subshapes to find.
1130      *  \return List of all found sub-shapes.
1131      */
1132     ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1133                                 in long        theShapeType,
1134                                 in GEOM_Object theCenter,
1135                                 in double      theRadius,
1136                                 in shape_state theState);
1137
1138     /*!
1139      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1140      *  the specified quadrangle by the certain way, defined through \a theState parameter.
1141      *  \param theShape Shape to find sub-shapes of.
1142      *  \param theShapeType Type of sub-shapes to be retrieved.
1143      *  \param theTopLeftPoint Top left quadrangle corner
1144      *  \param theTopRigthPoint Top right quadrangle corner
1145      *  \param theBottomLeftPoint Bottom left quadrangle corner
1146      *  \param theBottomRigthPoint Bottom right quadrangle corner
1147      *  \param theState The state of the subshapes to find.
1148      *  \return List of all found sub-shapes.
1149      */
1150     ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1151                                     in long        theShapeType,
1152                                     in GEOM_Object theTopLeftPoint,
1153                                     in GEOM_Object theTopRigthPoint,
1154                                     in GEOM_Object theBottomLeftPoint,
1155                                     in GEOM_Object theBottomRigthPoint,
1156                                     in shape_state theState);
1157
1158     /*!
1159      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1160      *  the specified plane by the certain way, defined through \a theState parameter.
1161      *  \param theShape Shape to find sub-shapes of.
1162      *  \param theShapeType Type of sub-shapes to be retrieved.
1163      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1164      *                direction and location of the plane to find shapes on.
1165      *  \param theState The state of the subshapes to find.
1166      *  \return List of IDs of all found sub-shapes.
1167      */
1168     ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1169                                     in long        theShapeType,
1170                                     in GEOM_Object theAx1,
1171                                     in shape_state theState);
1172                                     
1173     /*!
1174      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1175      *  the specified plane by the certain way, defined through \a theState parameter.
1176      *  \param theShape Shape to find sub-shapes of.
1177      *  \param theShapeType Type of sub-shapes to be retrieved.
1178      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1179      *                direction of the plane to find shapes on.
1180      *  \param thePnt Point specifying location of the plane to find shapes on.     
1181      *  \param theState The state of the subshapes to find.
1182      *  \return List of IDs of all found sub-shapes.
1183      */
1184     ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1185                                                 in long        theShapeType,
1186                                                 in GEOM_Object theAx1,
1187                                                 in GEOM_Object thePnt,
1188                                                 in shape_state theState);
1189
1190     /*!
1191      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1192      *  the specified cylinder by the certain way, defined through \a theState parameter.
1193      *  \param theShape Shape to find sub-shapes of.
1194      *  \param theShapeType Type of sub-shapes to be retrieved.
1195      *  \param theAxis Vector (or line, or linear edge), specifying
1196      *                 axis of the cylinder to find shapes on.
1197      *  \param theRadius Radius of the cylinder to find shapes on.
1198      *  \param theState The state of the subshapes to find.
1199      *  \return List of IDs of all found sub-shapes.
1200      */
1201     ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1202                                        in long        theShapeType,
1203                                        in GEOM_Object theAxis,
1204                                        in double      theRadius,
1205                                        in shape_state theState);
1206
1207     /*!
1208      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1209      *  the specified sphere by the certain way, defined through \a theState parameter.
1210      *  \param theShape Shape to find sub-shapes of.
1211      *  \param theShapeType Type of sub-shapes to be retrieved.
1212      *  \param theCenter Point, specifying center of the sphere to find shapes on.
1213      *  \param theRadius Radius of the sphere to find shapes on.
1214      *  \param theState The state of the subshapes to find.
1215      *  \return List of IDs of all found sub-shapes.
1216      */
1217     ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1218                                      in long        theShapeType,
1219                                      in GEOM_Object theCenter,
1220                                      in double      theRadius,
1221                                      in shape_state theState);
1222
1223     /*!
1224      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1225      *  the specified quadrangle by the certain way, defined through \a theState parameter.
1226      *  \param theShape Shape to find sub-shapes of.
1227      *  \param theShapeType Type of sub-shapes to be retrieved.
1228      *  \param theTopLeftPoint Top left quadrangle corner
1229      *  \param theTopRigthPoint Top right quadrangle corner
1230      *  \param theBottomLeftPoint Bottom left quadrangle corner
1231      *  \param theBottomRigthPoint Bottom right quadrangle corner
1232      *  \param theState The state of the subshapes to find.
1233      *  \return List of IDs of all found sub-shapes.
1234      */
1235     ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1236                                          in long        theShapeType,
1237                                          in GEOM_Object theTopLeftPoint,
1238                                          in GEOM_Object theTopRigthPoint,
1239                                          in GEOM_Object theBottomLeftPoint,
1240                                          in GEOM_Object theBottomRigthPoint,
1241                                          in shape_state theState);
1242
1243     /*!
1244      * \brief Find subshapes complying with given status
1245      * \param theBox - the box to check state of subshapes against
1246      * \param theShape - the shape to explore
1247      * \param theShapeType - type of subshape of theShape
1248      * \param theState - required state
1249      * \return List of IDs of all found sub-shapes.
1250      */
1251     ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1252                                   in GEOM_Object theShape,
1253                                   in long        theShapeType,
1254                                   in shape_state theState);
1255
1256     /*!
1257      * \brief Find subshapes complying with given status
1258      * \param theBox - the box to check state of subshapes against
1259      * \param theShape - the shape to explore
1260      * \param theShapeType - type of subshape of theShape
1261      * \param theState - required state
1262      * \return List of all found sub-shapes.
1263      */
1264     ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1265                              in GEOM_Object theShape,
1266                              in long        theShapeType,
1267                              in shape_state theState);
1268
1269     /*!
1270      *  Get sub-shape(s) of theShapeWhere, which are
1271      *  coincident with \a theShapeWhat or could be a part of it.
1272      *  \param theShapeWhere Shape to find sub-shapes of.
1273      *  \param theShapeWhat Shape, specifying what to find.
1274      *  \return Group of all found sub-shapes or a single found sub-shape.
1275      */
1276     GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1277                             in GEOM_Object theShapeWhat);
1278
1279     /*!
1280      *  Get sub-shape of theShapeWhere, which are
1281      *  coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1282      *  \param theShapeWhere Shape to find sub-shapes of.
1283      *  \param theShapeWhat Shape, specifying what to find.
1284      *  \return found sub-shape.
1285      */
1286     GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1287                          in GEOM_Object theShapeWhat);
1288   };
1289
1290   /*!
1291    *  GEOM_IBlocksOperations: Interface for Blocks construction
1292    *  Face from points or edges, Block from faces,
1293    *  Blocks multi-translation and multi-rotation
1294    */
1295   interface GEOM_IBlocksOperations : GEOM_IOperations
1296   {
1297     /*!
1298      *  Creation of blocks
1299      */
1300
1301     /*!
1302      *  Create a quadrangle face from four edges. Order of Edges is not
1303      *  important. It is  not necessary that edges share the same vertex.
1304      *  \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1305      *  \return New GEOM_Object, containing the created face.
1306      */
1307     GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1308                           in GEOM_Object theEdge2,
1309                           in GEOM_Object theEdge3,
1310                           in GEOM_Object theEdge4);
1311
1312     /*!
1313      *  Create a quadrangle face on two edges.
1314      *  The missing edges will be built by creating the shortest ones.
1315      *  \param theEdge1,theEdge2 Two opposite edges for the face.
1316      *  \return New GEOM_Object, containing the created face.
1317      */
1318     GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1319                                 in GEOM_Object theEdge2);
1320
1321     /*!
1322      *  Create a quadrangle face with specified corners.
1323      *  The missing edges will be built by creating the shortest ones.
1324      *  \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1325      *  \return New GEOM_Object, containing the created face.
1326      */
1327     GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1328                                    in GEOM_Object thePnt2,
1329                                    in GEOM_Object thePnt3,
1330                                    in GEOM_Object thePnt4);
1331
1332     /*!
1333      *  Create a hexahedral solid, bounded by the six given faces. Order of
1334      *  faces is not important. It is  not necessary that Faces share the same edge.
1335      *  \param theFace1-theFace6 Faces for the hexahedral solid.
1336      *  \return New GEOM_Object, containing the created solid.
1337      */
1338     GEOM_Object MakeHexa (in GEOM_Object theFace1,
1339                           in GEOM_Object theFace2,
1340                           in GEOM_Object theFace3,
1341                           in GEOM_Object theFace4,
1342                           in GEOM_Object theFace5,
1343                           in GEOM_Object theFace6);
1344
1345     /*!
1346      *  Create a hexahedral solid between two given faces.
1347      *  The missing faces will be built by creating the smallest ones.
1348      *  \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1349      *  \return New GEOM_Object, containing the created solid.
1350      */
1351     GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1352                                 in GEOM_Object theFace2);
1353
1354     /*!
1355      *  Extract elements of blocks and blocks compounds
1356      */
1357
1358     /*!
1359      *  Get a vertex, found in the given shape by its coordinates.
1360      *  \param theShape Block or a compound of blocks.
1361      *  \param theX,theY,theZ Coordinates of the sought vertex.
1362      *  \param theEpsilon Maximum allowed distance between the resulting
1363      *                    vertex and point with the given coordinates.
1364      *  \return New GEOM_Object, containing the found vertex.
1365      */
1366     GEOM_Object GetPoint (in GEOM_Object theShape,
1367                           in double      theX,
1368                           in double      theY,
1369                           in double      theZ,
1370                           in double      theEpsilon);
1371
1372     /*!
1373      *  Get an edge, found in the given shape by two given vertices.
1374      *  \param theShape Block or a compound of blocks.
1375      *  \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1376      *  \return New GEOM_Object, containing the found edge.
1377      */
1378     GEOM_Object GetEdge (in GEOM_Object theShape,
1379                          in GEOM_Object thePoint1,
1380                          in GEOM_Object thePoint2);
1381
1382     /*!
1383      *  Find an edge of the given shape, which has minimal distance to the given point.
1384      *  \param theShape Block or a compound of blocks.
1385      *  \param thePoint Point, close to the desired edge.
1386      *  \return New GEOM_Object, containing the found edge.
1387      */
1388     GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1389                                   in GEOM_Object thePoint);
1390
1391     /*!
1392      *  Returns a face, found in the given shape by four given corner vertices.
1393      *  \param theShape Block or a compound of blocks.
1394      *  \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1395      *  \return New GEOM_Object, containing the found face.
1396      */
1397     GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1398                                  in GEOM_Object thePoint1,
1399                                  in GEOM_Object thePoint2,
1400                                  in GEOM_Object thePoint3,
1401                                  in GEOM_Object thePoint4);
1402
1403     /*!
1404      *  Get a face of block, found in the given shape by two given edges.
1405      *  \param theShape Block or a compound of blocks.
1406      *  \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1407      *  \return New GEOM_Object, containing the found face.
1408      */
1409     GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1410                                 in GEOM_Object theEdge1,
1411                                 in GEOM_Object theEdge2);
1412
1413     /*!
1414      *  Find a face, opposite to the given one in the given block.
1415      *  \param theBlock Must be a hexahedral solid.
1416      *  \param theFace Face of \a theBlock, opposite to the desired face.
1417      *  \return New GEOM_Object, containing the found face.
1418      */
1419     GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1420                                  in GEOM_Object theFace);
1421
1422     /*!
1423      *  Find a face of the given shape, which has minimal distance to the given point.
1424      *  \param theShape Block or a compound of blocks.
1425      *  \param thePoint Point, close to the desired face.
1426      *  \return New GEOM_Object, containing the found face.
1427      */
1428     GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1429                                   in GEOM_Object thePoint);
1430
1431     /*!
1432      *  Find a face of block, whose outside normale has minimal angle with the given vector.
1433      *  \param theShape Block or a compound of blocks.
1434      *  \param theVector Vector, close to the normale of the desired face.
1435      *  \return New GEOM_Object, containing the found face.
1436      */
1437     GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1438                                   in GEOM_Object theVector);
1439
1440     /*!
1441      *  Extract blocks from blocks compounds
1442      */
1443
1444     /*!
1445      *  Check, if the compound contains only specified blocks.
1446      *  \param theCompound The compound to check.
1447      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
1448      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1449      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1450      *  \return TRUE, if the given compound contains only blocks.
1451      *  \return theNbBlocks Number of specified blocks in theCompound.
1452      */
1453     boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
1454                                 in long        theMinNbFaces,
1455                                 in long        theMaxNbFaces,
1456                                 out long       theNbBlocks);
1457
1458     /*!
1459      *  Enumeration of Blocks Compound defects.
1460      */
1461     enum BCErrorType
1462     {
1463       /* Each element of the compound should be a Block */
1464       NOT_BLOCK,
1465
1466       /* An element is a potential block, but has degenerated and/or seam edge(s). */
1467       EXTRA_EDGE,
1468
1469       /* A connection between two Blocks should be an entire face or an entire edge */
1470       INVALID_CONNECTION,
1471
1472       /* The compound should be connexe */
1473       NOT_CONNECTED,
1474
1475       /* The glue between two quadrangle faces should be applied */
1476       NOT_GLUED
1477     };
1478
1479     /*!
1480      *  Description of Blocks Compound defect: type and incriminated sub-shapes.
1481      */
1482     struct BCError
1483     {
1484       BCErrorType error;
1485       ListOfLong  incriminated;
1486     };
1487
1488     /*!
1489      *  Sequence of all Blocks Compound defects.
1490      */
1491     typedef sequence<BCError> BCErrors;
1492
1493     /*!
1494      *  Check, if the compound of blocks is given.
1495      *  To be considered as a compound of blocks, the
1496      *  given shape must satisfy the following conditions:
1497      *  - Each element of the compound should be a Block (6 faces and 12 edges).
1498      *  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
1499      *  - The compound should be connexe.
1500      *  - The glue between two quadrangle faces should be applied.
1501      *    \note Single block is also accepted as a valid compound of blocks.
1502      *  \param theCompound The compound to check.
1503      *  \return TRUE, if the given shape is a compound of blocks.
1504      *  \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
1505      */
1506     boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
1507                                    out BCErrors   theErrors);
1508
1509     /*!
1510      *  Convert sequence of Blocks Compound errors, returned by
1511      *  <VAR>CheckCompoundOfBlocks()</VAR>, into string.
1512      *  \param theCompound The bad compound.
1513      *  \param theErrors The sequence of \a theCompound errors.
1514      *  \return String, describing all the errors in form, suitable for printing.
1515      */
1516     string PrintBCErrors (in GEOM_Object theCompound,
1517                           in BCErrors    theErrors);
1518
1519     /*!
1520      *  Remove all seam and degenerated edges from \a theShape.
1521      *  Unite faces and edges, sharing one surface.
1522      *  \param theShape The compound or single solid to remove irregular edges from.
1523      *  \return Improved shape.
1524      */
1525     GEOM_Object RemoveExtraEdges (in GEOM_Object theShape);
1526
1527     /*!
1528      *  Check, if the given shape is a blocks compound.
1529      *  Fix all detected errors.
1530      *    \note Single block can be also fixed by this method.
1531      *  \param theCompound The compound to check and improve.
1532      *  \return Improved compound.
1533      */
1534     GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
1535
1536     /*!
1537      *  Get all the blocks, contained in the given compound.
1538      *  \param theCompound The compound to explode.
1539      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
1540      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1541      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1542      *  \return List of GEOM_Objects, containing the retrieved blocks.
1543      */
1544     ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
1545                                       in long        theMinNbFaces,
1546                                       in long        theMaxNbFaces);
1547
1548     /*!
1549      *  Find block, containing the given point inside its volume or on boundary.
1550      *  \param theCompound Compound, to find block in.
1551      *  \param thePoint Point, close to the desired block. If the point lays on
1552      *         boundary between some blocks, we return block with nearest center.
1553      *  \return New GEOM_Object, containing the found block.
1554      */
1555     GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
1556                                    in GEOM_Object thePoint);
1557
1558     /*!
1559      *  Find block, containing all the elements, passed as the parts, or maximum quantity of them.
1560      *  \param theCompound Compound, to find block in.
1561      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
1562      *  \return New GEOM_Object, containing the found block.
1563      */
1564     GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
1565                                  in ListOfGO    theParts);
1566
1567     /*!
1568      *  Return all blocks, containing all the elements, passed as the parts.
1569      *  \param theCompound Compound, to find blocks in.
1570      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
1571      *  \return List of GEOM_Objects, containing the found blocks.
1572      */
1573     ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
1574                                in ListOfGO    theParts);
1575
1576     /*!
1577      *  Operations on blocks with gluing of result
1578      */
1579
1580     /*!
1581      *  Multi-transformate block and glue the result.
1582      *  Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
1583      *  \param theBlock Hexahedral solid to be multi-transformed.
1584      *  \param theDirFace1 First direction face global index.
1585      *  \param theDirFace2 Second direction face global index.
1586      *  \param theNbTimes Quantity of transformations to be done.
1587      *    \note Global index of sub-shape can be obtained, using method
1588      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1589      *  \return New GEOM_Object, containing the result shape.
1590      */
1591     GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
1592                                            in long        theDirFace1,
1593                                            in long        theDirFace2,
1594                                            in long        theNbTimes);
1595
1596     /*!
1597      *  Multi-transformate block and glue the result.
1598      *  \param theBlock Hexahedral solid to be multi-transformed.
1599      *  \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
1600      *  \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
1601      *  \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
1602      *  \return New GEOM_Object, containing the result shape.
1603      */
1604     GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
1605                                            in long        theDirFace1U,
1606                                            in long        theDirFace2U,
1607                                            in long        theNbTimesU,
1608                                            in long        theDirFace1V,
1609                                            in long        theDirFace2V,
1610                                            in long        theNbTimesV);
1611
1612     /*!
1613      *  Special operation - propagation
1614      */
1615
1616     /*!
1617      *  Build all possible propagation groups.
1618      *  Propagation group is a set of all edges, opposite to one (main)
1619      *  edge of this group directly or through other opposite edges.
1620      *  Notion of Opposite Edge make sence only on quadrangle face.
1621      *  \param theShape Shape to build propagation groups on.
1622      *  \return List of GEOM_Objects, each of them is a propagation group.
1623      */
1624     ListOfGO Propagate (in GEOM_Object theShape);
1625   };
1626
1627   /*!
1628    *  GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
1629    */
1630   interface GEOM_IBooleanOperations : GEOM_IOperations
1631   {
1632     /*!
1633      *  Perform one of boolean operations on two given shapes.
1634      *  \param theShape1 First argument for boolean operation.
1635      *  \param theShape2 Second argument for boolean operation.
1636      *  \param theOperation Indicates the operation to be done:
1637      *                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1638      *  \return New GEOM_Object, containing the result shape.
1639      */
1640     GEOM_Object MakeBoolean (in GEOM_Object theShape1,
1641                              in GEOM_Object theShape2,
1642                              in long theOperation);
1643
1644     /*!
1645      *  Perform partition operation.
1646      *  \param theShapes Shapes to be intersected.
1647      *  \param theTools Shapes to intersect theShapes.
1648      *  \note  Each compound from ListShapes and ListTools will be exploded in order
1649      *         to avoid possible intersection between shapes from this compound.
1650      *  \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1651      *
1652      *  After implementation new version of PartitionAlgo (October 2006)
1653      *  other parameters are ignored by current functionality. They are kept
1654      *  in this function only for supporting old versions.
1655      *  Ignored parameters:
1656      *  \param theKeepInside Shapes, outside which the results will be deleted.
1657      *         Each shape from theKeepInside must belong to theShapes also.
1658      *  \param theRemoveInside Shapes, inside which the results will be deleted.
1659      *         Each shape from theRemoveInside must belong to theShapes also.
1660      *  \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
1661      *  \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
1662      *
1663      *  \return New GEOM_Object, containing the result shapes.
1664      */
1665     GEOM_Object MakePartition (in ListOfGO   theShapes,
1666                                in ListOfGO   theTools,
1667                                in ListOfGO   theKeepInside,
1668                                in ListOfGO   theRemoveInside,
1669                                in short      theLimit,
1670                                in boolean    theRemoveWebs,
1671                                in ListOfLong theMaterials);
1672
1673     /*!
1674      *  Perform partition operation.
1675      *  This method may be usefull if it is needed to make a partition for
1676      *  a compound containing nonintersected shapes. Performance will be better
1677      *  since intersection between shapes from compound is not performed.
1678      *
1679      *  Description of all parameters as in previous method MakePartition()
1680      *
1681      *  \note Passed compounds (via ListShapes or via ListTools)
1682      *        have to consist of nonintersecting shapes.
1683      *
1684      *  \return New GEOM_Object, containing the result shapes.
1685      */
1686     GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO   theShapes,
1687                                                       in ListOfGO   theTools,
1688                                                       in ListOfGO   theKeepInside,
1689                                                       in ListOfGO   theRemoveInside,
1690                                                       in short      theLimit,
1691                                                       in boolean    theRemoveWebs,
1692                                                       in ListOfLong theMaterials);
1693
1694     /*!
1695      *  Perform partition of the Shape with the Plane
1696      *  \param theShape Shape to be intersected.
1697      *  \param thePlane Tool shape, to intersect theShape.
1698      *  \return New GEOM_Object, containing the result shape.
1699      */
1700     GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
1701                                    in GEOM_Object thePlane);
1702   };
1703
1704   /*!
1705    *  GEOM_ICurvesOperations: Interface for curves creation.
1706    *  Polyline, Circle, Spline (Bezier and Interpolation)
1707    */
1708   interface GEOM_ICurvesOperations : GEOM_IOperations
1709   {
1710     /*!
1711      *  Create a circle with given center, normal vector and radius.
1712      *  \param thePnt Circle center.
1713      *  \param theVec Vector, normal to the plane of the circle.
1714      *  \param theR Circle radius.
1715      *  \return New GEOM_Object, containing the created circle.
1716      */
1717     GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
1718                                    in GEOM_Object theVec,
1719                                    in double theR);
1720     /*!
1721      *  Create a circle, passing through three given points
1722      *  \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1723      *  \return New GEOM_Object, containing the created circle.
1724      */
1725     GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
1726                                     in GEOM_Object thePnt2,
1727                                     in GEOM_Object thePnt3);
1728
1729     /*!
1730      *  Create an ellipse with given center, normal vector and radiuses.
1731      *  \param thePnt Ellipse center.
1732      *  \param theVec Vector, normal to the plane of the ellipse.
1733      *  \param theRMajor Major ellipse radius.
1734      *  \param theRMinor Minor ellipse radius.
1735      *  \return New GEOM_Object, containing the created ellipse.
1736      */
1737     GEOM_Object MakeEllipse (in GEOM_Object thePnt,
1738                              in GEOM_Object theVec,
1739                              in double theRMajor,
1740                              in double theRMinor);
1741
1742     /*!
1743      *  Create an arc of circle, passing through three given points.
1744      *  \param thePnt1 Start point of the arc.
1745      *  \param thePnt2 Middle point of the arc.
1746      *  \param thePnt3 End point of the arc.
1747      *  \return New GEOM_Object, containing the created arc.
1748      */
1749     GEOM_Object MakeArc (in GEOM_Object thePnt1,
1750                          in GEOM_Object thePnt2,
1751                          in GEOM_Object thePnt3);
1752
1753     /*!
1754      *  Create an arc of circle of center C from one point to another
1755      *  \param theCenter Center point of the arc.
1756      *  \param thePnt1 Start point of the arc.
1757      *  \param thePnt2 End point of the arc.
1758      *  \param theSense Orientation of the arc
1759      *  \return New GEOM_Object, containing the created arc.
1760      */
1761     GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
1762                                in GEOM_Object thePnt1,
1763                                in GEOM_Object thePnt2,
1764                                in boolean theSense);
1765
1766
1767     /*!
1768      *  Create a polyline on the set of points.
1769      *  \param thePoints Sequence of points for the polyline.
1770      *  \return New GEOM_Object, containing the created polyline.
1771      */
1772     GEOM_Object MakePolyline (in ListOfGO thePoints);
1773
1774     /*!
1775      *  Create bezier curve on the set of points.
1776      *  \param thePoints Sequence of points for the bezier curve.
1777      *  \return New GEOM_Object, containing the created bezier curve.
1778      */
1779     GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
1780
1781     /*!
1782      *  Create B-Spline curve on the set of points.
1783      *  \param thePoints Sequence of points for the B-Spline curve.
1784      *  \return New GEOM_Object, containing the created B-Spline curve.
1785      */
1786     GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints);
1787
1788     /*!
1789      *  Create a sketcher (wire or face), following the textual description,
1790      *  passed through \a theCommand argument. \n
1791      *  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
1792      *  Format of the description string have to be the following:
1793      *
1794      *  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
1795      *
1796      *  Where:
1797      *  - x1, y1 are coordinates of the first sketcher point (zero by default),
1798      *  - CMD is one of
1799      *     - "R angle" : Set the direction by angle
1800      *     - "D dx dy" : Set the direction by DX & DY
1801      *     .
1802      *       \n
1803      *     - "TT x y" : Create segment by point at X & Y
1804      *     - "T dx dy" : Create segment by point with DX & DY
1805      *     - "L length" : Create segment by direction & Length
1806      *     - "IX x" : Create segment by direction & Intersect. X
1807      *     - "IY y" : Create segment by direction & Intersect. Y
1808      *     .
1809      *       \n
1810      *     - "C radius length" : Create arc by direction, radius and length(in degree)
1811      *     .
1812      *       \n
1813      *     - "WW" : Close Wire (to finish)
1814      *     - "WF" : Close Wire and build face (to finish)
1815      *
1816      *  \param theCommand String, defining the sketcher in local
1817      *                    coordinates of the working plane.
1818      *  \param theWorkingPlane Nine double values, defining origin,
1819      *                         OZ and OX directions of the working plane.
1820      *  \return New GEOM_Object, containing the created wire.
1821      */
1822     GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
1823
1824       /*!
1825      *  Create a sketcher (wire or face), following the textual description,
1826      *  passed through \a theCommand argument. \n
1827      *  For format of the description string see the previous method.\n
1828      *  \param theCommand String, defining the sketcher in local
1829      *                    coordinates of the working plane.
1830      *  \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
1831      *  \return New GEOM_Object, containing the created wire.
1832      */
1833     GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
1834   };
1835
1836   /*!
1837    *  GEOM_ILocalOperations: Interface for fillet and chamfer creation.
1838    */
1839   interface GEOM_ILocalOperations : GEOM_IOperations
1840   {
1841     /*!
1842      *  Perform a fillet on all edges of the given shape.
1843      *  \param theShape Shape, to perform fillet on.
1844      *  \param theR Fillet radius.
1845      *  \return New GEOM_Object, containing the result shape.
1846      */
1847     GEOM_Object MakeFilletAll (in GEOM_Object theShape,
1848                                in double      theR);
1849
1850     /*!
1851      *  Perform a fillet on the specified edges of the given shape
1852      *  \param theShape Shape, to perform fillet on.
1853      *  \param theR Fillet radius.
1854      *  \param theEdges Global indices of edges to perform fillet on.
1855      *    \note Global index of sub-shape can be obtained, using method
1856      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1857      *  \return New GEOM_Object, containing the result shape.
1858      */
1859     GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
1860                                  in double      theR,
1861                                  in ListOfLong  theEdges);
1862
1863     /*!
1864      *  Perform a fillet on all edges of the specified faces of the given shape.
1865      *  \param theShape Shape, to perform fillet on.
1866      *  \param theR Fillet radius.
1867      *  \param theFaces Global indices of faces to perform fillet on.
1868      *    \note Global index of sub-shape can be obtained, using method
1869      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1870      *  \return New GEOM_Object, containing the result shape.
1871      */
1872     GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
1873                                  in double      theR,
1874                                  in ListOfLong  theFaces);
1875
1876     /*!
1877      *  Perform a symmetric chamfer on all edges of the given shape.
1878      *  \param theShape Shape, to perform chamfer on.
1879      *  \param theD Chamfer size along each face.
1880      *  \return New GEOM_Object, containing the result shape.
1881      */
1882     GEOM_Object MakeChamferAll (in GEOM_Object theShape,
1883                                 in double      theD);
1884
1885     /*!
1886      *  Perform a chamfer on edges, common to the specified faces.
1887      *  with distance D1 on the Face1
1888      *  \param theShape Shape, to perform chamfer on.
1889      *  \param theD1 Chamfer size along \a theFace1.
1890      *  \param theD2 Chamfer size along \a theFace2.
1891      *  \param theFace1,theFace2 Global indices of two faces of \a theShape.
1892      *    \note Global index of sub-shape can be obtained, using method
1893      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1894      *  \return New GEOM_Object, containing the result shape.
1895      */
1896     GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
1897                                  in double theD1, in double theD2,
1898                                  in long theFace1, in long theFace2);
1899
1900     /*!
1901      *  Perform a chamfer on all edges of the specified faces.
1902      *  with distance D1 on the first specified face (if several for one edge)
1903      *  \param theShape Shape, to perform chamfer on.
1904      *  \param theD1 Chamfer size along face from \a theFaces. If both faces,
1905      *               connected to the edge, are in \a theFaces, \a theD1
1906      *               will be get along face, which is nearer to \a theFaces beginning.
1907      *  \param theD2 Chamfer size along another of two faces, connected to the edge.
1908      *  \param theFaces Sequence of global indices of faces of \a theShape.
1909      *    \note Global index of sub-shape can be obtained, using method
1910      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1911      *  \return New GEOM_Object, containing the result shape.
1912      */
1913     GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
1914                                   in double theD1, in double theD2,
1915                                   in ListOfLong theFaces);
1916
1917     /*!
1918      *  Perform an Archimde operation on the given shape with given parameters.
1919      *                    The object presenting the resulting face is returned
1920      *  \param theShape Shape to be put in water.
1921      *  \param theWeight Weight og the shape.
1922      *  \param theWaterDensity Density of the water.
1923      *  \param theMeshDeflection Deflection od the mesh, using to compute the section.
1924      *  \return New GEOM_Object, containing a section of \a theShape
1925      *          by a plane, corresponding to water level.
1926      */
1927     GEOM_Object MakeArchimede (in GEOM_Object theShape,
1928                                in double theWeight,
1929                                in double theWaterDensity,
1930                                in double theMeshDeflection);
1931
1932     /*!
1933      *  Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1934      *  Present here only for compatibility.
1935      */
1936     long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
1937   };
1938
1939   /*!
1940    *  GEOM_IHealingOperations: Interface for shape healing operations.
1941    *  Shape Processing, SuppressFaces, etc.
1942    */
1943   interface GEOM_IHealingOperations : GEOM_IOperations
1944   {
1945     /*!
1946      *  Apply a sequence of Shape Healing operators to the given object.
1947      *  \param theShapes Shape to be processed.
1948      *  \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1949      *  \param theParameters List of names of parameters
1950      *                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1951      *  \param theValues List of values of parameters, in the same order
1952      *                    as parameters are listed in \a theParameters list.
1953      *  \return New GEOM_Object, containing processed shape.
1954      */
1955     GEOM_Object ProcessShape (in GEOM_Object theShapes,
1956                               in string_array theOperators,
1957                               in string_array theParameters,
1958                               in string_array theValues);
1959
1960     /*!
1961      *  Get default sequence of operators, their parameters and parameters' values
1962      *  of Shape Process operation. In the current implementation the defaults are
1963      *  read from the file pointed by CSF_ShHealingDefaults environmental variable.
1964      *  \param theOperators Output. Default list of names of operators.
1965      *  \param theParameters Output. Default list of names of parameters.
1966      *  \param theValues Output. List of default values of parameters, in the same order
1967      *                           as parameters are listed in \a theParameters list.
1968      */
1969     void GetShapeProcessParameters (out string_array theOperators,
1970                                     out string_array theParameters,
1971                                     out string_array theValues);
1972     /*!
1973      *  Get parameters and parameters' values for the given Shape Process operation.
1974      *  In the current implementation the defaults are
1975      *  read from the file pointed by CSF_ShHealingDefaults environmental variable.
1976      *  \param theOperator Input. The operator's name.
1977      *  \param theParameters Output. Default list of names of parameters.
1978      *  \param theValues Output. List of default values of parameters, in the same order
1979      *                           as parameters are listed in \a theParameters list.
1980      */
1981     void GetOperatorParameters (in string theOperator,
1982                                 out string_array theParameters,
1983                                 out string_array theValues);
1984
1985     /*!
1986      *  Remove faces from the given object (shape).
1987      *  \param theObject Shape to be processed.
1988      *  \param theFaces Indices of faces to be removed, if EMPTY then the method
1989      *                  removes ALL faces of the given object.
1990      *  \return New GEOM_Object, containing processed shape.
1991      */
1992     GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
1993
1994     /*!
1995      *  Close an open wire.
1996      *  \param theObject Shape to be processed.
1997      *  \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1998      *                  if -1, then theObject itself is a wire.
1999      *  \param isCommonVertex If TRUE : closure by creation of a common vertex,
2000      *                        If FALS : closure by creation of an edge between ends.
2001      *  \return New GEOM_Object, containing processed shape.
2002      */
2003     GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2004                               in boolean isCommonVertex);
2005
2006     /*!
2007      *  Remove internal wires and edges from the given object (face).
2008      *  \param theObject Shape to be processed.
2009      *  \param theWires Indices of wires to be removed, if EMPTY then the method
2010      *                  removes ALL internal wires of the given object.
2011      *  \return New GEOM_Object, containing processed shape.
2012      */
2013     GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2014
2015     /*!
2016      *  Remove internal closed contours (holes) from the given object.
2017      *  \param theObject Shape to be processed.
2018      *  \param theWires Indices of wires to be removed, if EMPTY then the method
2019      *                  removes ALL internal holes of the given object
2020      *  \return New GEOM_Object, containing processed shape.
2021      */
2022     GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2023
2024     /*!
2025      *  Sewing of the given object.
2026      *  \param theObject Shape to be processed.
2027      *  \param theTolerance Required tolerance value.
2028      *  \return New GEOM_Object, containing processed shape.
2029      */
2030     GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2031
2032     /*!
2033      *  Addition of a point to a given edge object.
2034      *  \param theObject Shape to be processed.
2035      *  \param theEdgeIndex Index of edge to be divided within theObject's shape,
2036      *                      if -1, then theObject itself is the edge.
2037      *  \param theValue Value of parameter on edge or length parameter,
2038      *                  depending on \a isByParameter.
2039      *  \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2040      *                       if FALSE : \a theValue is treated as a length parameter [0..1]
2041      *  \return New GEOM_Object, containing processed shape.
2042      */
2043     GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2044                             in double theValue, in boolean isByParameter);
2045
2046     /*!
2047      *  Get a list of wires (wrapped in GEOM_Object-s),
2048      *  that constitute a free boundary of the given shape.
2049      *  \param theObject Shape to get free boundary of.
2050      *  \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2051      *  \param theOpenWires Output. Open wires on the free boundary of the given shape.
2052      *  \return FALSE, if an error(s) occured during the method execution.
2053      */
2054     boolean GetFreeBoundary (in GEOM_Object theObject,
2055                              out ListOfGO theClosedWires,
2056                              out ListOfGO theOpenWires);
2057
2058     /*!
2059      *  Change orientation of the given object.
2060      *  \param theObject Shape to be processed.
2061      *  \return New GEOM_Object, containing processed shape.
2062      */
2063     GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2064     GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2065
2066   };
2067
2068   /*!
2069    *  GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2070    *
2071    */
2072   interface GEOM_IInsertOperations : GEOM_IOperations
2073   {
2074     /*!
2075      *  Create a copy of the given object
2076      */
2077     GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2078
2079     /*!
2080      *  Export the given shape into a file with given name.
2081      *  \param theObject Shape to be stored in the file.
2082      *  \param theFileName Name of the file to store the given shape in.
2083      *  \param theFormatName Specify format for the shape storage.
2084      *         Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2085      */
2086     void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2087
2088     /*!
2089      *  Import a shape from the BRep or IGES or STEP file
2090      *  (depends on given format) with given name.
2091      *  \param theFileName The file, containing the shape.
2092      *  \param theFormatName Specify format for the file reading.
2093      *         Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2094      *  \return New GEOM_Object, containing the imported shape.
2095      */
2096     GEOM_Object Import (in string theFileName, in string theFormatName);
2097
2098     /*!
2099      *  Get the supported import formats and corresponding patterns for File dialog.
2100      *  \param theFormats Output. List of formats, available for import.
2101      *  \param thePatterns Output. List of file patterns, corresponding to available formats.
2102      *  \return Returns available formats and patterns through the arguments.
2103      */
2104     void ImportTranslators (out string_array theFormats,
2105                             out string_array thePatterns);
2106
2107     /*!
2108      *  Get the supported export formats and corresponding patterns for File dialog.
2109      *  \param theFormats Output. List of formats, available for export.
2110      *  \param thePatterns Output. List of file patterns, corresponding to available formats.
2111      *  \return Returns available formats and patterns through the arguments.
2112      */
2113     void ExportTranslators (out string_array theFormats,
2114                             out string_array thePatterns);
2115   };
2116
2117   /*!
2118    *  GEOM_IKindOfShape: namespace for shape_kind enumeration.
2119    */
2120   interface GEOM_IKindOfShape
2121   {
2122     enum shape_kind {
2123       NO_SHAPE,
2124       // COMPOSITEs
2125       COMPOUND,
2126       COMPSOLID,
2127       SHELL,
2128       WIRE,
2129       // SOLIDs
2130       SPHERE,
2131       CYLINDER,
2132       BOX,
2133       ROTATED_BOX,
2134       TORUS,
2135       CONE,
2136       POLYHEDRON,
2137       SOLID,
2138       // FACEs
2139       SPHERE2D,
2140       CYLINDER2D,
2141       TORUS2D,
2142       CONE2D,
2143       DISK,
2144       ELLIPSE2D,
2145       POLYGON,
2146       PLANAR,
2147       FACE,
2148       // EDGEs
2149       CIRCLE,
2150       ARC,
2151       ELLIPSE,
2152       ARC_ELLIPSE,
2153       LINE, // infinite segment
2154       SEGMENT,
2155       EDGE,
2156       // VERTEX
2157       VERTEX
2158     };
2159   };
2160
2161
2162   /*!
2163    *  GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
2164    *  properties calculation (like Centre of Mass, Inertia, etc.).
2165    *
2166    */
2167   interface GEOM_IMeasureOperations : GEOM_IOperations
2168   {
2169     /*!
2170      *  Get kind of theShape.
2171      *  \param theShape Shape to get a kind of.
2172      *  \param theIntegers Output. Integer and enumerated shape's parameters
2173      *                     (kind of surface, closed/unclosed, number of edges, etc.)
2174      *  \param theDoubles  Output. Double shape's parameters (coordinates, dimensions, etc.)
2175      *  \note  Concrete meaning of each value, returned via \a theIntegers
2176      *         or \a theDoubles list depends on the kind of the shape.
2177      *  \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
2178      */
2179     //short KindOfShape (in GEOM_Object   theShape,
2180     GEOM_IKindOfShape::shape_kind KindOfShape (in  GEOM_Object  theShape,
2181                                                out ListOfLong   theIntegers,
2182                                                out ListOfDouble theDoubles);
2183
2184     /*!
2185      *  Get position (LCS) of theShape.
2186      *  \param theShape Shape to calculate position of.
2187      *  \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
2188      *                  Origin of the LCS is situated at the shape's center of mass.
2189      *  \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
2190      *  \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
2191      *                  Axes of the LCS are obtained from shape's location or,
2192      *                  if the shape is a planar face, from position of its plane.
2193      *  \return Returns position of the shape through the last nine arguments.
2194      */
2195     void GetPosition (in GEOM_Object theShape,
2196                       out double Ox, out double Oy, out double Oz,
2197                       out double Zx, out double Zy, out double Zz,
2198                       out double Xx, out double Xy, out double Xz);
2199
2200     /*!
2201      *  Get summarized length of all wires,
2202      *  area of surface and volume of the given shape.
2203      *  \param theShape Shape to define properties of.
2204      *  \param theLength Output. Summarized length of all wires of the given shape.
2205      *  \param theSurfArea Output. Area of surface of the given shape.
2206      *  \param theVolume Output. Volume of the given shape.
2207      *  \return Returns shape properties through the last three arguments.
2208      */
2209     void GetBasicProperties (in GEOM_Object theShape,
2210                              out double theLength,
2211                              out double theSurfArea,
2212                              out double theVolume);
2213
2214     /*!
2215      *  Get a point, situated at the centre of mass of theShape.
2216      *  \param theShape Shape to define centre of mass of.
2217      *  \return New GEOM_Object, containing the created point.
2218      */
2219     GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
2220
2221     /*!
2222      *  Get inertia matrix and moments of inertia of theShape.
2223      *  \param theShape Shape to calculate inertia of.
2224      *  \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
2225      *  \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
2226      *  \return Returns inertia through the last twelve arguments.
2227      */
2228     void GetInertia (in GEOM_Object theShape,
2229                      out double I11, out double I12, out double I13,
2230                      out double I21, out double I22, out double I23,
2231                      out double I31, out double I32, out double I33,
2232                      out double Ix , out double Iy , out double Iz);
2233
2234     /*!
2235      *  Get parameters of bounding box of the given shape
2236      *  \param theShape Shape to obtain bounding box of.
2237      *  \param Xmin,Xmax Output. Limits of shape along OX axis.
2238      *  \param Ymin,Ymax Output. Limits of shape along OY axis.
2239      *  \param Zmin,Zmax Output. Limits of shape along OZ axis.
2240      *  \return Returns parameters of bounding box through the last six arguments.
2241      */
2242     void GetBoundingBox (in GEOM_Object theShape,
2243                          out double Xmin, out double Xmax,
2244                          out double Ymin, out double Ymax,
2245                          out double Zmin, out double Zmax);
2246
2247     /*!
2248      *  Get min and max tolerances of sub-shapes of theShape
2249      *  \param theShape Shape, to get tolerances of.
2250      *  \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
2251      *  \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
2252      *  \param VertMin,VertMax Output. Min and max tolerances of the vertices.
2253      *  \return Returns shape tolerances through the last six arguments.
2254      */
2255     void GetTolerance (in GEOM_Object theShape,
2256                        out double FaceMin, out double FaceMax,
2257                        out double EdgeMin, out double EdgeMax,
2258                        out double VertMin, out double VertMax);
2259
2260     /*!
2261      *  Check a topology of the given shape.
2262      *  \param theShape Shape to check validity of.
2263      *  \param theDescription Output. Description of problems in the shape, if they are.
2264      *  \return TRUE, if the shape "seems to be valid" from the topological point of view.
2265      */
2266     boolean CheckShape (in GEOM_Object theShape,
2267                         out string     theDescription);
2268
2269     /*!
2270      *  Check a topology and a geometry of the given shape.
2271      *  \param theShape Shape to check validity of.
2272      *  \param theDescription Output. Description of problems in the shape, if they are.
2273      *  \return TRUE, if the shape "seems to be valid".
2274      */
2275     boolean CheckShapeWithGeometry (in GEOM_Object theShape,
2276                                     out string     theDescription);
2277
2278     /*!
2279      *  Obtain description of the given shape
2280      *  \param theShape Shape to be described.
2281      *  \return Description of the given shape.
2282      */
2283     string WhatIs (in GEOM_Object theShape);
2284
2285     /*!
2286      *  Get minimal distance between the given shapes.
2287      *  \param theShape1,theShape2 Shapes to find minimal distance between.
2288      *  \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
2289      *  \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
2290      *  \return Value of the minimal distance between the given shapes.
2291      */
2292     double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
2293                            out double X1, out double Y1, out double Z1,
2294                            out double X2, out double Y2, out double Z2);
2295
2296
2297     /*!
2298      *  Get point coordinates
2299      */
2300     void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
2301   };
2302
2303
2304   /*!
2305    *  GEOM_IGroupOperations: Interface for groups creation.
2306    */
2307   interface GEOM_IGroupOperations : GEOM_IOperations
2308   {
2309     /*!
2310      *  Creates a new group which will store  sub shapes of theMainShape
2311      *  \param theMainShape is a GEOM object on which the group is selected
2312      *  \param theShapeType defines a shape type of the group
2313      *  \return a newly created GEOM group
2314      */
2315     GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
2316
2317     /*!
2318      *  Adds a sub object with ID theSubShapeId to the group
2319      *  \param theGroup is a GEOM group to which the new sub shape is added
2320      *  \param theSubShapeId is a sub shape ID in the main object.
2321      *  \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
2322      */
2323     void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
2324
2325     /*!
2326      *  Removes a sub object with ID \a theSubShapeId from the group
2327      *  \param theGroup is a GEOM group from which the sub shape is removed.
2328      *  \param theSubShapeId is a sub shape ID in the main object.
2329      *  \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
2330      */
2331     void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
2332
2333     /*!
2334      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2335      *  \param theGroup is a GEOM group to which the new sub shapes are added.
2336      *  \param theSubShapes is a list of sub shapes to be added.
2337      */
2338     void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2339
2340     /*!
2341      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
2342      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
2343      *  \param theSubShapes is a list of sub-shapes to be removed.
2344      */
2345     void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2346
2347     /*!
2348      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2349      *  \param theGroup is a GEOM group to which the new sub shapes are added.
2350      *  \param theSubShapes is a list of IDs of sub shapes to be added.
2351      */
2352     void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2353
2354     /*!
2355      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
2356      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
2357      *  \param theSubShapes is a list of IDs of sub-shapes to be removed.
2358      */
2359     void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2360
2361     /*!
2362      *  Returns a type of sub objects stored in the group
2363      *  \param theGroup is a GEOM group which type is returned.
2364      */
2365     long GetType (in GEOM_Object theGroup);
2366
2367     /*!
2368      *  Returns a main shape associated with the group
2369      *  \param theGroup is a GEOM group for which a main shape object is requested
2370      *  \return a GEOM object which is a main shape for theGroup
2371      */
2372     GEOM_Object GetMainShape (in GEOM_Object theGroup);
2373
2374     /*!
2375      *  Returns a list of sub objects ID stored in the group
2376      *  \param theGroup is a GEOM group for which a list of IDs is requested
2377      */
2378     ListOfLong GetObjects (in GEOM_Object theGroup);
2379   };
2380
2381
2382   /*!
2383    *  GEOM_Gen: Interface to access other GEOM interfaces.
2384    *  Also contains some methods to access and manage GEOM objects.
2385    */
2386   interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
2387   {
2388     /*!
2389      *  Undo/Redo Management
2390      */
2391
2392     void Undo (in long theStudyID);
2393
2394     void Redo (in long theStudyID);
2395
2396     /*!
2397      * Publishing manangement
2398      * Adds in theStudy a object theObject under with a name theName,
2399      * if theFather is not NULL the object is placed under thFather's SObject.
2400      * Returns a SObject where theObject is placed
2401      */
2402     SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
2403                                   in GEOM_Object theObject,
2404                                   in string theName,
2405                                   in GEOM_Object theFather);
2406
2407     /*!
2408      *  Methods to access interfaces for objects creation and transformation
2409      */
2410     GEOM_IBasicOperations     GetIBasicOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2411     GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
2412     GEOM_I3DPrimOperations    GetI3DPrimOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2413     GEOM_IShapesOperations    GetIShapesOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2414     GEOM_IBooleanOperations   GetIBooleanOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2415     GEOM_ICurvesOperations    GetICurvesOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2416     GEOM_ILocalOperations     GetILocalOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2417     GEOM_IHealingOperations   GetIHealingOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2418     GEOM_IInsertOperations    GetIInsertOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2419     GEOM_IMeasureOperations   GetIMeasureOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2420     GEOM_IBlocksOperations    GetIBlocksOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2421     GEOM_IGroupOperations     GetIGroupOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2422
2423     /*!
2424      *  Objects Management
2425      */
2426
2427     /*!
2428      *  Removes the object from the GEOM component
2429      *  \param theObject is a GEOM object to be removed
2430      */
2431     void RemoveObject (in GEOM_Object theObject);
2432
2433     /*!
2434      *  Returns an object defined by the study and its entry in the GEOM component
2435      *  \param theStudyID is a SALOMEDS Study ID
2436      *  \param theEntry is an entry of the requested GEOM object in the GEOM component
2437      *  \note if the object has not previously been created a NULL GEOM object is returned
2438      */
2439     GEOM_Object GetObject (in long theStudyID, in string theEntry);
2440
2441     /*!
2442      *  Add a sub shape defined by indices in \a theIndices
2443      *  (contains unique IDs of sub shapes inside theMainShape)
2444      *  \note The sub shape GEOM_Objects can has ONLY ONE function.
2445      *        Don't try to apply modification operations on them.
2446      *  \note Internal method
2447      */
2448     GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
2449
2450     /*!
2451      *  GEOM object's IOR Management
2452      */
2453
2454     /*!
2455      *  Returns a GEOM Object defined by its IOR
2456      *  \param theIOR a string containg an IOR of the requested GEOM object
2457      */
2458     GEOM_Object GetIORFromString (in string theIOR);
2459
2460     /*!
2461      *  Returns a string which contains an IOR of the GEOM object
2462      *  \param theObject is a GEOM object which IOR is requested
2463      */
2464     string GetStringFromIOR (in GEOM_Object theObject);
2465
2466     /*!
2467      *  Returns a name with which a GEOM object was dumped into python script
2468      *  \param theStudyEntry is an entry of the GEOM object in the study
2469      */
2470     string GetDumpName (in string theStudyEntry);
2471
2472     /*!
2473      *  Returns all names with which a GEOM objects was dumped
2474      *  into python script to avoid the same names in SMESH script
2475      */
2476     string_array GetAllDumpNames();
2477   };
2478 };
2479
2480 #endif