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