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>
13 /// Sketch feature kind
14 const std::string SKETCH_KIND("Sketch");
16 /// Origin point of the sketcher in 3D space
17 const std::string SKETCH_ATTR_ORIGIN("Origin");
18 /// Vector X inside of the sketch plane
19 const std::string SKETCH_ATTR_DIRX("DirX");
20 /// Vector Y inside of the sketch plane
21 const std::string SKETCH_ATTR_DIRY("DirY");
22 /// Vector Z, normal to the sketch plane
23 const std::string SKETCH_ATTR_NORM("Norm");
24 /// All features of this sketch (list of references)
25 const std::string SKETCH_ATTR_FEATURES("Features");
27 /**\class SketchPlugin_Sketch
29 * \brief Feature for creation of the new part in PartSet.
31 class SketchPlugin_Sketch: public SketchPlugin_Feature
34 /// Returns the kind of a feature
35 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
36 {static std::string MY_KIND = SKETCH_KIND; return MY_KIND;}
38 /// Returns to which group in the document must be added feature
39 SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
40 {static std::string MY_GROUP = "Construction"; return MY_GROUP;}
42 /// Creates a new part document if needed
43 SKETCHPLUGIN_EXPORT virtual void execute();
45 /// Request for initialization of data model of the feature: adding all attributes
46 SKETCHPLUGIN_EXPORT virtual void initAttributes();
48 /// Returns the sketch preview
49 SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
51 /// Adds sub-feature of the higher level feature (sub-element of the sketch)
52 /// \param theFeature sub-feature
53 SKETCHPLUGIN_EXPORT virtual const void addSub(
54 const FeaturePtr& theFeature);
57 /// \param theDeltaX the delta for X coordinate is moved
58 /// \param theDeltaY the delta for Y coordinate is moved
59 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) {};
61 /// Converts a 2D sketch space point into point in 3D space
62 SKETCHPLUGIN_EXPORT boost::shared_ptr<GeomAPI_Pnt> to3D(
63 const double theX, const double theY);
65 /// Returns true if this feature must be displayed in the history (top level of Part tree)
66 SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return true;}
68 /// Use plugin manager for features creation
69 SketchPlugin_Sketch();
71 /// Creates a plane and append it to the list
72 /// \param theX the X normal value
73 /// \param theY the Y normal value
74 /// \param theZ the Z normal value
75 /// \param theShapes the list of result shapes
76 void addPlane(double theX, double theY, double theZ,
77 std::list<boost::shared_ptr<GeomAPI_Shape> >& theShapes) const;
79 /// Checks whether the plane is set in the sketch.
80 /// \returns the boolean state