src/SketchPlugin/SketchPlugin_ConstraintBase.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:    SketchPlugin_ConstraintBase.h
   4 // Created: 08 May 2014
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchPlugin_ConstraintBase_H_
   8 #define SketchPlugin_ConstraintBase_H_
   9
  10 #include "SketchPlugin.h"
  11 #include <SketchPlugin_Constraint.h>
  12 #include <SketchPlugin_Sketch.h>
  13 #include <ModelAPI_AttributeReference.h>
  14 #include <ModelAPI_AttributeRefAttr.h>
  15
  16 #include <GeomAPI_IPresentable.h>
  17
  18 #include <list>
  19
  20 /*  Description:
  21  *    Each constraint uses a set of parameters. In the SolveSpace library
  22  *    these parameters are named "valA", "ptA", "ptB", "entityA", "entityB".
  23  *    The "ptA" and "ptB" parameters represents a point in the constraint.
  24  *    The "entityA" and "entityB" represents any other object (and a point too).
  25  *    And the "valA" represents a real value.
  26  *
  27  *    The attributes below are named independent of the SolveSpace.
  28  *    Some of them may be unused.
  29  *
  30  *    Also the list of possible attributes is provided to simplify assignment.
  31  */
  32
  33 /** \class SketchPlugin_ConstraintBase
  34  *  \ingroup DataModel
  35  *  \brief Feature for creation of a new constraint between other features.
  36  *         Some feature's methods implemented here as dummy to
  37  *         Base class for all constraints.
  38  */
  39 class SketchPlugin_ConstraintBase : public SketchPlugin_Constraint, public GeomAPI_IPresentable
  40 {
  41  public:
  42   /// Returns the AIS preview
  43   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  44
  45   /** \brief Adds sub-feature of the higher level feature (sub-element of the sketch)
  46    *  \param theFeature sub-feature
  47    */
  48   SKETCHPLUGIN_EXPORT virtual const void addSub(const FeaturePtr& theFeature);
  49   /// Moves the feature
  50   /// \param theDeltaX the delta for X coordinate is moved
  51   /// \param theDeltaY the delta for Y coordinate is moved
  52   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  53
  54   /// Return the distance between the feature and the point
  55   /// \param thePoint the point
  56   virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  57
  58  protected:
  59   /// \brief Use plugin manager for features creation
  60   SketchPlugin_ConstraintBase()
  61   {
  62   }
  63 };
  64
  65 #endif