SHAPER 9.16.0
SketchPlugin_ConstraintLength.h
1// Copyright (C) 2014-2026 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_ConstraintLength_H_
21#define SketchPlugin_ConstraintLength_H_
22
23#include "SketchPlugin.h"
24#include "SketchPlugin_ConstraintBase.h"
25#include "SketchPlugin_Sketch.h"
26
27#include <GeomAPI_ICustomPrs.h>
28
29#include <list>
30
31class GeomAPI_Pnt2d;
33
43{
44 public:
46 inline static const std::string& ID()
47 {
48 static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength");
49 return MY_CONSTRAINT_LENGTH_ID;
50 }
51
53 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
54 {
55 static std::string MY_KIND = SketchPlugin_ConstraintLength::ID();
56 return MY_KIND;
57 }
58
60 inline static const std::string& LOCATION_TYPE_ID()
61 {
62 static const std::string MY_LOCATION_TYPE_ID("LocationType");
63 return MY_LOCATION_TYPE_ID;
64 }
65
67 SKETCHPLUGIN_EXPORT virtual void execute();
68
72 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
73
75 SKETCHPLUGIN_EXPORT virtual void initAttributes();
76
78 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
79 std::string& theDefault);
80
82 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
83
86 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
87
90
94 bool computeLenghtValue(double& theValue);
95
97 inline bool isZeroValueAllowed() override
98 {
99 return false;
100 }
101
102private:
104 bool getPoints(
105 std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
106 std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,
107 std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint);
108
109private:
110 bool myFlyoutUpdate;
111};
112
113#endif
2D point defined by two coordinates
Definition: GeomAPI_Pnt2d.h:36
Attribute that contains 2D point coordinates.
Definition: GeomDataAPI_Point2D.h:37
Feature for creation of a new constraint between other features.
Definition: SketchPlugin_ConstraintBase.h:56
Feature for creation of a new constraint which defines a length of a line segment.
Definition: SketchPlugin_ConstraintLength.h:43
static const std::string & LOCATION_TYPE_ID()
attribute name of dimension location type
Definition: SketchPlugin_ConstraintLength.h:60
bool computeLenghtValue(double &theValue)
Computes distance between length point attributes.
Definition: SketchPlugin_ConstraintLength.cpp:129
virtual void execute()
Creates a new part document if needed.
Definition: SketchPlugin_ConstraintLength.cpp:78
virtual void colorConfigInfo(std::string &theSection, std::string &theName, std::string &theDefault)
Returns the parameters of color definition in the resources config manager.
Definition: SketchPlugin_ConstraintLength.cpp:70
static const std::string & ID()
Length constraint kind.
Definition: SketchPlugin_ConstraintLength.h:46
bool isZeroValueAllowed() override
Get if a constraint is able to have a zero numeric value.
Definition: SketchPlugin_ConstraintLength.h:97
virtual void attributeChanged(const std::string &theID)
Called on change of any argument-attribute of this object.
Definition: SketchPlugin_ConstraintLength.cpp:177
SketchPlugin_ConstraintLength()
Use plugin manager for features creation.
Definition: SketchPlugin_ConstraintLength.cpp:49
virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious)
Returns the AIS preview.
Definition: SketchPlugin_ConstraintLength.cpp:165
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: SketchPlugin_ConstraintLength.cpp:54
virtual bool compute(const std::string &theAttributeId)
Computes the attribute value on the base of other attributes if the value can be computed.
Definition: SketchPlugin_ConstraintLength.cpp:104
virtual const std::string & getKind()
Returns the kind of a feature.
Definition: SketchPlugin_ConstraintLength.h:53