1 // Copyright (C) 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 // File: SketchPlugin_ConstraintDistanceAlongDir.h
22 // Created: 24 October 2017
23 // Author: Artem ZHIDKOV
25 #ifndef SketchPlugin_ConstraintDistanceAlongDir_H_
26 #define SketchPlugin_ConstraintDistanceAlongDir_H_
28 #include <SketchPlugin.h>
29 #include <SketchPlugin_ConstraintDistance.h>
31 /** \class SketchPlugin_ConstraintDistanceAlongDir
33 * \brief Feature for creation of a new constraint which defines a distance along direction.
34 * The base class for horizontal and vertical constraints.
36 * This constraint has three attributes:
37 * SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
39 class SketchPlugin_ConstraintDistanceAlongDir : public SketchPlugin_ConstraintDistance
42 /// attribute name of dimension location type
43 inline static const std::string& LOCATION_TYPE_ID()
45 static const std::string MY_LOCATION_TYPE_ID("LocationType");
46 return MY_LOCATION_TYPE_ID;
49 /// attribute name of the distance value shown to the user
50 inline static const std::string& DISTANCE_VALUE_ID()
52 static const std::string& MY_DISTANCE_VALUE("DistanceValue");
53 return MY_DISTANCE_VALUE;
56 /// attribute name of the sign of distance
57 inline static const std::string& NEGATIVE_TYPE_ID()
59 static const std::string MY_NEGATIVE_VALUE("NegativeValue");
60 return MY_NEGATIVE_VALUE;
63 /// \brief Creates a new part document if needed
64 SKETCHPLUGIN_EXPORT virtual void execute();
66 /// \brief Request for initialization of data model of the feature: adding all attributes
67 SKETCHPLUGIN_EXPORT virtual void initAttributes();
69 /// Returns the AIS preview
70 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
72 /// Called on change of any argument-attribute of this object
73 /// \param theID identifier of changed attribute
74 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
76 /// \brief Use plugin manager for features creation
77 SketchPlugin_ConstraintDistanceAlongDir();
80 /// Returns the current distance between the feature attributes
81 virtual double calculateCurrentDistance() = 0;
83 /// Update flyout point
84 virtual void updateFlyoutPoint() = 0;