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