SHAPER  9.12.0
FeaturesPlugin_Extrusion.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 FeaturesPlugin_Extrusion_H_
21 #define FeaturesPlugin_Extrusion_H_
22 
23 #include "FeaturesPlugin.h"
24 
25 #include "FeaturesPlugin_CompositeSketch.h"
26 
27 #include <GeomAlgoAPI_MakeShape.h>
28 
37 {
38 public:
41 
43  inline static const std::string& ID()
44  {
45  static const std::string MY_ID("Extrusion");
46  return MY_ID;
47  }
48 
50  inline static const std::string& CREATION_METHOD()
51  {
52  static const std::string MY_CREATION_METHOD_ID("CreationMethod");
53  return MY_CREATION_METHOD_ID;
54  }
55 
57  inline static const std::string& CREATION_METHOD_BY_SIZES()
58  {
59  static const std::string MY_CREATION_METHOD_BY_SIZES("BySizes");
60  return MY_CREATION_METHOD_BY_SIZES;
61  }
62 
64  inline static const std::string& CREATION_METHOD_BY_PLANES()
65  {
66  static const std::string MY_CREATION_METHOD_BY_PLANES("ByPlanesAndOffsets");
67  return MY_CREATION_METHOD_BY_PLANES;
68  }
69 
71  inline static const std::string& CREATION_METHOD_THROUGH_ALL()
72  {
73  static const std::string MY_CREATION_METHOD_THROUGH_ALL("ThroughAll");
74  return MY_CREATION_METHOD_THROUGH_ALL;
75  }
76 
78  inline static const std::string& DIRECTION_OBJECT_ID()
79  {
80  static const std::string MY_DIRECTION_OBJECT_ID("direction_object");
81  return MY_DIRECTION_OBJECT_ID;
82  }
83 
85  inline static const std::string& TO_SIZE_ID()
86  {
87  static const std::string MY_TO_SIZE_ID("to_size");
88  return MY_TO_SIZE_ID;
89  }
90 
92  inline static const std::string& FROM_SIZE_ID()
93  {
94  static const std::string MY_FROM_SIZE_ID("from_size");
95  return MY_FROM_SIZE_ID;
96  }
97 
99  inline static const std::string& TO_OBJECT_ID()
100  {
101  static const std::string MY_TO_OBJECT_ID("to_object");
102  return MY_TO_OBJECT_ID;
103  }
104 
106  inline static const std::string& TO_OFFSET_ID()
107  {
108  static const std::string MY_TO_OFFSET_ID("to_offset");
109  return MY_TO_OFFSET_ID;
110  }
111 
113  inline static const std::string& FROM_OBJECT_ID()
114  {
115  static const std::string MY_FROM_OBJECT_ID("from_object");
116  return MY_FROM_OBJECT_ID;
117  }
118 
120  inline static const std::string& FROM_OFFSET_ID()
121  {
122  static const std::string MY_FROM_OFFSET_ID("from_offset");
123  return MY_FROM_OFFSET_ID;
124  }
125 
127  FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
128  {
129  static std::string MY_KIND = FeaturesPlugin_Extrusion::ID();
130  return MY_KIND;
131  }
132 
134  FEATURESPLUGIN_EXPORT virtual void initAttributes();
135 
137  FEATURESPLUGIN_EXPORT virtual void execute();
138 
139 protected:
145  bool makeExtrusions(ListOfShape& theBaseShapes,
146  ListOfShape& theBoundaryShapes,
147  ListOfMakeShape& theMakeShapes);
148 
150  void storeResultWithBoundaries(const GeomShapePtr theBaseShape,
151  const ListOfShape& theBoundaryShapes,
152  const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
153  const int theIndex = 0);
154 
156  void getDirection(std::shared_ptr<GeomAPI_Dir>& theDir);
157 
159  virtual void getSizes(double& theToSize, double& theFromSize);
160 };
161 
162 #endif
Interface for the composite sketch feature.
Definition: FeaturesPlugin_CompositeSketch.h:33
Feature for creation of extrusion from the planar face.
Definition: FeaturesPlugin_Extrusion.h:37
void storeResultWithBoundaries(const GeomShapePtr theBaseShape, const ListOfShape &theBoundaryShapes, const std::shared_ptr< GeomAlgoAPI_MakeShape > theMakeShape, const int theIndex=0)
Stores result of generation.
Definition: FeaturesPlugin_Extrusion.cpp:166
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_Extrusion.h:50
virtual void getSizes(double &theToSize, double &theFromSize)
Retrieve or calculate prism sizes.
Definition: FeaturesPlugin_Extrusion.cpp:218
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: FeaturesPlugin_Extrusion.cpp:43
static const std::string & FROM_SIZE_ID()
Attribute name of extrusion from size.
Definition: FeaturesPlugin_Extrusion.h:92
static const std::string & CREATION_METHOD_BY_PLANES()
Attribute name for creation method.
Definition: FeaturesPlugin_Extrusion.h:64
static const std::string & TO_SIZE_ID()
Attribute name of extrusion to size.
Definition: FeaturesPlugin_Extrusion.h:85
static const std::string & TO_OBJECT_ID()
Attribute name of an object to which the extrusion grows.
Definition: FeaturesPlugin_Extrusion.h:99
FeaturesPlugin_Extrusion()
Use plugin manager for features creation.
Definition: FeaturesPlugin_Extrusion.cpp:38
virtual const std::string & getKind()
Definition: FeaturesPlugin_Extrusion.h:127
static const std::string & FROM_OBJECT_ID()
Attribute name of an object from which the extrusion grows.
Definition: FeaturesPlugin_Extrusion.h:113
static const std::string & DIRECTION_OBJECT_ID()
Attribute name of an object to which the extrusion grows.
Definition: FeaturesPlugin_Extrusion.h:78
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_Extrusion.h:43
static const std::string & CREATION_METHOD_THROUGH_ALL()
Attribute name for creation method.
Definition: FeaturesPlugin_Extrusion.h:71
bool makeExtrusions(ListOfShape &theBaseShapes, ListOfShape &theBoundaryShapes, ListOfMakeShape &theMakeShapes)
Generates extrusions.
Definition: FeaturesPlugin_Extrusion.cpp:94
static const std::string & TO_OFFSET_ID()
Attribute name of extrusion offset.
Definition: FeaturesPlugin_Extrusion.h:106
void getDirection(std::shared_ptr< GeomAPI_Dir > &theDir)
Retrieve direction argument.
Definition: FeaturesPlugin_Extrusion.cpp:186
virtual void execute()
Performs the algorithm and stores results it in the data structure.
Definition: FeaturesPlugin_Extrusion.cpp:68
static const std::string & CREATION_METHOD_BY_SIZES()
Attribute name for creation method.
Definition: FeaturesPlugin_Extrusion.h:57
static const std::string & FROM_OFFSET_ID()
Attribute name of extrusion offset.
Definition: FeaturesPlugin_Extrusion.h:120