src/FeaturesAPI/FeaturesAPI_Placement.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef FeaturesAPI_Placement_H_
  22 #define FeaturesAPI_Placement_H_
  23
  24 #include "FeaturesAPI.h"
  25
  26 #include <FeaturesPlugin_Placement.h>
  27
  28 #include <ModelHighAPI_Interface.h>
  29 #include <ModelHighAPI_Macro.h>
  30
  31 class ModelHighAPI_Dumper;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_Placement
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Placement feature.
  37 class FeaturesAPI_Placement: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_Placement(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   FeaturesAPI_Placement(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                         const std::list<ModelHighAPI_Selection>& theObjects,
  48                         const ModelHighAPI_Selection& theStartShape,
  49                         const ModelHighAPI_Selection& theEndShape,
  50                         const bool theReverseDirection = false,
  51                         const bool theCentering = false);
  52
  53   /// Destructor.
  54   FEATURESAPI_EXPORT
  55   virtual ~FeaturesAPI_Placement();
  56
  57   INTERFACE_5(FeaturesPlugin_Placement::ID(),
  58               objects, FeaturesPlugin_Placement::OBJECTS_LIST_ID(),
  59               ModelAPI_AttributeSelectionList, /** Main objects */,
  60               startShape, FeaturesPlugin_Placement::START_SHAPE_ID(),
  61               ModelAPI_AttributeSelection, /** Start shape */,
  62               endShape, FeaturesPlugin_Placement::END_SHAPE_ID(),
  63               ModelAPI_AttributeSelection, /** End shape */,
  64               reverseDirection, FeaturesPlugin_Placement::REVERSE_ID(),
  65               ModelAPI_AttributeBoolean, /** Reverse direction flag */,
  66               centering, FeaturesPlugin_Placement::CENTERING_ID(),
  67               ModelAPI_AttributeBoolean, /** Centering flag */)
  68
  69   /// Set objects.
  70   FEATURESAPI_EXPORT
  71   void setObjects(const std::list<ModelHighAPI_Selection>& theObjects);
  72
  73   /// Set start shape.
  74   FEATURESAPI_EXPORT
  75   void setStartShape(const ModelHighAPI_Selection& theStartShape);
  76
  77   /// Set end shape.
  78   FEATURESAPI_EXPORT
  79   void setEndShape(const ModelHighAPI_Selection& theEndShape);
  80
  81   /// Set reverse direction flag.
  82   FEATURESAPI_EXPORT
  83   void setReverseDirection(const bool theReverseDirection);
  84
  85   /// Set centering flag.
  86   FEATURESAPI_EXPORT
  87   void setCentering(const bool theCentering);
  88
  89   /// Dump wrapped feature
  90   FEATURESAPI_EXPORT
  91   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  92 };
  93
  94 /// Pointer on Placement object.
  95 typedef std::shared_ptr<FeaturesAPI_Placement> PlacementPtr;
  96
  97 /// \ingroup CPPHighAPI
  98 /// \brief Create Placement feature.
  99 FEATURESAPI_EXPORT
 100 PlacementPtr addPlacement(const std::shared_ptr<ModelAPI_Document>& thePart,
 101                           const std::list<ModelHighAPI_Selection>& theObjects,
 102                           const ModelHighAPI_Selection& theStartShape,
 103                           const ModelHighAPI_Selection& theEndShape,
 104                           const bool theReverseDirection = false,
 105                           const bool theCentering = false);
 106
 107 #endif // FeaturesAPI_Placement_H_