1 // File: SketchPlugin_Feature.h
2 // Created: 27 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef SketchPlugin_Feature_H_
6 #define SketchPlugin_Feature_H_
8 #include "SketchPlugin.h"
9 #include <ModelAPI_CompositeFeature.h>
10 #include <GeomAPI_Shape.h>
11 #include <GeomAPI_AISObject.h>
12 #include <ModelAPI_Document.h>
14 class SketchPlugin_Sketch;
16 class Handle_AIS_InteractiveObject;
18 /**\class SketchPlugin_Feature
20 * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
21 * an interface to create the sketch feature preview.
23 class SketchPlugin_Feature : public ModelAPI_Feature
26 /// Simple creation of interactive object by the result of the object
27 static AISObjectPtr simpleAISObject(boost::shared_ptr<ModelAPI_Result> theRes,
28 AISObjectPtr thePrevious);
30 /// Reference to the external edge or vertex as a AttributeSelection
31 inline static const std::string& EXTERNAL_ID()
33 static const std::string MY_EXTERNAL_ID("External");
34 return MY_EXTERNAL_ID;
37 /// Returns true if this feature must be displayed in the history (top level of Part tree)
38 SKETCHPLUGIN_EXPORT virtual bool isInHistory()
44 /// \param theDeltaX the delta for X coordinate is moved
45 /// \param theDeltaY the delta for Y coordinate is moved
46 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 0;
48 /// Return the distance between the feature and the point
49 /// \param thePoint the point
50 virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
52 /// Construction result is allways recomuted on the fly
53 SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
55 /// Returns true is sketch element is under the rigid constraint
56 SKETCHPLUGIN_EXPORT virtual bool isFixed() {return false;}
58 /// Returns the sketch of this feature
59 inline SketchPlugin_Sketch* sketch() {return mySketch;}
61 /// Sets the higher-level feature for the sub-feature (sketch for line)
62 void setSketch(SketchPlugin_Sketch* theSketch)
66 /// initializes mySketch
67 SketchPlugin_Feature();
69 friend class SketchPlugin_Sketch;
72 boost::shared_ptr<GeomAPI_Shape> myPreview; ///< the preview shape
73 SketchPlugin_Sketch* mySketch; /// sketch that contains this feature