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