src/FeaturesAPI/FeaturesAPI_NormalToFace.h

   1 // Copyright (C) 2014-2022  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef FeaturesAPI_NormalToFace_H_
  21 #define FeaturesAPI_NormalToFace_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_NormalToFace.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_NormalToFace
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for NormalToface feature.
  36 class FeaturesAPI_NormalToFace: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_NormalToFace(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   explicit FeaturesAPI_NormalToFace(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                                     const ModelHighAPI_Selection& theBaseFace,
  47                                     const ModelHighAPI_Selection& theOptionalPoint);
  48
  49   /// Constructor with values.
  50   FEATURESAPI_EXPORT
  51   explicit FeaturesAPI_NormalToFace(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  52                                     const ModelHighAPI_Selection& theBaseFace);
  53
  54   /// Destructor.
  55   FEATURESAPI_EXPORT
  56   virtual ~FeaturesAPI_NormalToFace();
  57
  58   INTERFACE_3(FeaturesPlugin_NormalToFace::ID(),
  59               faceSelected, FeaturesPlugin_NormalToFace::FACE_SELECTED_ID(),
  60               ModelAPI_AttributeSelection, /** base face */,
  61               vertexSelected, FeaturesPlugin_NormalToFace::VERTEX_SELECTED_ID(),
  62               ModelAPI_AttributeSelection, /** vertex */,
  63               vertexOption, FeaturesPlugin_NormalToFace::VERTEX_OPTION_ID(),
  64               ModelAPI_AttributeString, /** use a vertex */)
  65
  66   /// Dump wrapped feature
  67   FEATURESAPI_EXPORT
  68   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  69
  70 };
  71
  72 /// Pointer on the NormalToface object.
  73 typedef std::shared_ptr<FeaturesAPI_NormalToFace> NormalPtr;
  74
  75 /// \ingroup CPPHighAPI
  76 /// \brief Create normal to a face feature
  77 /// \param thePart the part
  78 /// \param theBaseFace the selected face
  79 /// \param theOptionalPoint the selected point
  80 FEATURESAPI_EXPORT
  81 NormalPtr getNormal(const std::shared_ptr<ModelAPI_Document>& thePart,
  82                     const ModelHighAPI_Selection& theBaseFace,
  83                     const ModelHighAPI_Selection& theOptionalPoint);
  84
  85 /// \ingroup CPPHighAPI
  86 /// \brief Create normal to a face feature
  87 /// \param thePart the part
  88 /// \param theBaseFace the selected face
  89 FEATURESAPI_EXPORT
  90 NormalPtr getNormal(const std::shared_ptr<ModelAPI_Document>& thePart,
  91                     const ModelHighAPI_Selection& theBaseFace);
  92
  93 #endif // FeaturesAPI_NormalToFace_H_