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