1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_
22 #define SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_
24 //--------------------------------------------------------------------------------------
25 #include "SketchAPI.h"
27 #include <SketchPlugin_Projection.h>
29 #include "SketchAPI_SketchEntity.h"
30 //--------------------------------------------------------------------------------------
31 class ModelHighAPI_Selection;
32 //--------------------------------------------------------------------------------------
33 /**\class SketchAPI_Projection
35 * \brief Interface for Projection feature
37 class SketchAPI_Projection : public SketchAPI_SketchEntity
40 /// Constructor without values
42 explicit SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature);
43 /// Constructor with values
45 SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature,
46 const ModelHighAPI_Selection & theExternalFeature);
47 /// Constructor with values
49 SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature,
50 const std::string & theExternalName);
53 virtual ~SketchAPI_Projection();
55 INTERFACE_4(SketchPlugin_Projection::ID(),
56 externalFeature, SketchPlugin_Projection::EXTERNAL_FEATURE_ID(),
57 ModelAPI_AttributeSelection, /** External feature */,
58 projectedFeature, SketchPlugin_Projection::PROJECTED_FEATURE_ID(),
59 ModelAPI_AttributeRefAttr, /** Projected feature */,
60 external, SketchPlugin_Projection::EXTERNAL_ID(),
61 ModelAPI_AttributeSelection, /** External */,
62 includeToResult, SketchPlugin_Projection::INCLUDE_INTO_RESULT(),
63 ModelAPI_AttributeBoolean, /** Include into result */
66 /// Set external feature
68 void setExternalFeature(const ModelHighAPI_Selection & theExternalLine);
70 /// Set by external name
72 void setByExternalName(const std::string & theExternalName);
74 /// Set flag to include projection to result or not
76 void setIncludeToResult(bool theKeepResult);
78 /// Returns created feature
80 std::shared_ptr<SketchAPI_SketchEntity> createdFeature() const;
82 /// Dump wrapped feature
84 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
87 //! Pointer on Projection object
88 typedef std::shared_ptr<SketchAPI_Projection> ProjectionPtr;
90 //--------------------------------------------------------------------------------------
91 //--------------------------------------------------------------------------------------
92 #endif /* SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_ */