src/FeaturesAPI/FeaturesAPI_Symmetry.h

   1 // Copyright (C) 2014-2019  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 FEATURESAPI_SYMMETRY_H_
  21 #define FEATURESAPI_SYMMETRY_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_Symmetry.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Double;
  31 class ModelHighAPI_Dumper;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_Symmetry
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Symmetry feature.
  37 class FeaturesAPI_Symmetry: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                                 const std::list<ModelHighAPI_Selection>& theMainObjects,
  48                                 const ModelHighAPI_Selection& theObject,
  49                                 bool theKeepOriginal = true);
  50
  51   /// Destructor.
  52   FEATURESAPI_EXPORT
  53   virtual ~FeaturesAPI_Symmetry();
  54
  55   INTERFACE_6(FeaturesPlugin_Symmetry::ID(),
  56               creationMethod, FeaturesPlugin_Symmetry::CREATION_METHOD(),
  57               ModelAPI_AttributeString, /** Creation method */,
  58               mainObjects, FeaturesPlugin_Symmetry::OBJECTS_LIST_ID(),
  59               ModelAPI_AttributeSelectionList, /** Main objects */,
  60               pointObject, FeaturesPlugin_Symmetry::POINT_OBJECT_ID(),
  61               ModelAPI_AttributeSelection, /** Point object */,
  62               axisObject, FeaturesPlugin_Symmetry::AXIS_OBJECT_ID(),
  63               ModelAPI_AttributeSelection, /** Axis object */,
  64               planeObject, FeaturesPlugin_Symmetry::PLANE_OBJECT_ID(),
  65               ModelAPI_AttributeSelection, /** Plane object */,
  66               keepOriginal, FeaturesPlugin_Symmetry::KEEP_ORIGINAL_RESULT(),
  67               ModelAPI_AttributeBoolean, /** Keep original shape */)
  68
  69   /// Set main objects.
  70   FEATURESAPI_EXPORT
  71   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  72
  73   /// Modify CreationMethod, point_object attribute of the feature.
  74   FEATURESAPI_EXPORT
  75   void setPoint(const ModelHighAPI_Selection& thePointObject);
  76
  77   /// Modify CreationMethod, axis_object attribute of the feature.
  78   FEATURESAPI_EXPORT
  79   void setAxis(const ModelHighAPI_Selection& theAxisObject);
  80
  81   /// Modify CreationMethod, plane_object attribute of the feature.
  82   FEATURESAPI_EXPORT
  83   void setPlane(const ModelHighAPI_Selection& thePlaneObject);
  84
  85   /// Dump wrapped feature
  86   FEATURESAPI_EXPORT
  87   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  88 };
  89
  90 /// Pointer on Symmetry object.
  91 typedef std::shared_ptr<FeaturesAPI_Symmetry> SymmetryPtr;
  92
  93 /// \ingroup CPPHighAPI
  94 /// \brief Create Symmetry feature.
  95 FEATURESAPI_EXPORT
  96 SymmetryPtr addSymmetry(const std::shared_ptr<ModelAPI_Document>& thePart,
  97                         const std::list<ModelHighAPI_Selection>& theMainObjects,
  98                         const ModelHighAPI_Selection& theObject,
  99                         bool theKeepOriginal = true);
 100
 101 #endif // FEATURESAPI_SYMMETRY_H_