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