]> SALOME platform Git repositories - modules/geom.git/blob - idl/GEOM_Gen.idl
Salome HOME
Fix for bug PAL11017 ( Can't select subshapes in the tree to create groups ).
[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/
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 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      *  Create a vector with the given components.
269      *  \param theDX X component of the vector.
270      *  \param theDY Y component of the vector.
271      *  \param theDZ Z component of the vector.
272      *  \return New GEOM_Object, containing the created vector.
273      */
274     GEOM_Object MakeVectorDXDYDZ (in double theDX,
275                                   in double theDY,
276                                   in double theDZ);
277
278     /*!
279      *  Create a vector between two points.
280      *  \param thePnt1 Start point for the vector.
281      *  \param thePnt2 End point for the vector.
282      *  \return New GEOM_Object, containing the created vector.
283      */
284     GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
285
286     /*!
287      *  Create a line, passing through the given point
288      *  and parrallel to the given direction
289      *  \param thePnt Point. The resulting line will pass through it.
290      *  \param theDir Direction. The resulting line will be parallel to it.
291      *  \return New GEOM_Object, containing the created line.
292      */
293     GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
294
295     /*!
296      *  Create a line, passing through the given points
297      *  \param thePnt1 First of two points, defining the line.
298      *  \param thePnt2 Second of two points, defining the line.
299      *  \return New GEOM_Object, containing the created line.
300      */
301     GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
302
303     /*!
304      *  Create a plane, passing through the three given points
305      *  \param thePnt1 First of three points, defining the plane.
306      *  \param thePnt2 Second of three points, defining the plane.
307      *  \param thePnt3 Fird of three points, defining the plane.
308      *  \param theTrimSize Half size of a side of quadrangle face, representing the plane.
309      *  \return New GEOM_Object, containing the created plane.
310      */
311     GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
312                                    in GEOM_Object thePnt2,
313                                    in GEOM_Object thePnt3,
314                                    in double theTrimSize);
315
316     /*!
317      *  Create a plane, passing through the given point
318      *  and normal to the given vector.
319      *  \param thePnt Point, the plane has to pass through.
320      *  \param theVec Vector, defining the plane normal direction.
321      *  \param theTrimSize Half size of a side of quadrangle face, representing the plane.
322      *  \return New GEOM_Object, containing the created plane.
323      */
324     GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
325                                  in GEOM_Object theVec,
326                                  in double theTrimSize);
327
328     /*!
329      *  Create a plane, similar to the existing one, but with another size of representing face.
330      *  \param theFace Referenced plane.
331      *  \param theTrimSize New half size of a side of quadrangle face, representing the plane.
332      *  \return New GEOM_Object, containing the created plane.
333      */
334     GEOM_Object MakePlaneFace (in GEOM_Object theFace,
335                                in double theTrimSize);
336
337     /*!
338      *  Create a local coordinate system.
339      *  \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
340      *  \param theXDX,theXDY,theXDZ Three components of OX direction
341      *  \param theYDX,theYDY,theYDZ Three components of OY direction
342      *  \return New GEOM_Object, containing the created coordinate system.
343      */
344     GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
345                             in double theXDX, in double theXDY, in double theXDZ,
346                             in double theYDX, in double theYDY, in double theYDZ);
347   };
348
349   interface GEOM_ITransformOperations : GEOM_IOperations
350   {
351     /*!
352      *  Translate the given object along the vector, specified by its end points.
353      *  \param theObject The object to be translated.
354      *  \param thePoint1 Start point of translation vector.
355      *  \param thePoint2 End point of translation vector.
356      *  \return theObject.
357      */
358     GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
359                                     in GEOM_Object thePoint1,
360                                     in GEOM_Object thePoint2);
361
362     /*!
363      *  Translate the given object along the vector, specified
364      *  by its end points, creating its copy before the translation.
365      *  \param theObject The object to be translated.
366      *  \param thePoint1 Start point of translation vector.
367      *  \param thePoint2 End point of translation vector.
368      *  \return New GEOM_Object, containing the translated object.
369      */
370     GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
371                                         in GEOM_Object thePoint1,
372                                         in GEOM_Object thePoint2);
373
374     /*!
375      *  Translate the given object along the vector, specified by its components.
376      *  \param theObject The object to be translated.
377      *  \param theDX,theDY,theDZ Components of translation vector.
378      *  \return theObject.
379      */
380     GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
381                                  in double theDX, in double theDY, in double theDZ);
382
383     /*!
384      *  Translate the given object along the vector, specified
385      *  by its components, creating its copy before the translation.
386      *  \param theObject The object to be translated.
387      *  \param theDX,theDY,theDZ Components of translation vector.
388      *  \return New GEOM_Object, containing the translated object.
389      */
390     GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
391                                      in double theDX, in double theDY, in double theDZ);
392
393
394     /*!
395      *  Translate the given object along the given vector.
396      *  \param theObject The object to be translated.
397      *  \param theVector Translation vector, giving both direction and distance.
398      *  \return theObject.
399      */
400     GEOM_Object TranslateVector (in GEOM_Object theObject,
401                                  in GEOM_Object theVector);
402
403     /*!
404      *  Translate the given object along the given vector,
405      *  creating its copy before the translation.
406      *  \param theObject The object to be translated.
407      *  \param theVector Translation vector, giving both direction and distance.
408      *  \return New GEOM_Object, containing the translated object.
409      */
410     GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
411                                      in GEOM_Object theVector);
412
413     /*!
414      *  Translate the given object along the given vector a given number times
415      *  \param theObject The object to be translated.
416      *  \param theVector Direction of the translation.
417      *  \param theStep Distance to translate on.
418      *  \param theNbTimes Quantity of translations to be done.
419      *  \return New GEOM_Object, containing compound of all
420      *          the shapes, obtained after each translation.
421      */
422     GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
423                                   in GEOM_Object theVector,
424                                   in double theStep,
425                                   in long theNbTimes);
426
427     /*!
428      *  Conseqently apply two specified translations to theObject specified number of times.
429      *  \param theObject The object to be translated.
430      *  \param theVector1 Direction of the first translation.
431      *  \param theStep1 Step of the first translation.
432      *  \param theNbTimes1 Quantity of translations to be done along theVector1.
433      *  \param theVector2 Direction of the second translation.
434      *  \param theStep2 Step of the second translation.
435      *  \param theNbTimes2 Quantity of translations to be done along theVector2.
436      *  \return New GEOM_Object, containing compound of all
437      *          the shapes, obtained after each translation.
438      */
439     GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
440                                   in GEOM_Object theVector1,
441                                   in double theStep1,
442                                   in long theNbTimes1,
443                                   in GEOM_Object theVector2,
444                                   in double theStep2,
445                                   in long theNbTimes2);
446
447     /*!
448      *  Rotate the given object around the given axis on the given angle.
449      *  \param theObject The object to be rotated.
450      *  \param theAxis Rotation axis.
451      *  \param theAngle Rotation angle in radians.
452      *  \return theObject.
453      */
454     GEOM_Object Rotate (in GEOM_Object theObject,
455                         in GEOM_Object theAxis,
456                         in double theAngle);
457
458     /*!
459      *  Rotate the given object around the given axis
460      *  on the given angle, creating its copy before the rotatation.
461      *  \param theObject The object to be rotated.
462      *  \param theAxis Rotation axis.
463      *  \param theAngle Rotation angle in radians.
464      *  \return New GEOM_Object, containing the rotated object.
465      */
466     GEOM_Object RotateCopy (in GEOM_Object theObject,
467                             in GEOM_Object theAxis,
468                             in double theAngle);
469
470     /*!
471      *  Rotate the given object around the given axis a given number times.
472      *  Rotation angle will be 2*PI/theNbTimes.
473      *  \param theObject The object to be rotated.
474      *  \param theAxis The rotation axis.
475      *  \param theNbTimes Quantity of rotations to be done.
476      *  \return New GEOM_Object, containing compound of all the
477      *          shapes, obtained after each rotation.
478      */
479     GEOM_Object MultiRotate1D (in GEOM_Object theObject,
480                                in GEOM_Object theAxis,
481                                in long theNbTimes);
482
483     /*!
484      *  Rotate the given object around the
485      *  given axis on the given angle a given number
486      *  times and multi-translate each rotation result.
487      *  Translation direction passes through center of gravity
488      *  of rotated shape and its projection on the rotation axis.
489      *  \param theObject The object to be rotated.
490      *  \param theAxis Rotation axis.
491      *  \param theAngle Rotation angle in graduces.
492      *  \param theNbTimes1 Quantity of rotations to be done.
493      *  \param theStep Translation distance.
494      *  \param theNbTimes2 Quantity of translations to be done.
495      *  \return New GEOM_Object, containing compound of all the
496      *          shapes, obtained after each transformation.
497      */
498     GEOM_Object MultiRotate2D (in GEOM_Object theObject,
499                                in GEOM_Object theAxis,
500                                in double theAngle,
501                                in long theNbTimes1,
502                                in double theStep,
503                                in long theNbTimes2);
504
505     /*!
506      *  Replace the given object by an object,
507      *  symmetrical to it relatively the given plane.
508      *  \param theObject The object to be mirrored.
509      *  \param thePlane Plane of symmetry.
510      */
511     GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
512
513     /*!
514      *  Create an object, symmetrical
515      *  to the given one relatively the given plane.
516      *  \param theObject The object to be mirrored.
517      *  \param thePlane Plane of symmetry.
518      *  \return New GEOM_Object, containing the mirrored shape.
519      */
520     GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
521
522     /*!
523      *  Replace the given object by an object,
524      *  symmetrical to it relatively the given axis.
525      *  \param theObject The object to be mirrored.
526      *  \param theAxis Axis of symmetry.
527      *  \return theObject.
528      */
529     GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
530
531     /*!
532      *  Create an object, symmetrical
533      *  to the given one relatively the given axis.
534      *  \param theObject The object to be mirrored.
535      *  \param theAxis Axis of symmetry.
536      *  \return New GEOM_Object, containing the mirrored object.
537      */
538     GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
539
540     /*!
541      *  Replace the given object by an object, symmetrical to it relatively the given point.
542      *  \param theObject The object to be mirrored.
543      *  \param thePoint Point of symmetry.
544      *  \return theObject.
545      */
546     GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
547
548     /*!
549      *  Create an object, symmetrical to the given one relatively the given point.
550      *  \param theObject The object to be mirrored.
551      *  \param thePoint Point of symmetry.
552      *  \return New GEOM_Object, containing the mirrored object.
553      */
554     GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
555
556     /*!
557      *  Replace the given object by its offset.
558      *  \param theObject The base object for the offset.
559      *  \param theOffset Offset value.
560      *  \return theObject.
561      */
562     GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
563
564     /*!
565      *  Create new object as offset of the given one.
566      *  \param theObject The base object for the offset.
567      *  \param theOffset Offset value.
568      *  \return New GEOM_Object, containing the offset object.
569      */
570     GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
571
572     /*!
573      *  Scale the given object by the factor.
574      *  \param theObject The object to be scaled.
575      *  \param thePoint Center point for scaling.
576      *  \param theFactor Scaling factor value.
577      *  \return theObject.
578      */
579     GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
580                             in double theFactor);
581
582     /*!
583      *  Scale the given object by the factor, creating its copy before the scaling.
584      *  \param theObject The object to be scaled.
585      *  \param thePoint Center point for scaling.
586      *  \param theFactor Scaling factor value.
587      *  \return New GEOM_Object, containing the scaled shape.
588      */
589     GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
590                                 in double theFactor);
591
592     /*!
593      *  Modify the Location of the given object by LCS
594      */
595     GEOM_Object PositionShape (in GEOM_Object theObject,
596                                in GEOM_Object theStartLCS,
597                                in GEOM_Object theEndLCS);
598
599     /*!
600      *  Modify the Location of the given object by LCS
601      *  creating its copy before the setting
602      */
603     GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
604                                    in GEOM_Object theStartLCS,
605                                    in GEOM_Object theEndLCS);
606   };
607
608   /*!
609    *  GEOM_I3DPrimOperations: Interface for 3D primitives creation
610    *  Box, Cylinder, Cone, Sphere, Prism (extrusion),
611    *  Pipe (extrusion along contour), Revolution, Solid (from shell).
612    */
613   interface GEOM_I3DPrimOperations : GEOM_IOperations
614   {
615     /*!
616      *  Create a box with specified dimensions along the coordinate axes
617      *  and with edges, parallel to the coordinate axes.
618      *  Center of the box will be at point (DX/2, DY/2, DZ/2).
619      *  \param theDX Length of Box edges, parallel to OX axis.
620      *  \param theDY Length of Box edges, parallel to OY axis.
621      *  \param theDZ Length of Box edges, parallel to OZ axis.
622      *  \return New GEOM_Object, containing the created box.
623      */
624     GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
625
626     /*!
627      *  Create a box with two specified opposite vertices,
628      *  and with edges, parallel to the coordinate axes
629      *  \param thePnt1 First of two opposite vertices.
630      *  \param thePnt2 Second of two opposite vertices.
631      *  \return New GEOM_Object, containing the created box.
632      */
633     GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
634
635     /*!
636      *  Create a cylinder with given radius and height at
637      *  the origin of coordinate system. Axis of the cylinder
638      *  will be collinear to the OZ axis of the coordinate system.
639      *  \param theR Cylinder radius.
640      *  \param theH Cylinder height.
641      *  \return New GEOM_Object, containing the created cylinder.
642      */
643     GEOM_Object MakeCylinderRH (in double theR, in double theH);
644
645     /*!
646      *  Create a cylinder with given base point, axis, radius and height.
647      *  \param thePnt Central point of cylinder base.
648      *  \param theAxis Cylinder axis.
649      *  \param theR Cylinder radius.
650      *  \param theH Cylinder height.
651      *  \return New GEOM_Object, containing the created cylinder.
652      */
653     GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
654                                       in GEOM_Object theAxis,
655                                       in double      theR,
656                                       in double      theH);
657
658     /*!
659      *  Create a cone with given height and radiuses at
660      *  the origin of coordinate system. Axis of the cone will
661      *  be collinear to the OZ axis of the coordinate system.
662      *  \param theR1 Radius of the first cone base.
663      *  \param theR2 Radius of the second cone base.
664      *    \note If both radiuses are non-zero, the cone will be truncated.
665      *    \note If the radiuses are equal, a cylinder will be created instead.
666      *  \param theH Cone height.
667      *  \return New GEOM_Object, containing the created cone.
668      */
669     GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
670
671     /*!
672      *  Create a cone with given base point, axis, height and radiuses.
673      *  \param thePnt Central point of the first cone base.
674      *  \param theAxis Cone axis.
675      *  \param theR1 Radius of the first cone base.
676      *  \param theR2 Radius of the second cone base.
677      *    \note If both radiuses are non-zero, the cone will be truncated.
678      *    \note If the radiuses are equal, a cylinder will be created instead.
679      *  \param theH Cone height.
680      *  \return New GEOM_Object, containing the created cone.
681      */
682     GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
683                                      in GEOM_Object theAxis,
684                                      in double      theR1,
685                                      in double      theR2,
686                                      in double      theH);
687
688     /*!
689      *  Create a torus with given radiuses at the origin of coordinate system.
690      *  \param theRMajor Torus major radius.
691      *  \param theRMinor Torus minor radius.
692      *  \return New GEOM_Object, containing the created torus.
693      */
694     GEOM_Object MakeTorusRR (in double theRMajor,
695                              in double theRMinor);
696
697     /*!
698      *  Create a torus with given center, normal vector and radiuses.
699      *  \param thePnt Torus central point.
700      *  \param theVec Torus axis of symmetry.
701      *  \param theRMajor Torus major radius.
702      *  \param theRMinor Torus minor radius.
703      *  \return New GEOM_Object, containing the created torus.
704      */
705     GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
706                                    in GEOM_Object theVec,
707                                    in double theRMajor,
708                                    in double theRMinor);
709
710     /*!
711      *  Create a sphere with given radius at the origin of coordinate system.
712      *  \param theR Sphere radius.
713      *  \return New GEOM_Object, containing the created sphere.
714      */
715     GEOM_Object MakeSphereR (in double theR);
716
717     /*!
718      *  Create a sphere with given center and radius.
719      *  \param thePnt Sphere center.
720      *  \param theR Sphere radius.
721      *  \return New GEOM_Object, containing the created .
722      */
723     GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
724
725     /*!
726      *  Create a shape by extrusion of the base shape along the vector,
727      *  i.e. all the space, transfixed by the base shape during its translation
728      *  along the vector on the given distance.
729      *  \param theBase Base shape to be extruded.
730      *  \param theVec Direction of extrusion.
731      *  \param theH Prism dimension along theVec.
732      *  \return New GEOM_Object, containing the created prism.
733      */
734     GEOM_Object MakePrismVecH (in GEOM_Object theBase,
735                                in GEOM_Object theVec,
736                                in double      theH);
737
738     /*!
739      *  Create a shape by extrusion of the base shape along a vector, defined by two points.
740      *  \param theBase Base shape to be extruded.
741      *  \param thePoint1 First end of extrusion vector.
742      *  \param thePoint2 Second end of extrusion vector.
743      *  \return New GEOM_Object, containing the created prism.
744      */
745     GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
746                                  in GEOM_Object thePoint1,
747                                  in GEOM_Object thePoint2);
748
749     /*!
750      *  Create a shape by extrusion of the base shape along
751      *  the path shape. The path shape can be a wire or an edge.
752      *  \param theBase Base shape to be extruded.
753      *  \param thePath Path shape to extrude the base shape along it.
754      *  \return New GEOM_Object, containing the created pipe.
755      */
756     GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
757
758     /*!
759      *  Create a shape by revolution of the base shape around the axis
760      *  on the given angle, i.e. all the space, transfixed by the base
761      *  shape during its rotation around the axis on the given angle.
762      *  \param theBase Base shape to be rotated.
763      *  \param theAxis Rotation axis.
764      *  \param theAngle Rotation angle in radians.
765      *  \return New GEOM_Object, containing the created revolution.
766      */
767     GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
768                                          in GEOM_Object theAxis,
769                                          in double theAngle);
770
771     /*!
772      *  Create a filling from the given compound of contours.
773      *  \param theMinDeg a minimal degree
774      *  \param theMaxDeg a maximal degree
775      *  \param theTol2D a 2d tolerance
776      *  \param theTol3D a 3d tolerance
777      *  \param theNbIter a number of iteration
778      *  \return New GEOM_Object, containing the created filling surface.
779      */
780     GEOM_Object MakeFilling (in GEOM_Object theShape,
781                              in long theMinDeg, in long theMaxDeg,
782                              in double theTol2D, in double theTol3D,
783                              in long theNbIter);
784   };
785
786   /*!
787    *  GEOM_IShapesOperations: Interface for Shapes creation:
788    *  Edge from two points, Wire from edges, Face from wire,
789    *  Shell from faces, Solid from shells, Compound from shapes
790    */
791   interface GEOM_IShapesOperations : GEOM_IOperations
792   {
793     /*!
794      *  Create a linear edge with specified ends.
795      *  \param thePnt1 Point for the first end of edge.
796      *  \param thePnt2 Point for the second end of edge.
797      *  \return New GEOM_Object, containing the created edge.
798      */
799     GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
800
801     /*!
802      *  Create a wire from the set of edges and wires.
803      *  \param theEdgesAndWires List of edge and/or wires.
804      *  \return New GEOM_Object, containing the created wire.
805      */
806     GEOM_Object MakeWire (in ListOfGO theEdgesAndWires);
807
808     /*!
809      *  Create a face on the given wire.
810      *  \param theWire Wire to build the face on.
811      *  \param isPlanarWanted If TRUE, only planar face will be built.
812      *                        If impossible, NULL object will be returned.
813      *  \return New GEOM_Object, containing the created face.
814      */
815     GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
816
817     /*!
818      *  Create a face on the given wires set.
819      *  \param theWires List of wires to build the face on.
820      *  \param isPlanarWanted If TRUE, only planar face will be built.
821      *                        If impossible, NULL object will be returned.
822      *  \return New GEOM_Object, containing the created face.
823      */
824     GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
825
826     /*!
827      *  Create a shell from the set of faces and shells.
828      *  \param theFacesAndShells List of faces and/or shells.
829      *  \return New GEOM_Object, containing the created shell.
830      */
831     GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
832
833     /*!
834      *  Create a solid, bounded by the given shell.
835      *  \param theShell Bounding shell.
836      *  \return New GEOM_Object, containing the created solid.
837      */
838     GEOM_Object MakeSolidShell (in GEOM_Object theShell);
839
840     /*!
841      *  Create a solid, bounded by the given shells.
842      *  \param theShells Bounding shells.
843      *  \return New GEOM_Object, containing the created solid.
844      */
845     GEOM_Object MakeSolidShells (in ListOfGO theShells);
846
847     /*!
848      *  Create a compound of the given shapes.
849      *  \param theShapes List of shapes to put in compound.
850      *  \return New GEOM_Object, containing the created compound.
851      */
852     GEOM_Object MakeCompound (in ListOfGO theShapes);
853
854     /*!
855      *  Replace coincident faces in theShape by one face.
856      *  \param theShape Initial shape.
857      *  \param theTolerance Maximum distance between faces, which can be considered as coincident.
858      *  \return New GEOM_Object, containing a copy of theShape without coincident faces.
859      */
860     GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance);
861
862     /*!
863      *  Explode a shape on subshapes of a given type.
864      *  \param theShape Shape to be exploded.
865      *  \param theShapeType Type of sub-shapes to be retrieved.
866      *  \param isSorted If this parameter is TRUE, sub-shapes will be
867      *                  sorted by coordinates of their gravity centers.
868      *  \return List of sub-shapes of type theShapeType, contained in theShape.
869      */
870     ListOfGO MakeExplode (in GEOM_Object theShape,
871                           in long        theShapeType,
872                           in boolean     isSorted);
873
874     /*!
875      *  Explode a shape on subshapes of a given type.
876      *  Does the same, as the above method, but returns IDs of sub-shapes,
877      *  not GEOM_Objects. It works faster.
878      *  \param theShape Shape to be exploded.
879      *  \param theShapeType Type of sub-shapes to be retrieved.
880      *  \param isSorted If this parameter is TRUE, sub-shapes will be
881      *                  sorted by coordinates of their gravity centers.
882      *  \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
883      */
884     ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
885                                in long        theShapeType,
886                                in boolean     isSorted);
887
888     /*!
889      *  Get a sub shape defined by its unique ID inside \a theMainShape
890      *  \note The sub shape GEOM_Objects can has ONLY ONE function.
891      *        Don't try to apply modification operations on them.
892      */
893     GEOM_Object GetSubShape (in GEOM_Object theMainShape,
894                              in long        theID);
895
896     /*!
897      *  Count number of faces in the given shape.
898      *  \param theShape Shape to count faces in.
899      *  \return Number of faces in the given shape.
900      */
901     long NumberOfFaces (in GEOM_Object theShape);
902
903     /*!
904      *  Count number of edges in the given shape.
905      *  \param theShape Shape to count edges in.
906      *  \return Number of edges in theShape.
907      */
908     long NumberOfEdges (in GEOM_Object theShape);
909
910     /*!
911      *  Reverses an orientation the given shape.
912      *  \param theShape Shape to be reversed.
913      *  \return The reversed copy of theShape.
914      */
915     GEOM_Object ChangeOrientation (in GEOM_Object theShape);
916
917     /*!
918      *  Retrieve all free faces from the given shape.
919      *  Free face is a face, which is not shared between two shells of the shape.
920      *  \param theShape Shape to find free faces in.
921      *  \return List of IDs of all free faces, contained in theShape.
922      */
923     ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
924
925     /*!
926      *  Get all sub-shapes of theShape1 of the given type, shared with theShape2.
927      *  \param theShape1 Shape to find sub-shapes in.
928      *  \param theShape2 Shape to find shared sub-shapes with.
929      *  \param theShapeType Type of sub-shapes to be retrieved.
930      *  \return List of sub-shapes of theShape1, shared with theShape2.
931      */
932     ListOfGO GetSharedShapes (in GEOM_Object theShape1,
933                               in GEOM_Object theShape2,
934                               in long        theShapeType);
935
936     /*!
937      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
938      *  the specified plane by the certain way, defined through \a theState parameter.
939      *  \param theShape Shape to find sub-shapes of.
940      *  \param theShapeType Type of sub-shapes to be retrieved.
941      *  \param theAx1 Vector (or line, or linear edge), specifying normal
942      *                direction and location of the plane to find shapes on.
943      *  \param theState The state of the subshapes to find.
944      *  \return List of all found sub-shapes.
945      */
946     ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
947                                in long        theShapeType,
948                                in GEOM_Object theAx1,
949                                in shape_state theState);
950
951     /*!
952      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
953      *  the specified cylinder by the certain way, defined through \a theState parameter.
954      *  \param theShape Shape to find sub-shapes of.
955      *  \param theShapeType Type of sub-shapes to be retrieved.
956      *  \param theAxis Vector (or line, or linear edge), specifying
957      *                 axis of the cylinder to find shapes on.
958      *  \param theRadius Radius of the cylinder to find shapes on.
959      *  \param theState The state of the subshapes to find.
960      *  \return List of all found sub-shapes.
961      */
962     ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
963                                   in long        theShapeType,
964                                   in GEOM_Object theAxis,
965                                   in double      theRadius,
966                                   in shape_state theState);
967
968     /*!
969      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
970      *  the specified sphere by the certain way, defined through \a theState parameter.
971      *  \param theShape Shape to find sub-shapes of.
972      *  \param theShapeType Type of sub-shapes to be retrieved.
973      *  \param theCenter Point, specifying center of the sphere to find shapes on.
974      *  \param theRadius Radius of the sphere to find shapes on.
975      *  \param theState The state of the subshapes to find.
976      *  \return List of all found sub-shapes.
977      */
978     ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
979                                 in long        theShapeType,
980                                 in GEOM_Object theCenter,
981                                 in double      theRadius,
982                                 in shape_state theState);
983
984     /*!
985      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
986      *  the specified quadrangle by the certain way, defined through \a theState parameter.
987      *  \param theShape Shape to find sub-shapes of.
988      *  \param theShapeType Type of sub-shapes to be retrieved.
989      *  \param theTopLeftPoint Top left quadrangle corner
990      *  \param theTopRigthPoint Top right quadrangle corner
991      *  \param theBottomLeftPoint Bottom left quadrangle corner
992      *  \param theBottomRigthPoint Bottom right quadrangle corner
993      *  \param theState The state of the subshapes to find.
994      *  \return List of all found sub-shapes.
995      */
996     ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
997                                     in long        theShapeType,
998                                     in GEOM_Object theTopLeftPoint,
999                                     in GEOM_Object theTopRigthPoint,
1000                                     in GEOM_Object theBottomLeftPoint,
1001                                     in GEOM_Object theBottomRigthPoint,
1002                                     in shape_state theState);
1003
1004     /*!
1005      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1006      *  the specified plane by the certain way, defined through \a theState parameter.
1007      *  \param theShape Shape to find sub-shapes of.
1008      *  \param theShapeType Type of sub-shapes to be retrieved.
1009      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1010      *                direction and location of the plane to find shapes on.
1011      *  \param theState The state of the subshapes to find.
1012      *  \return List of IDs of all found sub-shapes.
1013      */
1014     ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1015                                     in long        theShapeType,
1016                                     in GEOM_Object theAx1,
1017                                     in shape_state theState);
1018
1019     /*!
1020      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1021      *  the specified cylinder by the certain way, defined through \a theState parameter.
1022      *  \param theShape Shape to find sub-shapes of.
1023      *  \param theShapeType Type of sub-shapes to be retrieved.
1024      *  \param theAxis Vector (or line, or linear edge), specifying
1025      *                 axis of the cylinder to find shapes on.
1026      *  \param theRadius Radius of the cylinder to find shapes on.
1027      *  \param theState The state of the subshapes to find.
1028      *  \return List of IDs of all found sub-shapes.
1029      */
1030     ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1031                                        in long        theShapeType,
1032                                        in GEOM_Object theAxis,
1033                                        in double      theRadius,
1034                                        in shape_state theState);
1035
1036     /*!
1037      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1038      *  the specified sphere by the certain way, defined through \a theState parameter.
1039      *  \param theShape Shape to find sub-shapes of.
1040      *  \param theShapeType Type of sub-shapes to be retrieved.
1041      *  \param theCenter Point, specifying center of the sphere to find shapes on.
1042      *  \param theRadius Radius of the sphere to find shapes on.
1043      *  \param theState The state of the subshapes to find.
1044      *  \return List of IDs of all found sub-shapes.
1045      */
1046     ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1047                                      in long        theShapeType,
1048                                      in GEOM_Object theCenter,
1049                                      in double      theRadius,
1050                                      in shape_state theState);
1051
1052     /*!
1053      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1054      *  the specified quadrangle by the certain way, defined through \a theState parameter.
1055      *  \param theShape Shape to find sub-shapes of.
1056      *  \param theShapeType Type of sub-shapes to be retrieved.
1057      *  \param theTopLeftPoint Top left quadrangle corner
1058      *  \param theTopRigthPoint Top right quadrangle corner
1059      *  \param theBottomLeftPoint Bottom left quadrangle corner
1060      *  \param theBottomRigthPoint Bottom right quadrangle corner
1061      *  \param theState The state of the subshapes to find.
1062      *  \return List of IDs of all found sub-shapes.
1063      */
1064     ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1065                                          in long        theShapeType,
1066                                          in GEOM_Object theTopLeftPoint,
1067                                          in GEOM_Object theTopRigthPoint,
1068                                          in GEOM_Object theBottomLeftPoint,
1069                                          in GEOM_Object theBottomRigthPoint,
1070                                          in shape_state theState);
1071
1072     /*!
1073      *  Get sub-shape(s) of theShapeWhere, which are
1074      *  coincident with \a theShapeWhat or could be a part of it.
1075      *  \param theShapeWhere Shape to find sub-shapes of.
1076      *  \param theShapeWhat Shape, specifying what to find.
1077      *  \return Group of all found sub-shapes or a single found sub-shape.
1078      */
1079     GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1080                             in GEOM_Object theShapeWhat);
1081   };
1082
1083   /*!
1084    *  GEOM_IBlocksOperations: Interface for Blocks construction
1085    *  Face from points or edges, Block from faces,
1086    *  Blocks multi-translation and multi-rotation
1087    */
1088   interface GEOM_IBlocksOperations : GEOM_IOperations
1089   {
1090     /*!
1091      *  Creation of blocks
1092      */
1093
1094     /*!
1095      *  Create a quadrangle face from four edges. Order of Edges is not
1096      *  important. It is  not necessary that edges share the same vertex.
1097      *  \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1098      *  \return New GEOM_Object, containing the created face.
1099      */
1100     GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1101                           in GEOM_Object theEdge2,
1102                           in GEOM_Object theEdge3,
1103                           in GEOM_Object theEdge4);
1104
1105     /*!
1106      *  Create a quadrangle face on two edges.
1107      *  The missing edges will be built by creating the shortest ones.
1108      *  \param theEdge1,theEdge2 Two opposite edges for the face.
1109      *  \return New GEOM_Object, containing the created face.
1110      */
1111     GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1112                                 in GEOM_Object theEdge2);
1113
1114     /*!
1115      *  Create a quadrangle face with specified corners.
1116      *  The missing edges will be built by creating the shortest ones.
1117      *  \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1118      *  \return New GEOM_Object, containing the created face.
1119      */
1120     GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1121                                    in GEOM_Object thePnt2,
1122                                    in GEOM_Object thePnt3,
1123                                    in GEOM_Object thePnt4);
1124
1125     /*!
1126      *  Create a hexahedral solid, bounded by the six given faces. Order of
1127      *  faces is not important. It is  not necessary that Faces share the same edge.
1128      *  \param theFace1-theFace6 Faces for the hexahedral solid.
1129      *  \return New GEOM_Object, containing the created solid.
1130      */
1131     GEOM_Object MakeHexa (in GEOM_Object theFace1,
1132                           in GEOM_Object theFace2,
1133                           in GEOM_Object theFace3,
1134                           in GEOM_Object theFace4,
1135                           in GEOM_Object theFace5,
1136                           in GEOM_Object theFace6);
1137
1138     /*!
1139      *  Create a hexahedral solid between two given faces.
1140      *  The missing faces will be built by creating the smallest ones.
1141      *  \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1142      *  \return New GEOM_Object, containing the created solid.
1143      */
1144     GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1145                                 in GEOM_Object theFace2);
1146
1147     /*!
1148      *  Extract elements of blocks and blocks compounds
1149      */
1150
1151     /*!
1152      *  Get a vertex, found in the given shape by its coordinates.
1153      *  \param theShape Block or a compound of blocks.
1154      *  \param theX,theY,theZ Coordinates of the sought vertex.
1155      *  \param theEpsilon Maximum allowed distance between the resulting
1156      *                    vertex and point with the given coordinates.
1157      *  \return New GEOM_Object, containing the found vertex.
1158      */
1159     GEOM_Object GetPoint (in GEOM_Object theShape,
1160                           in double      theX,
1161                           in double      theY,
1162                           in double      theZ,
1163                           in double      theEpsilon);
1164
1165     /*!
1166      *  Get an edge, found in the given shape by two given vertices.
1167      *  \param theShape Block or a compound of blocks.
1168      *  \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1169      *  \return New GEOM_Object, containing the found edge.
1170      */
1171     GEOM_Object GetEdge (in GEOM_Object theShape,
1172                          in GEOM_Object thePoint1,
1173                          in GEOM_Object thePoint2);
1174
1175     /*!
1176      *  Find an edge of the given shape, which has minimal distance to the given point.
1177      *  \param theShape Block or a compound of blocks.
1178      *  \param thePoint Point, close to the desired edge.
1179      *  \return New GEOM_Object, containing the found edge.
1180      */
1181     GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1182                                   in GEOM_Object thePoint);
1183
1184     /*!
1185      *  Returns a face, found in the given shape by four given corner vertices.
1186      *  \param theShape Block or a compound of blocks.
1187      *  \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1188      *  \return New GEOM_Object, containing the found face.
1189      */
1190     GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1191                                  in GEOM_Object thePoint1,
1192                                  in GEOM_Object thePoint2,
1193                                  in GEOM_Object thePoint3,
1194                                  in GEOM_Object thePoint4);
1195
1196     /*!
1197      *  Get a face of block, found in the given shape by two given edges.
1198      *  \param theShape Block or a compound of blocks.
1199      *  \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1200      *  \return New GEOM_Object, containing the found face.
1201      */
1202     GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1203                                 in GEOM_Object theEdge1,
1204                                 in GEOM_Object theEdge2);
1205
1206     /*!
1207      *  Find a face, opposite to the given one in the given block.
1208      *  \param theBlock Must be a hexahedral solid.
1209      *  \param theFace Face of \a theBlock, opposite to the desired face.
1210      *  \return New GEOM_Object, containing the found face.
1211      */
1212     GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1213                                  in GEOM_Object theFace);
1214
1215     /*!
1216      *  Find a face of the given shape, which has minimal distance to the given point.
1217      *  \param theShape Block or a compound of blocks.
1218      *  \param thePoint Point, close to the desired face.
1219      *  \return New GEOM_Object, containing the found face.
1220      */
1221     GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1222                                   in GEOM_Object thePoint);
1223
1224     /*!
1225      *  Find a face of block, whose outside normale has minimal angle with the given vector.
1226      *  \param theShape Block or a compound of blocks.
1227      *  \param theVector Vector, close to the normale of the desired face.
1228      *  \return New GEOM_Object, containing the found face.
1229      */
1230     GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1231                                   in GEOM_Object theVector);
1232
1233     /*!
1234      *  Extract blocks from blocks compounds
1235      */
1236
1237     /*!
1238      *  Check, if the compound contains only specified blocks.
1239      *  \param theCompound The compound to check.
1240      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
1241      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1242      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1243      *  \return TRUE, if the given compound contains only blocks.
1244      *  \return theNbBlocks Number of specified blocks in theCompound.
1245      */
1246     boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
1247                                 in long        theMinNbFaces,
1248                                 in long        theMaxNbFaces,
1249                                 out long       theNbBlocks);
1250
1251     /*!
1252      *  Enumeration of Blocks Compound defects.
1253      */
1254     enum BCErrorType
1255     {
1256       /* Each element of the compound should be a Block */
1257       NOT_BLOCK,
1258
1259       /* An element is a potential block, but has degenerated and/or seam edge(s). */
1260       EXTRA_EDGE,
1261
1262       /* A connection between two Blocks should be an entire face or an entire edge */
1263       INVALID_CONNECTION,
1264
1265       /* The compound should be connexe */
1266       NOT_CONNECTED,
1267
1268       /* The glue between two quadrangle faces should be applied */
1269       NOT_GLUED
1270     };
1271
1272     /*!
1273      *  Description of Blocks Compound defect: type and incriminated sub-shapes.
1274      */
1275     struct BCError
1276     {
1277       BCErrorType error;
1278       ListOfLong  incriminated;
1279     };
1280
1281     /*!
1282      *  Sequence of all Blocks Compound defects.
1283      */
1284     typedef sequence<BCError> BCErrors;
1285
1286     /*!
1287      *  Check, if the compound of blocks is given.
1288      *  To be considered as a compound of blocks, the
1289      *  given shape must satisfy the following conditions:
1290      *  - Each element of the compound should be a Block (6 faces and 12 edges).
1291      *  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
1292      *  - The compound should be connexe.
1293      *  - The glue between two quadrangle faces should be applied.
1294      *    \note Single block is also accepted as a valid compound of blocks.
1295      *  \param theCompound The compound to check.
1296      *  \return TRUE, if the given shape is a compound of blocks.
1297      *  \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
1298      */
1299     boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
1300                                    out BCErrors   theErrors);
1301
1302     /*!
1303      *  Convert sequence of Blocks Compound errors, returned by
1304      *  <VAR>CheckCompoundOfBlocks()</VAR>, into string.
1305      *  \param theCompound The bad compound.
1306      *  \param theErrors The sequence of \a theCompound errors.
1307      *  \return String, describing all the errors in form, suitable for printing.
1308      */
1309     string PrintBCErrors (in GEOM_Object theCompound,
1310                           in BCErrors    theErrors);
1311
1312     /*!
1313      *  Remove all seam and degenerated edges from \a theShape.
1314      *  Unite faces and edges, sharing one surface.
1315      *  \param theShape The compound or single solid to remove irregular edges from.
1316      *  \return Improved shape.
1317      */
1318     GEOM_Object RemoveExtraEdges (in GEOM_Object theShape);
1319
1320     /*!
1321      *  Check, if the given shape is a blocks compound.
1322      *  Fix all detected errors.
1323      *    \note Single block can be also fixed by this method.
1324      *  \param theCompound The compound to check and improve.
1325      *  \return Improved compound.
1326      */
1327     GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
1328
1329     /*!
1330      *  Get all the blocks, contained in the given compound.
1331      *  \param theCompound The compound to explode.
1332      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
1333      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1334      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1335      *  \return List of GEOM_Objects, containing the retrieved blocks.
1336      */
1337     ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
1338                                       in long        theMinNbFaces,
1339                                       in long        theMaxNbFaces);
1340
1341     /*!
1342      *  Find block, containing the given point inside its volume or on boundary.
1343      *  \param theCompound Compound, to find block in.
1344      *  \param thePoint Point, close to the desired block. If the point lays on
1345      *         boundary between some blocks, we return block with nearest center.
1346      *  \return New GEOM_Object, containing the found block.
1347      */
1348     GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
1349                                    in GEOM_Object thePoint);
1350
1351     /*!
1352      *  Find block, containing all the elements, passed as the parts, or maximum quantity of them.
1353      *  \param theCompound Compound, to find block in.
1354      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
1355      *  \return New GEOM_Object, containing the found block.
1356      */
1357     GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
1358                                  in ListOfGO    theParts);
1359
1360     /*!
1361      *  Return all blocks, containing all the elements, passed as the parts.
1362      *  \param theCompound Compound, to find blocks in.
1363      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
1364      *  \return List of GEOM_Objects, containing the found blocks.
1365      */
1366     ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
1367                                in ListOfGO    theParts);
1368
1369     /*!
1370      *  Operations on blocks with gluing of result
1371      */
1372
1373     /*!
1374      *  Multi-transformate block and glue the result.
1375      *  Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
1376      *  \param theBlock Hexahedral solid to be multi-transformed.
1377      *  \param theDirFace1 First direction face global index.
1378      *  \param theDirFace2 Second direction face global index.
1379      *  \param theNbTimes Quantity of transformations to be done.
1380      *    \note Global index of sub-shape can be obtained, using method
1381      *          <VAR>GEOM_ILocalOperations.GetSubShapeIndex()</VAR>.
1382      *  \return New GEOM_Object, containing the result shape.
1383      */
1384     GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
1385                                            in long        theDirFace1,
1386                                            in long        theDirFace2,
1387                                            in long        theNbTimes);
1388
1389     /*!
1390      *  Multi-transformate block and glue the result.
1391      *  \param theBlock Hexahedral solid to be multi-transformed.
1392      *  \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
1393      *  \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
1394      *  \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
1395      *  \return New GEOM_Object, containing the result shape.
1396      */
1397     GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
1398                                            in long        theDirFace1U,
1399                                            in long        theDirFace2U,
1400                                            in long        theNbTimesU,
1401                                            in long        theDirFace1V,
1402                                            in long        theDirFace2V,
1403                                            in long        theNbTimesV);
1404
1405     /*!
1406      *  Special operation - propagation
1407      */
1408
1409     /*!
1410      *  Build all possible propagation groups.
1411      *  Propagation group is a set of all edges, opposite to one (main)
1412      *  edge of this group directly or through other opposite edges.
1413      *  Notion of Opposite Edge make sence only on quadrangle face.
1414      *  \param theShape Shape to build propagation groups on.
1415      *  \return List of GEOM_Objects, each of them is a propagation group.
1416      */
1417     ListOfGO Propagate (in GEOM_Object theShape);
1418   };
1419
1420   /*!
1421    *  GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
1422    */
1423   interface GEOM_IBooleanOperations : GEOM_IOperations
1424   {
1425     /*!
1426      *  Perform one of boolean operations on two given shapes.
1427      *  \param theShape1 First argument for boolean operation.
1428      *  \param theShape2 Second argument for boolean operation.
1429      *  \param theOperation Indicates the operation to be done:
1430      *                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1431      *  \return New GEOM_Object, containing the result shape.
1432      */
1433     GEOM_Object MakeBoolean (in GEOM_Object theShape1,
1434                              in GEOM_Object theShape2,
1435                              in long theOperation);
1436
1437     /*!
1438      *  Perform partition operation.
1439      *  \param theShapes Shapes to be intersected.
1440      *  \param theTools Shapes to intersect theShapes.
1441      *  \param theKeepInside Shapes, outside which the results will be deleted.
1442      *         Each shape from theKeepInside must belong to theShapes also.
1443      *  \param theRemoveInside Shapes, inside which the results will be deleted.
1444      *         Each shape from theRemoveInside must belong to theShapes also.
1445      *  \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1446      *  \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
1447      *  \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
1448      *  \return New GEOM_Object, containing the result shapes.
1449      */
1450     GEOM_Object MakePartition (in ListOfGO   theShapes,
1451                                in ListOfGO   theTools,
1452                                in ListOfGO   theKeepInside,
1453                                in ListOfGO   theRemoveInside,
1454                                in short      theLimit,
1455                                in boolean    theRemoveWebs,
1456                                in ListOfLong theMaterials);
1457
1458     /*!
1459      *  Perform partition of the Shape with the Plane
1460      *  \param theShape Shape to be intersected.
1461      *  \param thePlane Tool shape, to intersect theShape.
1462      *  \return New GEOM_Object, containing the result shape.
1463      */
1464     GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
1465                                    in GEOM_Object thePlane);
1466   };
1467
1468   /*!
1469    *  GEOM_ICurvesOperations: Interface for curves creation.
1470    *  Polyline, Circle, Spline (Bezier and Interpolation)
1471    */
1472   interface GEOM_ICurvesOperations : GEOM_IOperations
1473   {
1474     /*!
1475      *  Create a circle with given center, normal vector and radius.
1476      *  \param thePnt Circle center.
1477      *  \param theVec Vector, normal to the plane of the circle.
1478      *  \param theR Circle radius.
1479      *  \return New GEOM_Object, containing the created circle.
1480      */
1481     GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
1482                                    in GEOM_Object theVec,
1483                                    in double theR);
1484     /*!
1485      *  Create a circle, passing through three given points
1486      *  \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1487      *  \return New GEOM_Object, containing the created circle.
1488      */
1489     GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
1490                                     in GEOM_Object thePnt2,
1491                                     in GEOM_Object thePnt3);
1492
1493     /*!
1494      *  Create an ellipse with given center, normal vector and radiuses.
1495      *  \param thePnt Ellipse center.
1496      *  \param theVec Vector, normal to the plane of the ellipse.
1497      *  \param theRMajor Major ellipse radius.
1498      *  \param theRMinor Minor ellipse radius.
1499      *  \return New GEOM_Object, containing the created ellipse.
1500      */
1501     GEOM_Object MakeEllipse (in GEOM_Object thePnt,
1502                              in GEOM_Object theVec,
1503                              in double theRMajor,
1504                              in double theRMinor);
1505
1506     /*!
1507      *  Create an arc of circle, passing through three given points.
1508      *  \param thePnt1 Start point of the arc.
1509      *  \param thePnt2 Middle point of the arc.
1510      *  \param thePnt3 End point of the arc.
1511      *  \return New GEOM_Object, containing the created arc.
1512      */
1513     GEOM_Object MakeArc (in GEOM_Object thePnt1,
1514                          in GEOM_Object thePnt2,
1515                          in GEOM_Object thePnt3);
1516
1517     /*!
1518      *  Create a polyline on the set of points.
1519      *  \param thePoints Sequence of points for the polyline.
1520      *  \return New GEOM_Object, containing the created polyline.
1521      */
1522     GEOM_Object MakePolyline (in ListOfGO thePoints);
1523
1524     /*!
1525      *  Create bezier curve on the set of points.
1526      *  \param thePoints Sequence of points for the bezier curve.
1527      *  \return New GEOM_Object, containing the created bezier curve.
1528      */
1529     GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
1530
1531     /*!
1532      *  Create B-Spline curve on the set of points.
1533      *  \param thePoints Sequence of points for the B-Spline curve.
1534      *  \return New GEOM_Object, containing the created B-Spline curve.
1535      */
1536     GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints);
1537
1538     /*!
1539      *  Create a sketcher (wire or face), following the textual description,
1540      *  passed through \a theCommand argument. \n
1541      *  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
1542      *  Format of the description string have to be the following:
1543      *
1544      *  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
1545      *
1546      *  Where:
1547      *  - x1, y1 are coordinates of the first sketcher point (zero by default),
1548      *  - CMD is one of
1549      *     - "R angle" : Set the direction by angle
1550      *     - "D dx dy" : Set the direction by DX & DY
1551      *     .
1552      *       \n
1553      *     - "TT x y" : Create segment by point at X & Y
1554      *     - "T dx dy" : Create segment by point with DX & DY
1555      *     - "L length" : Create segment by direction & Length
1556      *     - "IX x" : Create segment by direction & Intersect. X
1557      *     - "IY y" : Create segment by direction & Intersect. Y
1558      *     .
1559      *       \n
1560      *     - "C radius length" : Create arc by direction, radius and length(in degree)
1561      *     .
1562      *       \n
1563      *     - "WW" : Close Wire (to finish)
1564      *     - "WF" : Close Wire and build face (to finish)
1565      *
1566      *  \param theCommand String, defining the sketcher in local
1567      *                    coordinates of the working plane.
1568      *  \param theWorkingPlane Nine double values, defining origin,
1569      *                         OZ and OX directions of the working plane.
1570      *  \return New GEOM_Object, containing the created wire.
1571      */
1572     GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
1573
1574       /*!
1575      *  Create a sketcher (wire or face), following the textual description,
1576      *  passed through \a theCommand argument. \n
1577      *  For format of the description string see the previous method.\n
1578      *  \param theCommand String, defining the sketcher in local
1579      *                    coordinates of the working plane.
1580      *  \param theWorkingPlane Planar Face of the working plane.
1581      *  \return New GEOM_Object, containing the created wire.
1582      */
1583     GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
1584   };
1585
1586   /*!
1587    *  GEOM_ILocalOperations: Interface for fillet and chamfer creation.
1588    */
1589   interface GEOM_ILocalOperations : GEOM_IOperations
1590   {
1591     /*!
1592      *  Perform a fillet on all edges of the given shape.
1593      *  \param theShape Shape, to perform fillet on.
1594      *  \param theR Fillet radius.
1595      *  \return New GEOM_Object, containing the result shape.
1596      */
1597     GEOM_Object MakeFilletAll (in GEOM_Object theShape,
1598                                in double      theR);
1599
1600     /*!
1601      *  Perform a fillet on the specified edges of the given shape
1602      *  \param theShape Shape, to perform fillet on.
1603      *  \param theR Fillet radius.
1604      *  \param theEdges Global indices of edges to perform fillet on.
1605      *    \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1606      *  \return New GEOM_Object, containing the result shape.
1607      */
1608     GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
1609                                  in double      theR,
1610                                  in ListOfLong  theEdges);
1611
1612     /*!
1613      *  Perform a fillet on all edges of the specified faces of the given shape.
1614      *  \param theShape Shape, to perform fillet on.
1615      *  \param theR Fillet radius.
1616      *  \param theFaces Global indices of faces to perform fillet on.
1617      *    \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1618      *  \return New GEOM_Object, containing the result shape.
1619      */
1620     GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
1621                                  in double      theR,
1622                                  in ListOfLong  theFaces);
1623
1624     /*!
1625      *  Perform a symmetric chamfer on all edges of the given shape.
1626      *  \param theShape Shape, to perform chamfer on.
1627      *  \param theD Chamfer size along each face.
1628      *  \return New GEOM_Object, containing the result shape.
1629      */
1630     GEOM_Object MakeChamferAll (in GEOM_Object theShape,
1631                                 in double      theD);
1632
1633     /*!
1634      *  Perform a chamfer on edges, common to the specified faces.
1635      *  with distance D1 on the Face1
1636      *  \param theShape Shape, to perform chamfer on.
1637      *  \param theD1 Chamfer size along \a theFace1.
1638      *  \param theD2 Chamfer size along \a theFace2.
1639      *  \param theFace1,theFace2 Global indices of two faces of \a theShape.
1640      *    \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1641      *  \return New GEOM_Object, containing the result shape.
1642      */
1643     GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
1644                                  in double theD1, in double theD2,
1645                                  in long theFace1, in long theFace2);
1646
1647     /*!
1648      *  Perform a chamfer on all edges of the specified faces.
1649      *  with distance D1 on the first specified face (if several for one edge)
1650      *  \param theShape Shape, to perform chamfer on.
1651      *  \param theD1 Chamfer size along face from \a theFaces. If both faces,
1652      *               connected to the edge, are in \a theFaces, \a theD1
1653      *               will be get along face, which is nearer to \a theFaces beginning.
1654      *  \param theD2 Chamfer size along another of two faces, connected to the edge.
1655      *  \param theFaces Sequence of global indices of faces of \a theShape.
1656      *    \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1657      *  \return New GEOM_Object, containing the result shape.
1658      */
1659     GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
1660                                   in double theD1, in double theD2,
1661                                   in ListOfLong theFaces);
1662
1663     /*!
1664      *  Perform an Archimde operation on the given shape with given parameters.
1665      *                    The object presenting the resulting face is returned
1666      *  \param theShape Shape to be put in water.
1667      *  \param theWeight Weight og the shape.
1668      *  \param theWaterDensity Density of the water.
1669      *  \param theMeshDeflection Deflection od the mesh, using to compute the section.
1670      *  \return New GEOM_Object, containing a section of \a theShape
1671      *          by a plane, corresponding to water level.
1672      */
1673     GEOM_Object MakeArchimede (in GEOM_Object theShape,
1674                                in double theWeight,
1675                                in double theWaterDensity,
1676                                in double theMeshDeflection);
1677
1678     /*!
1679      *  Get global index of \a theSubShape in \a theShape.
1680      *  \param theShape Main shape.
1681      *  \param theSubShape Sub-shape of the main shape.
1682      *  \return global index of \a theSubShape in \a theShape.
1683      */
1684     long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
1685   };
1686
1687   /*!
1688    *  GEOM_IHealingOperations: Interface for shape healing operations.
1689    *  Shape Processing, SuppressFaces, etc.
1690    */
1691   interface GEOM_IHealingOperations : GEOM_IOperations
1692   {
1693     /*!
1694      *  Apply a sequence of Shape Healing operators to the given object.
1695      *  \param theShapes Shape to be processed.
1696      *  \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1697      *  \param theParameters List of names of parameters
1698      *                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1699      *  \param theValues List of values of parameters, in the same order
1700      *                    as parameters are listed in \a theParameters list.
1701      *  \return New GEOM_Object, containing processed shape.
1702      */
1703     GEOM_Object ProcessShape (in GEOM_Object theShapes,
1704                               in string_array theOperators,
1705                               in string_array theParameters,
1706                               in string_array theValues);
1707
1708     /*!
1709      *  Get default sequence of operators, their parameters and parameters' values
1710      *  of Shape Process operation. In the current implementation the defaults are
1711      *  read from the file pointed by CSF_ShHealingDefaults environmental variable.
1712      *  \param theOperators Output. Default list of names of operators.
1713      *  \param theParameters Output. Default list of names of parameters.
1714      *  \param theValues Output. List of default values of parameters, in the same order
1715      *                           as parameters are listed in \a theParameters list.
1716      */
1717     void GetShapeProcessParameters (out string_array theOperators,
1718                                     out string_array theParameters,
1719                                     out string_array theValues);
1720     /*!
1721      *  Get parameters and parameters' values for the given Shape Process operation.
1722      *  In the current implementation the defaults are
1723      *  read from the file pointed by CSF_ShHealingDefaults environmental variable.
1724      *  \param theOperator Input. The operator's name.
1725      *  \param theParameters Output. Default list of names of parameters.
1726      *  \param theValues Output. List of default values of parameters, in the same order
1727      *                           as parameters are listed in \a theParameters list.
1728      */
1729     void GetOperatorParameters (in string theOperator,
1730                                 out string_array theParameters,
1731                                 out string_array theValues);
1732
1733     /*!
1734      *  Remove faces from the given object (shape).
1735      *  \param theObject Shape to be processed.
1736      *  \param theFaces Indices of faces to be removed, if EMPTY then the method
1737      *                  removes ALL faces of the given object.
1738      *  \return New GEOM_Object, containing processed shape.
1739      */
1740     GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
1741
1742     /*!
1743      *  Close an open wire.
1744      *  \param theObject Shape to be processed.
1745      *  \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1746      *                  if -1, then theObject itself is a wire.
1747      *  \param isCommonVertex If TRUE : closure by creation of a common vertex,
1748      *                        If FALS : closure by creation of an edge between ends.
1749      *  \return New GEOM_Object, containing processed shape.
1750      */
1751     GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
1752                               in boolean isCommonVertex);
1753
1754     /*!
1755      *  Remove internal wires and edges from the given object (face).
1756      *  \param theObject Shape to be processed.
1757      *  \param theWires Indices of wires to be removed, if EMPTY then the method
1758      *                  removes ALL internal wires of the given object.
1759      *  \return New GEOM_Object, containing processed shape.
1760      */
1761     GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
1762
1763     /*!
1764      *  Remove internal closed contours (holes) from the given object.
1765      *  \param theObject Shape to be processed.
1766      *  \param theWires Indices of wires to be removed, if EMPTY then the method
1767      *                  removes ALL internal holes of the given object
1768      *  \return New GEOM_Object, containing processed shape.
1769      */
1770     GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
1771
1772     /*!
1773      *  Sewing of the given object.
1774      *  \param theObject Shape to be processed.
1775      *  \param theTolerance Required tolerance value.
1776      *  \return New GEOM_Object, containing processed shape.
1777      */
1778     GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
1779
1780     /*!
1781      *  Addition of a point to a given edge object.
1782      *  \param theObject Shape to be processed.
1783      *  \param theEdgeIndex Index of edge to be divided within theObject's shape,
1784      *                      if -1, then theObject itself is the edge.
1785      *  \param theValue Value of parameter on edge or length parameter,
1786      *                  depending on \a isByParameter.
1787      *  \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
1788      *                       if FALSE : \a theValue is treated as a length parameter [0..1]
1789      *  \return New GEOM_Object, containing processed shape.
1790      */
1791     GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
1792                             in double theValue, in boolean isByParameter);
1793
1794     /*!
1795      *  Get a list of wires (wrapped in GEOM_Object-s),
1796      *  that constitute a free boundary of the given shape.
1797      *  \param theObject Shape to get free boundary of.
1798      *  \param theClosedWires Output. Closed wires on the free boundary of the given shape.
1799      *  \param theOpenWires Output. Open wires on the free boundary of the given shape.
1800      *  \return FALSE, if an error(s) occured during the method execution.
1801      */
1802     boolean GetFreeBoundary (in GEOM_Object theObject,
1803                              out ListOfGO theClosedWires,
1804                              out ListOfGO theOpenWires);
1805   };
1806
1807   /*!
1808    *  GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
1809    *
1810    */
1811   interface GEOM_IInsertOperations : GEOM_IOperations
1812   {
1813     /*!
1814      *  Create a copy of the given object
1815      */
1816     GEOM_Object MakeCopy (in GEOM_Object theOriginal);
1817
1818     /*!
1819      *  Export the given shape into a file with given name.
1820      *  \param theObject Shape to be stored in the file.
1821      *  \param theFileName Name of the file to store the given shape in.
1822      *  \param theFormatName Specify format for the shape storage.
1823      *         Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
1824      */
1825     void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
1826
1827     /*!
1828      *  Import a shape from the BRep or IGES or STEP file
1829      *  (depends on given format) with given name.
1830      *  \param theFileName The file, containing the shape.
1831      *  \param theFormatName Specify format for the file reading.
1832      *         Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
1833      *  \return New GEOM_Object, containing the imported shape.
1834      */
1835     GEOM_Object Import (in string theFileName, in string theFormatName);
1836
1837     /*!
1838      *  Get the supported import formats and corresponding patterns for File dialog.
1839      *  \param theFormats Output. List of formats, available for import.
1840      *  \param thePatterns Output. List of file patterns, corresponding to available formats.
1841      *  \return Returns available formats and patterns through the arguments.
1842      */
1843     void ImportTranslators (out string_array theFormats,
1844                             out string_array thePatterns);
1845
1846     /*!
1847      *  Get the supported export formats and corresponding patterns for File dialog.
1848      *  \param theFormats Output. List of formats, available for export.
1849      *  \param thePatterns Output. List of file patterns, corresponding to available formats.
1850      *  \return Returns available formats and patterns through the arguments.
1851      */
1852     void ExportTranslators (out string_array theFormats,
1853                             out string_array thePatterns);
1854   };
1855
1856   /*!
1857    *  GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
1858    *  properties calculation (like Centre of Mass, Inertia, etc.).
1859    *
1860    */
1861   interface GEOM_IMeasureOperations : GEOM_IOperations
1862   {
1863     /*!
1864      *  Get summarized length of all wires,
1865      *  area of surface and volume of the given shape.
1866      *  \param theShape Shape to define properties of.
1867      *  \param theLength Output. Summarized length of all wires of the given shape.
1868      *  \param theSurfArea Output. Area of surface of the given shape.
1869      *  \param theVolume Output. Volume of the given shape.
1870      *  \return Returns shape properties through the last three arguments.
1871      */
1872     void GetBasicProperties (in GEOM_Object theShape,
1873                              out double theLength,
1874                              out double theSurfArea,
1875                              out double theVolume);
1876
1877     /*!
1878      *  Get a point, situated at the centre of mass of theShape.
1879      *  \param theShape Shape to define centre of mass of.
1880      *  \return New GEOM_Object, containing the created point.
1881      */
1882     GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
1883
1884     /*!
1885      *  Get inertia matrix and moments of inertia of theShape.
1886      *  \param theShape Shape to calculate inertia of.
1887      *  \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
1888      *  \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
1889      *  \return Returns inertia through the last twelve arguments.
1890      */
1891     void GetInertia (in GEOM_Object theShape,
1892                      out double I11, out double I12, out double I13,
1893                      out double I21, out double I22, out double I23,
1894                      out double I31, out double I32, out double I33,
1895                      out double Ix , out double Iy , out double Iz);
1896
1897     /*!
1898      *  Get parameters of bounding box of the given shape
1899      *  \param theShape Shape to obtain bounding box of.
1900      *  \param Xmin,Xmax Output. Limits of shape along OX axis.
1901      *  \param Ymin,Ymax Output. Limits of shape along OY axis.
1902      *  \param Zmin,Zmax Output. Limits of shape along OZ axis.
1903      *  \return Returns parameters of bounding box through the last six arguments.
1904      */
1905     void GetBoundingBox (in GEOM_Object theShape,
1906                          out double Xmin, out double Xmax,
1907                          out double Ymin, out double Ymax,
1908                          out double Zmin, out double Zmax);
1909
1910     /*!
1911      *  Get min and max tolerances of sub-shapes of theShape
1912      *  \param theShape Shape, to get tolerances of.
1913      *  \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
1914      *  \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
1915      *  \param VertMin,VertMax Output. Min and max tolerances of the vertices.
1916      *  \return Returns shape tolerances through the last six arguments.
1917      */
1918     void GetTolerance (in GEOM_Object theShape,
1919                        out double FaceMin, out double FaceMax,
1920                        out double EdgeMin, out double EdgeMax,
1921                        out double VertMin, out double VertMax);
1922
1923     /*!
1924      *  Check a topology of the given shape.
1925      *  \param theShape Shape to check validity of.
1926      *  \param theDescription Output. Description of problems in the shape, if they are.
1927      *  \return TRUE, if the shape "seems to be valid" from the topological point of view.
1928      */
1929     boolean CheckShape (in GEOM_Object theShape,
1930                         out string     theDescription);
1931
1932     /*!
1933      *  Obtain description of the given shape
1934      *  \param theShape Shape to be described.
1935      *  \return Description of the given shape.
1936      */
1937     string WhatIs (in GEOM_Object theShape);
1938
1939     /*!
1940      *  Get minimal distance between the given shapes.
1941      *  \param theShape1,theShape2 Shapes to find minimal distance between.
1942      *  \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
1943      *  \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
1944      *  \return Value of the minimal distance between the given shapes.
1945      */
1946     double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
1947                            out double X1, out double Y1, out double Z1,
1948                            out double X2, out double Y2, out double Z2);
1949
1950
1951     /*!
1952      *  Get point coordinates
1953      */
1954     void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
1955   };
1956
1957
1958   /*!
1959    *  GEOM_IGroupOperations: Interface for groups creation.
1960    */
1961   interface GEOM_IGroupOperations : GEOM_IOperations
1962   {
1963     /*!
1964      *  Creates a new group which will store  sub shapes of theMainShape
1965      *  \param theMainShape is a GEOM object on which the group is selected
1966      *  \param theShapeType defines a shape type of the group
1967      *  \return a newly created GEOM group
1968      */
1969     GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
1970
1971     /*!
1972      *  Adds a sub object with ID theSubShapeId to the group
1973      *  \param theGroup is a GEOM group to which the new sub shape is added
1974      *  \param theSubShapeId is a sub shape ID in the main object.
1975      *  \note Use method <VAR>ILocalOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
1976      */
1977     void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
1978
1979     /*!
1980      *  Removes a sub object with ID \a theSubShapeId from the group
1981      *  \param theGroup is a GEOM group from which the sub shape is removed.
1982      *  \param theSubShapeId is a sub shape ID in the main object.
1983      *  \note Use method <VAR>ILocalOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
1984      */
1985     void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
1986
1987     /*!
1988      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
1989      *  \param theGroup is a GEOM group to which the new sub shapes are added.
1990      *  \param theSubShapes is a list of sub shapes to be added.
1991      */
1992     void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
1993
1994     /*!
1995      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
1996      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
1997      *  \param theSubShapes is a list of sub-shapes to be removed.
1998      */
1999     void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2000
2001     /*!
2002      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2003      *  \param theGroup is a GEOM group to which the new sub shapes are added.
2004      *  \param theSubShapes is a list of IDs of sub shapes to be added.
2005      */
2006     void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2007
2008     /*!
2009      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
2010      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
2011      *  \param theSubShapes is a list of IDs of sub-shapes to be removed.
2012      */
2013     void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2014
2015     /*!
2016      *  Returns a type of sub objects stored in the group
2017      *  \param theGroup is a GEOM group which type is returned.
2018      */
2019     long GetType (in GEOM_Object theGroup);
2020
2021     /*!
2022      *  Returns a main shape associated with the group
2023      *  \param theGroup is a GEOM group for which a main shape object is requested
2024      *  \return a GEOM object which is a main shape for theGroup
2025      */
2026     GEOM_Object GetMainShape (in GEOM_Object theGroup);
2027
2028     /*!
2029      *  Returns a list of sub objects ID stored in the group
2030      *  \param theGroup is a GEOM group for which a list of IDs is requested
2031      */
2032     ListOfLong GetObjects (in GEOM_Object theGroup);
2033   };
2034
2035
2036   /*!
2037    *  GEOM_Gen: Interface to access other GEOM interfaces.
2038    *  Also contains some methods to access and manage GEOM objects.
2039    */
2040   interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
2041   {
2042     /*!
2043      *  Undo/Redo Management
2044      */
2045
2046     void Undo (in long theStudyID);
2047
2048     void Redo (in long theStudyID);
2049
2050     /*!
2051      * Publishing manangement
2052      * Adds in theStudy a object theObject under with a name theName,
2053      * if theFather is not NULL the object is placed under thFather's SObject.
2054      * Returns a SObject where theObject is placed
2055      */
2056     SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
2057                                   in GEOM_Object theObject,
2058                                   in string theName,
2059                                   in GEOM_Object theFather);
2060
2061     /*!
2062      *  Methods to access interfaces for objects creation and transformation
2063      */
2064     GEOM_IBasicOperations     GetIBasicOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2065     GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
2066     GEOM_I3DPrimOperations    GetI3DPrimOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2067     GEOM_IShapesOperations    GetIShapesOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2068     GEOM_IBooleanOperations   GetIBooleanOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2069     GEOM_ICurvesOperations    GetICurvesOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2070     GEOM_ILocalOperations     GetILocalOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2071     GEOM_IHealingOperations   GetIHealingOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2072     GEOM_IInsertOperations    GetIInsertOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2073     GEOM_IMeasureOperations   GetIMeasureOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2074     GEOM_IBlocksOperations    GetIBlocksOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2075     GEOM_IGroupOperations     GetIGroupOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2076
2077     /*!
2078      *  Objects Management
2079      */
2080
2081     /*!
2082      *  Removes the object from the GEOM component
2083      *  \param theObject is a GEOM object to be removed
2084      */
2085     void RemoveObject (in GEOM_Object theObject);
2086
2087     /*!
2088      *  Returns an object defined by the study and its entry in the GEOM component
2089      *  \param theStudyID is a SALOMEDS Study ID
2090      *  \param theEntry is an entry of the requested GEOM object in the GEOM component
2091      *  \note if the object has not previously been created a NULL GEOM object is returned
2092      */
2093     GEOM_Object GetObject (in long theStudyID, in string theEntry);
2094
2095     /*!
2096      *  Add a sub shape defined by indices in \a theIndices
2097      *  (contains unique IDs of sub shapes inside theMainShape)
2098      *  \note The sub shape GEOM_Objects can has ONLY ONE function.
2099      *        Don't try to apply modification operations on them.
2100      *  \note Internal method
2101      */
2102     GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
2103
2104     /*!
2105      *  GEOM object's IOR Management
2106      */
2107
2108     /*!
2109      *  Returns a GEOM Object defined by its IOR
2110      *  \param theIOR a string containg an IOR of the requested GEOM object
2111      */
2112     GEOM_Object GetIORFromString (in string theIOR);
2113
2114     /*!
2115      *  Returns a string which contains an IOR of the GEOM object
2116      *  \param theObject is a GEOM object which IOR is requested
2117      */
2118     string GetStringFromIOR (in GEOM_Object theObject);
2119
2120     /*!
2121      *  Returns a name with which a GEOM object was dumped into python script
2122      *  \param theStudyEntry is an entry of the GEOM object in the study
2123      */
2124     string GetDumpName (in string theStudyEntry);
2125
2126     /*!
2127      *  Returns all names with which a GEOM objects was dumped
2128      *  into python script to avoid the same names in SMESH script
2129      */
2130     string_array GetAllDumpNames();
2131   };
2132 };
2133
2134 #endif