1 // File: SketchPlugin_Constraint.h
2 // Created: 08 May 2014
3 // Author: Artem ZHIDKOV
5 #ifndef SketchPlugin_Constraint_HeaderFile
6 #define SketchPlugin_Constraint_HeaderFile
8 #include "SketchPlugin.h"
9 #include "SketchPlugin_Feature.h"
10 #include <SketchPlugin_Sketch.h>
11 #include <ModelAPI_AttributeReference.h>
12 #include <ModelAPI_AttributeRefAttr.h>
16 * Each constraint uses a set of parameters. In the SolveSpace library
17 * these parameters are named "valA", "ptA", "ptB", "entityA", "entityB".
18 * The "ptA" and "ptB" parameters represents a point in the constraint.
19 * The "entityA" and "entityB" represents any other object (and a point too).
20 * And the "valA" represents a real value.
22 * The attributes below are named independent of the SolveSpace.
23 * Some of them may be unused.
25 * Also the list of possible attributes is provided to simplify assignment.
27 /// The value parameter for the constraint
28 const std::string CONSTRAINT_ATTR_VALUE("ConstraintValue");
29 /// The value parameter for the constraint
30 const std::string CONSTRAINT_ATTR_FLYOUT_VALUE("ConstraintFlyoutValue");
31 /// First entity for the constraint
32 const std::string CONSTRAINT_ATTR_ENTITY_A("ConstraintEntityA");
33 /// Second entity for the constraint
34 const std::string CONSTRAINT_ATTR_ENTITY_B("ConstraintEntityB");
35 /// Third entity for the constraint
36 const std::string CONSTRAINT_ATTR_ENTITY_C("ConstraintEntityC");
37 /// Fourth entity for the constraint
38 const std::string CONSTRAINT_ATTR_ENTITY_D("ConstraintEntityD");
39 /// List of constraint attributes
40 const unsigned int CONSTRAINT_ATTR_SIZE = 4;
41 const std::string CONSTRAINT_ATTRIBUTES[CONSTRAINT_ATTR_SIZE] =
42 {CONSTRAINT_ATTR_ENTITY_A, CONSTRAINT_ATTR_ENTITY_B,
43 CONSTRAINT_ATTR_ENTITY_C, CONSTRAINT_ATTR_ENTITY_D};
46 /** \class SketchPlugin_Constraint
48 * \brief Feature for creation of a new constraint between other features.
49 * Base class for all constraints.
51 class SketchPlugin_Constraint: public SketchPlugin_Feature
54 /// \brief Returns to which group in the document must be added feature
55 SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
56 {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;}
58 /** \brief Adds sub-feature of the higher level feature (sub-element of the sketch)
59 * \param theFeature sub-feature
61 SKETCHPLUGIN_EXPORT virtual const void addSub(
62 const FeaturePtr& theFeature) {}
65 /// \brief Use plugin manager for features creation
66 SketchPlugin_Constraint() {}