src/FeaturesAPI/FeaturesAPI_Measurement.h

   1 // Copyright (C) 2018-2024  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 FeaturesAPI_Measurement_H_
  21 #define FeaturesAPI_Measurement_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <list>
  26 #include <memory>
  27
  28 class ModelAPI_Document;
  29 class ModelHighAPI_Selection;
  30
  31 /// \ingroup CPPHighAPI
  32 /// \brief Calculate length of the edge.
  33 FEATURESAPI_EXPORT
  34 double measureLength(const std::shared_ptr<ModelAPI_Document>& thePart,
  35                      const ModelHighAPI_Selection& theEdge);
  36
  37 /// \ingroup CPPHighAPI
  38 /// \brief Calculate distance between objects.
  39 FEATURESAPI_EXPORT
  40 double measureDistance(const std::shared_ptr<ModelAPI_Document>& thePart,
  41                        const ModelHighAPI_Selection& theFrom,
  42                        const ModelHighAPI_Selection& theTo);
  43
  44 /// \ingroup CPPHighAPI
  45 /// \brief Calculate radius of circular edge, cylindrical surface or sphere.
  46 FEATURESAPI_EXPORT
  47 double measureRadius(const std::shared_ptr<ModelAPI_Document>& thePart,
  48                      const ModelHighAPI_Selection& theObject);
  49
  50 /// \ingroup CPPHighAPI
  51 /// \brief Calculate angle(s) between edges.
  52 FEATURESAPI_EXPORT
  53 std::list<double> measureAngle(const std::shared_ptr<ModelAPI_Document>& thePart,
  54                                const ModelHighAPI_Selection& theFrom,
  55                                const ModelHighAPI_Selection& theTo);
  56
  57 /// \ingroup CPPHighAPI
  58 /// \brief Calculate angle by 3 points.
  59 FEATURESAPI_EXPORT
  60 double measureAngle(const std::shared_ptr<ModelAPI_Document>& thePart,
  61                     const ModelHighAPI_Selection& thePoint1,
  62                     const ModelHighAPI_Selection& thePoint2,
  63                     const ModelHighAPI_Selection& thePoint3);
  64
  65 /// \ingroup CPPHighAPI
  66 /// \brief Calculate maximum of all distances between objects.
  67 FEATURESAPI_EXPORT
  68 double shapeProximity(const std::shared_ptr<ModelAPI_Document>& thePart,
  69                       const ModelHighAPI_Selection& theFrom,
  70                       const ModelHighAPI_Selection& theTo);
  71
  72 #endif // FeaturesAPI_Measurement_H_