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 Z, normal to the sketch plane
48 inline static const std::string& NORM_ID()
50 static const std::string MY_NORM_ID("Norm");
53 /// All features of this sketch (list of references)
54 inline static const std::string& FEATURES_ID()
56 static const std::string MY_FEATURES_ID("Features");
57 return MY_FEATURES_ID;
60 /// Returns the kind of a feature
61 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
63 static std::string MY_KIND = SketchPlugin_Sketch::ID();
67 /// Creates a new part document if needed
68 SKETCHPLUGIN_EXPORT virtual void execute();
70 /// Request for initialization of data model of the feature: adding all attributes
71 SKETCHPLUGIN_EXPORT virtual void initAttributes();
74 /// \param theDeltaX the delta for X coordinate is moved
75 /// \param theDeltaY the delta for Y coordinate is moved
76 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY)
80 /// Return the distance between the feature and the point
81 /// \param thePoint the point
82 virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint)
87 /// Converts a 2D sketch space point into point in 3D space
88 SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY);
90 /// Returns true if this feature must be displayed in the history (top level of Part tree)
91 SKETCHPLUGIN_EXPORT virtual bool isInHistory()
96 /// Use plugin manager for features creation
97 SketchPlugin_Sketch();
99 /// Returns the basis plane for the sketch
100 std::shared_ptr<GeomAPI_Pln> plane();
102 SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Ax3> coordinatePlane() const;
104 //virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
106 /// removes also all sub-sketch elements
107 SKETCHPLUGIN_EXPORT virtual void erase();
109 /// appends a feature to the sketch sub-elements container
110 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
112 /// Just to synchronise the container of sub-features
113 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
115 /// Returns the number of sub-elements
116 SKETCHPLUGIN_EXPORT virtual int numberOfSubs() const;
118 /// Returns the sub-feature by zero-base index
119 SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
120 subFeature(const int theIndex) const;
122 /// Returns the sub-feature unique identifier in this composite feature by zero-base index
123 SKETCHPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
125 /// Returns true if feature or reuslt belong to this composite feature as subs
126 SKETCHPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
128 /// Construction result is allways recomuted on the fly
129 SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
131 /// Returns the point projected into the sketch plane
132 std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt);
134 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
136 /// Checks whether the plane is set in the sketch.
137 /// \returns the boolean state