src/FeaturesAPI/FeaturesAPI_Extrusion.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        FeaturesAPI_Extrusion.h
   4 // Created:     09 June 2016
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef FeaturesAPI_Extrusion_H_
   8 #define FeaturesAPI_Extrusion_H_
   9
  10 #include "FeaturesAPI.h"
  11
  12 #include <FeaturesPlugin_Extrusion.h>
  13
  14 #include <ModelHighAPI_Interface.h>
  15 #include <ModelHighAPI_Macro.h>
  16
  17 class ModelHighAPI_Double;
  18 class ModelHighAPI_Reference;
  19 class ModelHighAPI_Selection;
  20
  21 /// \class FeaturesAPI_Extrusion
  22 /// \ingroup CPPHighAPI
  23 /// \brief Interface for Extrusion feature.
  24 class FeaturesAPI_Extrusion: public ModelHighAPI_Interface
  25 {
  26 public:
  27   /// Constructor without values.
  28   FEATURESAPI_EXPORT
  29   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  30
  31   /// Constructor with values.
  32   FEATURESAPI_EXPORT
  33   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  34                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
  35                                  const ModelHighAPI_Double& theSize);
  36
  37   /// Constructor with values.
  38   FEATURESAPI_EXPORT
  39   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  40                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
  41                                  const ModelHighAPI_Selection& theDirection,
  42                                  const ModelHighAPI_Double& theSize);
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
  47                                  const ModelHighAPI_Double& theToSize,
  48                                  const ModelHighAPI_Double& theFromSize);
  49
  50   /// Constructor with values.
  51   FEATURESAPI_EXPORT
  52   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  53                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
  54                                  const ModelHighAPI_Selection& theDirection,
  55                                  const ModelHighAPI_Double& theToSize,
  56                                  const ModelHighAPI_Double& theFromSize);
  57
  58   /// Constructor with values.
  59   FEATURESAPI_EXPORT
  60   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  61                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
  62                                  const ModelHighAPI_Selection& theToObject,
  63                                  const ModelHighAPI_Double& theToOffset,
  64                                  const ModelHighAPI_Selection& theFromObject,
  65                                  const ModelHighAPI_Double& theFromOffset);
  66
  67   /// Constructor with values.
  68   FEATURESAPI_EXPORT
  69   explicit FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  70                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
  71                                  const ModelHighAPI_Selection& theDirection,
  72                                  const ModelHighAPI_Selection& theToObject,
  73                                  const ModelHighAPI_Double& theToOffset,
  74                                  const ModelHighAPI_Selection& theFromObject,
  75                                  const ModelHighAPI_Double& theFromOffset);
  76
  77   /// Destructor.
  78   FEATURESAPI_EXPORT
  79   virtual ~FeaturesAPI_Extrusion();
  80
  81   INTERFACE_10(FeaturesPlugin_Extrusion::ID(),
  82                sketch, FeaturesPlugin_Extrusion::SKETCH_ID(), ModelAPI_AttributeReference, /** Sketch launcher */,
  83                baseObjects, FeaturesPlugin_Extrusion::BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList, /** Base objects */,
  84                direction, FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID(), ModelAPI_AttributeSelection, /** Direction */,
  85                creationMethod, FeaturesPlugin_Extrusion::CREATION_METHOD(), ModelAPI_AttributeString, /** Creation method */,
  86                toSize, FeaturesPlugin_Extrusion::TO_SIZE_ID(), ModelAPI_AttributeDouble, /** To size */,
  87                fromSize, FeaturesPlugin_Extrusion::FROM_SIZE_ID(), ModelAPI_AttributeDouble, /** From size */,
  88                toObject, FeaturesPlugin_Extrusion::TO_OBJECT_ID(), ModelAPI_AttributeSelection, /** To object */,
  89                toOffset, FeaturesPlugin_Extrusion::TO_OFFSET_ID(), ModelAPI_AttributeDouble, /** To offset */,
  90                fromObject, FeaturesPlugin_Extrusion::FROM_OBJECT_ID(), ModelAPI_AttributeSelection, /** From object */,
  91                fromOffset, FeaturesPlugin_Extrusion::FROM_OFFSET_ID(), ModelAPI_AttributeDouble, /** From offset */)
  92
  93   /// Modify base attribute of the feature.
  94   FEATURESAPI_EXPORT
  95   void setNestedSketch(const ModelHighAPI_Reference& theSketch);
  96
  97   /// Modify base attribute of the feature.
  98   FEATURESAPI_EXPORT
  99   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
 100
 101   /// Modify direction_object attribute of the feature.
 102   FEATURESAPI_EXPORT
 103   void setDirection(const ModelHighAPI_Selection& theDirection);
 104
 105   /// Modify CreationMethod, to_size, from_size attributes of the feature.
 106   FEATURESAPI_EXPORT
 107   void setSizes(const ModelHighAPI_Double& theToSize, const ModelHighAPI_Double& theFromSize);
 108
 109   /// Modify creation_method, to_size, from_size attributes of the feature.
 110   FEATURESAPI_EXPORT
 111   void setSize(const ModelHighAPI_Double& theSize);
 112
 113   /// Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature.
 114   FEATURESAPI_EXPORT
 115   void setPlanesAndOffsets(const ModelHighAPI_Selection& theToObject,
 116                            const ModelHighAPI_Double& theToOffset,
 117                            const ModelHighAPI_Selection& theFromObject,
 118                            const ModelHighAPI_Double& theFromOffset);
 119
 120   /// Dump wrapped feature
 121   FEATURESAPI_EXPORT
 122   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 123
 124 private:
 125   void execIfBaseNotEmpty();
 126 };
 127
 128 /// Pointer on Extrusion object.
 129 typedef std::shared_ptr<FeaturesAPI_Extrusion> ExtrusionPtr;
 130
 131 /// \ingroup CPPHighAPI
 132 /// \brief Create Extrusion feature.
 133 FEATURESAPI_EXPORT
 134 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
 135                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
 136                           const ModelHighAPI_Double& theSize);
 137
 138 /// \ingroup CPPHighAPI
 139 /// \brief Create Extrusion feature.
 140 FEATURESAPI_EXPORT
 141 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
 142                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
 143                           const ModelHighAPI_Selection& theDirection,
 144                           const ModelHighAPI_Double& theSize);
 145
 146 /// \ingroup CPPHighAPI
 147 /// \brief Create Extrusion feature.
 148 FEATURESAPI_EXPORT
 149 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
 150                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
 151                           const ModelHighAPI_Double& theToSize,
 152                           const ModelHighAPI_Double& theFromSize);
 153
 154 /// \ingroup CPPHighAPI
 155 /// \brief Create Extrusion feature.
 156 FEATURESAPI_EXPORT
 157 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
 158                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
 159                           const ModelHighAPI_Selection& theDirection,
 160                           const ModelHighAPI_Double& theToSize,
 161                           const ModelHighAPI_Double& theFromSize);
 162
 163 /// \ingroup CPPHighAPI
 164 /// \brief Create Extrusion feature.
 165 FEATURESAPI_EXPORT
 166 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
 167                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
 168                           const ModelHighAPI_Selection& theToObject,
 169                           const ModelHighAPI_Double& theToOffset,
 170                           const ModelHighAPI_Selection& theFromObject,
 171                           const ModelHighAPI_Double& theFromOffset);
 172
 173 /// \ingroup CPPHighAPI
 174 /// \brief Create Extrusion feature.
 175 FEATURESAPI_EXPORT
 176 ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
 177                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
 178                           const ModelHighAPI_Selection& theDirection,
 179                           const ModelHighAPI_Selection& theToObject,
 180                           const ModelHighAPI_Double& theToOffset,
 181                           const ModelHighAPI_Selection& theFromObject,
 182                           const ModelHighAPI_Double& theFromOffset);
 183
 184 #endif // FeaturesAPI_Extrusion_H_