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(FeaturePtr 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<FeaturePtr, 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(FeaturePtr 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(FeaturePtr 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 FeaturePtr 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 mouse double click in the point
92 /// \param theEvent the mouse event
93 /// \param theView a viewer to have the viewer the eye position
94 /// \param theSelected the list of selected presentations
95 /// \param theHighlighted the list of highlighted presentations
96 virtual void mouseDoubleClick(QMouseEvent* theEvent, Handle_V3d_View theView,
97 const std::list<XGUI_ViewerPrs>& theSelected,
98 const std::list<XGUI_ViewerPrs>& theHighlighted);
100 /// Processes the key pressed in the view
101 /// \param theKey a key value
102 virtual void keyReleased(const int theKey);
104 virtual void keyReleased(std::string theName, QKeyEvent* theEvent);
106 /// Emits a signal about the operation start. This signal has an information about the feature.
107 /// If the provided feature is empty, the current operation feature is used.
108 /// \param theType a type of an operation started
109 /// theFeature the operation argument
110 void restartOperation(const std::string& theType,
111 FeaturePtr theFeature = FeaturePtr());
114 /// signal about the request to launch operation
115 /// theName the operation name
116 /// theFeature the operation argument
117 void launchOperation(std::string theName, FeaturePtr theFeature);
118 /// signal about the focus activated
119 /// theName the attribute name
120 void focusActivated(const std::string& theAttibuteName);
122 /// Signal about the feature construing is finished
123 /// \param theFeature the result feature
124 /// \param theMode the mode of the feature modification
125 void featureConstructed(FeaturePtr theFeature,
127 /// Signal about the features should be selected
128 /// \param theSelected the list of selected presentations
129 void featureSelected(const std::list<XGUI_ViewerPrs>& theSelected);
130 /// signal to enable/disable multi selection in the viewer
131 /// \param theEnabled the boolean state
132 void multiSelectionEnabled(bool theEnabled);
134 /// signal to enable/disable selection in the viewer
135 /// \param theFeatures a list of features to be disabled
136 /// \param theToStop the boolean state whether it it stopped or non stopped
137 void stopSelection(const std::list<XGUI_ViewerPrs>& theFeatures, const bool theToStop);
138 /// signal to set selection in the viewer
139 /// \param theFeatures a list of features to be disabled
140 void setSelection(const std::list<XGUI_ViewerPrs>& theFeatures);
142 /// signal to close the operation local context if it is opened
143 void closeLocalContext();
146 /// Creates an operation new feature
147 /// In addition to the default realization it appends the created line feature to
148 /// the sketch feature
149 /// \param theFlushMessage the flag whether the create message should be flushed
150 /// \returns the created feature
151 virtual FeaturePtr createFeature(const bool theFlushMessage = true);