1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
20 #ifndef SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_
21 #define SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_
23 //--------------------------------------------------------------------------------------
24 #include "SketchAPI.h"
26 #include <SketchPlugin_Projection.h>
28 #include "SketchAPI_SketchEntity.h"
29 //--------------------------------------------------------------------------------------
30 class ModelHighAPI_Selection;
31 //--------------------------------------------------------------------------------------
32 /**\class SketchAPI_Projection
34 * \brief Interface for Projection feature
36 class SketchAPI_Projection : public SketchAPI_SketchEntity
39 /// Constructor without values
41 explicit SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature);
42 /// Constructor with values
44 SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature,
45 const ModelHighAPI_Selection & theExternalFeature);
46 /// Constructor with values
48 SketchAPI_Projection(const std::shared_ptr<ModelAPI_Feature> & theFeature,
49 const std::string & theExternalName);
52 virtual ~SketchAPI_Projection();
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 */
65 /// Set external feature
67 void setExternalFeature(const ModelHighAPI_Selection & theExternalLine);
69 /// Set by external name
71 void setByExternalName(const std::string & theExternalName);
73 /// Set flag to include projection to result or not
75 void setIncludeToResult(bool theKeepResult);
77 /// Returns created feature
79 std::shared_ptr<SketchAPI_SketchEntity> createdFeature() const;
81 /// Dump wrapped feature
83 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
86 //! Pointer on Projection object
87 typedef std::shared_ptr<SketchAPI_Projection> ProjectionPtr;
89 //--------------------------------------------------------------------------------------
90 //--------------------------------------------------------------------------------------
91 #endif /* SRC_SKETCHAPI_SKETCHAPI_PROJECTION_H_ */