1 // File: SketchPlugin_ConstraintBase.h
2 // Created: 08 May 2014
3 // Author: Artem ZHIDKOV
5 #ifndef SketchPlugin_ConstraintBase_H_
6 #define SketchPlugin_ConstraintBase_H_
8 #include "SketchPlugin.h"
9 #include <SketchPlugin_Constraint.h>
10 #include <SketchPlugin_Sketch.h>
11 #include <ModelAPI_AttributeReference.h>
12 #include <ModelAPI_AttributeRefAttr.h>
14 #include <GeomAPI_IPresentable.h>
20 * Each constraint uses a set of parameters. In the SolveSpace library
21 * these parameters are named "valA", "ptA", "ptB", "entityA", "entityB".
22 * The "ptA" and "ptB" parameters represents a point in the constraint.
23 * The "entityA" and "entityB" represents any other object (and a point too).
24 * And the "valA" represents a real value.
26 * The attributes below are named independent of the SolveSpace.
27 * Some of them may be unused.
29 * Also the list of possible attributes is provided to simplify assignment.
32 /** \class SketchPlugin_ConstraintBase
34 * \brief Feature for creation of a new constraint between other features.
35 * Some feature's methods implemented here as dummy to
36 * Base class for all constraints.
38 class SketchPlugin_ConstraintBase: public SketchPlugin_Constraint,
39 public GeomAPI_IPresentable
42 /// Returns the AIS preview
43 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
45 /** \brief Adds sub-feature of the higher level feature (sub-element of the sketch)
46 * \param theFeature sub-feature
48 SKETCHPLUGIN_EXPORT virtual const void addSub(const FeaturePtr& theFeature);
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);
54 /// Return the distance between the feature and the point
55 /// \param thePoint the point
56 virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint);
59 /// \brief Use plugin manager for features creation
60 SketchPlugin_ConstraintBase() {}