1 // File: SketchPlugin_Sketch.h
2 // Created: 27 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef SketchPlugin_Sketch_HeaderFile
6 #define SketchPlugin_Sketch_HeaderFile
8 #include "SketchPlugin.h"
9 #include <SketchPlugin_Feature.h>
10 #include <GeomAPI_Pnt.h>
11 #include <GeomAPI_Pln.h>
12 #include <GeomAPI_IPresentable.h>
15 /**\class SketchPlugin_Sketch
17 * \brief Feature for creation of the new part in PartSet.
19 class SketchPlugin_Sketch: public SketchPlugin_Feature, public GeomAPI_IPresentable
22 /// Sketch feature kind
23 inline static const std::string& ID()
25 static const std::string MY_SKETCH_ID("Sketch");
28 /// Origin point of the sketcher in 3D space
29 inline static const std::string& ORIGIN_ID()
31 static const std::string MY_ORIGIN_ID("Origin");
34 /// Vector X inside of the sketch plane
35 inline static const std::string& DIRX_ID()
37 static const std::string MY_DIRX_ID("DirX");
40 /// Vector Y inside of the sketch plane
41 inline static const std::string& DIRY_ID()
43 static const std::string MY_DIRY_ID("DirY");
46 /// Vector Z, normal to the sketch plane
47 inline static const std::string& NORM_ID()
49 static const std::string MY_NORM_ID("Norm");
52 /// All features of this sketch (list of references)
53 inline static const std::string& FEATURES_ID()
55 static const std::string MY_FEATURES_ID("Features");
56 return MY_FEATURES_ID;
59 /// Returns the kind of a feature
60 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
61 {static std::string MY_KIND = SketchPlugin_Sketch::ID(); return MY_KIND;}
63 /// Creates a new part document if needed
64 SKETCHPLUGIN_EXPORT virtual void execute();
66 /// Request for initialization of data model of the feature: adding all attributes
67 SKETCHPLUGIN_EXPORT virtual void initAttributes();
69 /// Returns the AIS preview
70 SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
71 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
73 /// Adds sub-feature of the higher level feature (sub-element of the sketch)
74 /// \param theFeature sub-feature
75 SKETCHPLUGIN_EXPORT virtual const void addSub(
76 const FeaturePtr& theFeature);
79 /// \param theDeltaX the delta for X coordinate is moved
80 /// \param theDeltaY the delta for Y coordinate is moved
81 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) {};
83 /// Return the distance between the feature and the point
84 /// \param thePoint the point
85 virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) { return 0; };
87 /// Converts a 2D sketch space point into point in 3D space
88 SKETCHPLUGIN_EXPORT boost::shared_ptr<GeomAPI_Pnt> to3D(
89 const double theX, const double theY);
91 /// Returns true if this feature must be displayed in the history (top level of Part tree)
92 SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return true;}
94 /// Use plugin manager for features creation
95 SketchPlugin_Sketch();
97 /// Returns the basis plane for the sketch
98 boost::shared_ptr<GeomAPI_Pln> plane();
100 /// Creates a plane and append it to the list
101 /// \param theX the X normal value
102 /// \param theY the Y normal value
103 /// \param theZ the Z normal value
104 /// \param theShapes the list of result shapes
105 void addPlane(double theX, double theY, double theZ,
106 std::list<boost::shared_ptr<GeomAPI_Shape> >& theShapes) const;
108 /// Checks whether the plane is set in the sketch.
109 /// \returns the boolean state