src/SketchPlugin/SketchPlugin_Constraint.h

   1 // File:    SketchPlugin_Constraint.h
   2 // Created: 08 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_Constraint_HeaderFile
   6 #define SketchPlugin_Constraint_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include "SketchPlugin_Feature.h"
  10 #include <ModelAPI_AttributeReference.h>
  11 #include <ModelAPI_AttributeRefAttr.h>
  12 #include <list>
  13
  14 /*  Description:
  15  *    Each constraint uses a set of parameters. In the SolveSpace library
  16  *    these parameters are named "valA", "ptA", "ptB", "entityA", "entityB".
  17  *    The "ptA" and "ptB" parameters represents a point in the constraint.
  18  *    The "entityA" and "entityB" represents any other object (and a point too).
  19  *    And the "valA" represents a real value.
  20  *
  21  *    The attributes below are named independent of the SolveSpace.
  22  *    Some of them may be unused.
  23  *
  24  *    Also the list of possible attributes is provided to simplify assignment.
  25  */
  26 /// The value parameter for the constraint
  27 const std::string CONSTRAINT_ATTR_VALUE("ConstraintValue");
  28 /// First entity for the constraint
  29 const std::string CONSTRAINT_ATTR_ENTITY_A("ConstraintEntityA");
  30 /// Second entity for the constraint
  31 const std::string CONSTRAINT_ATTR_ENTITY_B("ConstraintEntityB");
  32 /// Third entity for the constraint
  33 const std::string CONSTRAINT_ATTR_ENTITY_C("ConstraintEntityC");
  34 /// Fourth entity for the constraint
  35 const std::string CONSTRAINT_ATTR_ENTITY_D("ConstraintEntityD");
  36 /// List of constraint attributes
  37 const std::string CONSTRAINT_ATTRIBUTES[4] =
  38                       {CONSTRAINT_ATTR_ENTITY_A, CONSTRAINT_ATTR_ENTITY_B,
  39                        CONSTRAINT_ATTR_ENTITY_C, CONSTRAINT_ATTR_ENTITY_D};
  40
  41
  42 /** \class SketchPlugin_Constraint
  43  *  \ingroup DataModel
  44  *  \brief Feature for creation of a new constraint between other features.
  45  *         Base class for all constraints.
  46  */
  47 class SketchPlugin_Constraint: public SketchPlugin_Feature
  48 {
  49 public:
  50   /// \brief Returns the kind of a feature
  51   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  52   {static std::string MY_KIND = "SketchConstraint"; return MY_KIND;}
  53
  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"; return MY_GROUP;}
  57
  58   /** \brief Adds sub-feature of the higher level feature (sub-element of the sketch)
  59    *  \param theFeature sub-feature
  60    */
  61   SKETCHPLUGIN_EXPORT virtual const void addSub(
  62     const boost::shared_ptr<ModelAPI_Feature>& theFeature) {}
  63
  64   /// \brief Use plugin manager for features creation
  65   SketchPlugin_Constraint() {}
  66 };
  67
  68 #endif