1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: FeaturesAPI_Extrusion.h
4 // Created: 09 June 2016
5 // Author: Dmitry Bobylev
7 #ifndef FeaturesAPI_Extrusion_H_
8 #define FeaturesAPI_Extrusion_H_
10 #include "FeaturesAPI.h"
12 #include <FeaturesPlugin_Extrusion.h>
14 #include <ModelHighAPI_Interface.h>
15 #include <ModelHighAPI_Macro.h>
17 class ModelHighAPI_Double;
18 class ModelHighAPI_Selection;
20 /// \class FeaturesAPI_Extrusion
21 /// \ingroup CPPHighAPI
22 /// \brief Interface for Extrusion feature.
23 class FeaturesAPI_Extrusion: public ModelHighAPI_Interface
26 /// Constructor without values.
28 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature);
30 /// Constructor with values.
32 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
33 const std::list<ModelHighAPI_Selection>& theBaseObjects,
34 const ModelHighAPI_Double& theSize);
36 /// Constructor with values.
38 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
39 const std::list<ModelHighAPI_Selection>& theBaseObjects,
40 const ModelHighAPI_Selection& theDirection,
41 const ModelHighAPI_Double& theSize);
42 /// Constructor with values.
44 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
45 const std::list<ModelHighAPI_Selection>& theBaseObjects,
46 const ModelHighAPI_Double& theToSize,
47 const ModelHighAPI_Double& theFromSize);
49 /// Constructor with values.
51 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
52 const std::list<ModelHighAPI_Selection>& theBaseObjects,
53 const ModelHighAPI_Selection& theDirection,
54 const ModelHighAPI_Double& theToSize,
55 const ModelHighAPI_Double& theFromSize);
57 /// Constructor with values.
59 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
60 const std::list<ModelHighAPI_Selection>& theBaseObjects,
61 const ModelHighAPI_Selection& theToObject,
62 const ModelHighAPI_Double& theToOffset,
63 const ModelHighAPI_Selection& theFromObject,
64 const ModelHighAPI_Double& theFromOffset);
66 /// Constructor with values.
68 explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
69 const std::list<ModelHighAPI_Selection>& theBaseObjects,
70 const ModelHighAPI_Selection& theDirection,
71 const ModelHighAPI_Selection& theToObject,
72 const ModelHighAPI_Double& theToOffset,
73 const ModelHighAPI_Selection& theFromObject,
74 const ModelHighAPI_Double& theFromOffset);
78 virtual ~FeaturesAPI_Extrusion();
80 INTERFACE_10(FeaturesPlugin_Extrusion::ID(),
81 baseObjects, FeaturesPlugin_Extrusion::BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList, /** Base objects */,
82 creationMethod, FeaturesPlugin_Extrusion::CREATION_METHOD(), ModelAPI_AttributeString, /** Creation method */,
83 toSize, FeaturesPlugin_Extrusion::TO_SIZE_ID(), ModelAPI_AttributeDouble, /** To size */,
84 fromSize, FeaturesPlugin_Extrusion::FROM_SIZE_ID(), ModelAPI_AttributeDouble, /** From size */,
85 toObject, FeaturesPlugin_Extrusion::TO_OBJECT_ID(), ModelAPI_AttributeSelection, /** To object */,
86 toOffset, FeaturesPlugin_Extrusion::TO_OFFSET_ID(), ModelAPI_AttributeDouble, /** To offset */,
87 fromObject, FeaturesPlugin_Extrusion::FROM_OBJECT_ID(), ModelAPI_AttributeSelection, /** From object */,
88 fromOffset, FeaturesPlugin_Extrusion::FROM_OFFSET_ID(), ModelAPI_AttributeDouble, /** From offset */,
89 direction, FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID(), ModelAPI_AttributeSelection, /** Direction */,
90 sketchLauncher, FeaturesPlugin_Extrusion::SKETCH_ID(), ModelAPI_AttributeReference, /** Sketch launcher */)
92 /// Modify base attribute of the feature.
94 void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
96 /// Modify direction_object attribute of the feature.
98 void setDirection(const ModelHighAPI_Selection& theDirection);
100 /// Modify CreationMethod, to_size, from_size attributes of the feature.
102 void setSizes(const ModelHighAPI_Double& theToSize, const ModelHighAPI_Double& theFromSize);
104 /// Modify creation_method, to_size, from_size attributes of the feature.
106 void setSize(const ModelHighAPI_Double& theSize);
108 /// Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature.
110 void setPlanesAndOffsets(const ModelHighAPI_Selection& theToObject,
111 const ModelHighAPI_Double& theToOffset,
112 const ModelHighAPI_Selection& theFromObject,
113 const ModelHighAPI_Double& theFromOffset);
116 /// Pointer on Extrusion object.
117 typedef std::shared_ptr<FeaturesAPI_Extrusion> ExtrusionPtr;
119 /// \ingroup CPPHighAPI
120 /// \brief Create Extrusion feature.
122 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
123 const std::list<ModelHighAPI_Selection>& theBaseObjects,
124 const ModelHighAPI_Double& theSize);
126 /// \ingroup CPPHighAPI
127 /// \brief Create Extrusion feature.
129 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
130 const std::list<ModelHighAPI_Selection>& theBaseObjects,
131 const ModelHighAPI_Selection& theDirection,
132 const ModelHighAPI_Double& theSize);
134 /// \ingroup CPPHighAPI
135 /// \brief Create Extrusion feature.
137 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
138 const std::list<ModelHighAPI_Selection>& theBaseObjects,
139 const ModelHighAPI_Double& theToSize,
140 const ModelHighAPI_Double& theFromSize);
142 /// \ingroup CPPHighAPI
143 /// \brief Create Extrusion feature.
145 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
146 const std::list<ModelHighAPI_Selection>& theBaseObjects,
147 const ModelHighAPI_Selection& theDirection,
148 const ModelHighAPI_Double& theToSize,
149 const ModelHighAPI_Double& theFromSize);
151 /// \ingroup CPPHighAPI
152 /// \brief Create Extrusion feature.
154 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
155 const std::list<ModelHighAPI_Selection>& theBaseObjects,
156 const ModelHighAPI_Selection& theToObject,
157 const ModelHighAPI_Double& theToOffset,
158 const ModelHighAPI_Selection& theFromObject,
159 const ModelHighAPI_Double& theFromOffset);
161 /// \ingroup CPPHighAPI
162 /// \brief Create Extrusion feature.
164 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
165 const std::list<ModelHighAPI_Selection>& theBaseObjects,
166 const ModelHighAPI_Selection& theDirection,
167 const ModelHighAPI_Selection& theToObject,
168 const ModelHighAPI_Double& theToOffset,
169 const ModelHighAPI_Selection& theFromObject,
170 const ModelHighAPI_Double& theFromOffset);
172 #endif // FeaturesAPI_Extrusion_H_