src/GEOMAlgo/GEOMAlgo_GetInPlaceAPI.hxx

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 // File:        GEOMAlgo_GetInPlaceAPI.hxx
  23 // Created:
  24 // Author:      Sergey KHROMOV
  25
  26 #ifndef _GEOMAlgo_GetInPlaceAPI_HeaderFile
  27 #define _GEOMAlgo_GetInPlaceAPI_HeaderFile
  28
  29 #include <GEOM_Function.hxx>
  30
  31 #include <TopTools_IndexedMapOfShape.hxx>
  32 #include <TopTools_ListOfShape.hxx>
  33 #include <gp_Vec.hxx>
  34
  35 class GEOMAlgo_GetInPlace;
  36 class BRepExtrema_DistShapeShape;
  37 class TopoDS_Face;
  38 class TopoDS_Shape;
  39
  40 /**
  41  * This is an API class for all GetInPlace algorithm.
  42  * It facilitates using different GetInPlace algorithms:
  43  * a new one(GEOMAlgo_GetInPlace), an old one and
  44  * GetInPlaceByHistory.
  45  */
  46 class GEOMAlgo_GetInPlaceAPI
  47 {
  48
  49 public:
  50
  51   /**
  52    *  \brief New GetInPlace method implementation.
  53    *  Initializes the GEOMAlgo_GetInPlace object with correct parameters and
  54    *  performs computation (calls theGIP's method Perform. Returns
  55    *  Standard_True in face of success; Standard_False otherwise.
  56    */
  57   Standard_EXPORT static Standard_Boolean GetInPlace
  58                       (const TopoDS_Shape        &theWhere,
  59                        const TopoDS_Shape        &theWhat,
  60                              GEOMAlgo_GetInPlace &theGIP);
  61
  62   /*!
  63    *  \brief Old implementation of GetInPlace algorithm.
  64    *  This method searches among sub shapes of the shape theWhere parts that are
  65    *  coincident with the shape theWhat. The result list of shape is returned as
  66    *  an output parameter. It returns the error code with the following possible
  67    *  values:
  68    *    0 - Success;
  69    *    1 - theWhere and/or theWhat TopoDS_Shape are Null;
  70    *    2 - An attempt to extract a shape of not supported type;
  71    *    3 - Not found any Results.
  72    */
  73   Standard_EXPORT static Standard_Integer GetInPlaceOld
  74             (const TopoDS_Shape         &theWhere,
  75              const TopoDS_Shape         &theWhat,
  76                    TopTools_ListOfShape &theShapesInPlace);
  77
  78
  79   /**
  80    *  \brief GetInPlaceByHistory method implementation.
  81    *  Returns Standard_True if something is found. Warning: theShapesInPlace
  82    *  list is not cleared at first.
  83    */
  84   Standard_EXPORT static Standard_Boolean GetInPlaceByHistory
  85                       (const Handle(GEOM_Function)       &theWhereFunction,
  86                        const TopTools_IndexedMapOfShape &theWhereIndices,
  87                        const TopoDS_Shape               &theWhat,
  88                              TopTools_ListOfShape       &theShapesInPlace);
  89
  90 protected:
  91
  92   /*!
  93    * \brief Return normal to face at extrema point
  94    */
  95   static gp_Vec GetNormal(const TopoDS_Face                &theFace,
  96                           const BRepExtrema_DistShapeShape &theExtrema);
  97
  98   /*!
  99    * Return the global properties of the shape: center of mass and
 100    * a size (length, area or volume depending on the shape type).
 101    */
 102   static void GetShapeProperties(const TopoDS_Shape  &theShape,
 103                                        Standard_Real  theTab[],
 104                                        gp_Pnt        &theVertex);
 105
 106 };
 107
 108
 109
 110 #endif