src/PrimitivesPlugin/PrimitivesPlugin_Box.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 PrimitivesPlugin_Box_H_
  21 #define PrimitivesPlugin_Box_H_
  22
  23 #include <PrimitivesPlugin.h>
  24 #include <ModelAPI_Feature.h>
  25 #include <GeomAlgoAPI_Box.h>
  26
  27 class GeomAPI_Shape;
  28 class ModelAPI_ResultBody;
  29
  30 /**\class PrimitivesPlugin_Box
  31  * \ingroup Plugins
  32  * \brief Feature for creation of a box primitive using various methods.
  33  *
  34  * Box creates a cuboid - Parallelepiped with 6 rectangular faces. It can be built via three
  35  * methods : using two points that define a diagonal, a point that define a center and 3 lengths
  36  * that define the half-lengths on X, Y and Z-axes, or using 3 lengths that define the
  37  * rectangular dimensions.
  38  */
  39 class PrimitivesPlugin_Box : public ModelAPI_Feature
  40 {
  41  public:
  42   /// Box kind
  43   inline static const std::string& ID()
  44   {
  45     static const std::string MY_BOX_ID("Box");
  46     return MY_BOX_ID;
  47   }
  48
  49   /// Attribute name for creation method
  50   inline static const std::string& CREATION_METHOD()
  51   {
  52     static const std::string MY_CREATION_METHOD_ID("CreationMethod");
  53     return MY_CREATION_METHOD_ID;
  54   }
  55
  56   /// Attribute name for creation method
  57   inline static const std::string& CREATION_METHOD_BY_DIMENSIONS()
  58   {
  59     static const std::string MY_CREATION_METHOD_ID("BoxByDimensions");
  60     return MY_CREATION_METHOD_ID;
  61   }
  62
  63   /// Attribute name for creation method
  64   inline static const std::string& CREATION_METHOD_BY_TWO_POINTS()
  65   {
  66     static const std::string MY_CREATION_METHOD_ID("BoxByTwoPoints");
  67     return MY_CREATION_METHOD_ID;
  68   }
  69
  70   /// Attribute name for creation method
  71   inline static const std::string& CREATION_METHOD_BY_ONE_POINT_AND_DIMS()
  72   {
  73     static const std::string MY_CREATION_METHOD_ID("BoxByOnePointAndDims");
  74     return MY_CREATION_METHOD_ID;
  75   }
  76
  77   /// Attribute name of first point
  78   inline static const std::string& POINT_FIRST_ID()
  79   {
  80     static const std::string MY_POINT_FIRST_ID("FirstPoint");
  81     return MY_POINT_FIRST_ID;
  82   }
  83
  84   /// Attribute name of second point
  85   inline static const std::string& POINT_SECOND_ID()
  86   {
  87     static const std::string MY_POINT_SECOND_ID("SecondPoint");
  88     return MY_POINT_SECOND_ID;
  89   }
  90
  91   /// Attribute first coordinate
  92   inline static const std::string& DX_ID()
  93   {
  94     static const std::string MY_DX_ID("dx");
  95     return MY_DX_ID;
  96   }
  97
  98   /// Attribute second coordinate
  99   inline static const std::string& DY_ID()
 100   {
 101     static const std::string MY_DY_ID("dy");
 102     return MY_DY_ID;
 103   }
 104
 105   /// Attribute third coordinate
 106   inline static const std::string& DZ_ID()
 107   {
 108     static const std::string MY_DZ_ID("dz");
 109     return MY_DZ_ID;
 110   }
 111
 112   /// Attribute name of the first coordinate of the center
 113   inline static const std::string& OX_ID()
 114   {
 115     static const std::string MY_OX_ID("ox");
 116     return MY_OX_ID;
 117   }
 118
 119   /// Attribute name of the second coordinate of the center
 120   inline static const std::string& OY_ID()
 121   {
 122     static const std::string MY_OY_ID("oy");
 123     return MY_OY_ID;
 124   }
 125
 126   /// Attribute name of the third coordinate of the center
 127   inline static const std::string& OZ_ID()
 128   {
 129     static const std::string MY_OZ_ID("oz");
 130     return MY_OZ_ID;
 131   }
 132
 133   /// Attribute name of the half-length on X axis
 134   inline static const std::string& HALF_DX_ID()
 135   {
 136     static const std::string MY_HALF_DX_ID("half_dx");
 137     return MY_HALF_DX_ID;
 138   }
 139
 140   /// Attribute name of the half-length on Y axis
 141   inline static const std::string& HALF_DY_ID()
 142   {
 143     static const std::string MY_HALF_DY_ID("half_dy");
 144     return MY_HALF_DY_ID;
 145   }
 146
 147   /// Attribute name of the half-length on Z axis
 148   inline static const std::string& HALF_DZ_ID()
 149   {
 150     static const std::string MY_HALF_DZ_ID("half_dz");
 151     return MY_HALF_DZ_ID;
 152   }
 153
 154   /// Returns the kind of a feature
 155   PRIMITIVESPLUGIN_EXPORT virtual const std::string& getKind()
 156   {
 157     static std::string MY_KIND = PrimitivesPlugin_Box::ID();
 158     return MY_KIND;
 159   }
 160
 161   /// Creates a new part document if needed
 162   PRIMITIVESPLUGIN_EXPORT virtual void execute();
 163
 164   /// Request for initialization of data model of the feature: adding all attributes
 165   PRIMITIVESPLUGIN_EXPORT virtual void initAttributes();
 166
 167   /// Use plugin manager for features creation
 168   PrimitivesPlugin_Box();
 169
 170  private:
 171   /// Load Naming data structure of the feature to the document
 172   void loadNamingDS(std::shared_ptr<GeomAlgoAPI_Box> theBoxAlgo,
 173                     std::shared_ptr<ModelAPI_ResultBody> theResultBox);
 174
 175   ///Perform the creation of the box using two points defining a diagonal
 176   void createBoxByTwoPoints();
 177
 178   ///Perform the creation of the box using three cordinates
 179   void createBoxByDimensions();
 180
 181   ///Perform the creation of the box using a center and three half-lenths
 182   void createBoxByOnePointAndDims();
 183
 184 };
 185
 186
 187 #endif