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 <SketchPlugin_Sketch.h>
  11 #include <ModelAPI_AttributeReference.h>
  12 #include <ModelAPI_AttributeRefAttr.h>
  13 #include <list>
  14
  15 /*  Description:
  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.
  21  *
  22  *    The attributes below are named independent of the SolveSpace.
  23  *    Some of them may be unused.
  24  *
  25  *    Also the list of possible attributes is provided to simplify assignment.
  26  */
  27 /// The value parameter for the constraint
  28 const std::string CONSTRAINT_ATTR_VALUE("ConstraintValue");
  29 /// First entity for the constraint
  30 const std::string CONSTRAINT_ATTR_ENTITY_A("ConstraintEntityA");
  31 /// Second entity for the constraint
  32 const std::string CONSTRAINT_ATTR_ENTITY_B("ConstraintEntityB");
  33 /// Third entity for the constraint
  34 const std::string CONSTRAINT_ATTR_ENTITY_C("ConstraintEntityC");
  35 /// Fourth entity for the constraint
  36 const std::string CONSTRAINT_ATTR_ENTITY_D("ConstraintEntityD");
  37 /// List of constraint attributes
  38 const unsigned int CONSTRAINT_ATTR_SIZE = 4;
  39 const std::string CONSTRAINT_ATTRIBUTES[CONSTRAINT_ATTR_SIZE] =
  40                       {CONSTRAINT_ATTR_ENTITY_A, CONSTRAINT_ATTR_ENTITY_B,
  41                        CONSTRAINT_ATTR_ENTITY_C, CONSTRAINT_ATTR_ENTITY_D};
  42
  43
  44 /** \class SketchPlugin_Constraint
  45  *  \ingroup DataModel
  46  *  \brief Feature for creation of a new constraint between other features.
  47  *         Base class for all constraints.
  48  */
  49 class SketchPlugin_Constraint: public SketchPlugin_Feature
  50 {
  51 public:
  52   /// \brief Returns the kind of a feature
  53   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  54   {static std::string MY_KIND = "SketchConstraint"; return MY_KIND;}
  55
  56   /// \brief Returns to which group in the document must be added feature
  57   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  58   {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;}
  59
  60   /** \brief Adds sub-feature of the higher level feature (sub-element of the sketch)
  61    *  \param theFeature sub-feature
  62    */
  63   SKETCHPLUGIN_EXPORT virtual const void addSub(
  64     const boost::shared_ptr<ModelAPI_Feature>& theFeature) {}
  65
  66 protected:
  67   /// \brief Use plugin manager for features creation
  68   SketchPlugin_Constraint() {}
  69 };
  70
  71 #endif