SHAPER  9.12.0
SketchAPI_Constraint.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 SRC_SKETCHAPI_SKETCHAPI_CONSTRAINT_H_
21 #define SRC_SKETCHAPI_SKETCHAPI_CONSTRAINT_H_
22 
23 #include "SketchAPI.h"
24 
25 #include <ModelHighAPI_Interface.h>
26 #include <ModelHighAPI_Macro.h>
27 #include <ModelHighAPI_RefAttr.h>
28 
29 #include <SketchPlugin_Constraint.h>
30 
33 
39 {
40 public:
42  SKETCHAPI_EXPORT
43  explicit SketchAPI_Constraint(const std::shared_ptr<ModelAPI_Feature> & theFeature);
44 
46  SKETCHAPI_EXPORT
47  virtual ~SketchAPI_Constraint();
48 
49  static std::string ID()
50  {
51  static const std::string MY_SKETCH_CONSTRAINT_ID = "SketchConstraint";
52  return MY_SKETCH_CONSTRAINT_ID;
53  }
54  virtual std::string getID() { return ID(); }
55 
56  SKETCHAPI_EXPORT
57  bool initialize();
58 
59  SKETCHAPI_EXPORT void setEntityA(const ModelHighAPI_RefAttr& theEntity);
60  SKETCHAPI_EXPORT void setEntityB(const ModelHighAPI_RefAttr& theEntity);
61  SKETCHAPI_EXPORT void setEntityC(const ModelHighAPI_RefAttr& theEntity);
62  SKETCHAPI_EXPORT void setEntityD(const ModelHighAPI_RefAttr& theEntity);
63 
64  SKETCHAPI_EXPORT void setValue(const ModelHighAPI_Double& theValue);
65 
66  SKETCHAPI_EXPORT double value() const;
67 
69  SKETCHAPI_EXPORT
70  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
71 
72 protected:
73  // Check all attributes of constraint are already dumped.
74  // If not, store the constraint as postponed.
75  bool areAllAttributesDumped(ModelHighAPI_Dumper& theDumper) const;
76 };
77 
78 #endif
Class for filling ModelAPI_AttributeDouble.
Definition: ModelHighAPI_Double.h:37
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeRefAttr.
Definition: ModelHighAPI_RefAttr.h:41
Interface for Constraint feature.
Definition: SketchAPI_Constraint.h:39
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: SketchAPI_Constraint.cpp:185
SketchAPI_Constraint(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: SketchAPI_Constraint.cpp:50
virtual ~SketchAPI_Constraint()
Destructor.
Definition: SketchAPI_Constraint.cpp:59
Base class for Sketch feature interfaces.
Definition: SketchAPI_SketchEntity.h:38