src/FeaturesPlugin/FeaturesPlugin_Placement.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        FeaturesPlugin_Placement.h
   4 // Created:     2 Dec 2014
   5 // Author:      Artem ZHIDKOV
   6
   7 #ifndef FeaturesPlugin_Placement_H_
   8 #define FeaturesPlugin_Placement_H_
   9
  10 #include "FeaturesPlugin.h"
  11 #include <ModelAPI_Feature.h>
  12 #include <GeomAlgoAPI_Placement.h>
  13
  14 class ModelAPI_ResultBody;
  15 class GeomAPI_Shape;
  16
  17 /**\class FeaturesPlugin_Placement
  18  * \ingroup Plugins
  19  * \brief Feature for applying of placement operation: relative movement of Solid.
  20  *
  21  * Locates the selected placement_attractable_object (face, edge, vertex) of the solid into
  22  * the selected placement_base_object. Faces must be planar, edges must be linear.
  23  * Orientation of the placed solid depends on the underlied planes of both faces.
  24  */
  25 class FeaturesPlugin_Placement : public ModelAPI_Feature
  26 {
  27  public:
  28   /// Placement kind
  29   inline static const std::string& ID()
  30   {
  31     static const std::string MY_PLACEMENT_ID("Placement");
  32     return MY_PLACEMENT_ID;
  33   }
  34   /// attribute name of referenced object
  35   inline static const std::string& BASE_OBJECT_ID()
  36   {
  37     static const std::string MY_BASE_OBJECT_ID("placement_base_object");
  38     return MY_BASE_OBJECT_ID;
  39   }
  40   /// attribute name of attractable face
  41   inline static const std::string& ATTRACT_OBJECT_ID()
  42   {
  43     static const std::string MY_ATTRACT_OBJECT_ID("placement_attractable_object");
  44     return MY_ATTRACT_OBJECT_ID;
  45   }
  46   /// attribute name of flag of reverse direction
  47   inline static const std::string& REVERSE_ID()
  48   {
  49     static const std::string MY_REVERSE_ID("placement_reverse_direction");
  50     return MY_REVERSE_ID;
  51   }
  52   /// attribute name of flag of centering position
  53   inline static const std::string& CENTERING_ID()
  54   {
  55     static const std::string MY_CENTERING_ID("placement_centering");
  56     return MY_CENTERING_ID;
  57   }
  58
  59   /// Returns the kind of a feature
  60   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  61   {
  62     static std::string MY_KIND = FeaturesPlugin_Placement::ID();
  63     return MY_KIND;
  64   }
  65
  66   /// Creates a new part document if needed
  67   FEATURESPLUGIN_EXPORT virtual void execute();
  68
  69   /// Request for initialization of data model of the feature: adding all attributes
  70   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  71
  72   /// Use plugin manager for features creation
  73   FeaturesPlugin_Placement();
  74 private:
  75   /// Load Naming data structure of the feature to the document
  76   void LoadNamingDS(GeomAlgoAPI_Placement& theFeature,
  77                     std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  78                     std::shared_ptr<GeomAPI_Shape> theSlaveObject);
  79 };
  80
  81 #endif