src/GEOMImpl/GEOMImpl_IShapesOperations.hxx

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //=============================================================================
  24 // File      : GEOMImpl_IShapesOperations.hxx
  25 // Created   :
  26 // Author    : modified by Lioka RAZAFINDRAZAKA (CEA) 22/06/2007
  27 // Project   : SALOME
  28 //=============================================================================
  29
  30 #ifndef _GEOMImpl_IShapesOperations_HXX_
  31 #define _GEOMImpl_IShapesOperations_HXX_
  32
  33 #include "GEOM_IOperations.hxx"
  34
  35 #include "GEOMAlgo_State.hxx"
  36
  37 #include <TColStd_HSequenceOfTransient.hxx>
  38 #include <TColStd_HSequenceOfInteger.hxx>
  39
  40 #include <Geom_Surface.hxx>
  41
  42 #include <list>
  43
  44 class GEOM_Engine;
  45 class Handle(GEOM_Object);
  46 class Handle(TColStd_HArray1OfInteger);
  47 class TopoDS_Shape;
  48
  49 class GEOMImpl_IShapesOperations : public GEOM_IOperations
  50 {
  51  public:
  52
  53   enum SubShapeType {
  54     None      = 0x00,
  55     Groups    = 0x01,
  56     Fields    = 0x02,
  57     SubShapes = 0x04,
  58     All       = Groups | Fields | SubShapes,
  59   };
  60
  61   Standard_EXPORT GEOMImpl_IShapesOperations(GEOM_Engine* theEngine, int theDocID);
  62   Standard_EXPORT ~GEOMImpl_IShapesOperations();
  63
  64   Standard_EXPORT Handle(GEOM_Object) MakeEdge (Handle(GEOM_Object) thePoint1,
  65                                                 Handle(GEOM_Object) thePoint2);
  66
  67   Standard_EXPORT Handle(GEOM_Object) MakeEdgeOnCurveByLength (Handle(GEOM_Object) theCurve,
  68                                                                const Standard_Real theLength,
  69                                                                Handle(GEOM_Object) theStartPoint);
  70
  71   Standard_EXPORT Handle(GEOM_Object) MakeEdgeWire (Handle(GEOM_Object) theWire,
  72                                                     const Standard_Real theLinearTolerance,
  73                                                     const Standard_Real theAngularTolerance);
  74
  75   Standard_EXPORT Handle(GEOM_Object) MakeWire (std::list<Handle(GEOM_Object)> theEdgesAndWires,
  76                                                 const Standard_Real            theTolerance);
  77
  78   Standard_EXPORT Handle(GEOM_Object) MakeFace (Handle(GEOM_Object) theWire, const bool isPlanarWanted);
  79
  80   Standard_EXPORT Handle(GEOM_Object) MakeFaceWires (std::list<Handle(GEOM_Object)> theWires,
  81                                                      const bool isPlanarWanted);
  82
  83   Standard_EXPORT Handle(GEOM_Object) MakeFaceFromSurface
  84                                               (Handle(GEOM_Object) theFace,
  85                                                Handle(GEOM_Object) theWire);
  86
  87   Standard_EXPORT Handle(GEOM_Object) MakeFaceWithConstraints (std::list<Handle(GEOM_Object)> theConstraints);
  88
  89   Standard_EXPORT Handle(GEOM_Object) MakeShell (std::list<Handle(GEOM_Object)> theShapes);
  90
  91   Standard_EXPORT Handle(GEOM_Object) MakeSolidShells (std::list<Handle(GEOM_Object)> theShells);
  92
  93   Standard_EXPORT Handle(GEOM_Object) MakeCompound (std::list<Handle(GEOM_Object)> theShapes);
  94
  95   Standard_EXPORT Handle(GEOM_Object) MakeSolidFromConnectedFaces (std::list<Handle(GEOM_Object)> theFacesOrShells,
  96                                                                    const Standard_Boolean isIntersect);
  97
  98   Standard_EXPORT Handle(GEOM_Object) MakeGlueFaces (std::list< Handle(GEOM_Object) >& theShapes,
  99                                                      const Standard_Real theTolerance,
 100                                                      const Standard_Boolean doKeepNonSolids);
 101
 102   Standard_EXPORT Handle(GEOM_Object) MakeGlueFacesByList (std::list< Handle(GEOM_Object) >& theShapes,
 103                                                            const Standard_Real theTolerance,
 104                                                            std::list<Handle(GEOM_Object)>& theFaces,
 105                                                            const Standard_Boolean doKeepNonSolids,
 106                                                            const Standard_Boolean doGlueAllEdges);
 107
 108   Standard_EXPORT Handle(GEOM_Object) MakeGlueEdges (std::list< Handle(GEOM_Object) >& theShapes,
 109                                                      const Standard_Real theTolerance);
 110
 111   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetGlueShapes (std::list< Handle(GEOM_Object) >& theShapes,
 112                                                                       const Standard_Real theTolerance,
 113                                                                       const TopAbs_ShapeEnum theType);
 114
 115   Standard_EXPORT Handle(GEOM_Object) MakeGlueEdgesByList (std::list< Handle(GEOM_Object) >& theShapes,
 116                                                            const Standard_Real theTolerance,
 117                                                            std::list<Handle(GEOM_Object)> & theEdges);
 118
 119   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetExistingSubObjects(Handle(GEOM_Object)    theShape,
 120                                                                              const Standard_Boolean theGroupsOnly);
 121   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetExistingSubObjects(Handle(GEOM_Object)    theShape,
 122                                                                              const Standard_Integer theTypes = All);
 123
 124   enum ExplodeType {
 125     EXPLODE_OLD_INCLUDE_MAIN,
 126     EXPLODE_NEW_INCLUDE_MAIN,
 127     EXPLODE_NEW_EXCLUDE_MAIN
 128   };
 129
 130   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) MakeExplode
 131     (Handle(GEOM_Object)    theShape,
 132      const Standard_Integer theShapeType,
 133      const Standard_Boolean isSorted,
 134      const ExplodeType      theExplodeType = EXPLODE_NEW_INCLUDE_MAIN);
 135
 136   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) SubShapeAllIDs
 137     (Handle(GEOM_Object)    theShape,
 138      const Standard_Integer theShapeType,
 139      const Standard_Boolean isSorted,
 140      const ExplodeType      theExplodeType = EXPLODE_NEW_INCLUDE_MAIN);
 141
 142   Standard_EXPORT Handle(GEOM_Object) GetSubShape (Handle(GEOM_Object)    theMainShape,
 143                                                    const Standard_Integer theID);
 144
 145   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) MakeSubShapes
 146     (Handle(GEOM_Object)              theMainShape,
 147      Handle(TColStd_HArray1OfInteger) theIndices);
 148
 149   Standard_EXPORT Standard_Integer GetSubShapeIndex (Handle(GEOM_Object) theMainShape,
 150                                                      Handle(GEOM_Object) theSubShape);
 151
 152   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetSubShapesIndices (Handle(GEOM_Object) theMainShape,
 153                                                                           std::list<Handle(GEOM_Object)> theSubShapes);
 154
 155   Standard_EXPORT Standard_Integer GetTopologyIndex (Handle(GEOM_Object) theMainShape,
 156                                                      Handle(GEOM_Object) theSubShape);
 157
 158   Standard_EXPORT TCollection_AsciiString GetShapeTypeString (Handle(GEOM_Object) theShape);
 159
 160   Standard_EXPORT Standard_Boolean IsSubShapeBelongsTo(Handle(GEOM_Object) theSubObject,
 161                                                        const Standard_Integer theSubObjectIndex,
 162                                                        Handle(GEOM_Object) theObject,
 163                                                        const Standard_Integer theObjectIndex);
 164
 165   Standard_EXPORT Standard_Integer NumberOfSubShapes (Handle(GEOM_Object)    theShape,
 166                                                       const Standard_Integer theShapeType);
 167
 168   Standard_EXPORT Handle(GEOM_Object) ReverseShape(Handle(GEOM_Object) theShapes);
 169
 170   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetFreeFacesIDs (Handle(GEOM_Object) theShape);
 171
 172   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 173     GetSharedShapes (Handle(GEOM_Object)    theShape1,
 174                      Handle(GEOM_Object)    theShape2,
 175                      const Standard_Integer theShapeType);
 176
 177   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 178     GetSharedShapes (std::list<Handle(GEOM_Object)>& theShapes,
 179                      const Standard_Integer          theShapeType,
 180                      const bool                      theMultiShare = true);
 181
 182   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 183     GetShapesOnPlane (const Handle(GEOM_Object)& theShape,
 184                       const Standard_Integer     theShapeType,
 185                       const Handle(GEOM_Object)& theAx1,
 186                       const GEOMAlgo_State       theState);
 187
 188   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 189     GetShapesOnPlaneWithLocation (const Handle(GEOM_Object)& theShape,
 190                                   const Standard_Integer     theShapeType,
 191                                   const Handle(GEOM_Object)& theAx1,
 192                                   const Handle(GEOM_Object)& thePnt,
 193                                   const GEOMAlgo_State       theState);
 194
 195
 196   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 197     GetShapesOnCylinder (const Handle(GEOM_Object)& theShape,
 198                          const Standard_Integer     theShapeType,
 199                          const Handle(GEOM_Object)& theAxis,
 200                          const Standard_Real        theRadius,
 201                          const GEOMAlgo_State       theState);
 202
 203   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 204     GetShapesOnCylinderWithLocation (const Handle(GEOM_Object)& theShape,
 205                                      const Standard_Integer     theShapeType,
 206                                      const Handle(GEOM_Object)& theAxis,
 207                                      const Handle(GEOM_Object)& thePnt,
 208                                      const Standard_Real        theRadius,
 209                                      const GEOMAlgo_State       theState);
 210
 211   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 212     GetShapesOnSphere (const Handle(GEOM_Object)& theShape,
 213                        const Standard_Integer     theShapeType,
 214                        const Handle(GEOM_Object)& theCenter,
 215                        const Standard_Real        theRadius,
 216                        const GEOMAlgo_State       theState);
 217
 218   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 219     GetShapesOnPlaneIDs (const Handle(GEOM_Object)& theShape,
 220                          const Standard_Integer     theShapeType,
 221                          const Handle(GEOM_Object)& theAx1,
 222                          const GEOMAlgo_State       theState);
 223
 224   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 225     GetShapesOnPlaneWithLocationIDs (const Handle(GEOM_Object)& theShape,
 226                                      const Standard_Integer     theShapeType,
 227                                      const Handle(GEOM_Object)& theAx1,
 228                                      const Handle(GEOM_Object)& thePnt,
 229                                      const GEOMAlgo_State       theState);
 230
 231   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 232     GetShapesOnCylinderIDs (const Handle(GEOM_Object)& theShape,
 233                             const Standard_Integer     theShapeType,
 234                             const Handle(GEOM_Object)& theAxis,
 235                             const Standard_Real        theRadius,
 236                             const GEOMAlgo_State       theState);
 237
 238   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 239     GetShapesOnCylinderWithLocationIDs (const Handle(GEOM_Object)& theShape,
 240                                         const Standard_Integer     theShapeType,
 241                                         const Handle(GEOM_Object)& theAxis,
 242                                         const Handle(GEOM_Object)& thePnt,
 243                                         const Standard_Real        theRadius,
 244                                         const GEOMAlgo_State       theState);
 245
 246   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 247     GetShapesOnSphereIDs (const Handle(GEOM_Object)& theShape,
 248                           const Standard_Integer     theShapeType,
 249                           const Handle(GEOM_Object)& theCenter,
 250                           const Standard_Real        theRadius,
 251                           const GEOMAlgo_State       theState);
 252
 253   /*!
 254    * \brief Find sub-shapes complying with given status about quadrangle
 255     * \param theShape - the shape to explore
 256     * \param theShapeType - type of sub-shape of theShape
 257     * \param theTopLeftPoint - top left quadrangle corner
 258     * \param theTopRigthPoint - top right quadrangle corner
 259     * \param theBottomLeftPoint - bottom left quadrangle corner
 260     * \param theBottomRigthPoint - bottom right quadrangle corner
 261     * \param theState - required state
 262     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 263    */
 264   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 265     GetShapesOnQuadrangle (const Handle(GEOM_Object)& theShape,
 266                            const Standard_Integer     theShapeType,
 267                            const Handle(GEOM_Object)& theTopLeftPoint,
 268                            const Handle(GEOM_Object)& theTopRigthPoint,
 269                            const Handle(GEOM_Object)& theBottomLeftPoint,
 270                            const Handle(GEOM_Object)& theBottomRigthPoint,
 271                            const GEOMAlgo_State       theState);
 272
 273   /*!
 274    * \brief Find IDs of sub-shapes complying with given status about quadrangle
 275     * \param theShape - the shape to explore
 276     * \param theShapeType - type of sub-shape of theShape
 277     * \param theTopLeftPoint - top left quadrangle corner
 278     * \param theTopRigthPoint - top right quadrangle corner
 279     * \param theBottomLeftPoint - bottom left quadrangle corner
 280     * \param theBottomRigthPoint - bottom right quadrangle corner
 281     * \param theState - required state
 282     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 283    */
 284   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 285     GetShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
 286                               const Standard_Integer     theShapeType,
 287                               const Handle(GEOM_Object)& theTopLeftPoint,
 288                               const Handle(GEOM_Object)& theTopRigthPoint,
 289                               const Handle(GEOM_Object)& theBottomLeftPoint,
 290                               const Handle(GEOM_Object)& theBottomRigthPoint,
 291                               const GEOMAlgo_State       theState);
 292
 293   Standard_EXPORT Handle(GEOM_Object) GetShapesOnCylinderOld (Handle(GEOM_Object)    theShape,
 294                                                               const Standard_Integer theShapeType,
 295                                                               Handle(GEOM_Object)    theAxis,
 296                                                               const Standard_Real    theRadius);
 297
 298   Standard_EXPORT Handle(GEOM_Object) GetShapesOnSphereOld (Handle(GEOM_Object)    theShape,
 299                                                             const Standard_Integer theShapeType,
 300                                                             Handle(GEOM_Object)    theCenter,
 301                                                             const Standard_Real    theRadius);
 302
 303   Standard_EXPORT Handle(GEOM_Object) GetInPlace (Handle(GEOM_Object) theShapeWhere,
 304                                                   Handle(GEOM_Object) theShapeWhat);
 305
 306   Standard_EXPORT Handle(GEOM_Object) GetInPlaceOld (Handle(GEOM_Object) theShapeWhere,
 307                                                      Handle(GEOM_Object) theShapeWhat);
 308
 309   Standard_EXPORT Handle(GEOM_Object) GetInPlaceByHistory (Handle(GEOM_Object) theShapeWhere,
 310                                                            Handle(GEOM_Object) theShapeWhat);
 311
 312   /*!
 313    * \brief Searches a shape equal to theWhat in the context of theWhere
 314    * \param theShapeWhere - a context shap
 315    * \param theShapeWhat - a sample shape
 316    * \retval Handle(GEOM_Object) - found shape
 317    */
 318   Standard_EXPORT Handle(GEOM_Object) GetSame(const Handle(GEOM_Object)& theShapeWhere,
 319                                               const Handle(GEOM_Object)& theShapeWhat);
 320
 321   /*!
 322    * \brief Searches a shape equal to theWhat in the context of theWhere
 323    * \param theShapeWhere - a context shap
 324    * \param theShapeWhat - a sample shape
 325    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 326    */
 327   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetSameIDs(const Handle(GEOM_Object)& theShapeWhere,
 328                                                                  const Handle(GEOM_Object)& theShapeWhat);
 329
 330   /*!
 331    * \brief Find IDs of sub-shapes complying with given status about surface
 332     * \param theBox - the box to check state of sub-shapes against
 333     * \param theShape - the shape to explore
 334     * \param theShapeType - type of sub-shape of theShape
 335     * \param theState - required state
 336     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 337    */
 338   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 339                               GetShapesOnBoxIDs(const Handle(GEOM_Object)& theBox,
 340                                                 const Handle(GEOM_Object)& theShape,
 341                                                 const Standard_Integer theShapeType,
 342                                                 GEOMAlgo_State theState);
 343
 344   /*!
 345    * \brief Find sub-shapes complying with given status about surface
 346    * \param theBox - the box to check state of sub-shapes against
 347    * \param theShape - the shape to explore
 348    * \param theShapeType - type of sub-shape of theShape
 349    * \param theState - required state
 350    * \retval Handle(TColStd_HSequenceOfTransient) - found shape objects
 351    */
 352   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 353                              GetShapesOnBox(const Handle(GEOM_Object)& theBox,
 354                                             const Handle(GEOM_Object)& theShape,
 355                                             const Standard_Integer theShapeType,
 356                                             GEOMAlgo_State theState);
 357
 358   /*!
 359    * \brief Find IDs of sub-shapes complying with given status about surface
 360    * \param theCheckShape - the shape to check state of sub-shapes against
 361    * \param theShape - the shape to explore
 362    * \param theShapeType - type of sub-shape of theShape
 363    * \param theState - required state
 364    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 365    */
 366   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 367                    GetShapesOnShapeIDs(const Handle(GEOM_Object)& theCheckShape,
 368                                        const Handle(GEOM_Object)& theShape,
 369                                        const Standard_Integer theShapeType,
 370                                        GEOMAlgo_State theState);
 371
 372   /*!
 373    * \brief Find sub-shapes complying with given status about surface
 374    * \param theCheckShape - the shape to check state of sub-shapes against
 375    * \param theShape - the shape to explore
 376    * \param theShapeType - type of sub-shape of theShape
 377    * \param theState - required state
 378    * \retval Handle(TColStd_HSequenceOfTransient) - found shape objects
 379    */
 380   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 381                       GetShapesOnShape(const Handle(GEOM_Object)& theCheckShape,
 382                                        const Handle(GEOM_Object)& theShape,
 383                                        const Standard_Integer theShapeType,
 384                                        GEOMAlgo_State theState);
 385   Standard_EXPORT Handle(GEOM_Object)
 386             GetShapesOnShapeAsCompound(const Handle(GEOM_Object)& theCheckShape,
 387                                        const Handle(GEOM_Object)& theShape,
 388                                        const Standard_Integer theShapeType,
 389                                        GEOMAlgo_State theState);
 390
 391   /*!
 392    * \brief Resize the input edge with the new Min and Max parameters.
 393    * The input edge parameters range is [0, 1]. If theMin parameter is
 394    * negative, the input edge is extended, otherwise it is shrinked by
 395    * theMin parameter. If theMax is greater than 1, the edge is extended,
 396    * otherwise it is shrinked by theMax parameter
 397    * \param theEdge the input edge to be resized
 398    * \param theMin the minimal parameter value
 399    * \param theMax the maximal parameter value
 400    * \retval Handle(GEOM_Object) - newly created edge
 401    */
 402   Standard_EXPORT Handle(GEOM_Object)
 403                             ExtendEdge(const Handle(GEOM_Object)& theEdge,
 404                                        const Standard_Real        theMin,
 405                                        const Standard_Real        theMax);
 406
 407   /*!
 408    * \brief Resize the input face with the new UMin, UMax, VMin and VMax
 409    * parameters. The input face U and V parameters range is [0, 1]. If
 410    * theUMin parameter is negative, the input face is extended, otherwise
 411    * it is shrinked along U direction by theUMin parameter. If theUMax is
 412    * greater than 1, the face is extended, otherwise it is shrinked along
 413    * U direction by theUMax parameter. So as for theVMin, theVMax and
 414    * V direction of the input face.
 415    * \param theFace the input face to be resized
 416    * \param theUMin the minimal U parameter value
 417    * \param theUMax the maximal U parameter value
 418    * \param theVMin the minimal V parameter value
 419    * \param theVMax the maximal V parameter value
 420    * \retval Handle(GEOM_Object) - newly created face
 421    */
 422   Standard_EXPORT Handle(GEOM_Object)
 423                             ExtendFace(const Handle(GEOM_Object)& theFace,
 424                                        const Standard_Real        theUMin,
 425                                        const Standard_Real        theUMax,
 426                                        const Standard_Real        theVMin,
 427                                        const Standard_Real        theVMax);
 428
 429   /*!
 430    * \brief Make a surface from a face. This function takes some face as
 431    * input parameter and creates new GEOM_Object, i.e. topological shape
 432    * by extracting underlying surface of the source face and limiting it
 433    * by the Umin, Umax, Vmin, Vmax parameters of the source face (in the
 434    * parametrical space).
 435    * \param theFace the input face
 436    * \retval Handle(GEOM_Object) - newly created face
 437    */
 438   Standard_EXPORT Handle(GEOM_Object)
 439                    MakeSurfaceFromFace(const Handle(GEOM_Object) &theFace);
 440
 441   /*!
 442    * \brief Explode a shape into edges sorted in a row from a starting point.
 443    * \param theShape - the shape to be exploded on edges.
 444    * \param theStartPoint - the starting point.
 445    * \return Ordered list of edges sorted in a row from a starting point.
 446    */
 447   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 448     GetSubShapeEdgeSorted (const Handle(GEOM_Object) &theShape,
 449                            const Handle(GEOM_Object) &theStartPoint);
 450
 451  private:
 452   Handle(GEOM_Object) MakeShape (std::list<Handle(GEOM_Object)>      theShapes,
 453                                  const Standard_Integer         theObjectType,
 454                                  const Standard_Integer         theFunctionType,
 455                                  const TCollection_AsciiString& theMethodName);
 456
 457 // ----------------------------------------------------
 458 // methods common for all GetShapesOnXXX() functions
 459 // ----------------------------------------------------
 460
 461   /*!
 462    * \brief Checks if theShapeType parameter of GetShapesOnXXX() is OK
 463    * \param theShapeType - the shape type to check
 464    * \retval bool  - result of the check
 465    */
 466   bool checkTypeShapesOn(const Standard_Integer theShapeType);
 467
 468   /*!
 469    * \brief Creates Geom_Plane
 470    * \param theAx1 - edge defining plane normal
 471    * \retval Handle(Geom_Surface) - resulting surface
 472    */
 473   Handle(Geom_Surface) makePlane(const TopoDS_Shape& theAx1);
 474
 475   /*!
 476    * \brief Creates Geom_CylindricalSurface
 477    * \param theAx1 - edge defining cylinder axis
 478    * \param theRadius - cylinder radius
 479    * \retval Handle(Geom_Surface) - resulting surface
 480    */
 481   Handle(Geom_Surface) makeCylinder(const TopoDS_Shape& theAx1,
 482                                     const Standard_Real theRadius);
 483
 484   /*!
 485    * \brief Find IDs of sub-shapes complying with given status about surface
 486    * \param theSurface - the surface to check state of sub-shapes against
 487    * \param theShape - the shape to explore
 488    * \param theShapeType - type of sub-shape of theShape
 489    * \param theState - required state
 490    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 491    */
 492   Handle(TColStd_HSequenceOfInteger)
 493     getShapesOnSurfaceIDs(const Handle(Geom_Surface)& theSurface,
 494                           const TopoDS_Shape&         theShape,
 495                           TopAbs_ShapeEnum            theShapeType,
 496                           GEOMAlgo_State              theState);
 497
 498   /*!
 499    * \brief Find sub-shapes complying with given status about surface
 500    * \param theSurface - the surface to check state of sub-shapes against
 501    * \param theShape - the shape to explore
 502    * \param theShapeType - type of sub-shape of theShape
 503    * \param theState - required state
 504    * \param theShapeEntries - outgoing entries like "entry1, entry2, ..."
 505    * \retval Handle(TColStd_HSequenceOfTransient) - found shape objects
 506    */
 507   Handle(TColStd_HSequenceOfTransient)
 508     getShapesOnSurface(const Handle(Geom_Surface)& theSurface,
 509                        const Handle(GEOM_Object)&  theShape,
 510                        TopAbs_ShapeEnum            theShapeType,
 511                        GEOMAlgo_State              theState,
 512                        TCollection_AsciiString &   theShapeEntries);
 513
 514   /*!
 515    * \brief Find IDs of sub-shapes complying with given status about quadrangle
 516    * \param theShape - the shape to explore
 517    * \param theShapeType - type of sub-shape of theShape
 518    * \param theTopLeftPoint - top left quadrangle corner
 519    * \param theTopRigthPoint - top right quadrangle corner
 520    * \param theBottomLeftPoint - bottom left quadrangle corner
 521    * \param theBottomRigthPoint - bottom right quadrangle corner
 522    * \param theState - required state
 523    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 524    */
 525   Handle(TColStd_HSequenceOfInteger)
 526     getShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
 527                               const Standard_Integer     theShapeType,
 528                               const Handle(GEOM_Object)& theTopLeftPoint,
 529                               const Handle(GEOM_Object)& theTopRigthPoint,
 530                               const Handle(GEOM_Object)& theBottomLeftPoint,
 531                               const Handle(GEOM_Object)& theBottomRigthPoint,
 532                               const GEOMAlgo_State       theState);
 533
 534   /*!
 535    * \brief Find IDs of sub-shapes complying with given status about surface
 536    * \param theBox - the box to check state of sub-shapes against
 537    * \param theShape - the shape to explore
 538    * \param theShapeType - type of sub-shape of theShape
 539    * \param theState - required state
 540    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 541    */
 542   Handle(TColStd_HSequenceOfInteger) getShapesOnBoxIDs(const Handle(GEOM_Object)& theBox,
 543                                                        const Handle(GEOM_Object)& theShape,
 544                                                        const Standard_Integer theShapeType,
 545                                                        GEOMAlgo_State theState);
 546
 547   /*!
 548    * \brief Find IDs of sub-shapes complying with given status about surface
 549    * \param theCheckShape - the shape to check state of sub-shapes against
 550    * \param theShape - the shape to explore
 551    * \param theShapeType - type of sub-shape of theShape
 552    * \param theState - required state
 553    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
 554    */
 555   Handle(TColStd_HSequenceOfInteger) getShapesOnShapeIDs
 556                                       (const Handle(GEOM_Object)& theCheckShape,
 557                                        const Handle(GEOM_Object)& theShape,
 558                                        const Standard_Integer theShapeType,
 559                                        GEOMAlgo_State theState);
 560
 561   /*!
 562    * \brief Find shape objects and their entries by their ids
 563    * \param theShape - the main shape
 564    * \param theShapeIDs - theShapeIDs - incoming shape ids
 565    * \param theShapeEntries - outgoing entries like "entry1, entry2, ..."
 566    * \retval Handle(TColStd_HSequenceOfTransient) - found shape objects
 567    */
 568   Handle(TColStd_HSequenceOfTransient)
 569     getObjectsShapesOn(const Handle(GEOM_Object)&                theShape,
 570                        const Handle(TColStd_HSequenceOfInteger)& theShapeIDs,
 571                        TCollection_AsciiString &                 theShapeEntries);
 572
 573   /*!
 574    * \brief Explode a shape into edges sorted in a row from a starting point.
 575    * \param theShape - the shape to be exploded on edges.
 576    * \param theStartPoint - the starting point.
 577    * \return Ordered list of edges sorted in a row from a starting point.
 578    */
 579   Handle(TColStd_HSequenceOfInteger) getSubShapeEdgeSortedIDs
 580                                 (const Handle(GEOM_Object) &theShape,
 581                                  const Handle(GEOM_Object) &theStartPoint);
 582
 583   /*!
 584    * \brief Select the object created last
 585    * \param theObj1 - Object 1
 586    * \param theObj2 - Object 2
 587    * \retval Handle(GEOM_Object) - selected object
 588    */
 589   static Handle(GEOM_Object) getCreatedLast(const Handle(GEOM_Object)& theObj1,
 590                                             const Handle(GEOM_Object)& theObj2);
 591 };
 592
 593 #endif