1 // Copyright (C) 2014-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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
20 #ifndef SketchPlugin_ConstraintDistance_H_
21 #define SketchPlugin_ConstraintDistance_H_
23 #include "SketchPlugin.h"
24 #include "SketchPlugin_ConstraintBase.h"
25 #include "SketchPlugin_Sketch.h"
26 #include "ModelAPI_Data.h"
28 #include <GeomAPI_ICustomPrs.h>
32 class SketchPlugin_Line;
33 class GeomDataAPI_Point2D;
35 /** \class SketchPlugin_ConstraintDistance
37 * \brief Feature for creation of a new constraint which defines a distance
38 * between a point and another feature (point, line, plane or face)
40 * This constraint has three attributes:
41 * SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
43 class SketchPlugin_ConstraintDistance : public SketchPlugin_ConstraintBase
46 /// Distance constraint kind
47 inline static const std::string& ID()
49 static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistance");
50 return MY_CONSTRAINT_DISTANCE_ID;
53 /// \brief Returns the kind of a feature
54 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
56 static std::string MY_KIND = SketchPlugin_ConstraintDistance::ID();
60 /// \brief Creates a new part document if needed
61 SKETCHPLUGIN_EXPORT virtual void execute();
63 /// \brief Request for initialization of data model of the feature: adding all attributes
64 SKETCHPLUGIN_EXPORT virtual void initAttributes();
66 /// Retuns the parameters of color definition in the resources config manager
67 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
68 std::string& theDefault);
70 /// Returns the AIS preview
71 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
74 /// \param theDeltaX the delta for X coordinate is moved
75 /// \param theDeltaY the delta for Y coordinate is moved
76 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
78 /// Called on change of any argument-attribute of this object
79 /// \param theID identifier of changed attribute
80 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
82 /// \brief Use plugin manager for features creation
83 SketchPlugin_ConstraintDistance();
86 /// Returns the current distance between the feature attributes
87 double calculateCurrentDistance();
90 bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point