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