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