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 SketchPlugin_Line_H_
21 #define SketchPlugin_Line_H_
23 #include <ModelAPI_IReentrant.h>
25 #include "SketchPlugin.h"
26 #include <SketchPlugin_SketchEntity.h>
27 #include <SketchPlugin_Sketch.h>
32 /**\class SketchPlugin_Line
34 * \brief Feature for creation of the new part in PartSet.
36 class SketchPlugin_Line : public SketchPlugin_SketchEntity,
37 public ModelAPI_IReentrant
41 inline static const std::string& ID()
43 static const std::string SKETCH_LINE_ID("SketchLine");
44 return SKETCH_LINE_ID;
46 /// Start 2D point of the line
47 inline static const std::string& START_ID()
49 static const std::string MY_START_ID("StartPoint");
52 /// End 2D point of the line
53 inline static const std::string& END_ID()
55 static const std::string MY_END_ID("EndPoint");
60 static const std::string& LENGTH_ID()
62 static const std::string MY_LENGTH("LineLength");
66 /// Reference to the parent feature
67 inline static const std::string& PARENT_ID()
69 static const std::string& MY_PARENT_ID("ParentFeature");
73 /// Returns the kind of a feature
74 SKETCHPLUGIN_EXPORT virtual const std::string& getKind();
76 /// Returns true is sketch element is under the rigid constraint
77 SKETCHPLUGIN_EXPORT virtual bool isFixed();
79 /// Request for initialization of data model of the feature: adding all attributes
80 virtual void initAttributes();
82 /// Creates a new part document if needed
83 SKETCHPLUGIN_EXPORT virtual void execute();
85 /// Apply information of the message to current object. It fills start attribute of
86 /// the current feature by last attribute of the message feature, build coincidence
87 /// if message has selected object
88 virtual std::string processEvent(const std::shared_ptr<Events_Message>& theMessage);
90 /// Return the distance between the feature and the point
91 /// \param thePoint the point
92 double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
94 /// Called on change of any argument-attribute of this object
95 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
97 /// Use plugin manager for features creation
101 /// Calculates the length of the line and fill the length attribute with the value
102 void updateLenghtValue();
105 /// \brief Initializes attributes of derived class.
106 virtual void initDerivedClassAttributes();