SHAPER  9.12.0
SketchPlugin_Line.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 SketchPlugin_Line_H_
21 #define SketchPlugin_Line_H_
22 
23 #include <ModelAPI_IReentrant.h>
24 
25 #include "SketchPlugin.h"
26 #include <SketchPlugin_SketchEntity.h>
27 #include <SketchPlugin_Sketch.h>
28 #include <list>
29 
30 class GeomAPI_Pnt2d;
31 
37  public ModelAPI_IReentrant
38 {
39  public:
41  inline static const std::string& ID()
42  {
43  static const std::string SKETCH_LINE_ID("SketchLine");
44  return SKETCH_LINE_ID;
45  }
47  inline static const std::string& START_ID()
48  {
49  static const std::string MY_START_ID("StartPoint");
50  return MY_START_ID;
51  }
53  inline static const std::string& END_ID()
54  {
55  static const std::string MY_END_ID("EndPoint");
56  return MY_END_ID;
57  }
58 
60  static const std::string& LENGTH_ID()
61  {
62  static const std::string MY_LENGTH("LineLength");
63  return MY_LENGTH;
64  }
65 
67  SKETCHPLUGIN_EXPORT virtual const std::string& getKind();
68 
70  SKETCHPLUGIN_EXPORT virtual bool isFixed();
71 
73  virtual void initAttributes();
74 
76  SKETCHPLUGIN_EXPORT virtual void execute();
77 
81  virtual std::string processEvent(const std::shared_ptr<Events_Message>& theMessage);
82 
84  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
85 
88 
89 private:
91  void updateLenghtValue();
92 
93 protected:
95  virtual void initDerivedClassAttributes();
96 };
97 
98 #endif
2D point defined by two coordinates
Definition: GeomAPI_Pnt2d.h:36
Interface of a class which can process specific messages.
Definition: ModelAPI_IReentrant.h:35
Feature for creation of the new part in PartSet.
Definition: SketchPlugin_Line.h:38
static const std::string & ID()
Arc feature kind.
Definition: SketchPlugin_Line.h:41
virtual const std::string & getKind()
Returns the kind of a feature.
Definition: SketchPlugin_Line.cpp:107
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: SketchPlugin_Line.cpp:44
virtual bool isFixed()
Returns true is sketch element is under the rigid constraint.
Definition: SketchPlugin_Line.cpp:113
static const std::string & END_ID()
End 2D point of the line.
Definition: SketchPlugin_Line.h:53
virtual std::string processEvent(const std::shared_ptr< Events_Message > &theMessage)
Apply information of the message to current object.
Definition: SketchPlugin_Line.cpp:84
virtual void execute()
Creates a new part document if needed.
Definition: SketchPlugin_Line.cpp:60
static const std::string & LENGTH_ID()
Line length.
Definition: SketchPlugin_Line.h:60
virtual void attributeChanged(const std::string &theID)
Called on change of any argument-attribute of this object.
Definition: SketchPlugin_Line.cpp:117
static const std::string & START_ID()
Start 2D point of the line.
Definition: SketchPlugin_Line.h:47
virtual void initDerivedClassAttributes()
Initializes attributes of derived class.
Definition: SketchPlugin_Line.cpp:52
SketchPlugin_Line()
Use plugin manager for features creation.
Definition: SketchPlugin_Line.cpp:40
Sketch Entity for creation of the new feature in PartSet.
Definition: SketchPlugin_SketchEntity.h:45