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