1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_Sketch.h
4 // Created: 27 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef SketchPlugin_Sketch_H_
8 #define SketchPlugin_Sketch_H_
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_Feature.h>
12 #include <GeomAPI_Pnt.h>
13 #include <GeomAPI_Pln.h>
14 #include <GeomAPI_IPresentable.h>
17 /// the plane edge color
18 #define SKETCH_PLANE_COLOR "#700000"
20 /// the plane edge width
21 #define SKETCH_WIDTH "4"
23 /// face of the square-face displayed for selection of general plane
24 #define PLANE_SIZE "200"
26 /**\class SketchPlugin_Sketch
28 * \brief Feature for creation of the new part in PartSet.
30 class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_IPresentable
33 /// Sketch feature kind
34 inline static const std::string& ID()
36 static const std::string MY_SKETCH_ID("Sketch");
39 /// Origin point of the sketcher in 3D space
40 inline static const std::string& ORIGIN_ID()
42 static const std::string MY_ORIGIN_ID("Origin");
45 /// Vector X inside of the sketch plane
46 inline static const std::string& DIRX_ID()
48 static const std::string MY_DIRX_ID("DirX");
51 /// Vector Y inside of the sketch plane
52 inline static const std::string& DIRY_ID()
54 static const std::string MY_DIRY_ID("DirY");
57 /// Vector Z, normal to the sketch plane
58 inline static const std::string& NORM_ID()
60 static const std::string MY_NORM_ID("Norm");
63 /// All features of this sketch (list of references)
64 inline static const std::string& FEATURES_ID()
66 static const std::string MY_FEATURES_ID("Features");
67 return MY_FEATURES_ID;
70 /// Returns the kind of a feature
71 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
73 static std::string MY_KIND = SketchPlugin_Sketch::ID();
77 /// Creates a new part document if needed
78 SKETCHPLUGIN_EXPORT virtual void execute();
80 /// Request for initialization of data model of the feature: adding all attributes
81 SKETCHPLUGIN_EXPORT virtual void initAttributes();
84 /// \param theDeltaX the delta for X coordinate is moved
85 /// \param theDeltaY the delta for Y coordinate is moved
86 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY)
91 /// Return the distance between the feature and the point
92 /// \param thePoint the point
93 virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint)
99 /// Converts a 2D sketch space point into point in 3D space
100 SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY);
102 /// Returns true if this feature must be displayed in the history (top level of Part tree)
103 SKETCHPLUGIN_EXPORT virtual bool isInHistory()
108 /// Use plugin manager for features creation
109 SketchPlugin_Sketch();
111 /// Returns the basis plane for the sketch
112 std::shared_ptr<GeomAPI_Pln> plane();
114 //virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
116 /// removes also all sub-sketch elements
117 SKETCHPLUGIN_EXPORT virtual void erase();
119 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
121 /// Returns the number of sub-elements
122 SKETCHPLUGIN_EXPORT virtual int numberOfSubs() const;
124 /// Returns the sub-feature by zero-base index
125 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
126 subFeature(const int theIndex) const;
128 /// Returns the sub-feature unique identifier in this composite feature by zero-base index
129 SKETCHPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
131 /// Returns true if feature or reuslt belong to this composite feature as subs
132 SKETCHPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
134 /// Construction result is allways recomuted on the fly
135 SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
137 /// Returns the point projected into the sketch plane
138 std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt);
140 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
142 /// Creates a plane and append it to the list
143 /// \param theX the X normal value
144 /// \param theY the Y normal value
145 /// \param theZ the Z normal value
146 /// \param theShapes the list of result shapes
147 //void addPlane(double theX, double theY, double theZ,
148 // std::list<std::shared_ptr<GeomAPI_Shape> >& theShapes) const;
150 /// Checks whether the plane is set in the sketch.
151 /// \returns the boolean state