1 // File: PartSet_OperationSketchBase.h
2 // Created: 20 Apr 2014
3 // Author: Natalia ERMOLAEVA
5 #ifndef PartSet_OperationSketchBase_H
6 #define PartSet_OperationSketchBase_H
10 #include <TopoDS_Shape.hxx>
12 #include <NCollection_List.hxx>
14 #include <ModuleBase_Operation.h>
15 #include <ModuleBase_Operation.h>
20 class Handle_V3d_View;
26 \class PartSet_OperationSketchBase
27 * \brief The base operation for the sketch features.
28 * Base class for all sketch operations. It provides an access to the feature preview
30 class PARTSET_EXPORT PartSet_OperationSketchBase : public ModuleBase_Operation
34 enum FeatureActionMode { FM_Activation, FM_Deactivation, FM_Hide };
38 /// \param theId an feature index
39 /// \param theParent the object parent
40 PartSet_OperationSketchBase(const QString& theId, QObject* theParent);
42 virtual ~PartSet_OperationSketchBase();
44 /// Returns the feature preview shape
45 /// \param theFeature the feature object to obtain the preview
46 static boost::shared_ptr<GeomAPI_Shape> preview(boost::shared_ptr<ModelAPI_Feature> theFeature);
48 /// Returns the map of the operation previews including the nested feature previews
49 /// \return the map of feature to the feature preview
50 virtual std::map<boost::shared_ptr<ModelAPI_Feature>, boost::shared_ptr<GeomAPI_Shape> > subPreview() const;
52 /// Returns the operation local selection mode
53 /// \param theFeature the feature object to get the selection mode
54 /// \return the selection mode
55 virtual std::list<int> getSelectionModes(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
57 /// Initializes some fields accorging to the feature
58 /// \param theSelected the list of selected presentations
59 /// \param theHighlighted the list of highlighted presentations
60 virtual void init(boost::shared_ptr<ModelAPI_Feature> theFeature,
61 const std::list<XGUI_ViewerPrs>& theSelected,
62 const std::list<XGUI_ViewerPrs>& theHighlighted) {}
64 /// Returns the operation sketch feature
65 /// \returns the sketch instance
66 virtual boost::shared_ptr<ModelAPI_Feature> sketch() const = 0;
68 /// Processes the mouse pressed in the point
69 /// \param theEvent the mouse event
70 /// \param theView a viewer to have the viewer the eye position
71 /// \param theSelected the list of selected presentations
72 /// \param theHighlighted the list of highlighted presentations
73 virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView,
74 const std::list<XGUI_ViewerPrs>& theSelected,
75 const std::list<XGUI_ViewerPrs>& theHighlighted);
77 /// Processes the mouse release in the point
78 /// \param theEvent the mouse event
79 /// \param theView a viewer to have the viewer the eye position
80 /// \param theSelected the list of selected presentations
81 /// \param theHighlighted the list of highlighted presentations
82 virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
83 const std::list<XGUI_ViewerPrs>& theSelected,
84 const std::list<XGUI_ViewerPrs>& theHighlighted);
86 /// Processes the mouse move in the point
87 /// \param theEvent the mouse event
88 /// \param theView a viewer to have the viewer the eye position
89 virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
91 /// Processes the key pressed in the view
92 /// \param theKey a key value
93 virtual void keyReleased(const int theKey);
95 virtual void keyReleased(std::string theName, QKeyEvent* theEvent);
97 /// Emits a signal about the operation start. This signal has an information about the feature.
98 /// If the provided feature is empty, the current operation feature is used.
99 /// \param theType a type of an operation started
100 /// theFeature the operation argument
101 void restartOperation(const std::string& theType,
102 boost::shared_ptr<ModelAPI_Feature> theFeature = boost::shared_ptr<ModelAPI_Feature>());
105 /// signal about the request to launch operation
106 /// theName the operation name
107 /// theFeature the operation argument
108 void launchOperation(std::string theName, boost::shared_ptr<ModelAPI_Feature> theFeature);
109 /// signal about the focus activated
110 /// theName the attribute name
111 void focusActivated(const std::string& theAttibuteName);
113 /// Signal about the feature construing is finished
114 /// \param theFeature the result feature
115 /// \param theMode the mode of the feature modification
116 void featureConstructed(boost::shared_ptr<ModelAPI_Feature> theFeature,
118 /// Signal about the features should be selected
119 /// \param theSelected the list of selected presentations
120 void featureSelected(const std::list<XGUI_ViewerPrs>& theSelected);
121 /// signal to enable/disable multi selection in the viewer
122 /// \param theEnabled the boolean state
123 void multiSelectionEnabled(bool theEnabled);
125 /// signal to enable/disable selection in the viewer
126 /// \param theFeatures a list of features to be disabled
127 /// \param theToStop the boolean state whether it it stopped or non stopped
128 void stopSelection(const std::list<XGUI_ViewerPrs>& theFeatures, const bool theToStop);
129 /// signal to set selection in the viewer
130 /// \param theFeatures a list of features to be disabled
131 void setSelection(const std::list<XGUI_ViewerPrs>& theFeatures);
133 /// signal to close the operation local context if it is opened
134 void closeLocalContext();
137 /// Creates an operation new feature
138 /// In addition to the default realization it appends the created line feature to
139 /// the sketch feature
140 /// \param theFlushMessage the flag whether the create message should be flushed
141 /// \returns the created feature
142 virtual boost::shared_ptr<ModelAPI_Feature> createFeature(const bool theFlushMessage = true);