1 // Copyright (C) 2014-2024 CEA, EDF
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef FeaturesAPI_PointCloudOnFace_H_
21 #define FeaturesAPI_PointCloudOnFace_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_PointCloudOnFace.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 #include <ModelHighAPI_Integer.h>
32 class ModelHighAPI_Selection;
34 /// \class FeaturesAPI_PointCloudOnFace
35 /// \ingroup CPPHighAPI
36 /// \brief Interface for PointCloudOnFace feature.
37 class FeaturesAPI_PointCloudOnFace: public ModelHighAPI_Interface
40 /// Constructor without values.
42 explicit FeaturesAPI_PointCloudOnFace(const std::shared_ptr<ModelAPI_Feature>& theFeature);
44 /// Constructor with values.
46 explicit FeaturesAPI_PointCloudOnFace(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47 const ModelHighAPI_Selection& theFace,
48 const ModelHighAPI_Integer& theNumber);
52 virtual ~FeaturesAPI_PointCloudOnFace();
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 */)
60 /// Modify CreationMethod, nb_points attribute of the feature.
62 void setNumberOfPoints(const ModelHighAPI_Integer& theNumber);
64 /// Dump wrapped feature
66 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
70 /// Pointer on the PointCloudOnFace object.
71 typedef std::shared_ptr<FeaturesAPI_PointCloudOnFace> PointCloudPtr;
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
79 PointCloudPtr makeVertexInsideFace(const std::shared_ptr<ModelAPI_Document>& thePart,
80 const ModelHighAPI_Selection& theFace,
81 const ModelHighAPI_Integer& theNumber);
83 #endif // FeaturesAPI_PointCloudOnFace_H_