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