src/FeaturesPlugin/FeaturesPlugin_BoundingBox.h

   1 // Copyright (C) 2018-2022  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_BoundingBox_H_
  21 #define FeaturesPlugin_BoundingBox_H_
  22
  23 #include <FeaturesPlugin_BoundingBoxBase.h>
  24
  25 /// \class FeaturesPlugin_BoundingBox
  26 /// \ingroup Plugins
  27 /// \brief Persistence feature to create the bounding box.
  28
  29 class FeaturesPlugin_BoundingBox : public FeaturesPlugin_BoundingBoxBase
  30 {
  31 public:
  32   /// Bounding box kind.
  33   inline static const std::string& ID()
  34   {
  35     static const std::string MY_ID("BoundingBox");
  36     return MY_ID;
  37   }
  38
  39   /// Attribute name for object selected.
  40   inline static const std::string& OBJECT_ID()
  41   {
  42     static const std::string MY_OBJECT_ID("main_object");
  43     return MY_OBJECT_ID;
  44   }
  45
  46   /// Attribute name for x coodinate.
  47   inline static const std::string& X_MIN_COORD_ID()
  48   {
  49     static const std::string MY_X_MIN_COORD_ID("xmincoordinate");
  50     return MY_X_MIN_COORD_ID;
  51   }
  52
  53   /// Attribute name for y coodinate.
  54   inline static const std::string& Y_MIN_COORD_ID()
  55   {
  56     static const std::string MY_Y_MIN_COORD_ID("ymincoordinate");
  57     return MY_Y_MIN_COORD_ID;
  58   }
  59
  60   /// Attribute name for z coodinate.
  61   inline static const std::string& Z_MIN_COORD_ID()
  62   {
  63     static const std::string MY_Z_MIN_COORD_ID("zmincoordinate");
  64     return MY_Z_MIN_COORD_ID;
  65   }
  66
  67   /// Attribute name for x max coodinate.
  68   inline static const std::string& X_MAX_COORD_ID()
  69   {
  70     static const std::string MY_X_MAX_COORD_ID("xmaxcoordinate");
  71     return MY_X_MAX_COORD_ID;
  72   }
  73
  74   /// Attribute name for y max coodinate.
  75   inline static const std::string& Y_MAX_COORD_ID()
  76   {
  77     static const std::string MY_Y_MAX_COORD_ID("ymaxcoordinate");
  78     return MY_Y_MAX_COORD_ID;
  79   }
  80
  81   /// Attribute name for z max coodinate.
  82   inline static const std::string& Z_MAX_COORD_ID()
  83   {
  84     static const std::string MY_Z_MAX_COORD_ID("zmaxcoordinate");
  85     return MY_Z_MAX_COORD_ID;
  86   }
  87
  88   /// Attribute name for values of result.
  89   inline static const std::string& RESULT_VALUES_ID()
  90   {
  91     static const std::string MY_RESULT_VALUES_ID("result_values");
  92     return MY_RESULT_VALUES_ID;
  93   }
  94
  95   /// Attribute name for indicate to compute the bounding box.
  96   inline static const std::string& COMPUTE_ID()
  97   {
  98     static const std::string MY_COMPUTE_ID("compute");
  99     return MY_COMPUTE_ID;
 100   }
 101
 102   /// \return the kind of a feature.
 103   virtual const std::string& getKind()
 104   {
 105     return ID();
 106   }
 107
 108   /// Performs the algorithm and stores results it in the data structure.
 109   FEATURESPLUGIN_EXPORT virtual void execute();
 110
 111   /// Request for initialization of data model of the feature: adding all attributes
 112   FEATURESPLUGIN_EXPORT virtual void initAttributes();
 113
 114   /// Called on change of any argument-attribute of this object
 115   /// \param theID identifier of changed attribute
 116   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 117
 118   /// Return Attribut values of result.
 119   FEATURESPLUGIN_EXPORT virtual AttributePtr attributResultValues();
 120
 121   /// Use plugin manager for features creation
 122   FeaturesPlugin_BoundingBox();
 123
 124 private:
 125   /// Update values displayed.
 126   bool updateValues();
 127
 128 };
 129
 130 #endif