src/FeaturesAPI/FeaturesAPI_Measurement.h

   1 // Copyright (C) 2018-20xx  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef FeaturesAPI_Measurement_H_
  22 #define FeaturesAPI_Measurement_H_
  23
  24 #include "FeaturesAPI.h"
  25
  26 #include <list>
  27 #include <memory>
  28
  29 class ModelAPI_Document;
  30 class ModelHighAPI_Selection;
  31
  32 /// \ingroup CPPHighAPI
  33 /// \brief Calculate length of the edge.
  34 FEATURESAPI_EXPORT
  35 double measureLength(const std::shared_ptr<ModelAPI_Document>& thePart,
  36                      const ModelHighAPI_Selection& theEdge);
  37
  38 /// \ingroup CPPHighAPI
  39 /// \brief Calculate distance between objects.
  40 FEATURESAPI_EXPORT
  41 double measureDistance(const std::shared_ptr<ModelAPI_Document>& thePart,
  42                        const ModelHighAPI_Selection& theFrom,
  43                        const ModelHighAPI_Selection& theTo);
  44
  45 /// \ingroup CPPHighAPI
  46 /// \brief Calculate radius of circular.
  47 FEATURESAPI_EXPORT
  48 double measureRadius(const std::shared_ptr<ModelAPI_Document>& thePart,
  49                      const ModelHighAPI_Selection& theObject);
  50
  51 /// \ingroup CPPHighAPI
  52 /// \brief Calculate angle(s) between edges.
  53 FEATURESAPI_EXPORT
  54 std::list<double> measureAngle(const std::shared_ptr<ModelAPI_Document>& thePart,
  55                                const ModelHighAPI_Selection& theFrom,
  56                                const ModelHighAPI_Selection& theTo);
  57
  58 #endif // FeaturesAPI_Measurement_H_