src/SketchAPI/SketchAPI_Projection.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 SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_
  21 #define SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_
  22
  23 //--------------------------------------------------------------------------------------
  24 #include "SketchAPI.h"
  25
  26 #include <SketchPlugin_Projection.h>
  27
  28 #include "SketchAPI_SketchEntity.h"
  29 //--------------------------------------------------------------------------------------
  30 class ModelHighAPI_Selection;
  31 //--------------------------------------------------------------------------------------
  32 /**\class SketchAPI_Projection
  33  * \ingroup CPPHighAPI
  34  * \brief Interface for Projection feature
  35  */
  36 class SketchAPI_Projection : public SketchAPI_SketchEntity
  37 {
  38 public:
  39   /// Constructor without values
  40   SKETCHAPI_EXPORT
  41   explicit SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  42   /// Constructor with values
  43   SKETCHAPI_EXPORT
  44   SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  45                        const ModelHighAPI_Selection & theExternalFeature);
  46   /// Constructor with values
  47   SKETCHAPI_EXPORT
  48   SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  49                        const std::string & theExternalName);
  50   /// Destructor
  51   SKETCHAPI_EXPORT
  52   virtual ~SketchAPI_Projection();
  53
  54   INTERFACE_4(SketchPlugin_Projection::ID(),
  55               externalFeature, SketchPlugin_Projection::EXTERNAL_FEATURE_ID(),
  56               ModelAPI_AttributeSelection, /** External feature */,
  57               projectedFeature, SketchPlugin_Projection::PROJECTED_FEATURE_ID(),
  58               ModelAPI_AttributeRefAttr, /** Projected feature */,
  59               external, SketchPlugin_Projection::EXTERNAL_ID(),
  60               ModelAPI_AttributeSelection, /** External */,
  61               includeToResult, SketchPlugin_Projection::INCLUDE_INTO_RESULT(),
  62               ModelAPI_AttributeBoolean, /** Include into result */
  63   )
  64
  65   /// Set external feature
  66   SKETCHAPI_EXPORT
  67   void setExternalFeature(const ModelHighAPI_Selection & theExternalLine);
  68
  69   /// Set by external name
  70   SKETCHAPI_EXPORT
  71   void setByExternalName(const std::string & theExternalName);
  72
  73   /// Set flag to include projection to result or not
  74   SKETCHAPI_EXPORT
  75   void setIncludeToResult(bool theKeepResult);
  76
  77   /// Returns created feature
  78   SKETCHAPI_EXPORT
  79   std::shared_ptr<SketchAPI_SketchEntity> createdFeature() const;
  80
  81   /// Dump wrapped feature
  82   SKETCHAPI_EXPORT
  83   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  84 };
  85
  86 //! Pointer on Projection object
  87 typedef std::shared_ptr<SketchAPI_Projection> ProjectionPtr;
  88
  89 //--------------------------------------------------------------------------------------
  90 //--------------------------------------------------------------------------------------
  91 #endif /* SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_ */