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>
15 #include <GeomAPI_Ax3.h>
18 #define YZ_PLANE_COLOR "#ff0000"
19 #define XZ_PLANE_COLOR "#00ff00"
20 #define XY_PLANE_COLOR "#0000ff"
22 /**\class SketchPlugin_Sketch
24 * \brief Feature for creation of the new part in PartSet.
26 class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_IPresentable
29 /// Sketch feature kind
30 inline static const std::string& ID()
32 static const std::string MY_SKETCH_ID("Sketch");
35 /// Origin point of the sketcher in 3D space
36 inline static const std::string& ORIGIN_ID()
38 static const std::string MY_ORIGIN_ID("Origin");
41 /// Vector X inside of the sketch plane
42 inline static const std::string& DIRX_ID()
44 static const std::string MY_DIRX_ID("DirX");
47 /// Vector Y inside of the sketch plane
48 inline static const std::string& DIRY_ID()
50 static const std::string MY_DIRY_ID("DirY");
53 /// Vector Z, normal to the sketch plane
54 inline static const std::string& NORM_ID()
56 static const std::string MY_NORM_ID("Norm");
59 /// All features of this sketch (list of references)
60 inline static const std::string& FEATURES_ID()
62 static const std::string MY_FEATURES_ID("Features");
63 return MY_FEATURES_ID;
66 /// Returns the kind of a feature
67 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
69 static std::string MY_KIND = SketchPlugin_Sketch::ID();
73 /// Creates a new part document if needed
74 SKETCHPLUGIN_EXPORT virtual void execute();
76 /// Request for initialization of data model of the feature: adding all attributes
77 SKETCHPLUGIN_EXPORT virtual void initAttributes();
80 /// \param theDeltaX the delta for X coordinate is moved
81 /// \param theDeltaY the delta for Y coordinate is moved
82 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)
93 /// Converts a 2D sketch space point into point in 3D space
94 SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY);
96 /// Returns true if this feature must be displayed in the history (top level of Part tree)
97 SKETCHPLUGIN_EXPORT virtual bool isInHistory()
102 /// Use plugin manager for features creation
103 SketchPlugin_Sketch();
105 /// Returns the basis plane for the sketch
106 std::shared_ptr<GeomAPI_Pln> plane();
108 SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Ax3> coordinatePlane() const;
110 //virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
112 /// removes also all sub-sketch elements
113 SKETCHPLUGIN_EXPORT virtual void erase();
115 /// appends a feature to the sketch sub-elements container
116 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
118 /// Just to synchronise the container of sub-features
119 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
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 /// Checks whether the plane is set in the sketch.
143 /// \returns the boolean state