src/ModelGeomAlgo/ModelGeomAlgo_Shape.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef ModelGeomAlgo_Shape_H
  21 #define ModelGeomAlgo_Shape_H
  22
  23 #include "ModelGeomAlgo.h"
  24 #include "GeomAPI_Shape.h"
  25
  26 #include <set>
  27
  28 class ModelAPI_Feature;
  29 class ModelAPI_Result;
  30
  31 namespace ModelGeomAlgo_Shape {
  32
  33   /// Searches Shape results of the feature satisfied the given shape type
  34   /// \param theFeature a feature to obtain AttributeRefAttr
  35   /// \param theType shape type
  36   /// \param theShapeResults a list of results
  37   MODELGEOMALGO_EXPORT void shapesOfType(
  38                               const std::shared_ptr<ModelAPI_Feature>& theFeature,
  39                               const GeomAPI_Shape::ShapeType& theType,
  40                               std::set<std::shared_ptr<ModelAPI_Result> >& theShapeResults);
  41
  42   struct SubshapeOfResult
  43   {
  44     std::shared_ptr<ModelAPI_Result> myResult;
  45     std::shared_ptr<GeomAPI_Shape> mySubshape;
  46     int myCenterType;
  47   };
  48
  49   /// Searches a sub-shape in the results of the given features,
  50   /// which contains the given point.
  51   /// \param[in]  theFeature    feature, which results are being processed
  52   /// \param[in]  thePoint      selected point which identifies the shape
  53   /// \param[in]  theShapeType  type of the selected shape
  54   /// \param[out] theSelected   applicable result, sub-shape of the found result and
  55   ///                           type of the point if it is a center of circle or a focus of ellipse
  56   /// \return \c true if the result and its applicable sub-shape are found
  57   MODELGEOMALGO_EXPORT bool findSubshapeByPoint(
  58                               const std::shared_ptr<ModelAPI_Feature>& theFeature,
  59                               const std::shared_ptr<GeomAPI_Pnt>& thePoint,
  60                               const GeomAPI_Shape::ShapeType& theShapeType,
  61                               std::list<SubshapeOfResult>& theSelected);
  62 }
  63
  64 #endif