SHAPER  9.12.0
FeaturesAPI_NormalToFace.h
1 // Copyright (C) 2014-2023 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_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 
32 
37 {
38 public:
40  FEATURESAPI_EXPORT
41  explicit FeaturesAPI_NormalToFace(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42 
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 
50  FEATURESAPI_EXPORT
51  explicit FeaturesAPI_NormalToFace(const std::shared_ptr<ModelAPI_Feature>& theFeature,
52  const ModelHighAPI_Selection& theBaseFace);
53 
55  FEATURESAPI_EXPORT
56  virtual ~FeaturesAPI_NormalToFace();
57 
58  INTERFACE_3(FeaturesPlugin_NormalToFace::ID(),
65 
66 
67  FEATURESAPI_EXPORT
68  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
69 
70 };
71 
73 typedef std::shared_ptr<FeaturesAPI_NormalToFace> NormalPtr;
74 
80 FEATURESAPI_EXPORT
81 NormalPtr getNormal(const std::shared_ptr<ModelAPI_Document>& thePart,
82  const ModelHighAPI_Selection& theBaseFace,
83  const ModelHighAPI_Selection& theOptionalPoint);
84 
89 FEATURESAPI_EXPORT
90 NormalPtr getNormal(const std::shared_ptr<ModelAPI_Document>& thePart,
91  const ModelHighAPI_Selection& theBaseFace);
92 
93 #endif // FeaturesAPI_NormalToFace_H_
Interface for NormalToface feature.
Definition: FeaturesAPI_NormalToFace.h:37
FeaturesAPI_NormalToFace(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_NormalToFace.cpp:27
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_NormalToFace.cpp:68
virtual std::shared_ptr< ModelAPI_AttributeString > vertexOption() const
use a vertex
Definition: FeaturesAPI_NormalToFace.h:64
virtual std::shared_ptr< ModelAPI_AttributeSelection > faceSelected() const
base face
Definition: FeaturesAPI_NormalToFace.h:64
virtual ~FeaturesAPI_NormalToFace()
Destructor.
Definition: FeaturesAPI_NormalToFace.cpp:63
virtual std::shared_ptr< ModelAPI_AttributeSelection > vertexSelected() const
vertex
Definition: FeaturesAPI_NormalToFace.h:64
static const std::string & FACE_SELECTED_ID()
Attribute name for face selected.
Definition: FeaturesPlugin_NormalToFace.h:43
static const std::string & ID()
Normal to face kind.
Definition: FeaturesPlugin_NormalToFace.h:36
static const std::string & VERTEX_OPTION_ID()
Attribute name of vertex option.
Definition: FeaturesPlugin_NormalToFace.h:57
static const std::string & VERTEX_SELECTED_ID()
Attribute name for vertex selected.
Definition: FeaturesPlugin_NormalToFace.h:50
Attribute that contains reference to the sub-shape of some result, the selected shape.
Definition: ModelAPI_AttributeSelection.h:35
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
NormalPtr getNormal(const std::shared_ptr< ModelAPI_Document > &thePart, const ModelHighAPI_Selection &theBaseFace, const ModelHighAPI_Selection &theOptionalPoint)
Create normal to a face feature.
Definition: FeaturesAPI_NormalToFace.cpp:90