1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_Tools.h
4 // Created: 11 July 2014
5 // Author: Vitaly Smetannikov
7 #ifndef ModuleBase_Tools_H
8 #define ModuleBase_Tools_H
10 #include "ModuleBase.h"
11 #include "ModuleBase_Definitions.h"
13 #include <ModelAPI_Attribute.h>
14 #include <ModelAPI_Feature.h>
16 #include <TopAbs_ShapeEnum.hxx>
17 #include <TopoDS_Shape.hxx>
18 #include <Prs3d_Drawer.hxx>
19 #include <AIS_Shape.hxx>
21 #include <Quantity_Color.hxx>
33 class ModuleBase_ParamIntSpinBox;
34 class ModuleBase_ParamSpinBox;
35 class ModuleBase_IWorkshop;
39 class Events_InfoMessage;
41 namespace ModuleBase_Tools {
43 /// Methods to adjust margins and spacings.
44 MODULEBASE_EXPORT void adjustMargins(QWidget* theWidget);
45 MODULEBASE_EXPORT void adjustMargins(QLayout* theLayout);
47 MODULEBASE_EXPORT void zeroMargins(QWidget* theWidget);
48 MODULEBASE_EXPORT void zeroMargins(QLayout* theLayout);
50 /// Calls the same-named Qt method for the given widget.
51 /// It sets the top-level widget containing this widget to be the active window.
52 /// An active window is a visible top-level window that has the keyboard input focus.
53 /// \param theWidget a widget to be activated
54 /// \param theIndo a debug information
55 MODULEBASE_EXPORT void activateWindow(QWidget* theWidget, const QString& theInfo = QString());
57 /// Calls the same-named Qt method for the given widget.
58 /// Gives the keyboard input focus to this widget (or its focus proxy) if this widget or
59 /// one of its parents is the active window.
60 /// \param theWidget a widget to be activated
61 /// \param theIndo a debug information
62 MODULEBASE_EXPORT void setFocus(QWidget* theWidget, const QString& theInfo = QString());
65 /// Sets or removes the shadow effect to the widget
66 /// \param theWidget a widget to be styled
67 /// \param isSetEffect if true, the shadow effect is set, overwise cleared
68 /// \return resulting pixmap
69 MODULEBASE_EXPORT void setShadowEffect(QWidget* theWidget, const bool isSetEffect);
72 /// Methods to modify a resource pixmap
74 /// Create composite pixmap.
75 /// Pixmap \a theAdditionalIcon is drawn over pixmap \a dest with coordinates
76 /// specified relatively to the upper left corner of \a theIcon.
78 /// \param theAdditionalIcon resource text of the additional pixmap
79 /// \param theIcon resource text of the background pixmap
80 /// \return resulting pixmap
81 MODULEBASE_EXPORT QPixmap composite(const QString& theAdditionalIcon, const QString& theIcon);
83 /// Generates the pixmap lighter than the resources pixmap.
84 /// Pixmap \a theIcon is lighted according to the given value.
85 /// If the lighter value is greater than 100, this functions returns a lighter pixmap.
86 /// Setting lighter value to 150 returns a color that is 50% brighter.
87 /// If the factor is less than 100,
88 /// the return pixmap is darker. If the factor is 0 or negative, the return pixmap is unspecified.
90 /// \param resource text of the pixmap
91 /// \param theLighterValue a lighter factor
92 /// \return resulting pixmap
93 MODULEBASE_EXPORT QPixmap lighter(const QString& theIcon, const int theLighterValue = 200);
95 /// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged)
96 /// \param theSpin an X or Y coordinate widget
97 /// \param theValue a new value
98 MODULEBASE_EXPORT void setSpinValue(QDoubleSpinBox* theSpin, double theValue);
100 /// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged)
101 /// \param theSpin an X or Y coordinate widget
102 /// \param theValue a new value
103 MODULEBASE_EXPORT void setSpinValue(ModuleBase_ParamSpinBox* theSpin, double theValue);
105 /// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged)
106 /// \param theSpin an ModuleBase_ParamSpinBox that accepts text
107 /// \param theText a new value
108 MODULEBASE_EXPORT void setSpinText(ModuleBase_ParamSpinBox* theSpin, const QString& theText);
110 /// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged)
111 /// \param theSpin a ModuleBase_ParamIntSpinBox object
112 /// \param theValue a new value
113 MODULEBASE_EXPORT void setSpinValue(ModuleBase_ParamIntSpinBox* theSpin, int theValue);
115 /// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged)
116 /// \param theSpin a SpinBox that accepts text
117 /// \param theText a new value
118 MODULEBASE_EXPORT void setSpinText(ModuleBase_ParamIntSpinBox* theSpin, const QString& theText);
120 /// Creates an action filled with the parameters
121 /// \param theIcon an action icon
122 /// \param theText an icon text
123 /// \param theParent an action object
124 /// \param theReceiver an object to process action triggered signal
125 /// \param theMember a slot to process the action triggered signal
126 /// \param theToolTip an action tool tip information, if empty the text is used
127 /// \param theStatusTip an action status tip information, if empty the text is used
128 MODULEBASE_EXPORT QAction* createAction(const QIcon& theIcon, const QString& theText,
129 QObject* theParent, const QObject* theReceiver = 0,
130 const char* theMember = "",
131 const QString& theToolTip = QString(),
132 const QString& theStatusTip = QString());
135 /// Converts the object to the feature or a result and generate information string
136 /// \param theObj an object
137 /// \param isUseAttributesInfo a flag whether the attribute values information is used
139 MODULEBASE_EXPORT QString objectInfo(const ObjectPtr& theObj,
140 const bool isUseAttributesInfo = false);
143 /// Converts string value (name of shape type) to shape enum value
144 /// \param theType - string with shape type name
145 /// \return TopAbs_ShapeEnum value
146 MODULEBASE_EXPORT int shapeType(const QString& theType);
148 /// Checks whether the object is a sub result. It gets the feature of the object,
149 /// obtains all results of the feature and check if the object is a sub result
150 /// \return boolean result
151 MODULEBASE_EXPORT bool isSubResult(ObjectPtr theObject);
153 /// Check types of objects which are in the given list
154 /// \param theObjects the list of objects
155 /// \param hasResult will be set to true if list contains Result objects
156 /// \param hasFeature will be set to true if list contains Feature objects
157 /// \param hasParameter will be set to true if list contains Parameter objects
158 /// \param hasCompositeOwner will be set to true if list contains Sub-Feature objects
159 MODULEBASE_EXPORT void checkObjects(const QObjectPtrList& theObjects, bool& hasResult,
160 bool& hasFeature, bool& hasParameter, bool& hasCompositeOwner);
162 /// Sets the default coeffient into the driver calculated accordingly the shape type.
163 /// It provides 1.e-4 for results of construction type
164 /// \param theResult a result object to define the deviation coeffient
165 /// \param theDrawer a drawer
166 //MODULEBASE_EXPORT void setDefaultDeviationCoefficient(
167 // const std::shared_ptr<ModelAPI_Result>& theResult,
168 // const Handle(Prs3d_Drawer)& theDrawer);
170 /// Sets the default coeffient into the driver calculated accordingly the shape type.
171 /// It provides 1.e-4 for a shape withe Edge shape type
172 /// \param theShape a shape to define the deviation coeffient,
173 /// \param theDrawer a drawer
174 MODULEBASE_EXPORT void setDefaultDeviationCoefficient(const TopoDS_Shape& theShape,
175 const Handle(Prs3d_Drawer)& theDrawer);
177 /// Obtains the color from the property manager and converts it to the OCCT color
178 /// \param theSection a property section
179 /// \param theName a property item name
180 /// \param theDefault a default color value
181 /// \return quantity color
182 MODULEBASE_EXPORT Quantity_Color color(const std::string& theSection,
183 const std::string& theName,
184 const std::string& theDefault);
186 /// Returns the object from the attribute
187 /// \param theObj an object
188 MODULEBASE_EXPORT ObjectPtr getObject(const AttributePtr& theAttribute);
190 /// Returns the object from the attribute
191 /// \param theObj an object
192 MODULEBASE_EXPORT TopAbs_ShapeEnum getCompoundSubType(const TopoDS_Shape& theShape);
194 /// Returns list of parameters accessible in the active part and partset
195 /// \theParameters a list of parameter names
196 MODULEBASE_EXPORT void getParameters(QStringList& theParameters);
198 /// Returns list of parameters accessible in the active part and partset
199 /// \theParameters a list of parameter names
200 MODULEBASE_EXPORT std::string findGreedAttribute(ModuleBase_IWorkshop* theWorkshop,
201 const FeaturePtr& theFeature);
203 /// Set the object to the attribute depending on the attribute type. If it is a list,
204 /// the values are appended if they are not in the list yet.
205 /// \param theAttribute an attribute where the object and shape are set
206 /// \param theObject an object
207 /// \param theShape a shape
208 /// \param theWorkshop to find an attribute for the given shape for attribute reference
209 /// \param theTemporarily if it is true, do not store and name the added in the data framework
210 /// It is useful for attribute selection
211 MODULEBASE_EXPORT bool hasObject(const AttributePtr& theAttribute, const ObjectPtr& theObject,
212 const std::shared_ptr<GeomAPI_Shape>& theShape,
213 ModuleBase_IWorkshop* theWorkshop,
214 const bool theTemporarily);
216 /// Set the object to the attribute depending on the attribute type. If it is a list,
217 /// the values are appended if they are not in the list yet.
218 /// \param theAttribute an attribute where the object and shape are set
219 /// \param theObject an object
220 /// \param theShape a shape
221 /// \param theWorkshop to find an attribute for the given shape for attribute reference
222 /// \param theTemporarily if it is true, do not store and name the added in the data framework
223 /// \param theCheckIfAttributeHasObject if it is true, the check isInList is called
224 /// It is useful for attribute selection
225 /// \return true if the attribute is filled with the given parameters
226 MODULEBASE_EXPORT bool setObject(const AttributePtr& theAttribute, const ObjectPtr& theObject,
227 const std::shared_ptr<GeomAPI_Shape>& theShape,
228 ModuleBase_IWorkshop* theWorkshop,
229 const bool theTemporarily,
230 const bool theCheckIfAttributeHasObject);
232 /// Returns the shape of the attribute. If the attribute is AttributeRefAttrPtr, the shape is found
233 /// using current module of the given workshop.
234 /// \param theAttribute an attribute where the shape is set
235 /// \param theWorkshop to find a shape for the given attribute
236 MODULEBASE_EXPORT std::shared_ptr<GeomAPI_Shape> getShape(const AttributePtr& theAttribute,
237 ModuleBase_IWorkshop* theWorkshop);
239 /// Flush updated signal for the object. The viewer update is blocked in the process
240 /// \param theObject parameter of the signal
241 MODULEBASE_EXPORT void flushUpdated(ObjectPtr theObject);
243 /// Sends a message about block/unblock viewer updating
244 /// \param theValue a boolean value
245 MODULEBASE_EXPORT void blockUpdateViewer(const bool theValue);
247 /// Generates a wrapped string to be less than value with '\n' separators
248 /// \param theValue a boolean value
249 /// \param theWidget a widget to know the font
250 /// \param theMaxLineInPixels a maximum line width in pixels
251 MODULEBASE_EXPORT QString wrapTextByWords(const QString& theValue, QWidget* theWidget,
252 int theMaxLineInPixels = 150);
254 /// Generates a locale to disable thousands separator for spin box
255 /// (to avoid inconsistency of double-2-string and string-2-double conversion)
257 MODULEBASE_EXPORT QLocale doubleLocale();
259 /// Returns a container of referenced feature to the current object in the object document.
260 /// \param theObject an object, which will be casted to a feature type
261 /// \param theRefFeatures an output container
262 void MODULEBASE_EXPORT refsToFeatureInFeatureDocument(const ObjectPtr& theObject,
263 std::set<FeaturePtr>& theRefFeatures);
266 /// Returns true if the object if a sub child of the feature. The feature is casted to the
267 /// composite one. If it is possible, the sub object check happens. The method is applyed
268 /// recursively to the feature subs.
269 /// \param theObject a candidate to be a sub object
270 /// \param theFeature a candidate to be a composite feature
271 /// \return a boolean value
272 //bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject, const FeaturePtr& theFeature);
275 /// Returns true if the result is a sub object of some composite object
276 /// \param theObject a result object
277 /// \returns boolean value
278 //bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject);
281 /// Returns first result of the feature: the object itself if it is a result of
282 /// first result of the object's feature
283 /// \param theObject an object
284 /// \return first result or NULL
285 std::shared_ptr<ModelAPI_Result> MODULEBASE_EXPORT firstResult(const ObjectPtr& theObject);
287 /// Returns true if the list contains at least one feature from the module document(PartSet)
288 /// The Part features are skipped.
289 /// \param theFeatures a list of features
290 /// \bool true if it is found
291 bool MODULEBASE_EXPORT hasModuleDocumentFeature(const std::set<FeaturePtr>& theFeatures);
293 /// Shows a dialog box about references. Ask whether they should be also removed.
294 /// \param theFeatures a list of features
295 /// \param theReferences a map of all references to the features
296 /// \param theParent a parent widget for the question message box
297 /// \param theReferencesToDelete an out set for references features to be removed
298 /// \return true if in message box answer is Yes
299 bool MODULEBASE_EXPORT askToDelete(const std::set<FeaturePtr> aFeatures,
300 const std::map<FeaturePtr,
301 std::set<FeaturePtr> >& theReferences,
303 std::set<FeaturePtr>& theReferencesToDelete,
304 const std::string& thePrefixInfo = "");
306 /// Converts a list of objects to set of corresponded features. If object is result, it is ingored
307 /// because the feauture only might be removed. But if result is in a parameter group, the feature
308 /// of this parameter is to be removed
309 /// \param theObjects a list of objects
310 /// \param theFeatures an out conteiner of features
311 void MODULEBASE_EXPORT convertToFeatures(const QObjectPtrList& theObjects,
312 std::set<FeaturePtr>& theFeatures);
315 /// Returns translation from the given data.
316 /// If translation is not exists then it returns a string
317 /// from the info data without translation
318 /// \param theMessage a message which dave to be translated
319 QString MODULEBASE_EXPORT translate(const Events_InfoMessage& theMessage);
321 /// Returns translation from the given data.
322 /// If translation is not exists then it returns a string
323 /// from the info data without translation
324 /// \param theContext context of the message (Feature Id)
325 /// \param theMessage a message which dave to be translated
326 QString MODULEBASE_EXPORT translate(const std::string& theContext, const std::string& theMessage);
328 /// Set Highlighting of points as a Ball shape
329 /// \param theAIS - the presentation
330 void MODULEBASE_EXPORT setPointBallHighlighting(AIS_Shape* theAIS);