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