-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File: FeaturesPlugin_Extrusion.h
-// Created: 30 May 2014
-// Author: Vitaly SMETANNIKOV
+// Copyright (C) 2014-2024 CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#ifndef FeaturesPlugin_Extrusion_H_
#define FeaturesPlugin_Extrusion_H_
-#include <FeaturesPlugin.h>
-#include <ModelAPI_Feature.h>
-#include <GeomAlgoAPI_Prism.h>
-
-class GeomAPI_Shape;
-class ModelAPI_ResultBody;
-
-/**\class FeaturesPlugin_Extrusion
- * \ingroup Plugins
- * \brief Feature for creation of extrusion from the planar face.
- *
- * Extrusion creates the lateral faces based on edges of the base face and
- * the top and bottom faces equal to the base face or this faces can be projection on the
- * bounding planes if they were set. Direction of extrusion is taken from the face
- * plane or if the bounding faces were set then it will be from the bottom to the top plane.
- */
-class FeaturesPlugin_Extrusion : public ModelAPI_Feature
+#include "FeaturesPlugin.h"
+
+#include "FeaturesPlugin_CompositeSketch.h"
+
+#include <GeomAlgoAPI_MakeShape.h>
+
+/// \class FeaturesPlugin_Extrusion
+/// \ingroup Plugins
+/// \brief Feature for creation of extrusion from the planar face.
+/// Extrusion creates the lateral faces based on edges of the base face and
+/// the top and bottom faces equal to the base face or this faces can be projection on the
+/// bounding planes if they were set. Direction of extrusion is taken from the face
+/// plane or if the bounding faces were set then it will be from the bottom to the top plane.
+class FeaturesPlugin_Extrusion: public FeaturesPlugin_CompositeSketch
{
- public:
- /// Extrusion kind
+public:
+ /// Use plugin manager for features creation
+ FeaturesPlugin_Extrusion();
+
+ /// Feature kind.
inline static const std::string& ID()
{
- static const std::string MY_EXTRUSION_ID("Extrusion");
- return MY_EXTRUSION_ID;
+ static const std::string MY_ID("Extrusion");
+ return MY_ID;
}
- /// attribute name of references sketch entities list, it should contain a sketch result or
- /// a pair a sketch result to sketch face
- inline static const std::string& LIST_ID()
+
+ /// Attribute name for creation method.
+ inline static const std::string& CREATION_METHOD()
{
- static const std::string MY_GROUP_LIST_ID("base");
- return MY_GROUP_LIST_ID;
+ static const std::string MY_CREATION_METHOD_ID("CreationMethod");
+ return MY_CREATION_METHOD_ID;
}
- /// attribute name of an object to which the extrusion grows
- inline static const std::string& AXIS_OBJECT_ID()
+ /// Attribute name for creation method.
+ inline static const std::string& CREATION_METHOD_BY_SIZES()
{
- static const std::string MY_TO_OBJECT_ID("axis_object");
- return MY_TO_OBJECT_ID;
+ static const std::string MY_CREATION_METHOD_BY_SIZES("BySizes");
+ return MY_CREATION_METHOD_BY_SIZES;
}
- /// attribute name for creation method
- inline static const std::string& CREATION_METHOD()
+ /// Attribute name for creation method.
+ inline static const std::string& CREATION_METHOD_BY_PLANES()
{
- static const std::string METHOD_ATTR("CreationMethod");
- return METHOD_ATTR;
+ static const std::string MY_CREATION_METHOD_BY_PLANES("ByPlanesAndOffsets");
+ return MY_CREATION_METHOD_BY_PLANES;
}
- /// attribute name of extrusion size
+ /// Attribute name for creation method.
+ inline static const std::string& CREATION_METHOD_THROUGH_ALL()
+ {
+ static const std::string MY_CREATION_METHOD_THROUGH_ALL("ThroughAll");
+ return MY_CREATION_METHOD_THROUGH_ALL;
+ }
+
+ /// Attribute name of an object to which the extrusion grows.
+ inline static const std::string& DIRECTION_OBJECT_ID()
+ {
+ static const std::string MY_DIRECTION_OBJECT_ID("direction_object");
+ return MY_DIRECTION_OBJECT_ID;
+ }
+
+ /// Attribute name of extrusion to size.
inline static const std::string& TO_SIZE_ID()
{
static const std::string MY_TO_SIZE_ID("to_size");
return MY_TO_SIZE_ID;
}
- /// attribute name of extrusion size
+ /// Attribute name of extrusion from size.
inline static const std::string& FROM_SIZE_ID()
{
static const std::string MY_FROM_SIZE_ID("from_size");
return MY_FROM_SIZE_ID;
}
- /// attribute name of an object to which the extrusion grows
+ /// Attribute name of an object to which the extrusion grows.
inline static const std::string& TO_OBJECT_ID()
{
static const std::string MY_TO_OBJECT_ID("to_object");
return MY_TO_OBJECT_ID;
}
- /// attribute name of tool object
+ /// Attribute name of extrusion offset.
+ inline static const std::string& TO_OFFSET_ID()
+ {
+ static const std::string MY_TO_OFFSET_ID("to_offset");
+ return MY_TO_OFFSET_ID;
+ }
+
+ /// Attribute name of an object from which the extrusion grows.
inline static const std::string& FROM_OBJECT_ID()
{
static const std::string MY_FROM_OBJECT_ID("from_object");
return MY_FROM_OBJECT_ID;
}
- /// Returns the kind of a feature
+ /// Attribute name of extrusion offset.
+ inline static const std::string& FROM_OFFSET_ID()
+ {
+ static const std::string MY_FROM_OFFSET_ID("from_offset");
+ return MY_FROM_OFFSET_ID;
+ }
+
+ /// \return the kind of a feature.
FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
{
static std::string MY_KIND = FeaturesPlugin_Extrusion::ID();
return MY_KIND;
}
- /// Creates a new part document if needed
- FEATURESPLUGIN_EXPORT virtual void execute();
-
- /// Request for initialization of data model of the feature: adding all attributes
+ /// Request for initialization of data model of the feature: adding all attributes.
FEATURESPLUGIN_EXPORT virtual void initAttributes();
- /// Use plugin manager for features creation
- FeaturesPlugin_Extrusion();
-private:
- /// Load Naming data structure of the feature to the document
- void LoadNamingDS(GeomAlgoAPI_Prism& theFeature, std::shared_ptr<ModelAPI_ResultBody> theResultBody,
- std::shared_ptr<GeomAPI_Shape> theBasis,
- std::shared_ptr<GeomAPI_Shape> theContext);
+ /// Performs the algorithm and stores results it in the data structure.
+ FEATURESPLUGIN_EXPORT virtual void execute();
+
+protected:
+ /// Generates extrusions.
+ /// \param[out] theBaseShapes list of base shapes.
+ /// \param[out] theBoundaryShapes list of faces limiting the extrusion
+ /// \param[out] theMakeShapes list of according algos.
+ /// \return false in case one of algo failed.
+ bool makeExtrusions(ListOfShape& theBaseShapes,
+ ListOfShape& theBoundaryShapes,
+ ListOfMakeShape& theMakeShapes);
+
+ /// Stores result of generation.
+ void storeResultWithBoundaries(const GeomShapePtr theBaseShape,
+ const ListOfShape& theBoundaryShapes,
+ const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+ const int theIndex = 0);
+
+ /// Retrieve direction argument.
+ void getDirection(std::shared_ptr<GeomAPI_Dir>& theDir);
+
+ /// Retrieve or calculate prism sizes.
+ virtual void getSizes(double& theToSize, double& theFromSize);
};
#endif
