1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_Feature.h
4 // Created: 27 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef SketchPlugin_Feature_H_
8 #define SketchPlugin_Feature_H_
10 #include "SketchPlugin.h"
11 #include <ModelAPI_CompositeFeature.h>
12 #include <GeomAPI_Shape.h>
13 #include <GeomAPI_AISObject.h>
14 #include <ModelAPI_Document.h>
15 #include <ModelAPI_AttributeSelection.h>
17 class SketchPlugin_Sketch;
19 class Handle_AIS_InteractiveObject;
21 /**\class SketchPlugin_Feature
23 * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
24 * an interface to create the sketch feature preview.
26 class SketchPlugin_Feature : public ModelAPI_Feature
29 /// Simple creation of interactive object by the result of the object
30 static AISObjectPtr simpleAISObject(std::shared_ptr<ModelAPI_Result> theRes,
31 AISObjectPtr thePrevious);
33 /// Reference to the external edge or vertex as a AttributeSelection
34 inline static const std::string& EXTERNAL_ID()
36 static const std::string MY_EXTERNAL_ID("External");
37 return MY_EXTERNAL_ID;
40 /// Returns true if this feature must be displayed in the history (top level of Part tree)
41 SKETCHPLUGIN_EXPORT virtual bool isInHistory()
47 /// \param theDeltaX the delta for X coordinate is moved
48 /// \param theDeltaY the delta for Y coordinate is moved
49 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 0;
51 /// Return the distance between the feature and the point
52 /// \param thePoint the point
53 virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
55 /// Construction result is allways recomuted on the fly
56 SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
58 /// Returns true is sketch element is under the rigid constraint
59 SKETCHPLUGIN_EXPORT virtual bool isFixed() {return false;}
61 inline bool isExternal() const
63 AttributeSelectionPtr aAttr = data()->selection(EXTERNAL_ID());
65 return aAttr->context();
69 /// Returns the sketch of this feature
70 SketchPlugin_Sketch* sketch();
72 /// Sets the higher-level feature for the sub-feature (sketch for line)
73 void setSketch(SketchPlugin_Sketch* theSketch)
77 /// initializes mySketch
78 SketchPlugin_Feature();
80 friend class SketchPlugin_Sketch;
83 std::shared_ptr<GeomAPI_Shape> myPreview; ///< the preview shape
84 SketchPlugin_Sketch* mySketch; /// sketch that contains this feature