]> SALOME platform Git repositories - modules/geom.git/blob - idl/GEOM_Gen.idl
Salome HOME
Common update of Salome GUI documentation
[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      *  Scale the given object by different factors along coordinate axes.
740      *  \param theObject The object to be scaled.
741      *  \param thePoint Center point for scaling.
742      *  \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
743      *  \return theObject.
744      */
745     GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
746                                      in GEOM_Object thePoint,
747                                      in double theFactorX,
748                                      in double theFactorY,
749                                      in double theFactorZ);
750
751     /*!
752      *  Scale the given object by different factors along coordinate axes,
753      *  creating its copy before the scaling.
754      *  \param theObject The object to be scaled.
755      *  \param thePoint Center point for scaling.
756      *  \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
757      *  \return New GEOM_Object, containing the scaled shape.
758      */
759     GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
760                                          in GEOM_Object thePoint,
761                                          in double theFactorX,
762                                          in double theFactorY,
763                                          in double theFactorZ);
764
765     /*!
766      *  Modify the Location of the given object by LCS.
767      *  \param theObject The object to be displaced.
768      *  \param theStartLCS Coordinate system to perform displacement from it.
769      *                     If \a theStartLCS is NULL, displacement
770      *                     will be performed from global CS.
771      *                     If \a theObject itself is used as \a theStartLCS,
772      *                     its location will be changed to \a theEndLCS.
773      *  \param theEndLCS Coordinate system to perform displacement to it.
774      *  \return theObject.
775      */
776     GEOM_Object PositionShape (in GEOM_Object theObject,
777                                in GEOM_Object theStartLCS,
778                                in GEOM_Object theEndLCS);
779
780     /*!
781      *  Modify the Location of the given object by LCS,
782      *  creating its copy before the setting.
783      *  \param theObject The object to be displaced.
784      *  \param theStartLCS Coordinate system to perform displacement from it.
785      *                     If \a theStartLCS is NULL, displacement
786      *                     will be performed from global CS.
787      *                     If \a theObject itself is used as \a theStartLCS,
788      *                     its location will be changed to \a theEndLCS.
789      *  \param theEndLCS Coordinate system to perform displacement to it.
790      *  \return New GEOM_Object, containing the displaced shape.
791      */
792     GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
793                                    in GEOM_Object theStartLCS,
794                                    in GEOM_Object theEndLCS);
795
796     /*!
797      *  Recompute the shape from its arguments.
798      *  \param theObject The object to be recomputed.
799      *  \return theObject.
800      */
801     GEOM_Object RecomputeObject (in GEOM_Object theObject);
802   };
803
804   /*!
805    *  GEOM_I3DPrimOperations: Interface for 3D primitives creation
806    *  Box, Cylinder, Cone, Sphere, Prism (extrusion),
807    *  Pipe (extrusion along contour), Revolution, Solid (from shell).
808    */
809   interface GEOM_I3DPrimOperations : GEOM_IOperations
810   {
811     /*!
812      *  Create a box with specified dimensions along the coordinate axes
813      *  and with edges, parallel to the coordinate axes.
814      *  Center of the box will be at point (DX/2, DY/2, DZ/2).
815      *  \param theDX Length of Box edges, parallel to OX axis.
816      *  \param theDY Length of Box edges, parallel to OY axis.
817      *  \param theDZ Length of Box edges, parallel to OZ axis.
818      *  \return New GEOM_Object, containing the created box.
819      */
820     GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
821
822     /*!
823      *  Create a box with two specified opposite vertices,
824      *  and with edges, parallel to the coordinate axes
825      *  \param thePnt1 First of two opposite vertices.
826      *  \param thePnt2 Second of two opposite vertices.
827      *  \return New GEOM_Object, containing the created box.
828      */
829     GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
830
831     /*!
832      *  Create a cylinder with given radius and height at
833      *  the origin of coordinate system. Axis of the cylinder
834      *  will be collinear to the OZ axis of the coordinate system.
835      *  \param theR Cylinder radius.
836      *  \param theH Cylinder height.
837      *  \return New GEOM_Object, containing the created cylinder.
838      */
839     GEOM_Object MakeCylinderRH (in double theR, in double theH);
840
841     /*!
842      *  Create a cylinder with given base point, axis, radius and height.
843      *  \param thePnt Central point of cylinder base.
844      *  \param theAxis Cylinder axis.
845      *  \param theR Cylinder radius.
846      *  \param theH Cylinder height.
847      *  \return New GEOM_Object, containing the created cylinder.
848      */
849     GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
850                                       in GEOM_Object theAxis,
851                                       in double      theR,
852                                       in double      theH);
853
854     /*!
855      *  Create a cone with given height and radiuses at
856      *  the origin of coordinate system. Axis of the cone will
857      *  be collinear to the OZ axis of the coordinate system.
858      *  \param theR1 Radius of the first cone base.
859      *  \param theR2 Radius of the second cone base.
860      *    \note If both radiuses are non-zero, the cone will be truncated.
861      *    \note If the radiuses are equal, a cylinder will be created instead.
862      *  \param theH Cone height.
863      *  \return New GEOM_Object, containing the created cone.
864      */
865     GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
866
867     /*!
868      *  Create a cone with given base point, axis, height and radiuses.
869      *  \param thePnt Central point of the first cone base.
870      *  \param theAxis Cone axis.
871      *  \param theR1 Radius of the first cone base.
872      *  \param theR2 Radius of the second cone base.
873      *    \note If both radiuses are non-zero, the cone will be truncated.
874      *    \note If the radiuses are equal, a cylinder will be created instead.
875      *  \param theH Cone height.
876      *  \return New GEOM_Object, containing the created cone.
877      */
878     GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
879                                      in GEOM_Object theAxis,
880                                      in double      theR1,
881                                      in double      theR2,
882                                      in double      theH);
883
884     /*!
885      *  Create a torus with given radiuses at the origin of coordinate system.
886      *  \param theRMajor Torus major radius.
887      *  \param theRMinor Torus minor radius.
888      *  \return New GEOM_Object, containing the created torus.
889      */
890     GEOM_Object MakeTorusRR (in double theRMajor,
891                              in double theRMinor);
892
893     /*!
894      *  Create a torus with given center, normal vector and radiuses.
895      *  \param thePnt Torus central point.
896      *  \param theVec Torus axis of symmetry.
897      *  \param theRMajor Torus major radius.
898      *  \param theRMinor Torus minor radius.
899      *  \return New GEOM_Object, containing the created torus.
900      */
901     GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
902                                    in GEOM_Object theVec,
903                                    in double theRMajor,
904                                    in double theRMinor);
905
906     /*!
907      *  Create a sphere with given radius at the origin of coordinate system.
908      *  \param theR Sphere radius.
909      *  \return New GEOM_Object, containing the created sphere.
910      */
911     GEOM_Object MakeSphereR (in double theR);
912
913     /*!
914      *  Create a sphere with given center and radius.
915      *  \param thePnt Sphere center.
916      *  \param theR Sphere radius.
917      *  \return New GEOM_Object, containing the created .
918      */
919     GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
920
921     /*!
922      *  Create a shape by extrusion of the base shape along the vector,
923      *  i.e. all the space, transfixed by the base shape during its translation
924      *  along the vector on the given distance.
925      *  \param theBase Base shape to be extruded.
926      *  \param theVec Direction of extrusion.
927      *  \param theH Prism dimension along theVec.
928      *  \return New GEOM_Object, containing the created prism.
929      */
930     GEOM_Object MakePrismVecH (in GEOM_Object theBase,
931                                in GEOM_Object theVec,
932                                in double      theH);
933     /*  The Same Prism but in 2 directions (forward&backward) */
934     GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
935                                     in GEOM_Object theVec,
936                                     in double      theH);
937
938     /*!
939      *  Create a shape by extrusion of the base shape along a vector, defined by two points.
940      *  \param theBase Base shape to be extruded.
941      *  \param thePoint1 First end of extrusion vector.
942      *  \param thePoint2 Second end of extrusion vector.
943      *  \return New GEOM_Object, containing the created prism.
944      */
945     GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
946                                  in GEOM_Object thePoint1,
947                                  in GEOM_Object thePoint2);
948     /*  The same prism but in two directions forward&backward */
949     GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
950                                       in GEOM_Object thePoint1,
951                                       in GEOM_Object thePoint2);
952
953     /*!
954      *  Create a shape by extrusion of the base shape along
955      *  the path shape. The path shape can be a wire or an edge.
956      *  \param theBase Base shape to be extruded.
957      *  \param thePath Path shape to extrude the base shape along it.
958      *  \return New GEOM_Object, containing the created pipe.
959      */
960     GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
961
962     /*!
963      *  Create a shape by revolution of the base shape around the axis
964      *  on the given angle, i.e. all the space, transfixed by the base
965      *  shape during its rotation around the axis on the given angle.
966      *  \param theBase Base shape to be rotated.
967      *  \param theAxis Rotation axis.
968      *  \param theAngle Rotation angle in radians.
969      *  \return New GEOM_Object, containing the created revolution.
970      */
971     GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
972                                          in GEOM_Object theAxis,
973                                          in double theAngle);
974     /*  The Same Revolution but in both ways forward&backward */
975     GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
976                                               in GEOM_Object theAxis,
977                                               in double theAngle);
978
979     /*!
980      *  Create a filling from the given compound of contours.
981      *  \param theMinDeg a minimal degree of BSpline surface to create
982      *  \param theMaxDeg a maximal degree of BSpline surface to create
983      *  \param theTol2D a 2d tolerance to be reached
984      *  \param theTol3D a 3d tolerance to be reached
985      *  \param theNbIter a number of iteration of approximation algorithm
986      *  \return New GEOM_Object, containing the created filling surface.
987      */
988     GEOM_Object MakeFilling (in GEOM_Object theShape,
989                              in long theMinDeg, in long theMaxDeg,
990                              in double theTol2D, in double theTol3D,
991                              in long theNbIter, in boolean theApprox);
992
993     /*!
994      *  Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
995      *  \param theSeqSections - set of specified sections.
996      *  \param theModeSolid - mode defining building solid or shell
997      *  \param thePreci - precision 3D used for smoothing by default 1.e-6
998      *  \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
999      *  \return New GEOM_Object, containing the created shell or solid.
1000      */
1001     GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1002                                  in boolean theModeSolid,
1003                                  in double thePreci,
1004                                  in boolean theRuled);
1005
1006       /*!
1007      *  Create a shape by extrusion of the profile shape along
1008      *  the path shape. The path shape can be a wire or an edge.
1009      *  the several profiles can be specified in the several locations of path. 
1010      *  \param theSeqBases - list of  Bases shape to be extruded.
1011      *  \param theLocations - list of locations on the path corresponding
1012      *                        specified list of the Bases shapes. Number of locations
1013      *                        should be equal to number of bases or list of locations can be empty.
1014      *  \param thePath - Path shape to extrude the base shape along it.
1015      *  \param theWithContact - the mode defining that the section is translated to be in
1016      *                          contact with the spine.
1017      *  \param - WithCorrection - defining that the section is rotated to be
1018      *                           orthogonal to the spine tangent in the correspondent point
1019      *  \return New GEOM_Object, containing the created pipe.
1020      */
1021     GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1022                                                in ListOfGO theLocations,
1023                                                in GEOM_Object thePath,
1024                                                in boolean theWithContact ,
1025                                                in boolean theWithCorrection );
1026
1027     /*!
1028      *  Create a shape by extrusion of the profile shape along
1029      *  the path shape. The path shape can be a shell or a face.
1030      *  the several profiles can be specified in the several locations of path. 
1031      *  \param theSeqBases - list of  Bases shape to be extruded.
1032      *  \param theSeqSubBases - list of corresponding subshapes of section shapes.
1033      *  \param theLocations - list of locations on the path corresponding
1034      *                        specified list of the Bases shapes. Number of locations
1035      *                        should be equal to number of bases.
1036      *  \param thePath - Path shape to extrude the base shape along it.
1037      *  \param theWithContact - the mode defining that the section is translated to be in
1038      *                          contact with the spine.
1039      *  \param - WithCorrection - defining that the section is rotated to be
1040      *                           orthogonal to the spine tangent in the correspondent point
1041      *  \return New GEOM_Object, containing the created pipe.
1042      */
1043     GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1044                                            in ListOfGO theSeqSubBases,
1045                                            in ListOfGO theLocations,
1046                                            in GEOM_Object thePath,
1047                                            in boolean theWithContact ,
1048                                            in boolean theWithCorrection );
1049
1050     /*!
1051      * Create solids between given sections
1052      *  \param theSeqBases - list of sections (shell or face).
1053      *  \param theLocations - list of corresponding vertexes
1054      *  \return New GEOM_Object, containing the created solids.
1055      */
1056     GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1057                                            in ListOfGO theLocations);
1058
1059     /*!
1060      *  Create a shape by extrusion of the base shape along
1061      *  the path shape with constant bi-normal direction along the given vector. 
1062      *  The path shape can be a wire or an edge.
1063      *  \param theBase Base shape to be extruded.
1064      *  \param thePath Path shape to extrude the base shape along it.
1065      *  \param theVec Vector defines a constant binormal direction to keep the
1066      *                same angle beetween the Direction and the sections
1067      *                along the sweep surface.
1068      *  \return New GEOM_Object, containing the created pipe.
1069      */
1070     GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase, 
1071                                              in GEOM_Object thePath, 
1072                                              in GEOM_Object theVec);
1073   };
1074
1075   /*!
1076    *  GEOM_IShapesOperations: Interface for Shapes creation:
1077    *  Edge from two points, Wire from edges, Face from wire,
1078    *  Shell from faces, Solid from shells, Compound from shapes
1079    */
1080   interface GEOM_IShapesOperations : GEOM_IOperations
1081   {
1082     /*!
1083      *  Create a linear edge with specified ends.
1084      *  \param thePnt1 Point for the first end of edge.
1085      *  \param thePnt2 Point for the second end of edge.
1086      *  \return New GEOM_Object, containing the created edge.
1087      */
1088     GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1089
1090     /*!
1091      *  Create a wire from the set of edges and wires.
1092      *  \param theEdgesAndWires List of edge and/or wires.
1093      *  \return New GEOM_Object, containing the created wire.
1094      */
1095     GEOM_Object MakeWire (in ListOfGO theEdgesAndWires);
1096
1097     /*!
1098      *  Create a face on the given wire.
1099      *  \param theWire closed Wire or Edge to build the face on.
1100      *  \param isPlanarWanted If TRUE, only planar face will be built.
1101      *                        If impossible, NULL object will be returned.
1102      *  \return New GEOM_Object, containing the created face.
1103      */
1104     GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1105
1106     /*!
1107      *  Create a face on the given wires set.
1108      *  \param theWires List of closed wires or edges to build the face on.
1109      *  \param isPlanarWanted If TRUE, only planar face will be built.
1110      *                        If impossible, NULL object will be returned.
1111      *  \return New GEOM_Object, containing the created face.
1112      */
1113     GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1114
1115     /*!
1116      *  Create a shell from the set of faces and shells.
1117      *  \param theFacesAndShells List of faces and/or shells.
1118      *  \return New GEOM_Object, containing the created shell.
1119      */
1120     GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1121
1122     /*!
1123      *  Create a solid, bounded by the given shell.
1124      *  \param theShell Bounding shell.
1125      *  \return New GEOM_Object, containing the created solid.
1126      */
1127     GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1128
1129     /*!
1130      *  Create a solid, bounded by the given shells.
1131      *  \param theShells Bounding shells.
1132      *  \return New GEOM_Object, containing the created solid.
1133      */
1134     GEOM_Object MakeSolidShells (in ListOfGO theShells);
1135
1136     /*!
1137      *  Create a compound of the given shapes.
1138      *  \param theShapes List of shapes to put in compound.
1139      *  \return New GEOM_Object, containing the created compound.
1140      */
1141     GEOM_Object MakeCompound (in ListOfGO theShapes);
1142
1143     /*!
1144      *  Replace coincident faces in theShape by one face.
1145      *  \param theShape Initial shape.
1146      *  \param theTolerance Maximum distance between faces, which can be considered as coincident.
1147      *  \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1148      *  \return New GEOM_Object, containing a copy of theShape without coincident faces.
1149      */
1150     GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1151
1152     /*!
1153      *  Find coincident faces in theShape for possible gluing.
1154      *  \param theShape Initial shape.
1155      *  \param theTolerance Maximum distance between faces, which can be considered as coincident.
1156      *  \return ListOfGO
1157      */
1158     ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1159
1160     /*!
1161      *  Replace coincident faces in theShape by one face
1162      *  in compliance with given list of faces
1163      *  \param theShape Initial shape.
1164      *  \param theTolerance Maximum distance between faces, which can be considered as coincident.
1165      *  \param theFaces List of faces for gluing.
1166      *  \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1167      *  \return New GEOM_Object, containing a copy of theShape without some faces.
1168      */
1169     GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1170                                      in ListOfGO theFaces, in boolean doKeepNonSolids);
1171
1172     /*!
1173      *  Explode a shape on subshapes of a given type.
1174      *  \param theShape Shape to be exploded.
1175      *  \param theShapeType Type of sub-shapes to be retrieved.
1176      *  \param isSorted If this parameter is TRUE, sub-shapes will be
1177      *                  sorted by coordinates of their gravity centers.
1178      *  \return List of sub-shapes of type theShapeType, contained in theShape.
1179      */
1180     ListOfGO MakeExplode (in GEOM_Object theShape,
1181                           in long        theShapeType,
1182                           in boolean     isSorted);
1183
1184     /*!
1185      *  Explode a shape on subshapes of a given type.
1186      *  Does the same, as the above method, but returns IDs of sub-shapes,
1187      *  not GEOM_Objects. It works faster.
1188      *  \param theShape Shape to be exploded.
1189      *  \param theShapeType Type of sub-shapes to be retrieved.
1190      *  \param isSorted If this parameter is TRUE, sub-shapes will be
1191      *                  sorted by coordinates of their gravity centers.
1192      *  \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1193      */
1194     ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1195                                in long        theShapeType,
1196                                in boolean     isSorted);
1197
1198     /*!
1199      *  Get a sub shape defined by its unique ID inside \a theMainShape
1200      *  \note The sub shape GEOM_Objects can has ONLY ONE function.
1201      *        Don't try to apply modification operations on them.
1202      */
1203     GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1204                              in long        theID);
1205
1206     /*!
1207      *  Get global index of \a theSubShape in \a theMainShape.
1208      *  \param theMainShape Main shape.
1209      *  \param theSubShape Sub-shape of the main shape.
1210      *  \return global index of \a theSubShape in \a theMainShape.
1211      */
1212     long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1213
1214     /*!
1215      *  Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1216      *  Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1217      *  to generate automatic names for sub-shapes, when publishing them in a study.
1218      *  \param theMainShape Main shape.
1219      *  \param theSubShape Sub-shape of the main shape.
1220      *  \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1221      */
1222     long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1223
1224     /*!
1225      *  \brief Get name of type of \a theShape.
1226      *
1227      *  Use wide type notation, taking into consideration both topology and geometry of the shape.
1228      *  Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1229      *  to generate automatic names for sub-shapes, when publishing them in a study.
1230      *  \param theShape The shape to get a type of.
1231      *  \return String, containing a type name of \a theShape.
1232      */
1233     string GetShapeTypeString (in GEOM_Object theShape);
1234
1235     /*!
1236      *  Count number of faces in the given shape.
1237      *  \param theShape Shape to count faces in.
1238      *  \return Number of faces in the given shape.
1239      */
1240     long NumberOfFaces (in GEOM_Object theShape);
1241
1242     /*!
1243      *  Count number of edges in the given shape.
1244      *  \param theShape Shape to count edges in.
1245      *  \return Number of edges in theShape.
1246      */
1247     long NumberOfEdges (in GEOM_Object theShape);
1248
1249     /*!
1250      *  Reverses an orientation the given shape.
1251      *  \param theShape Shape to be reversed.
1252      *  \return The reversed copy of theShape.
1253      */
1254     GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1255
1256     /*!
1257      *  Retrieve all free faces from the given shape.
1258      *  Free face is a face, which is not shared between two shells of the shape.
1259      *  \param theShape Shape to find free faces in.
1260      *  \return List of IDs of all free faces, contained in theShape.
1261      */
1262     ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1263
1264     /*!
1265      *  Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1266      *  \param theShape1 Shape to find sub-shapes in.
1267      *  \param theShape2 Shape to find shared sub-shapes with.
1268      *  \param theShapeType Type of sub-shapes to be retrieved.
1269      *  \return List of sub-shapes of theShape1, shared with theShape2.
1270      */
1271     ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1272                               in GEOM_Object theShape2,
1273                               in long        theShapeType);
1274
1275     /*!
1276      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1277      *  the specified plane by the certain way, defined through \a theState parameter.
1278      *  \param theShape Shape to find sub-shapes of.
1279      *  \param theShapeType Type of sub-shapes to be retrieved.
1280      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1281      *                direction and location of the plane to find shapes on.
1282      *  \param theState The state of the subshapes to find.
1283      *  \return List of all found sub-shapes.
1284      */
1285     ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1286                                in long        theShapeType,
1287                                in GEOM_Object theAx1,
1288                                in shape_state theState);
1289     /*!
1290      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1291      *  the specified plane by the certain way, defined through \a theState parameter.
1292      *  \param theShape Shape to find sub-shapes of.
1293      *  \param theShapeType Type of sub-shapes to be retrieved.
1294      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1295      *                direction of the plane to find shapes on.
1296      *  \param thePnt Point specifying location of the plane to find shapes on.
1297      *  \param theState The state of the subshapes to find.
1298      *  \return List of all found sub-shapes.
1299      */
1300     ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1301                                            in long        theShapeType,
1302                                            in GEOM_Object theAx1,
1303                                            in GEOM_Object thePnt,
1304                                            in shape_state theState);
1305
1306
1307
1308     /*!
1309      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1310      *  the specified cylinder by the certain way, defined through \a theState parameter.
1311      *  \param theShape Shape to find sub-shapes of.
1312      *  \param theShapeType Type of sub-shapes to be retrieved.
1313      *  \param theAxis Vector (or line, or linear edge), specifying
1314      *                 axis of the cylinder to find shapes on.
1315      *  \param theRadius Radius of the cylinder to find shapes on.
1316      *  \param theState The state of the subshapes to find.
1317      *  \return List of all found sub-shapes.
1318      */
1319     ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1320                                   in long        theShapeType,
1321                                   in GEOM_Object theAxis,
1322                                   in double      theRadius,
1323                                   in shape_state theState);
1324
1325     /*!
1326      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1327      *  the specified sphere by the certain way, defined through \a theState parameter.
1328      *  \param theShape Shape to find sub-shapes of.
1329      *  \param theShapeType Type of sub-shapes to be retrieved.
1330      *  \param theCenter Point, specifying center of the sphere to find shapes on.
1331      *  \param theRadius Radius of the sphere to find shapes on.
1332      *  \param theState The state of the subshapes to find.
1333      *  \return List of all found sub-shapes.
1334      */
1335     ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1336                                 in long        theShapeType,
1337                                 in GEOM_Object theCenter,
1338                                 in double      theRadius,
1339                                 in shape_state theState);
1340
1341     /*!
1342      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1343      *  the specified quadrangle by the certain way, defined through \a theState parameter.
1344      *  \param theShape Shape to find sub-shapes of.
1345      *  \param theShapeType Type of sub-shapes to be retrieved.
1346      *  \param theTopLeftPoint Top left quadrangle corner
1347      *  \param theTopRigthPoint Top right quadrangle corner
1348      *  \param theBottomLeftPoint Bottom left quadrangle corner
1349      *  \param theBottomRigthPoint Bottom right quadrangle corner
1350      *  \param theState The state of the subshapes to find.
1351      *  \return List of all found sub-shapes.
1352      */
1353     ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1354                                     in long        theShapeType,
1355                                     in GEOM_Object theTopLeftPoint,
1356                                     in GEOM_Object theTopRigthPoint,
1357                                     in GEOM_Object theBottomLeftPoint,
1358                                     in GEOM_Object theBottomRigthPoint,
1359                                     in shape_state theState);
1360
1361     /*!
1362      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1363      *  the specified plane 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 theAx1 Vector (or line, or linear edge), specifying normal
1367      *                direction and location of the plane 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 GetShapesOnPlaneIDs (in GEOM_Object theShape,
1372                                     in long        theShapeType,
1373                                     in GEOM_Object theAx1,
1374                                     in shape_state theState);
1375
1376     /*!
1377      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1378      *  the specified plane by the certain way, defined through \a theState parameter.
1379      *  \param theShape Shape to find sub-shapes of.
1380      *  \param theShapeType Type of sub-shapes to be retrieved.
1381      *  \param theAx1 Vector (or line, or linear edge), specifying normal
1382      *                direction of the plane to find shapes on.
1383      *  \param thePnt Point specifying location of the plane to find shapes on.
1384      *  \param theState The state of the subshapes to find.
1385      *  \return List of IDs of all found sub-shapes.
1386      */
1387     ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1388                                                 in long        theShapeType,
1389                                                 in GEOM_Object theAx1,
1390                                                 in GEOM_Object thePnt,
1391                                                 in shape_state theState);
1392
1393     /*!
1394      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1395      *  the specified cylinder by the certain way, defined through \a theState parameter.
1396      *  \param theShape Shape to find sub-shapes of.
1397      *  \param theShapeType Type of sub-shapes to be retrieved.
1398      *  \param theAxis Vector (or line, or linear edge), specifying
1399      *                 axis of the cylinder to find shapes on.
1400      *  \param theRadius Radius of the cylinder to find shapes on.
1401      *  \param theState The state of the subshapes to find.
1402      *  \return List of IDs of all found sub-shapes.
1403      */
1404     ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1405                                        in long        theShapeType,
1406                                        in GEOM_Object theAxis,
1407                                        in double      theRadius,
1408                                        in shape_state theState);
1409
1410     /*!
1411      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1412      *  the specified sphere by the certain way, defined through \a theState parameter.
1413      *  \param theShape Shape to find sub-shapes of.
1414      *  \param theShapeType Type of sub-shapes to be retrieved.
1415      *  \param theCenter Point, specifying center of the sphere to find shapes on.
1416      *  \param theRadius Radius of the sphere to find shapes on.
1417      *  \param theState The state of the subshapes to find.
1418      *  \return List of IDs of all found sub-shapes.
1419      */
1420     ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1421                                      in long        theShapeType,
1422                                      in GEOM_Object theCenter,
1423                                      in double      theRadius,
1424                                      in shape_state theState);
1425
1426     /*!
1427      *  Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1428      *  the specified quadrangle by the certain way, defined through \a theState parameter.
1429      *  \param theShape Shape to find sub-shapes of.
1430      *  \param theShapeType Type of sub-shapes to be retrieved.
1431      *  \param theTopLeftPoint Top left quadrangle corner
1432      *  \param theTopRigthPoint Top right quadrangle corner
1433      *  \param theBottomLeftPoint Bottom left quadrangle corner
1434      *  \param theBottomRigthPoint Bottom right quadrangle corner
1435      *  \param theState The state of the subshapes to find.
1436      *  \return List of IDs of all found sub-shapes.
1437      */
1438     ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1439                                          in long        theShapeType,
1440                                          in GEOM_Object theTopLeftPoint,
1441                                          in GEOM_Object theTopRigthPoint,
1442                                          in GEOM_Object theBottomLeftPoint,
1443                                          in GEOM_Object theBottomRigthPoint,
1444                                          in shape_state theState);
1445
1446     /*!
1447      * \brief Find subshapes complying with given status
1448      * \param theBox - the box to check state of subshapes against
1449      * \param theShape - the shape to explore
1450      * \param theShapeType - type of subshape of theShape
1451      * \param theState - required state
1452      * \return List of IDs of all found sub-shapes.
1453      */
1454     ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1455                                   in GEOM_Object theShape,
1456                                   in long        theShapeType,
1457                                   in shape_state theState);
1458
1459     /*!
1460      * \brief Find subshapes complying with given status
1461      * \param theBox - the box to check state of subshapes against
1462      * \param theShape - the shape to explore
1463      * \param theShapeType - type of subshape of theShape
1464      * \param theState - required state
1465      * \return List of all found sub-shapes.
1466      */
1467     ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1468                              in GEOM_Object theShape,
1469                              in long        theShapeType,
1470                              in shape_state theState);
1471
1472     /*!
1473      * \brief Find subshapes complying with given status
1474      * \param theCheckShape - the shape to check state of subshapes against
1475      * \param theShape - the shape to explore
1476      * \param theShapeType - type of subshape of theShape
1477      * \param theState - required state
1478      * \return List of IDs of all found sub-shapes.
1479      */
1480     ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1481                                     in GEOM_Object theShape,
1482                                     in short       theShapeType,
1483                                     in shape_state theState);
1484
1485     /*!
1486      * \brief Find subshapes complying with given status
1487      * \param theCheckShape - the shape to check state of subshapes against
1488      * \param theShape - the shape to explore
1489      * \param theShapeType - type of subshape of theShape
1490      * \param theState - required state
1491      * \return List of all found sub-shapes.
1492      */
1493     ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1494                                in GEOM_Object theShape,
1495                                in short       theShapeType,
1496                                in shape_state theState);
1497
1498     /*!
1499      * \brief Find subshapes complying with given status
1500      * \param theCheckShape - the shape to check state of subshapes against
1501      * \param theShape - the shape to explore
1502      * \param theShapeType - type of subshape of theShape
1503      * \param theState - required state
1504      * \return compound includes all found sub-shapes.
1505      */
1506     GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1507                                             in GEOM_Object theShape,
1508                                             in short       theShapeType,
1509                                             in shape_state theState);
1510
1511     /*!
1512      *  Get sub-shape(s) of \a theShapeWhere, which are
1513      *  coincident with \a theShapeWhat or could be a part of it.
1514      *  \param theShapeWhere Shape to find sub-shapes of.
1515      *  \param theShapeWhat Shape, specifying what to find.
1516      *  \return Group of all found sub-shapes or a single found sub-shape.
1517      */
1518     GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1519                             in GEOM_Object theShapeWhat);
1520
1521     /*!
1522      *  Get sub-shape(s) of \a theShapeWhere, which are
1523      *  coincident with \a theShapeWhat or could be a part of it.
1524      *
1525      *  Implementation of this method is based on a saved history of an operation,
1526      *  produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1527      *  arguments (an argument shape or a sub-shape of an argument shape).
1528      *  The operation could be the Partition or one of boolean operations,
1529      *  performed on simple shapes (not on compounds).
1530      *
1531      *  \param theShapeWhere Shape to find sub-shapes of.
1532      *  \param theShapeWhat Shape, specifying what to find.
1533      *  \return Group of all found sub-shapes or a single found sub-shape.
1534      */
1535     GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1536                                      in GEOM_Object theShapeWhat);
1537
1538     /*!
1539      *  Get sub-shape of theShapeWhere, which are
1540      *  coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1541      *  \param theShapeWhere Shape to find sub-shapes of.
1542      *  \param theShapeWhat Shape, specifying what to find.
1543      *  \return found sub-shape.
1544      */
1545     GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1546                          in GEOM_Object theShapeWhat);
1547   };
1548
1549   /*!
1550    *  GEOM_IBlocksOperations: Interface for Blocks construction
1551    *  Face from points or edges, Block from faces,
1552    *  Blocks multi-translation and multi-rotation
1553    */
1554   interface GEOM_IBlocksOperations : GEOM_IOperations
1555   {
1556     /*!
1557      *  Creation of blocks
1558      */
1559
1560     /*!
1561      *  Create a quadrangle face from four edges. Order of Edges is not
1562      *  important. It is  not necessary that edges share the same vertex.
1563      *  \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1564      *  \return New GEOM_Object, containing the created face.
1565      */
1566     GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1567                           in GEOM_Object theEdge2,
1568                           in GEOM_Object theEdge3,
1569                           in GEOM_Object theEdge4);
1570
1571     /*!
1572      *  Create a quadrangle face on two edges.
1573      *  The missing edges will be built by creating the shortest ones.
1574      *  \param theEdge1,theEdge2 Two opposite edges for the face.
1575      *  \return New GEOM_Object, containing the created face.
1576      */
1577     GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1578                                 in GEOM_Object theEdge2);
1579
1580     /*!
1581      *  Create a quadrangle face with specified corners.
1582      *  The missing edges will be built by creating the shortest ones.
1583      *  \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1584      *  \return New GEOM_Object, containing the created face.
1585      */
1586     GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1587                                    in GEOM_Object thePnt2,
1588                                    in GEOM_Object thePnt3,
1589                                    in GEOM_Object thePnt4);
1590
1591     /*!
1592      *  Create a hexahedral solid, bounded by the six given faces. Order of
1593      *  faces is not important. It is  not necessary that Faces share the same edge.
1594      *  \param theFace1-theFace6 Faces for the hexahedral solid.
1595      *  \return New GEOM_Object, containing the created solid.
1596      */
1597     GEOM_Object MakeHexa (in GEOM_Object theFace1,
1598                           in GEOM_Object theFace2,
1599                           in GEOM_Object theFace3,
1600                           in GEOM_Object theFace4,
1601                           in GEOM_Object theFace5,
1602                           in GEOM_Object theFace6);
1603
1604     /*!
1605      *  Create a hexahedral solid between two given faces.
1606      *  The missing faces will be built by creating the smallest ones.
1607      *  \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1608      *  \return New GEOM_Object, containing the created solid.
1609      */
1610     GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1611                                 in GEOM_Object theFace2);
1612
1613     /*!
1614      *  Extract elements of blocks and blocks compounds
1615      */
1616
1617     /*!
1618      *  Get a vertex, found in the given shape by its coordinates.
1619      *  \param theShape Block or a compound of blocks.
1620      *  \param theX,theY,theZ Coordinates of the sought vertex.
1621      *  \param theEpsilon Maximum allowed distance between the resulting
1622      *                    vertex and point with the given coordinates.
1623      *  \return New GEOM_Object, containing the found vertex.
1624      */
1625     GEOM_Object GetPoint (in GEOM_Object theShape,
1626                           in double      theX,
1627                           in double      theY,
1628                           in double      theZ,
1629                           in double      theEpsilon);
1630
1631     /*!
1632      *  Get an edge, found in the given shape by two given vertices.
1633      *  \param theShape Block or a compound of blocks.
1634      *  \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1635      *  \return New GEOM_Object, containing the found edge.
1636      */
1637     GEOM_Object GetEdge (in GEOM_Object theShape,
1638                          in GEOM_Object thePoint1,
1639                          in GEOM_Object thePoint2);
1640
1641     /*!
1642      *  Find an edge of the given shape, which has minimal distance to the given point.
1643      *  \param theShape Block or a compound of blocks.
1644      *  \param thePoint Point, close to the desired edge.
1645      *  \return New GEOM_Object, containing the found edge.
1646      */
1647     GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1648                                   in GEOM_Object thePoint);
1649
1650     /*!
1651      *  Returns a face, found in the given shape by four given corner vertices.
1652      *  \param theShape Block or a compound of blocks.
1653      *  \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1654      *  \return New GEOM_Object, containing the found face.
1655      */
1656     GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1657                                  in GEOM_Object thePoint1,
1658                                  in GEOM_Object thePoint2,
1659                                  in GEOM_Object thePoint3,
1660                                  in GEOM_Object thePoint4);
1661
1662     /*!
1663      *  Get a face of block, found in the given shape by two given edges.
1664      *  \param theShape Block or a compound of blocks.
1665      *  \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1666      *  \return New GEOM_Object, containing the found face.
1667      */
1668     GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1669                                 in GEOM_Object theEdge1,
1670                                 in GEOM_Object theEdge2);
1671
1672     /*!
1673      *  Find a face, opposite to the given one in the given block.
1674      *  \param theBlock Must be a hexahedral solid.
1675      *  \param theFace Face of \a theBlock, opposite to the desired face.
1676      *  \return New GEOM_Object, containing the found face.
1677      */
1678     GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1679                                  in GEOM_Object theFace);
1680
1681     /*!
1682      *  Find a face of the given shape, which has minimal distance to the given point.
1683      *  \param theShape Block or a compound of blocks.
1684      *  \param thePoint Point, close to the desired face.
1685      *  \return New GEOM_Object, containing the found face.
1686      */
1687     GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1688                                   in GEOM_Object thePoint);
1689
1690     /*!
1691      *  Find a face of block, whose outside normale has minimal angle with the given vector.
1692      *  \param theShape Block or a compound of blocks.
1693      *  \param theVector Vector, close to the normale of the desired face.
1694      *  \return New GEOM_Object, containing the found face.
1695      */
1696     GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1697                                   in GEOM_Object theVector);
1698
1699     /*!
1700      *  Extract blocks from blocks compounds
1701      */
1702
1703     /*!
1704      *  Check, if the compound contains only specified blocks.
1705      *  \param theCompound The compound to check.
1706      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
1707      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1708      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1709      *  \return TRUE, if the given compound contains only blocks.
1710      *  \return theNbBlocks Number of specified blocks in theCompound.
1711      */
1712     boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
1713                                 in long        theMinNbFaces,
1714                                 in long        theMaxNbFaces,
1715                                 out long       theNbBlocks);
1716
1717     /*!
1718      *  Enumeration of Blocks Compound defects.
1719      */
1720     enum BCErrorType
1721     {
1722       /* Each element of the compound should be a Block */
1723       NOT_BLOCK,
1724
1725       /* An element is a potential block, but has degenerated and/or seam edge(s). */
1726       EXTRA_EDGE,
1727
1728       /* A connection between two Blocks should be an entire face or an entire edge */
1729       INVALID_CONNECTION,
1730
1731       /* The compound should be connexe */
1732       NOT_CONNECTED,
1733
1734       /* The glue between two quadrangle faces should be applied */
1735       NOT_GLUED
1736     };
1737
1738     /*!
1739      *  Description of Blocks Compound defect: type and incriminated sub-shapes.
1740      */
1741     struct BCError
1742     {
1743       BCErrorType error;
1744       ListOfLong  incriminated;
1745     };
1746
1747     /*!
1748      *  Sequence of all Blocks Compound defects.
1749      */
1750     typedef sequence<BCError> BCErrors;
1751
1752     /*!
1753      *  Check, if the compound of blocks is given.
1754      *  To be considered as a compound of blocks, the
1755      *  given shape must satisfy the following conditions:
1756      *  - Each element of the compound should be a Block (6 faces and 12 edges).
1757      *  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
1758      *  - The compound should be connexe.
1759      *  - The glue between two quadrangle faces should be applied.
1760      *    \note Single block is also accepted as a valid compound of blocks.
1761      *  \param theCompound The compound to check.
1762      *  \return TRUE, if the given shape is a compound of blocks.
1763      *  \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
1764      */
1765     boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
1766                                    out BCErrors   theErrors);
1767
1768     /*!
1769      *  Convert sequence of Blocks Compound errors, returned by
1770      *  <VAR>CheckCompoundOfBlocks()</VAR>, into string.
1771      *  \param theCompound The bad compound.
1772      *  \param theErrors The sequence of \a theCompound errors.
1773      *  \return String, describing all the errors in form, suitable for printing.
1774      */
1775     string PrintBCErrors (in GEOM_Object theCompound,
1776                           in BCErrors    theErrors);
1777
1778     /*!
1779      *  Remove all seam and degenerated edges from \a theShape.
1780      *  Unite faces and edges, sharing one surface.
1781      *  \param theShape The compound or single solid to remove irregular edges from.
1782      *  \return Improved shape.
1783      */
1784     GEOM_Object RemoveExtraEdges (in GEOM_Object theShape);
1785
1786     /*!
1787      *  Check, if the given shape is a blocks compound.
1788      *  Fix all detected errors.
1789      *    \note Single block can be also fixed by this method.
1790      *  \param theCompound The compound to check and improve.
1791      *  \return Improved compound.
1792      */
1793     GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
1794
1795     /*!
1796      *  Get all the blocks, contained in the given compound.
1797      *  \param theCompound The compound to explode.
1798      *  \param theMinNbFaces If solid has lower number of faces, it is not a block.
1799      *  \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1800      *    \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1801      *  \return List of GEOM_Objects, containing the retrieved blocks.
1802      */
1803     ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
1804                                       in long        theMinNbFaces,
1805                                       in long        theMaxNbFaces);
1806
1807     /*!
1808      *  Find block, containing the given point inside its volume or on boundary.
1809      *  \param theCompound Compound, to find block in.
1810      *  \param thePoint Point, close to the desired block. If the point lays on
1811      *         boundary between some blocks, we return block with nearest center.
1812      *  \return New GEOM_Object, containing the found block.
1813      */
1814     GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
1815                                    in GEOM_Object thePoint);
1816
1817     /*!
1818      *  Find block, containing all the elements, passed as the parts, or maximum quantity of them.
1819      *  \param theCompound Compound, to find block in.
1820      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
1821      *  \return New GEOM_Object, containing the found block.
1822      */
1823     GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
1824                                  in ListOfGO    theParts);
1825
1826     /*!
1827      *  Return all blocks, containing all the elements, passed as the parts.
1828      *  \param theCompound Compound, to find blocks in.
1829      *  \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
1830      *  \return List of GEOM_Objects, containing the found blocks.
1831      */
1832     ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
1833                                in ListOfGO    theParts);
1834
1835     /*!
1836      *  Operations on blocks with gluing of result
1837      */
1838
1839     /*!
1840      *  Multi-transformate block and glue the result.
1841      *  Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
1842      *  \param theBlock Hexahedral solid to be multi-transformed.
1843      *  \param theDirFace1 First direction face global index.
1844      *  \param theDirFace2 Second direction face global index.
1845      *  \param theNbTimes Quantity of transformations to be done.
1846      *    \note Global index of sub-shape can be obtained, using method
1847      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1848      *  \return New GEOM_Object, containing the result shape.
1849      */
1850     GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
1851                                            in long        theDirFace1,
1852                                            in long        theDirFace2,
1853                                            in long        theNbTimes);
1854
1855     /*!
1856      *  Multi-transformate block and glue the result.
1857      *  \param theBlock Hexahedral solid to be multi-transformed.
1858      *  \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
1859      *  \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
1860      *  \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
1861      *  \return New GEOM_Object, containing the result shape.
1862      */
1863     GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
1864                                            in long        theDirFace1U,
1865                                            in long        theDirFace2U,
1866                                            in long        theNbTimesU,
1867                                            in long        theDirFace1V,
1868                                            in long        theDirFace2V,
1869                                            in long        theNbTimesV);
1870
1871     /*!
1872      *  Special operation - propagation
1873      */
1874
1875     /*!
1876      *  Build all possible propagation groups.
1877      *  Propagation group is a set of all edges, opposite to one (main)
1878      *  edge of this group directly or through other opposite edges.
1879      *  Notion of Opposite Edge make sence only on quadrangle face.
1880      *  \param theShape Shape to build propagation groups on.
1881      *  \return List of GEOM_Objects, each of them is a propagation group.
1882      */
1883     ListOfGO Propagate (in GEOM_Object theShape);
1884   };
1885
1886   /*!
1887    *  GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
1888    */
1889   interface GEOM_IBooleanOperations : GEOM_IOperations
1890   {
1891     /*!
1892      *  Perform one of boolean operations on two given shapes.
1893      *  \param theShape1 First argument for boolean operation.
1894      *  \param theShape2 Second argument for boolean operation.
1895      *  \param theOperation Indicates the operation to be done:
1896      *                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1897      *  \return New GEOM_Object, containing the result shape.
1898      */
1899     GEOM_Object MakeBoolean (in GEOM_Object theShape1,
1900                              in GEOM_Object theShape2,
1901                              in long theOperation);
1902
1903     /*!
1904      *  Perform partition operation.
1905      *  \param theShapes Shapes to be intersected.
1906      *  \param theTools Shapes to intersect theShapes.
1907      *  \note  Each compound from ListShapes and ListTools will be exploded in order
1908      *         to avoid possible intersection between shapes from this compound.
1909      *  \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1910      #  \param KeepNonlimitShapes: if this parameter == 0 - only shapes with
1911      #                             type <= Limit are kept in the result,
1912      #                             else - shapes with type > Limit are kept
1913      #                             also (if they exist)
1914      *
1915      *  After implementation new version of PartitionAlgo (October 2006)
1916      *  other parameters are ignored by current functionality. They are kept
1917      *  in this function only for supporting old versions.
1918      *  Ignored parameters:
1919      *  \param theKeepInside Shapes, outside which the results will be deleted.
1920      *         Each shape from theKeepInside must belong to theShapes also.
1921      *  \param theRemoveInside Shapes, inside which the results will be deleted.
1922      *         Each shape from theRemoveInside must belong to theShapes also.
1923      *  \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
1924      *  \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
1925      *
1926      *  \return New GEOM_Object, containing the result shapes.
1927      */
1928     GEOM_Object MakePartition (in ListOfGO   theShapes,
1929                                in ListOfGO   theTools,
1930                                in ListOfGO   theKeepInside,
1931                                in ListOfGO   theRemoveInside,
1932                                in short      theLimit,
1933                                in boolean    theRemoveWebs,
1934                                in ListOfLong theMaterials,
1935                                in short      theKeepNonlimitShapes);
1936
1937     /*!
1938      *  Perform partition operation.
1939      *  This method may be usefull if it is needed to make a partition for
1940      *  a compound containing nonintersected shapes. Performance will be better
1941      *  since intersection between shapes from compound is not performed.
1942      *
1943      *  Description of all parameters as in previous method MakePartition()
1944      *
1945      *  \note Passed compounds (via ListShapes or via ListTools)
1946      *        have to consist of nonintersecting shapes.
1947      *
1948      *  \return New GEOM_Object, containing the result shapes.
1949      */
1950     GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO   theShapes,
1951                                                       in ListOfGO   theTools,
1952                                                       in ListOfGO   theKeepInside,
1953                                                       in ListOfGO   theRemoveInside,
1954                                                       in short      theLimit,
1955                                                       in boolean    theRemoveWebs,
1956                                                       in ListOfLong theMaterials,
1957                                                       in short      theKeepNonlimitShapes);
1958
1959     /*!
1960      *  Perform partition of the Shape with the Plane
1961      *  \param theShape Shape to be intersected.
1962      *  \param thePlane Tool shape, to intersect theShape.
1963      *  \return New GEOM_Object, containing the result shape.
1964      */
1965     GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
1966                                    in GEOM_Object thePlane);
1967   };
1968
1969   /*!
1970    *  GEOM_ICurvesOperations: Interface for curves creation.
1971    *  Polyline, Circle, Spline (Bezier and Interpolation)
1972    */
1973   interface GEOM_ICurvesOperations : GEOM_IOperations
1974   {
1975     /*!
1976      *  Create a circle with given center, normal vector and radius.
1977      *  \param thePnt Circle center.
1978      *  \param theVec Vector, normal to the plane of the circle.
1979      *  \param theR Circle radius.
1980      *  \return New GEOM_Object, containing the created circle.
1981      */
1982     GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
1983                                    in GEOM_Object theVec,
1984                                    in double theR);
1985     /*!
1986      *  Create a circle, passing through three given points
1987      *  \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1988      *  \return New GEOM_Object, containing the created circle.
1989      */
1990     GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
1991                                     in GEOM_Object thePnt2,
1992                                     in GEOM_Object thePnt3);
1993     /*!
1994      *  Create a circle with given center, with a radius equals the distance from center to Point1
1995      *  and on a plane defined by all of three points.
1996      *  \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1997      *  \return New GEOM_Object, containing the created circle.
1998      */
1999     GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2000                                       in GEOM_Object thePnt2,
2001                                       in GEOM_Object thePnt3);
2002     /*!
2003      *  Create an ellipse with given center, normal vector and radiuses.
2004      *  \param thePnt Ellipse center.
2005      *  \param theVec Vector, normal to the plane of the ellipse.
2006      *  \param theRMajor Major ellipse radius.
2007      *  \param theRMinor Minor ellipse radius.
2008      *  \return New GEOM_Object, containing the created ellipse.
2009      */
2010     GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2011                              in GEOM_Object theVec,
2012                              in double theRMajor,
2013                              in double theRMinor);
2014
2015     /*!
2016      *  Create an arc of circle, passing through three given points.
2017      *  \param thePnt1 Start point of the arc.
2018      *  \param thePnt2 Middle point of the arc.
2019      *  \param thePnt3 End point of the arc.
2020      *  \return New GEOM_Object, containing the created arc.
2021      */
2022     GEOM_Object MakeArc (in GEOM_Object thePnt1,
2023                          in GEOM_Object thePnt2,
2024                          in GEOM_Object thePnt3);
2025
2026     /*!
2027      *  Create an arc of circle of center C from one point to another
2028      *  \param theCenter Center point of the arc.
2029      *  \param thePnt1 Start point of the arc.
2030      *  \param thePnt2 End point of the arc.
2031      *  \param theSense Orientation of the arc
2032      *  \return New GEOM_Object, containing the created arc.
2033      */
2034     GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2035                                in GEOM_Object thePnt1,
2036                                in GEOM_Object thePnt2,
2037                                in boolean theSense);
2038
2039
2040     /*!
2041      *  Create a polyline on the set of points.
2042      *  \param thePoints Sequence of points for the polyline.
2043      *  \return New GEOM_Object, containing the created polyline.
2044      */
2045     GEOM_Object MakePolyline (in ListOfGO thePoints);
2046
2047     /*!
2048      *  Create bezier curve on the set of points.
2049      *  \param thePoints Sequence of points for the bezier curve.
2050      *  \return New GEOM_Object, containing the created bezier curve.
2051      */
2052     GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
2053
2054     /*!
2055      *  Create B-Spline curve on the set of points.
2056      *  \param thePoints Sequence of points for the B-Spline curve.
2057      *  \return New GEOM_Object, containing the created B-Spline curve.
2058      */
2059     GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints);
2060
2061     /*!
2062      *  Create a sketcher (wire or face), following the textual description,
2063      *  passed through \a theCommand argument. \n
2064      *  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2065      *  Format of the description string have to be the following:
2066      *
2067      *  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2068      *
2069      *  Where:
2070      *  - x1, y1 are coordinates of the first sketcher point (zero by default),
2071      *  - CMD is one of
2072      *     - "R angle" : Set the direction by angle
2073      *     - "D dx dy" : Set the direction by DX & DY
2074      *     .
2075      *       \n
2076      *     - "TT x y" : Create segment by point at X & Y
2077      *     - "T dx dy" : Create segment by point with DX & DY
2078      *     - "L length" : Create segment by direction & Length
2079      *     - "IX x" : Create segment by direction & Intersect. X
2080      *     - "IY y" : Create segment by direction & Intersect. Y
2081      *     .
2082      *       \n
2083      *     - "C radius length" : Create arc by direction, radius and length(in degree)
2084      *     .
2085      *       \n
2086      *     - "WW" : Close Wire (to finish)
2087      *     - "WF" : Close Wire and build face (to finish)
2088      *
2089      *  \param theCommand String, defining the sketcher in local
2090      *                    coordinates of the working plane.
2091      *  \param theWorkingPlane Nine double values, defining origin,
2092      *                         OZ and OX directions of the working plane.
2093      *  \return New GEOM_Object, containing the created wire.
2094      */
2095     GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2096
2097       /*!
2098      *  Create a sketcher (wire or face), following the textual description,
2099      *  passed through \a theCommand argument. \n
2100      *  For format of the description string see the previous method.\n
2101      *  \param theCommand String, defining the sketcher in local
2102      *                    coordinates of the working plane.
2103      *  \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2104      *  \return New GEOM_Object, containing the created wire.
2105      */
2106     GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2107   };
2108
2109   /*!
2110    *  GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2111    */
2112   interface GEOM_ILocalOperations : GEOM_IOperations
2113   {
2114     /*!
2115      *  Perform a fillet on all edges of the given shape.
2116      *  \param theShape Shape, to perform fillet on.
2117      *  \param theR Fillet radius.
2118      *  \return New GEOM_Object, containing the result shape.
2119      */
2120     GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2121                                in double      theR);
2122
2123     /*!
2124      *  Perform a fillet on the specified edges of the given shape
2125      *  \param theShape Shape, to perform fillet on.
2126      *  \param theR Fillet radius.
2127      *  \param theEdges Global indices of edges to perform fillet on.
2128      *    \note Global index of sub-shape can be obtained, using method
2129      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2130      *  \return New GEOM_Object, containing the result shape.
2131      */
2132     GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2133                                  in double      theR,
2134                                  in ListOfLong  theEdges);
2135     GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2136                                      in double      theR1,
2137                                      in double      theR2,
2138                                      in ListOfLong  theEdges);
2139
2140     /*!
2141      *  Perform a fillet on all edges of the specified faces of the given shape.
2142      *  \param theShape Shape, to perform fillet on.
2143      *  \param theR Fillet radius.
2144      *  \param theFaces Global indices of faces to perform fillet on.
2145      *    \note Global index of sub-shape can be obtained, using method
2146      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2147      *  \return New GEOM_Object, containing the result shape.
2148      */
2149     GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2150                                  in double      theR,
2151                                  in ListOfLong  theFaces);
2152     GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2153                                      in double      theR1,
2154                                      in double      theR2,
2155                                      in ListOfLong  theFaces);
2156
2157     /*!
2158      *  Perform a symmetric chamfer on all edges of the given shape.
2159      *  \param theShape Shape, to perform chamfer on.
2160      *  \param theD Chamfer size along each face.
2161      *  \return New GEOM_Object, containing the result shape.
2162      */
2163     GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2164                                 in double      theD);
2165
2166     /*!
2167      *  Perform a chamfer on edges, common to the specified faces.
2168      *  with distance D1 on the Face1
2169      *  \param theShape Shape, to perform chamfer on.
2170      *  \param theD1 Chamfer size along \a theFace1.
2171      *  \param theD2 Chamfer size along \a theFace2.
2172      *  \param theFace1,theFace2 Global indices of two faces of \a theShape.
2173      *    \note Global index of sub-shape can be obtained, using method
2174      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2175      *  \return New GEOM_Object, containing the result shape.
2176      */
2177     GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2178                                  in double theD1, in double theD2,
2179                                  in long theFace1, in long theFace2);
2180     /*!
2181      *  The Same but with params theD = Chamfer Lenght
2182      *  and theAngle = Chamfer Angle (Angle in radians)
2183      */
2184     GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2185                                    in double theD, in double theAngle,
2186                                    in long theFace1, in long theFace2);
2187
2188     /*!
2189      *  Perform a chamfer on all edges of the specified faces.
2190      *  with distance D1 on the first specified face (if several for one edge)
2191      *  \param theShape Shape, to perform chamfer on.
2192      *  \param theD1 Chamfer size along face from \a theFaces. If both faces,
2193      *               connected to the edge, are in \a theFaces, \a theD1
2194      *               will be get along face, which is nearer to \a theFaces beginning.
2195      *  \param theD2 Chamfer size along another of two faces, connected to the edge.
2196      *  \param theFaces Sequence of global indices of faces of \a theShape.
2197      *    \note Global index of sub-shape can be obtained, using method
2198      *          <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2199      *  \return New GEOM_Object, containing the result shape.
2200      */
2201     GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2202                                   in double theD1, in double theD2,
2203                                   in ListOfLong theFaces);
2204     /*!
2205      *  The Same but with params theD = Chamfer Lenght
2206      *  and theAngle = Chamfer Angle (Angle in radians)
2207      */
2208     GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2209                                     in double theD, in double theAngle,
2210                                     in ListOfLong theFaces);
2211
2212    /*!
2213     *  Perform a chamfer on edges,
2214     *  with distance D1 on the first specified face (if several for one edge)
2215     *  \param theShape Shape, to perform chamfer on.
2216     *  \param theD1 theD2 Chamfer size
2217     *  \param theEdges Sequence of edges of \a theShape.
2218     *  \return New GEOM_Object, containing the result shape.
2219     */
2220     GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2221                                   in double theD1, in double theD2,
2222                                   in ListOfLong theEdges);
2223     /*!
2224      *  The Same but with params theD = Chamfer Lenght
2225      *  and theAngle = Chamfer Angle (Angle in radians)
2226      */
2227     GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2228                                     in double theD, in double theAngle,
2229                                     in ListOfLong theEdges);
2230
2231     /*!
2232      *  Perform an Archimde operation on the given shape with given parameters.
2233      *                    The object presenting the resulting face is returned
2234      *  \param theShape Shape to be put in water.
2235      *  \param theWeight Weight og the shape.
2236      *  \param theWaterDensity Density of the water.
2237      *  \param theMeshDeflection Deflection od the mesh, using to compute the section.
2238      *  \return New GEOM_Object, containing a section of \a theShape
2239      *          by a plane, corresponding to water level.
2240      */
2241     GEOM_Object MakeArchimede (in GEOM_Object theShape,
2242                                in double theWeight,
2243                                in double theWaterDensity,
2244                                in double theMeshDeflection);
2245
2246     /*!
2247      *  Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2248      *  Present here only for compatibility.
2249      */
2250     long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2251   };
2252
2253   /*!
2254    *  GEOM_IHealingOperations: Interface for shape healing operations.
2255    *  Shape Processing, SuppressFaces, etc.
2256    */
2257   interface GEOM_IHealingOperations : GEOM_IOperations
2258   {
2259     /*!
2260      *  Apply a sequence of Shape Healing operators to the given object.
2261      *  \param theShapes Shape to be processed.
2262      *  \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2263      *  \param theParameters List of names of parameters
2264      *                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2265      *  \param theValues List of values of parameters, in the same order
2266      *                    as parameters are listed in \a theParameters list.
2267      *  \return New GEOM_Object, containing processed shape.
2268      */
2269     GEOM_Object ProcessShape (in GEOM_Object theShapes,
2270                               in string_array theOperators,
2271                               in string_array theParameters,
2272                               in string_array theValues);
2273
2274     /*!
2275      *  Get default sequence of operators, their parameters and parameters' values
2276      *  of Shape Process operation. In the current implementation the defaults are
2277      *  read from the file pointed by CSF_ShHealingDefaults environmental variable.
2278      *  \param theOperators Output. Default list of names of operators.
2279      *  \param theParameters Output. Default list of names of parameters.
2280      *  \param theValues Output. List of default values of parameters, in the same order
2281      *                           as parameters are listed in \a theParameters list.
2282      */
2283     void GetShapeProcessParameters (out string_array theOperators,
2284                                     out string_array theParameters,
2285                                     out string_array theValues);
2286     /*!
2287      *  Get parameters and parameters' values for the given Shape Process operation.
2288      *  In the current implementation the defaults are
2289      *  read from the file pointed by CSF_ShHealingDefaults environmental variable.
2290      *  \param theOperator Input. The operator's name.
2291      *  \param theParameters Output. Default list of names of parameters.
2292      *  \param theValues Output. List of default values of parameters, in the same order
2293      *                           as parameters are listed in \a theParameters list.
2294      */
2295     void GetOperatorParameters (in string theOperator,
2296                                 out string_array theParameters,
2297                                 out string_array theValues);
2298
2299     /*!
2300      *  Remove faces from the given object (shape).
2301      *  \param theObject Shape to be processed.
2302      *  \param theFaces Indices of faces to be removed, if EMPTY then the method
2303      *                  removes ALL faces of the given object.
2304      *  \return New GEOM_Object, containing processed shape.
2305      */
2306     GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2307
2308     /*!
2309      *  Close an open wire.
2310      *  \param theObject Shape to be processed.
2311      *  \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2312      *                  if -1, then theObject itself is a wire.
2313      *  \param isCommonVertex If TRUE : closure by creation of a common vertex,
2314      *                        If FALS : closure by creation of an edge between ends.
2315      *  \return New GEOM_Object, containing processed shape.
2316      */
2317     GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2318                               in boolean isCommonVertex);
2319
2320     /*!
2321      *  Remove internal wires and edges from the given object (face).
2322      *  \param theObject Shape to be processed.
2323      *  \param theWires Indices of wires to be removed, if EMPTY then the method
2324      *                  removes ALL internal wires of the given object.
2325      *  \return New GEOM_Object, containing processed shape.
2326      */
2327     GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2328
2329     /*!
2330      *  Remove internal closed contours (holes) from the given object.
2331      *  \param theObject Shape to be processed.
2332      *  \param theWires Indices of wires to be removed, if EMPTY then the method
2333      *                  removes ALL internal holes of the given object
2334      *  \return New GEOM_Object, containing processed shape.
2335      */
2336     GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2337
2338     /*!
2339      *  Sewing of the given object.
2340      *  \param theObject Shape to be processed.
2341      *  \param theTolerance Required tolerance value.
2342      *  \return New GEOM_Object, containing processed shape.
2343      */
2344     GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2345
2346     /*!
2347      *  Addition of a point to a given edge object.
2348      *  \param theObject Shape to be processed.
2349      *  \param theEdgeIndex Index of edge to be divided within theObject's shape,
2350      *                      if -1, then theObject itself is the edge.
2351      *  \param theValue Value of parameter on edge or length parameter,
2352      *                  depending on \a isByParameter.
2353      *  \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2354      *                       if FALSE : \a theValue is treated as a length parameter [0..1]
2355      *  \return New GEOM_Object, containing processed shape.
2356      */
2357     GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2358                             in double theValue, in boolean isByParameter);
2359
2360     /*!
2361      *  Get a list of wires (wrapped in GEOM_Object-s),
2362      *  that constitute a free boundary of the given shape.
2363      *  \param theObject Shape to get free boundary of.
2364      *  \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2365      *  \param theOpenWires Output. Open wires on the free boundary of the given shape.
2366      *  \return FALSE, if an error(s) occured during the method execution.
2367      */
2368     boolean GetFreeBoundary (in GEOM_Object theObject,
2369                              out ListOfGO theClosedWires,
2370                              out ListOfGO theOpenWires);
2371
2372     /*!
2373      *  Change orientation of the given object.
2374      *  \param theObject Shape to be processed.
2375      *  \return New GEOM_Object, containing processed shape.
2376      */
2377     GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2378     GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2379
2380   };
2381
2382   /*!
2383    *  GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2384    *
2385    */
2386   interface GEOM_IInsertOperations : GEOM_IOperations
2387   {
2388     /*!
2389      *  Create a copy of the given object
2390      */
2391     GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2392
2393     /*!
2394      *  Export the given shape into a file with given name.
2395      *  \param theObject Shape to be stored in the file.
2396      *  \param theFileName Name of the file to store the given shape in.
2397      *  \param theFormatName Specify format for the shape storage.
2398      *         Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2399      */
2400     void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2401
2402     /*!
2403      *  Import a shape from the BRep or IGES or STEP file
2404      *  (depends on given format) with given name.
2405      *  \param theFileName The file, containing the shape.
2406      *  \param theFormatName Specify format for the file reading.
2407      *         Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2408      *  \return New GEOM_Object, containing the imported shape.
2409      */
2410     GEOM_Object Import (in string theFileName, in string theFormatName);
2411
2412     /*!
2413      *  Get the supported import formats and corresponding patterns for File dialog.
2414      *  \param theFormats Output. List of formats, available for import.
2415      *  \param thePatterns Output. List of file patterns, corresponding to available formats.
2416      *  \return Returns available formats and patterns through the arguments.
2417      */
2418     void ImportTranslators (out string_array theFormats,
2419                             out string_array thePatterns);
2420
2421     /*!
2422      *  Get the supported export formats and corresponding patterns for File dialog.
2423      *  \param theFormats Output. List of formats, available for export.
2424      *  \param thePatterns Output. List of file patterns, corresponding to available formats.
2425      *  \return Returns available formats and patterns through the arguments.
2426      */
2427     void ExportTranslators (out string_array theFormats,
2428                             out string_array thePatterns);
2429   };
2430
2431   /*!
2432    *  GEOM_IKindOfShape: namespace for shape_kind enumeration.
2433    */
2434   interface GEOM_IKindOfShape
2435   {
2436     enum shape_kind {
2437       NO_SHAPE,
2438       // COMPOSITEs
2439       COMPOUND,
2440       COMPSOLID,
2441       SHELL,
2442       WIRE,
2443       // SOLIDs
2444       SPHERE,       // full sphere
2445       CYLINDER,     // cylinder
2446       BOX,          // box with faces, parallel to global coordinate planes
2447       ROTATED_BOX,  // other box
2448       TORUS,        // full torus
2449       CONE,         // cone
2450       POLYHEDRON,   // solid, bounded by polygons
2451       SOLID,        // other solid
2452       // FACEs
2453       SPHERE2D,     // spherical face (closed)
2454       CYLINDER2D,   // cylindrical face with defined height
2455       TORUS2D,      // toroidal face (closed)
2456       CONE2D,       // conical face with defined height
2457       DISK_CIRCLE,  // planar, bounded by circle
2458       DISK_ELLIPSE, // planar, bounded by ellipse
2459       POLYGON,      // planar, bounded by segments
2460       PLANE,        // infinite planar
2461       PLANAR,       // other planar
2462       FACE,         // other face
2463       // EDGEs
2464       CIRCLE,       // full circle
2465       ARC_CIRCLE,   // arc of circle
2466       ELLIPSE,      // full ellipse
2467       ARC_ELLIPSE,  // arc of ellipse
2468       LINE,         // infinite segment
2469       SEGMENT,      // segment
2470       EDGE,         // other edge
2471       // VERTEX
2472       VERTEX
2473     };
2474   };
2475
2476
2477   /*!
2478    *  GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
2479    *  properties calculation (like Centre of Mass, Inertia, etc.).
2480    *
2481    */
2482   interface GEOM_IMeasureOperations : GEOM_IOperations
2483   {
2484     /*!
2485      *  Get kind of theShape.
2486      *  \param theShape Shape to get a kind of.
2487      *  \param theIntegers Output. Integer and enumerated shape's parameters
2488      *                     (kind of surface, closed/unclosed, number of edges, etc.)
2489      *  \param theDoubles  Output. Double shape's parameters (coordinates, dimensions, etc.)
2490      *  \note  Concrete meaning of each value, returned via \a theIntegers
2491      *         or \a theDoubles list depends on the kind of the shape.
2492      *  \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
2493      */
2494     //short KindOfShape (in GEOM_Object   theShape,
2495     GEOM_IKindOfShape::shape_kind KindOfShape (in  GEOM_Object  theShape,
2496                                                out ListOfLong   theIntegers,
2497                                                out ListOfDouble theDoubles);
2498
2499     /*!
2500      *  Get position (LCS) of theShape.
2501      *  \param theShape Shape to calculate position of.
2502      *  \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
2503      *                  Origin of the LCS is situated at the shape's center of mass.
2504      *  \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
2505      *  \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
2506      *                  Axes of the LCS are obtained from shape's location or,
2507      *                  if the shape is a planar face, from position of its plane.
2508      *  \return Returns position of the shape through the last nine arguments.
2509      */
2510     void GetPosition (in GEOM_Object theShape,
2511                       out double Ox, out double Oy, out double Oz,
2512                       out double Zx, out double Zy, out double Zz,
2513                       out double Xx, out double Xy, out double Xz);
2514
2515     /*!
2516      *  Get summarized length of all wires,
2517      *  area of surface and volume of the given shape.
2518      *  \param theShape Shape to define properties of.
2519      *  \param theLength Output. Summarized length of all wires of the given shape.
2520      *  \param theSurfArea Output. Area of surface of the given shape.
2521      *  \param theVolume Output. Volume of the given shape.
2522      *  \return Returns shape properties through the last three arguments.
2523      */
2524     void GetBasicProperties (in GEOM_Object theShape,
2525                              out double theLength,
2526                              out double theSurfArea,
2527                              out double theVolume);
2528
2529     /*!
2530      *  Get a point, situated at the centre of mass of theShape.
2531      *  \param theShape Shape to define centre of mass of.
2532      *  \return New GEOM_Object, containing the created point.
2533      */
2534     GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
2535
2536     /*!
2537      *  Get a vector, representing the normal of theFace.
2538      *  If the face is not planar, theOptionalPoint is obligatory.
2539      *  \param theFace Shape (face) to define the normal of.
2540      *  \param theOptionalPoint Shape (point) to define the normal at.
2541      *                          Can be NULL in case of planar face.
2542      *  \return New GEOM_Object, containing the created normal vector.
2543      */
2544     GEOM_Object GetNormal (in GEOM_Object theFace,
2545                            in GEOM_Object theOptionalPoint);
2546
2547     /*!
2548      *  Get inertia matrix and moments of inertia of theShape.
2549      *  \param theShape Shape to calculate inertia of.
2550      *  \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
2551      *  \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
2552      *  \return Returns inertia through the last twelve arguments.
2553      */
2554     void GetInertia (in GEOM_Object theShape,
2555                      out double I11, out double I12, out double I13,
2556                      out double I21, out double I22, out double I23,
2557                      out double I31, out double I32, out double I33,
2558                      out double Ix , out double Iy , out double Iz);
2559
2560     /*!
2561      *  Get parameters of bounding box of the given shape
2562      *  \param theShape Shape to obtain bounding box of.
2563      *  \param Xmin,Xmax Output. Limits of shape along OX axis.
2564      *  \param Ymin,Ymax Output. Limits of shape along OY axis.
2565      *  \param Zmin,Zmax Output. Limits of shape along OZ axis.
2566      *  \return Returns parameters of bounding box through the last six arguments.
2567      */
2568     void GetBoundingBox (in GEOM_Object theShape,
2569                          out double Xmin, out double Xmax,
2570                          out double Ymin, out double Ymax,
2571                          out double Zmin, out double Zmax);
2572
2573     /*!
2574      *  Get min and max tolerances of sub-shapes of theShape
2575      *  \param theShape Shape, to get tolerances of.
2576      *  \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
2577      *  \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
2578      *  \param VertMin,VertMax Output. Min and max tolerances of the vertices.
2579      *  \return Returns shape tolerances through the last six arguments.
2580      */
2581     void GetTolerance (in GEOM_Object theShape,
2582                        out double FaceMin, out double FaceMax,
2583                        out double EdgeMin, out double EdgeMax,
2584                        out double VertMin, out double VertMax);
2585
2586     /*!
2587      *  Check a topology of the given shape.
2588      *  \param theShape Shape to check validity of.
2589      *  \param theDescription Output. Description of problems in the shape, if they are.
2590      *  \return TRUE, if the shape "seems to be valid" from the topological point of view.
2591      */
2592     boolean CheckShape (in GEOM_Object theShape,
2593                         out string     theDescription);
2594
2595     /*!
2596      *  Check a topology and a geometry of the given shape.
2597      *  \param theShape Shape to check validity of.
2598      *  \param theDescription Output. Description of problems in the shape, if they are.
2599      *  \return TRUE, if the shape "seems to be valid".
2600      */
2601     boolean CheckShapeWithGeometry (in GEOM_Object theShape,
2602                                     out string     theDescription);
2603
2604     /*!
2605      *  Obtain description of the given shape
2606      *  \param theShape Shape to be described.
2607      *  \return Description of the given shape.
2608      */
2609     string WhatIs (in GEOM_Object theShape);
2610
2611     /*!
2612      *  Get minimal distance between the given shapes.
2613      *  \param theShape1,theShape2 Shapes to find minimal distance between.
2614      *  \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
2615      *  \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
2616      *  \return Value of the minimal distance between the given shapes.
2617      */
2618     double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
2619                            out double X1, out double Y1, out double Z1,
2620                            out double X2, out double Y2, out double Z2);
2621
2622     /*!
2623      *  Get angle between the given lines or linear edges.
2624      *  \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
2625      *  \return Value of the angle between the given shapes.
2626      */
2627     double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
2628
2629     /*!
2630      *  Get point coordinates
2631      */
2632     void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
2633
2634     /*!
2635      *  Get radius of curvature of curve in the point determinated by param
2636      *  \param theShape - curve.
2637      *  \param theParam - parameter on curve
2638      *  \return Value of curvature.
2639      */
2640     double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
2641
2642     /*!
2643      *  Get radius of curvature of curve in the given point
2644      *  \param theShape - curve.
2645      *  \param thePoint - point
2646      *  \return Value of curvature.
2647      */
2648     double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
2649
2650     /*!
2651      *  Get max radius of curvature of surface in the point determinated by params
2652      *  \param theShape - surface.
2653      *  \param theUParam - U-parameter on surface
2654      *  \param theVParam - V-parameter on surface
2655      *  \return Value of curvature.
2656      */
2657     double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
2658                                        in double theVParam);
2659
2660     /*!
2661      *  Get max radius of curvature of surface in the given point
2662      *  \param theShape - surface.
2663      *  \param thePoint - point
2664      *  \return Value of curvature.
2665      */
2666     double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
2667
2668     /*!
2669      *  Get min radius of curvature of surface in the point determinated by params
2670      *  \param theShape - surface.
2671      *  \param theUParam - U-parameter on surface
2672      *  \param theVParam - V-parameter on surface
2673      *  \return Value of curvature.
2674      */
2675     double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
2676                                        in double theVParam);
2677
2678     /*!
2679      *  Get min radius of curvature of surface in the given point
2680      *  \param theShape - surface.
2681      *  \param thePoint - point
2682      *  \return Value of curvature.
2683      */
2684     double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
2685
2686   };
2687
2688
2689   /*!
2690    *  GEOM_IGroupOperations: Interface for groups creation.
2691    */
2692   interface GEOM_IGroupOperations : GEOM_IOperations
2693   {
2694     /*!
2695      *  Creates a new group which will store  sub shapes of theMainShape
2696      *  \param theMainShape is a GEOM object on which the group is selected
2697      *  \param theShapeType defines a shape type of the group
2698      *  \return a newly created GEOM group
2699      */
2700     GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
2701
2702     /*!
2703      *  Adds a sub object with ID theSubShapeId to the group
2704      *  \param theGroup is a GEOM group to which the new sub shape is added
2705      *  \param theSubShapeId is a sub shape ID in the main object.
2706      *  \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
2707      */
2708     void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
2709
2710     /*!
2711      *  Removes a sub object with ID \a theSubShapeId from the group
2712      *  \param theGroup is a GEOM group from which the sub shape is removed.
2713      *  \param theSubShapeId is a sub shape ID in the main object.
2714      *  \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
2715      */
2716     void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
2717
2718     /*!
2719      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2720      *  \param theGroup is a GEOM group to which the new sub shapes are added.
2721      *  \param theSubShapes is a list of sub shapes to be added.
2722      */
2723     void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2724
2725     /*!
2726      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
2727      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
2728      *  \param theSubShapes is a list of sub-shapes to be removed.
2729      */
2730     void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2731
2732     /*!
2733      *  Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2734      *  \param theGroup is a GEOM group to which the new sub shapes are added.
2735      *  \param theSubShapes is a list of IDs of sub shapes to be added.
2736      */
2737     void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2738
2739     /*!
2740      *  Removes from the group all the given shapes. No errors, if some shapes are not included.
2741      *  \param theGroup is a GEOM group from which the sub-shapes are removed.
2742      *  \param theSubShapes is a list of IDs of sub-shapes to be removed.
2743      */
2744     void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2745
2746     /*!
2747      *  Returns a type of sub objects stored in the group
2748      *  \param theGroup is a GEOM group which type is returned.
2749      */
2750     long GetType (in GEOM_Object theGroup);
2751
2752     /*!
2753      *  Returns a main shape associated with the group
2754      *  \param theGroup is a GEOM group for which a main shape object is requested
2755      *  \return a GEOM object which is a main shape for theGroup
2756      */
2757     GEOM_Object GetMainShape (in GEOM_Object theGroup);
2758
2759     /*!
2760      *  Returns a list of sub objects ID stored in the group
2761      *  \param theGroup is a GEOM group for which a list of IDs is requested
2762      */
2763     ListOfLong GetObjects (in GEOM_Object theGroup);
2764   };
2765
2766
2767   /*!
2768    *  GEOM_Gen: Interface to access other GEOM interfaces.
2769    *  Also contains some methods to access and manage GEOM objects.
2770    */
2771   interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
2772   {
2773     /*!
2774      *  Undo/Redo Management
2775      */
2776
2777     void Undo (in long theStudyID);
2778
2779     void Redo (in long theStudyID);
2780
2781     /*!
2782      * Publishing management
2783      * Adds in theStudy a object theObject under with a name theName,
2784      * if theFather is not NULL the object is placed under thFather's SObject.
2785      * Returns a SObject where theObject is placed
2786      */
2787     SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
2788                                   in GEOM_Object theObject,
2789                                   in string theName,
2790                                   in GEOM_Object theFather);
2791
2792     /*!
2793      *  Publish sub-shapes, standing for arguments and sub-shapes of arguments
2794      *  To be used from python scripts out of geompy.addToStudy (non-default usage)
2795      *  \param theStudy  the study, in which theObject is published already,
2796      *                   and in which the arguments will be published
2797      *  \param theObject published GEOM object, arguments of which will be published
2798      *  \param theArgs   list of GEOM_Object, operation arguments to be published.
2799      *                   If this list is empty, all operation arguments will be published
2800      *  \param theFindMethod method to search subshapes, corresponding to arguments and
2801      *                       their subshapes. Value from enumeration GEOM::find_shape_method.
2802      *  \param theInheritFirstArg set properties of the first argument for \a theObject.
2803      *                            Do not publish subshapes in place of arguments, but only
2804      *                            in place of subshapes of the first argument,
2805      *                            because the whole shape corresponds to the first argument.
2806      *                            Mainly to be used after transformations, but it also can be
2807      *                            usefull after partition with one object shape, and some other
2808      *                            operations, where only the first argument has to be considered.
2809      *                            If theObject has only one argument shape, this flag is automatically
2810      *                            considered as True, not regarding really passed value.
2811      *  \return True in case of success, False otherwise.
2812      */
2813     boolean RestoreSubShapesO (in SALOMEDS::Study   theStudy,
2814                                in GEOM_Object       theObject,
2815                                in ListOfGO          theArgs,
2816                                in find_shape_method theFindMethod,
2817                                in boolean           theInheritFirstArg);
2818
2819     /*!
2820      *  Publish sub-shapes, standing for arguments and sub-shapes of arguments
2821      *  To be used from GUI and from geompy.addToStudy.
2822      *  Work like the above method, but accepts study object theSObject instead of GEOM_Object.
2823      *  \param theSObject study object, referencing GEOM object, arguments of which will be published
2824      */
2825     boolean RestoreSubShapesSO (in SALOMEDS::Study   theStudy,
2826                                 in SALOMEDS::SObject theSObject,
2827                                 in ListOfGO          theArgs,
2828                                 in find_shape_method theFindMethod,
2829                                 in boolean           theInheritFirstArg);
2830
2831     /*!
2832      *  Methods to access interfaces for objects creation and transformation
2833      */
2834     GEOM_IBasicOperations     GetIBasicOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2835     GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
2836     GEOM_I3DPrimOperations    GetI3DPrimOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2837     GEOM_IShapesOperations    GetIShapesOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2838     GEOM_IBooleanOperations   GetIBooleanOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2839     GEOM_ICurvesOperations    GetICurvesOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2840     GEOM_ILocalOperations     GetILocalOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2841     GEOM_IHealingOperations   GetIHealingOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2842     GEOM_IInsertOperations    GetIInsertOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2843     GEOM_IMeasureOperations   GetIMeasureOperations  (in long theStudyID) raises (SALOME::SALOME_Exception);
2844     GEOM_IBlocksOperations    GetIBlocksOperations   (in long theStudyID) raises (SALOME::SALOME_Exception);
2845     GEOM_IGroupOperations     GetIGroupOperations    (in long theStudyID) raises (SALOME::SALOME_Exception);
2846
2847     /*!
2848      *  Objects Management
2849      */
2850
2851     /*!
2852      *  Removes the object from the GEOM component
2853      *  \param theObject is a GEOM object to be removed
2854      */
2855     void RemoveObject (in GEOM_Object theObject);
2856
2857     /*!
2858      *  Returns an object defined by the study and its entry in the GEOM component
2859      *  \param theStudyID is a SALOMEDS Study ID
2860      *  \param theEntry is an entry of the requested GEOM object in the GEOM component
2861      *  \note if the object has not previously been created a NULL GEOM object is returned
2862      */
2863     GEOM_Object GetObject (in long theStudyID, in string theEntry);
2864
2865     /*!
2866      *  Add a sub shape defined by indices in \a theIndices
2867      *  (contains unique IDs of sub shapes inside theMainShape)
2868      *  \note The sub shape GEOM_Objects can has ONLY ONE function.
2869      *        Don't try to apply modification operations on them.
2870      *  \note Internal method
2871      */
2872     GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
2873
2874     /*!
2875      *  GEOM object's IOR Management
2876      */
2877
2878     /*!
2879      *  Returns a GEOM Object defined by its IOR
2880      *  \param theIOR a string containg an IOR of the requested GEOM object
2881      */
2882     GEOM_Object GetIORFromString (in string theIOR);
2883
2884     /*!
2885      *  Returns a string which contains an IOR of the GEOM object
2886      *  \param theObject is a GEOM object which IOR is requested
2887      */
2888     string GetStringFromIOR (in GEOM_Object theObject);
2889
2890     /*!
2891      *  Returns a name with which a GEOM object was dumped into python script
2892      *  \param theStudyEntry is an entry of the GEOM object in the study
2893      */
2894     string GetDumpName (in string theStudyEntry);
2895
2896     /*!
2897      *  Returns all names with which a GEOM objects was dumped
2898      *  into python script to avoid the same names in SMESH script
2899      */
2900     string_array GetAllDumpNames();
2901   };
2902 };
2903
2904 #endif