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 #define YZ_PLANE_COLOR "#ff0000"
18 #define XZ_PLANE_COLOR "#00ff00"
19 #define XY_PLANE_COLOR "#0000ff"
21 /**\class SketchPlugin_Sketch
23 * \brief Feature for creation of the new part in PartSet.
25 class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_IPresentable
28 /// Sketch feature kind
29 inline static const std::string& ID()
31 static const std::string MY_SKETCH_ID("Sketch");
34 /// Origin point of the sketcher in 3D space
35 inline static const std::string& ORIGIN_ID()
37 static const std::string MY_ORIGIN_ID("Origin");
40 /// Vector X inside of the sketch plane
41 inline static const std::string& DIRX_ID()
43 static const std::string MY_DIRX_ID("DirX");
46 /// Vector Y inside of the sketch plane
47 inline static const std::string& DIRY_ID()
49 static const std::string MY_DIRY_ID("DirY");
52 /// Vector Z, normal to the sketch plane
53 inline static const std::string& NORM_ID()
55 static const std::string MY_NORM_ID("Norm");
58 /// All features of this sketch (list of references)
59 inline static const std::string& FEATURES_ID()
61 static const std::string MY_FEATURES_ID("Features");
62 return MY_FEATURES_ID;
65 /// Returns the kind of a feature
66 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
68 static std::string MY_KIND = SketchPlugin_Sketch::ID();
72 /// Creates a new part document if needed
73 SKETCHPLUGIN_EXPORT virtual void execute();
75 /// Request for initialization of data model of the feature: adding all attributes
76 SKETCHPLUGIN_EXPORT virtual void initAttributes();
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)
86 /// Return the distance between the feature and the point
87 /// \param thePoint the point
88 virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint)
94 /// Converts a 2D sketch space point into point in 3D space
95 SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY);
97 /// Returns true if this feature must be displayed in the history (top level of Part tree)
98 SKETCHPLUGIN_EXPORT virtual bool isInHistory()
103 /// Use plugin manager for features creation
104 SketchPlugin_Sketch();
106 /// Returns the basis plane for the sketch
107 std::shared_ptr<GeomAPI_Pln> plane();
109 //virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
111 /// removes also all sub-sketch elements
112 SKETCHPLUGIN_EXPORT virtual void erase();
114 /// appends a feature to the sketch sub-elements container
115 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
117 /// appends a feature from the sketch sub-elements container
118 SKETCHPLUGIN_EXPORT virtual void removeFeature(ModelAPI_Feature* theFeature);
120 /// Returns the number of sub-elements
121 SKETCHPLUGIN_EXPORT virtual int numberOfSubs() const;
123 /// Returns the sub-feature by zero-base index
124 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
125 subFeature(const int theIndex) const;
127 /// Returns the sub-feature unique identifier in this composite feature by zero-base index
128 SKETCHPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
130 /// Returns true if feature or reuslt belong to this composite feature as subs
131 SKETCHPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
133 /// Construction result is allways recomuted on the fly
134 SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
136 /// Returns the point projected into the sketch plane
137 std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt);
139 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
141 /// Checks whether the plane is set in the sketch.
142 /// \returns the boolean state