src/GEOMImpl/GEOMImpl_IShapesOperations.hxx

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20
  21 #ifndef _GEOMImpl_IShapesOperations_HXX_
  22 #define _GEOMImpl_IShapesOperations_HXX_
  23
  24 #include "GEOM_IOperations.hxx"
  25
  26 #include "GEOMAlgo_State.hxx"
  27
  28 #include <TopTools_ListOfShape.hxx>
  29 #include <TColStd_HSequenceOfTransient.hxx>
  30 #include <TColStd_HSequenceOfInteger.hxx>
  31
  32 #include <list>
  33 #include <Handle_Geom_Surface.hxx>
  34
  35 class GEOM_Engine;
  36 class Handle(GEOM_Object);
  37 class Handle(TColStd_HArray1OfInteger);
  38
  39 class GEOMImpl_IShapesOperations : public GEOM_IOperations {
  40  public:
  41   Standard_EXPORT GEOMImpl_IShapesOperations(GEOM_Engine* theEngine, int theDocID);
  42   Standard_EXPORT ~GEOMImpl_IShapesOperations();
  43
  44   Standard_EXPORT Handle(GEOM_Object) MakeEdge (Handle(GEOM_Object) thePoint1,
  45                                 Handle(GEOM_Object) thePoint2);
  46
  47   Standard_EXPORT Handle(GEOM_Object) MakeWire (list<Handle(GEOM_Object)> theEdgesAndWires);
  48
  49   Standard_EXPORT Handle(GEOM_Object) MakeFace (Handle(GEOM_Object) theWire, const bool isPlanarWanted);
  50
  51   Standard_EXPORT Handle(GEOM_Object) MakeFaceWires (list<Handle(GEOM_Object)> theWires,
  52                                      const bool isPlanarWanted);
  53
  54   Standard_EXPORT Handle(GEOM_Object) MakeShell (list<Handle(GEOM_Object)> theShapes);
  55
  56   Standard_EXPORT Handle(GEOM_Object) MakeSolidShell (Handle(GEOM_Object) theShell);
  57
  58   Standard_EXPORT Handle(GEOM_Object) MakeSolidShells (list<Handle(GEOM_Object)> theShells);
  59
  60   Standard_EXPORT Handle(GEOM_Object) MakeCompound (list<Handle(GEOM_Object)> theShapes);
  61
  62   Standard_EXPORT Handle(GEOM_Object) MakeGlueFaces (Handle(GEOM_Object) theShape,
  63                                      const Standard_Real theTolerance);
  64
  65   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) MakeExplode (Handle(GEOM_Object)    theShape,
  66                                                     const Standard_Integer theShapeType,
  67                                                     const Standard_Boolean isSorted);
  68
  69   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) SubShapeAllIDs (Handle(GEOM_Object)    theShape,
  70                                                      const Standard_Integer theShapeType,
  71                                                      const Standard_Boolean isSorted);
  72
  73   Standard_EXPORT Handle(GEOM_Object) GetSubShape (Handle(GEOM_Object)    theMainShape,
  74                                                    const Standard_Integer theID);
  75
  76   Standard_EXPORT Standard_Integer GetSubShapeIndex (Handle(GEOM_Object) theMainShape,
  77                                                      Handle(GEOM_Object) theSubShape);
  78
  79   Standard_EXPORT Standard_Integer GetTopologyIndex (Handle(GEOM_Object) theMainShape,
  80                                                      Handle(GEOM_Object) theSubShape);
  81
  82   Standard_EXPORT TCollection_AsciiString GetShapeTypeString (Handle(GEOM_Object) theShape);
  83
  84   Standard_EXPORT Standard_Integer NumberOfFaces (Handle(GEOM_Object) theShape);
  85   Standard_EXPORT Standard_Integer NumberOfEdges (Handle(GEOM_Object) theShape);
  86
  87   Standard_EXPORT Handle(GEOM_Object) ReverseShape(Handle(GEOM_Object) theShapes);
  88
  89   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetFreeFacesIDs (Handle(GEOM_Object) theShape);
  90
  91   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetSharedShapes (Handle(GEOM_Object)    theShape1,
  92                                                         Handle(GEOM_Object)    theShape2,
  93                                                         const Standard_Integer theShapeType);
  94
  95   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetShapesOnPlane (const Handle(GEOM_Object)& theShape,
  96                                                          const Standard_Integer     theShapeType,
  97                                                          const Handle(GEOM_Object)& theAx1,
  98                                                          const GEOMAlgo_State       theState);
  99
 100   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetShapesOnPlaneWithLocation (const Handle(GEOM_Object)& theShape,
 101                                                                      const Standard_Integer     theShapeType,
 102                                                                      const Handle(GEOM_Object)& theAx1,
 103                                                                      const Handle(GEOM_Object)& thePnt,
 104                                                                      const GEOMAlgo_State       theState);
 105
 106
 107   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetShapesOnCylinder (const Handle(GEOM_Object)& theShape,
 108                                                             const Standard_Integer     theShapeType,
 109                                                             const Handle(GEOM_Object)& theAxis,
 110                                                             const Standard_Real        theRadius,
 111                                                             const GEOMAlgo_State       theState);
 112
 113   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetShapesOnSphere (const Handle(GEOM_Object)& theShape,
 114                                                           const Standard_Integer     theShapeType,
 115                                                           const Handle(GEOM_Object)& theCenter,
 116                                                           const Standard_Real        theRadius,
 117                                                           const GEOMAlgo_State       theState);
 118
 119   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetShapesOnPlaneIDs (const Handle(GEOM_Object)& theShape,
 120                                                           const Standard_Integer     theShapeType,
 121                                                           const Handle(GEOM_Object)& theAx1,
 122                                                           const GEOMAlgo_State       theState);
 123
 124   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetShapesOnPlaneWithLocationIDs (const Handle(GEOM_Object)& theShape,
 125                                                       const Standard_Integer     theShapeType,
 126                                                           const Handle(GEOM_Object)& theAx1,
 127                                                           const Handle(GEOM_Object)& thePnt,
 128                                                           const GEOMAlgo_State       theState);
 129
 130   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetShapesOnCylinderIDs (const Handle(GEOM_Object)& theShape,
 131                                                              const Standard_Integer     theShapeType,
 132                                                              const Handle(GEOM_Object)& theAxis,
 133                                                              const Standard_Real        theRadius,
 134                                                              const GEOMAlgo_State       theState);
 135
 136   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetShapesOnSphereIDs (const Handle(GEOM_Object)& theShape,
 137                                                            const Standard_Integer     theShapeType,
 138                                                            const Handle(GEOM_Object)& theCenter,
 139                                                            const Standard_Real        theRadius,
 140                                                            const GEOMAlgo_State       theState);
 141
 142   /*!
 143    * \brief Find subshapes complying with given status about quadrangle
 144     * \param theShape - the shape to explore
 145     * \param theShapeType - type of subshape of theShape
 146     * \param theTopLeftPoint - top left quadrangle corner
 147     * \param theTopRigthPoint - top right quadrangle corner
 148     * \param theBottomLeftPoint - bottom left quadrangle corner
 149     * \param theBottomRigthPoint - bottom right quadrangle corner
 150     * \param theState - required state
 151     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found subshapes
 152    */
 153   Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
 154     GetShapesOnQuadrangle (const Handle(GEOM_Object)& theShape,
 155                            const Standard_Integer     theShapeType,
 156                            const Handle(GEOM_Object)& theTopLeftPoint,
 157                            const Handle(GEOM_Object)& theTopRigthPoint,
 158                            const Handle(GEOM_Object)& theBottomLeftPoint,
 159                            const Handle(GEOM_Object)& theBottomRigthPoint,
 160                            const GEOMAlgo_State       theState);
 161
 162   /*!
 163    * \brief Find IDs of subshapes complying with given status about quadrangle
 164     * \param theShape - the shape to explore
 165     * \param theShapeType - type of subshape of theShape
 166     * \param theTopLeftPoint - top left quadrangle corner
 167     * \param theTopRigthPoint - top right quadrangle corner
 168     * \param theBottomLeftPoint - bottom left quadrangle corner
 169     * \param theBottomRigthPoint - bottom right quadrangle corner
 170     * \param theState - required state
 171     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found subshapes
 172    */
 173   Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
 174     GetShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
 175                               const Standard_Integer     theShapeType,
 176                               const Handle(GEOM_Object)& theTopLeftPoint,
 177                               const Handle(GEOM_Object)& theTopRigthPoint,
 178                               const Handle(GEOM_Object)& theBottomLeftPoint,
 179                               const Handle(GEOM_Object)& theBottomRigthPoint,
 180                               const GEOMAlgo_State       theState);
 181
 182   Standard_EXPORT Handle(GEOM_Object) GetShapesOnCylinderOld (Handle(GEOM_Object)    theShape,
 183                                               const Standard_Integer theShapeType,
 184                                               Handle(GEOM_Object)    theAxis,
 185                                               const Standard_Real    theRadius);
 186
 187   Standard_EXPORT Handle(GEOM_Object) GetShapesOnSphereOld (Handle(GEOM_Object)    theShape,
 188                                             const Standard_Integer theShapeType,
 189                                             Handle(GEOM_Object)    theCenter,
 190                                             const Standard_Real    theRadius);
 191
 192   Standard_EXPORT Handle(GEOM_Object) GetInPlace (Handle(GEOM_Object) theShapeWhere,
 193                                   Handle(GEOM_Object) theShapeWhat);
 194
 195   Standard_EXPORT static void SortShapes (TopTools_ListOfShape& SL);
 196
 197   /*!
 198    * \brief Searches a shape equal to theWhat in the context of theWhere
 199     * \param theShapeWhere - a context shap
 200     * \param theShapeWhat - a sample shape
 201     * \retval Handle(GEOM_Object) - found shape
 202    */
 203   Standard_EXPORT Handle(GEOM_Object) GetSame(const Handle(GEOM_Object)& theShapeWhere,
 204                                               const Handle(GEOM_Object)& theShapeWhat);
 205
 206  private:
 207   Handle(GEOM_Object) MakeShape (list<Handle(GEOM_Object)>      theShapes,
 208                                  const Standard_Integer         theObjectType,
 209                                  const Standard_Integer         theFunctionType,
 210                                  const TCollection_AsciiString& theMethodName);
 211
 212 // ----------------------------------------------------
 213   // methods common for all GetShapesOnXXX() functions
 214 // ----------------------------------------------------
 215
 216   bool CheckTriangulation (const TopoDS_Shape& aShape);
 217
 218   /*!
 219    * \brief Checks if theShapeType parameter of GetShapesOnXXX() is OK
 220     * \param theShapeType - the shape type to check
 221     * \retval bool  - result of the check
 222    */
 223   bool checkTypeShapesOn(const Standard_Integer theShapeType);
 224
 225   /*!
 226    * \brief Creates Geom_Plane
 227     * \param theAx1 - edge defining plane normal
 228     * \retval Handle(Geom_Surface) - resulting surface
 229    */
 230   Handle(Geom_Surface) makePlane(const TopoDS_Shape& theAx1);
 231
 232   /*!
 233    * \brief Creates Geom_CylindricalSurface
 234     * \param theAx1 - edge defining cylinder axis
 235     * \param theRadius - cylinder radius
 236     * \retval Handle(Geom_Surface) - resulting surface
 237    */
 238   Handle(Geom_Surface) makeCylinder(const TopoDS_Shape& theAx1,
 239                                     const Standard_Real theRadius);
 240
 241   /*!
 242    * \brief Find IDs of subshapes complying with given status about surface
 243     * \param theSurface - the surface to check state of subshapes against
 244     * \param theShape - the shape to explore
 245     * \param theShapeType - type of subshape of theShape
 246     * \param theState - required state
 247     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found subshapes
 248    */
 249   Handle(TColStd_HSequenceOfInteger)
 250     getShapesOnSurfaceIDs(const Handle(Geom_Surface)& theSurface,
 251                           const TopoDS_Shape&         theShape,
 252                           TopAbs_ShapeEnum            theShapeType,
 253                           GEOMAlgo_State              theState);
 254
 255   /*!
 256    * \brief Find subshapes complying with given status about surface
 257     * \param theSurface - the surface to check state of subshapes against
 258     * \param theShape - the shape to explore
 259     * \param theShapeType - type of subshape of theShape
 260     * \param theState - required state
 261     * \param theShapeEntries - outgoing entries like "entry1, entry2, ..."
 262     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found subshapes
 263    */
 264   Handle(TColStd_HSequenceOfTransient)
 265     getShapesOnSurface(const Handle(Geom_Surface)& theSurface,
 266                        const Handle(GEOM_Object)&  theShape,
 267                        TopAbs_ShapeEnum            theShapeType,
 268                        GEOMAlgo_State              theState,
 269                        TCollection_AsciiString &   theShapeEntries
 270                        );
 271
 272   /*!
 273    * \brief Find IDs of subshapes complying with given status about quadrangle
 274     * \param theShape - the shape to explore
 275     * \param theShapeType - type of subshape of theShape
 276     * \param theTopLeftPoint - top left quadrangle corner
 277     * \param theTopRigthPoint - top right quadrangle corner
 278     * \param theBottomLeftPoint - bottom left quadrangle corner
 279     * \param theBottomRigthPoint - bottom right quadrangle corner
 280     * \param theState - required state
 281     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found subshapes
 282    */
 283   Handle(TColStd_HSequenceOfInteger)
 284     getShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
 285                               const Standard_Integer     theShapeType,
 286                               const Handle(GEOM_Object)& theTopLeftPoint,
 287                               const Handle(GEOM_Object)& theTopRigthPoint,
 288                               const Handle(GEOM_Object)& theBottomLeftPoint,
 289                               const Handle(GEOM_Object)& theBottomRigthPoint,
 290                               const GEOMAlgo_State       theState);
 291
 292   /*!
 293    * \brief Find shape objects and their entries by their ids
 294     * \param theShape - the main shape
 295     * \param theShapeIDs - theShapeIDs - incoming shape ids
 296     * \param theShapeEntries - outgoing entries like "entry1, entry2, ..."
 297     * \retval Handle(TColStd_HSequenceOfTransient) - found shape objects
 298    */
 299   Handle(TColStd_HSequenceOfTransient)
 300     getObjectsShapesOn(const Handle(GEOM_Object)&                theShape,
 301                        const Handle(TColStd_HSequenceOfInteger)& theShapeIDs,
 302                        TCollection_AsciiString &                 theShapeEntries);
 303
 304   /*!
 305    * \brief Select the object created last
 306     * \param theObj1 - Object 1
 307     * \param theObj2 - Object 2
 308     * \retval Handle(GEOM_Object) - selected object
 309    */
 310   static Handle(GEOM_Object) getCreatedLast(const Handle(GEOM_Object)& theObj1,
 311                                             const Handle(GEOM_Object)& theObj2);
 312 };
 313
 314 #endif