X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2FFeaturesPlugin_Extrusion.h;h=aa2b483618da5cde068777cdfd436b3e650dd3ce;hb=38dd97c8f7a3605ec6c362c3aefdefa3ee2675be;hp=c6c500fe211a9caaab4ddbd2f1b6852f9a81db32;hpb=db3da60baa0e8cb3dec62db38063d3b9a951a4cd;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h b/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h index c6c500fe2..aa2b48361 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h +++ b/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + // File: FeaturesPlugin_Extrusion.h // Created: 30 May 2014 // Author: Vitaly SMETANNIKOV @@ -6,58 +8,121 @@ #define FeaturesPlugin_Extrusion_H_ #include "FeaturesPlugin.h" -#include -#include -#include -#include -class FeaturesPlugin_Extrusion : public ModelAPI_Feature + +#include "FeaturesPlugin_CompositeSketch.h" + +#include + +/// \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 for creation method. + inline static const std::string& CREATION_METHOD() + { + static const std::string MY_CREATION_METHOD_ID("CreationMethod"); + return MY_CREATION_METHOD_ID; + } + + /// Attribute name for creation method. + inline static const std::string& CREATION_METHOD_BY_SIZES() + { + static const std::string MY_CREATION_METHOD_ID("BySizes"); + return MY_CREATION_METHOD_ID; + } + + /// Attribute name for creation method. + inline static const std::string& CREATION_METHOD_BY_PLANES() + { + static const std::string MY_CREATION_METHOD_ID("ByPlanesAndOffsets"); + return MY_CREATION_METHOD_ID; + } + + /// 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 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. + 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 referenced face - inline static const std::string& FACE_ID() + + /// Attribute name of extrusion offset. + inline static const std::string& TO_OFFSET_ID() { - static const std::string MY_FACE_ID("extrusion_face"); - return MY_FACE_ID; + static const std::string MY_TO_OFFSET_ID("to_offset"); + return MY_TO_OFFSET_ID; } - /// attribute name of extrusion size - inline static const std::string& SIZE_ID() + + /// Attribute name of an object from which the extrusion grows. + inline static const std::string& FROM_OBJECT_ID() { - static const std::string MY_SIZE_ID("extrusion_size"); - return MY_SIZE_ID; + static const std::string MY_FROM_OBJECT_ID("from_object"); + return MY_FROM_OBJECT_ID; } - /// attribute name of reverse direction - inline static const std::string& REVERSE_ID() + + /// Attribute name of extrusion offset. + inline static const std::string& FROM_OFFSET_ID() { - static const std::string MY_REVERSE_ID("extrusion_reverse"); - return MY_REVERSE_ID; + static const std::string MY_FROM_OFFSET_ID("from_offset"); + return MY_FROM_OFFSET_ID; } - /// Returns the kind of a feature + /// \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(); + /// Creates a new part document if needed. + FEATURESPLUGIN_EXPORT virtual void execute(); - /// Load Naming data structure of the feature to the document - void LoadNamingDS(GeomAlgoAPI_Extrusion& theFeature, boost::shared_ptr theResultBody, - boost::shared_ptr theBasis, - boost::shared_ptr theContext); +protected: + /// Generates extrusions. + /// \param[out] theBaseShapes list of base shapes. + /// \param[out] theMakeShapes list of according algos. + /// \return false in case one of algo failed. + bool makeExtrusions(ListOfShape& theBaseShapes, + ListOfMakeShape& theMakeShapes); }; #endif