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