]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintDistanceAlongDir.h
Salome HOME
[bos #37570] [CEA] SHAPER hdf tests are failing. Fix Sphere feature attributes order.
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintDistanceAlongDir.h
1 // Copyright (C) 2017-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 // File:    SketchPlugin_ConstraintDistanceAlongDir.h
21 // Created: 24 October 2017
22 // Author:  Artem ZHIDKOV
23
24 #ifndef SketchPlugin_ConstraintDistanceAlongDir_H_
25 #define SketchPlugin_ConstraintDistanceAlongDir_H_
26
27 #include <SketchPlugin.h>
28 #include <SketchPlugin_ConstraintDistance.h>
29
30 /** \class SketchPlugin_ConstraintDistanceAlongDir
31  *  \ingroup Plugins
32  *  \brief Feature for creation of a new constraint which defines a distance along direction.
33  *         The base class for horizontal and vertical constraints.
34  *
35  *  This constraint has three attributes:
36  *  SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
37  */
38 class SketchPlugin_ConstraintDistanceAlongDir : public SketchPlugin_ConstraintDistance
39 {
40 public:
41   /// attribute name of dimension location type
42   inline static const std::string& LOCATION_TYPE_ID()
43   {
44     static const std::string MY_LOCATION_TYPE_ID("LocationType");
45     return MY_LOCATION_TYPE_ID;
46   }
47
48   /// attribute name of the distance value shown to the user
49   inline static const std::string& DISTANCE_VALUE_ID()
50   {
51     static const std::string& MY_DISTANCE_VALUE("DistanceValue");
52     return MY_DISTANCE_VALUE;
53   }
54
55   /// attribute name of the sign of distance
56   inline static const std::string& NEGATIVE_TYPE_ID()
57   {
58     static const std::string MY_NEGATIVE_VALUE("NegativeValue");
59     return MY_NEGATIVE_VALUE;
60   }
61
62   /// \brief Creates a new part document if needed
63   SKETCHPLUGIN_EXPORT virtual void execute();
64
65   /// \brief Request for initialization of data model of the feature: adding all attributes
66   SKETCHPLUGIN_EXPORT virtual void initAttributes();
67
68   /// Returns the AIS preview
69   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
70
71   /// Called on change of any argument-attribute of this object
72   /// \param theID identifier of changed attribute
73   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
74
75   /// \brief Use plugin manager for features creation
76   SketchPlugin_ConstraintDistanceAlongDir();
77
78 protected:
79   /// Returns the current distance between the feature attributes
80   virtual double calculateCurrentDistance() = 0;
81
82   /// Update flyout point
83   virtual void updateFlyoutPoint() = 0;
84
85 protected:
86   double myValue;
87   bool myValueUpdate;
88 };
89
90 #endif