src/FeaturesPlugin/FeaturesPlugin_Scale.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   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_SCALE_H_
  21 #define FEATURESPLUGIN_SCALE_H_
  22
  23 #include <FeaturesPlugin.h>
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 #include <GeomAlgoAPI_Scale.h>
  28
  29 /** \class FeaturesPlugin_Scale
  30  *  \ingroup Plugins
  31  *  \brief Feature for changing the scale of an object.
  32  */
  33 class FeaturesPlugin_Scale : public ModelAPI_Feature
  34 {
  35  public:
  36   /// Scale kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_SCALE_ID("Scale");
  40     return MY_SCALE_ID;
  41   }
  42
  43   /// Attribute name for creation method.
  44   inline static const std::string& CREATION_METHOD()
  45   {
  46     static const std::string MY_CREATION_METHOD_ID("CreationMethod");
  47     return MY_CREATION_METHOD_ID;
  48   }
  49
  50   /// Attribute name for creation method "ByFactor".
  51   inline static const std::string& CREATION_METHOD_BY_FACTOR()
  52   {
  53     static const std::string MY_CREATION_METHOD_ID("ByFactor");
  54     return MY_CREATION_METHOD_ID;
  55   }
  56
  57   /// Attribute name for creation method "ByFactor".
  58   inline static const std::string& CREATION_METHOD_BY_DIMENSIONS()
  59   {
  60     static const std::string MY_CREATION_METHOD_ID("ByDimensions");
  61     return MY_CREATION_METHOD_ID;
  62   }
  63
  64   /// Attribute name of referenced objects.
  65   inline static const std::string& OBJECTS_LIST_ID()
  66   {
  67     static const std::string MY_OBJECTS_LIST_ID("main_objects");
  68     return MY_OBJECTS_LIST_ID;
  69   }
  70
  71   /// Attribute name of center point.
  72   inline static const std::string& CENTER_POINT_ID()
  73   {
  74     static const std::string MY_CENTER_POINT_ID("center_point");
  75     return MY_CENTER_POINT_ID;
  76   }
  77
  78   /// Attribute name of scale factor.
  79   inline static const std::string& SCALE_FACTOR_ID()
  80   {
  81     static const std::string MY_SCALE_FACTOR_ID("scale_factor");
  82     return MY_SCALE_FACTOR_ID;
  83   }
  84
  85   /// Attribute name of scale factor in X.
  86   inline static const std::string& SCALE_FACTOR_X_ID()
  87   {
  88     static const std::string MY_SCALE_FACTOR_X_ID("scale_factor_x");
  89     return MY_SCALE_FACTOR_X_ID;
  90   }
  91
  92   /// Attribute name of scale factor in Y.
  93   inline static const std::string& SCALE_FACTOR_Y_ID()
  94   {
  95     static const std::string MY_SCALE_FACTOR_Y_ID("scale_factor_y");
  96     return MY_SCALE_FACTOR_Y_ID;
  97   }
  98
  99   /// Attribute name of scale factor in Z.
 100   inline static const std::string& SCALE_FACTOR_Z_ID()
 101   {
 102     static const std::string MY_SCALE_FACTOR_Z_ID("scale_factor_z");
 103     return MY_SCALE_FACTOR_Z_ID;
 104   }
 105
 106   /// \return the kind of a feature.
 107   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
 108   {
 109     static std::string MY_KIND = FeaturesPlugin_Scale::ID();
 110     return MY_KIND;
 111   }
 112
 113   /// Creates a new part document if needed.
 114   FEATURESPLUGIN_EXPORT virtual void execute();
 115
 116   /// Request for initialization of data model of the feature: adding all attributes.
 117   FEATURESPLUGIN_EXPORT virtual void initAttributes();
 118
 119   /// Use plugin manager for features creation.
 120   FeaturesPlugin_Scale();
 121
 122 private:
 123   /// Perform scale using a central point and a value of the scale.
 124   void performScaleByFactor();
 125
 126   /// Perform symmetry using a central point and three dimensions
 127   void performScaleByDimensions();
 128 };
 129
 130 #endif // FEATURESPLUGIN_SCALE_H_