src/PrimitivesAPI/PrimitivesAPI_Box.h

   1 // Copyright (C) 2014-2016 CEA/DEN, EDF R&D -->
   2
   3 // File:        PrimitivesAPI_Box.h
   4 // Created:     28 June 2016
   5 // Author:      Clarisse Genrault (CEA)
   6
   7 #ifndef PrimitivesAPI_Box_H_
   8 #define PrimitivesAPI_Box_H_
   9
  10 #include "PrimitivesAPI.h"
  11
  12 #include <PrimitivesPlugin_Box.h>
  13
  14 #include <ModelHighAPI_Interface.h>
  15 #include <ModelHighAPI_Macro.h>
  16
  17 class ModelHighAPI_Double;
  18 class ModelHighAPI_Selection;
  19
  20 /// \class PrimitivesAPI_Box
  21 /// \ingroup CPPHighAPI
  22 /// \brief Interface for primitive Box feature.
  23 class PrimitivesAPI_Box: public ModelHighAPI_Interface
  24 {
  25 public:
  26   /// Constructor without values.
  27   PRIMITIVESAPI_EXPORT
  28   explicit PrimitivesAPI_Box(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  29
  30   /// Constructor with values.
  31   PRIMITIVESAPI_EXPORT
  32   explicit PrimitivesAPI_Box(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  33                              const ModelHighAPI_Double& theDx,
  34                              const ModelHighAPI_Double& theDy,
  35                              const ModelHighAPI_Double& theDz);
  36
  37   /// Constructor with values.
  38   PRIMITIVESAPI_EXPORT
  39   explicit PrimitivesAPI_Box(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  40                              const ModelHighAPI_Selection& theFirstPoint,
  41                              const ModelHighAPI_Selection& theSecondPoint);
  42
  43   /// Destructor.
  44   PRIMITIVESAPI_EXPORT
  45   virtual ~PrimitivesAPI_Box();
  46
  47   INTERFACE_6(PrimitivesPlugin_Box::ID(),
  48              creationMethod, PrimitivesPlugin_Box::CREATION_METHOD(),
  49              ModelAPI_AttributeString, /** Creation method */,
  50              dx, PrimitivesPlugin_Box::DX_ID(),
  51              ModelAPI_AttributeDouble, /** Dimension in X */,
  52              dy, PrimitivesPlugin_Box::DY_ID(),
  53              ModelAPI_AttributeDouble, /** Dimension in Y */,
  54              dz, PrimitivesPlugin_Box::DZ_ID(),
  55              ModelAPI_AttributeDouble, /** Dimension in Z */,
  56              firstPoint, PrimitivesPlugin_Box::POINT_FIRST_ID(),
  57              ModelAPI_AttributeSelection, /** First point */,
  58              secondPoint, PrimitivesPlugin_Box::POINT_SECOND_ID(),
  59              ModelAPI_AttributeSelection, /** Second point */)
  60
  61   /// Set dimensions
  62   PRIMITIVESAPI_EXPORT
  63   void setDimensions(const ModelHighAPI_Double& theDx,
  64                      const ModelHighAPI_Double& theDy,
  65                      const ModelHighAPI_Double& theDz);
  66
  67   /// Set points
  68   PRIMITIVESAPI_EXPORT
  69   void setPoints(const ModelHighAPI_Selection& theFirstPoint,
  70                  const ModelHighAPI_Selection& theSecondPoint);
  71 };
  72
  73 /// Pointer on primitive Box object
  74 typedef std::shared_ptr<PrimitivesAPI_Box> BoxPtr;
  75
  76 /// \ingroup CPPHighAPI
  77 /// \brief Create primitive Box feature.
  78 PRIMITIVESAPI_EXPORT
  79 BoxPtr addBox(const std::shared_ptr<ModelAPI_Document>& thePart,
  80               const ModelHighAPI_Double& theDx,
  81               const ModelHighAPI_Double& theDy,
  82               const ModelHighAPI_Double& theDz);
  83
  84 /// \ingroup CPPHighAPI
  85 /// \brief Create primitive Box feature.
  86 PRIMITIVESAPI_EXPORT
  87 BoxPtr addBox(const std::shared_ptr<ModelAPI_Document>& thePart,
  88               const ModelHighAPI_Selection& theFirstPoint,
  89               const ModelHighAPI_Selection& theSecondPoint);
  90
  91 #endif // PrimitivesAPI_Box_H_