src/FeaturesAPI/FeaturesAPI_PointCloudOnFace.h

   1 // Copyright (C) 2014-2023  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_PointCloudOnFace_H_
  21 #define FeaturesAPI_PointCloudOnFace_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_PointCloudOnFace.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29 #include <ModelHighAPI_Integer.h>
  30
  31
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_PointCloudOnFace
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for PointCloudOnFace feature.
  37 class FeaturesAPI_PointCloudOnFace: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_PointCloudOnFace(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   explicit FeaturesAPI_PointCloudOnFace(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                                         const ModelHighAPI_Selection& theFace,
  48                                         const ModelHighAPI_Integer& theNumber);
  49
  50   /// Destructor.
  51   FEATURESAPI_EXPORT
  52   virtual ~FeaturesAPI_PointCloudOnFace();
  53
  54   INTERFACE_2(FeaturesPlugin_PointCloudOnFace::ID(),
  55               faceSelected, FeaturesPlugin_PointCloudOnFace::FACE_SELECTED_ID(),
  56               ModelAPI_AttributeSelection, /** face */,
  57               nbPoints, FeaturesPlugin_PointCloudOnFace::NUMBER_ID(),
  58               ModelAPI_AttributeInteger, /** Number of points */)
  59
  60   /// Modify CreationMethod, nb_points attribute of the feature.
  61   FEATURESAPI_EXPORT
  62   void setNumberOfPoints(const ModelHighAPI_Integer& theNumber);
  63
  64   /// Dump wrapped feature
  65   FEATURESAPI_EXPORT
  66   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  67
  68 };
  69
  70 /// Pointer on the PointCloudOnFace object.
  71 typedef std::shared_ptr<FeaturesAPI_PointCloudOnFace> PointCloudPtr;
  72
  73 /// \ingroup CPPHighAPI
  74 /// \brief Create point cloud on a face feature
  75 /// \param thePart the part
  76 /// \param theFace the selected face
  77 /// \param theNumberOfPoints the selected point
  78 FEATURESAPI_EXPORT
  79 PointCloudPtr makeVertexInsideFace(const std::shared_ptr<ModelAPI_Document>& thePart,
  80                                    const ModelHighAPI_Selection& theFace,
  81                                    const ModelHighAPI_Integer& theNumber);
  82
  83 #endif // FeaturesAPI_PointCloudOnFace_H_