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