src/ModuleBase/ModuleBase_Tools.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_Tools.h
   4 // Created:     11 July 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #ifndef ModuleBase_Tools_H
   8 #define ModuleBase_Tools_H
   9
  10 #include "ModuleBase.h"
  11 #include "ModuleBase_Definitions.h"
  12
  13 #include <ModelAPI_Attribute.h>
  14 #include <ModelAPI_Feature.h>
  15
  16 #include <TopAbs_ShapeEnum.hxx>
  17 #include <TopoDS_Shape.hxx>
  18 #include <Prs3d_Drawer.hxx>
  19 #include <AIS_Shape.hxx>
  20
  21 #include <Quantity_Color.hxx>
  22
  23 #include <QIcon>
  24 #include <QPixmap>
  25 #include <QLocale>
  26
  27 #include <map>
  28
  29 class QWidget;
  30 class QLayout;
  31 class QDoubleSpinBox;
  32 class QAction;
  33 class ModuleBase_ParamIntSpinBox;
  34 class ModuleBase_ParamSpinBox;
  35 class ModuleBase_IWorkshop;
  36
  37 class GeomAPI_Shape;
  38
  39 class Events_InfoMessage;
  40
  41 namespace ModuleBase_Tools {
  42
  43 /// Methods to adjust margins and spacings.
  44 MODULEBASE_EXPORT void adjustMargins(QWidget* theWidget);
  45 MODULEBASE_EXPORT void adjustMargins(QLayout* theLayout);
  46
  47 MODULEBASE_EXPORT void zeroMargins(QWidget* theWidget);
  48 MODULEBASE_EXPORT void zeroMargins(QLayout* theLayout);
  49
  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());
  56
  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());
  63
  64
  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);
  70
  71 /// \ingroup GUI
  72 /// Methods to modify a resource pixmap
  73
  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.
  77
  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);
  82
  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.
  89
  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);
  94
  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);
  99
 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);
 104
 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);
 109
 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);
 114
 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);
 119
 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());
 133
 134 #ifdef _DEBUG
 135 /// Returns name of data of the object if it is not NULL
 136 /// \param theObj an object
 137 /// \return a string
 138 MODULEBASE_EXPORT QString objectName(const ObjectPtr& theObj);
 139
 140 /// Converts the object to the feature or a result and generate information string
 141 /// \param theObj an object
 142 /// \param isUseAttributesInfo a flag whether the attribute values information is used
 143 /// \return a string
 144 MODULEBASE_EXPORT QString objectInfo(const ObjectPtr& theObj,
 145                                      const bool isUseAttributesInfo = false);
 146 #endif
 147
 148 /// Converts string value (name of shape type) to shape enum value
 149 /// \param theType - string with shape type name
 150 /// \return TopAbs_ShapeEnum value
 151 MODULEBASE_EXPORT int shapeType(const QString& theType);
 152
 153 /// Checks whether the object is a sub result. It gets the feature of the object,
 154 /// obtains all results of the feature and check if the object is a sub result
 155 /// \return boolean result
 156 MODULEBASE_EXPORT bool isSubResult(ObjectPtr theObject);
 157
 158 /// Check types of objects which are in the given list
 159 /// \param theObjects the list of objects
 160 /// \param hasResult will be set to true if list contains Result objects
 161 /// \param hasFeature will be set to true if list contains Feature objects
 162 /// \param hasParameter will be set to true if list contains Parameter objects
 163 /// \param hasCompositeOwner will be set to true if list contains Sub-Feature objects
 164 /// \param hasResultInHistory will be set to true if one of result is in history
 165 MODULEBASE_EXPORT void checkObjects(const QObjectPtrList& theObjects, bool& hasResult,
 166                            bool& hasFeature, bool& hasParameter, bool& hasCompositeOwner,
 167                            bool& hasResultInHistory);
 168
 169 /// Sets the default coeffient into the driver calculated accordingly the shape type.
 170 /// It provides 1.e-4 for results of construction type
 171 /// \param theResult a result object to define the deviation coeffient
 172 /// \param theDrawer a drawer
 173 //MODULEBASE_EXPORT void setDefaultDeviationCoefficient(
 174 //                           const std::shared_ptr<ModelAPI_Result>& theResult,
 175 //                           const Handle(Prs3d_Drawer)& theDrawer);
 176
 177 /// Sets the default coeffient into the driver calculated accordingly the shape type.
 178 /// It provides 1.e-4 for a shape withe Edge shape type
 179 /// \param theShape a shape to define the deviation coeffient,
 180 /// \param theDrawer a drawer
 181 MODULEBASE_EXPORT void setDefaultDeviationCoefficient(const TopoDS_Shape& theShape,
 182                                                       const Handle(Prs3d_Drawer)& theDrawer);
 183
 184 /// Obtains the color from the property manager and converts it to the OCCT color
 185 /// \param theSection a property section
 186 /// \param theName a property item name
 187 /// \return quantity color
 188 MODULEBASE_EXPORT Quantity_Color color(const std::string& theSection,
 189                                        const std::string& theName);
 190
 191 /// Returns the object from the attribute
 192 /// \param theObj an object
 193 MODULEBASE_EXPORT ObjectPtr getObject(const AttributePtr& theAttribute);
 194
 195 /// Returns the object from the attribute
 196 /// \param theObj an object
 197 MODULEBASE_EXPORT TopAbs_ShapeEnum getCompoundSubType(const TopoDS_Shape& theShape);
 198
 199 /// Returns list of parameters accessible in the active part and partset
 200 /// \theParameters a list of parameter names
 201 MODULEBASE_EXPORT void getParameters(QStringList& theParameters);
 202
 203 /// Returns list of parameters accessible in the active part and partset
 204 /// \theParameters a list of parameter names
 205 MODULEBASE_EXPORT std::string findGreedAttribute(ModuleBase_IWorkshop* theWorkshop,
 206                                                  const FeaturePtr& theFeature);
 207
 208 /// Set the object to the attribute depending on the attribute type. If it is a list,
 209 /// the values are appended if they are not in the list yet.
 210 /// \param theAttribute an attribute where the object and shape are set
 211 /// \param theObject an object
 212 /// \param theShape a shape
 213 /// \param theWorkshop to find an attribute for the given shape for attribute reference
 214 /// \param theTemporarily if it is true, do not store and name the added in the data framework
 215 ///        It is useful for attribute selection
 216 MODULEBASE_EXPORT bool hasObject(const AttributePtr& theAttribute, const ObjectPtr& theObject,
 217                                  const std::shared_ptr<GeomAPI_Shape>& theShape,
 218                                  ModuleBase_IWorkshop* theWorkshop,
 219                                  const bool theTemporarily);
 220
 221 /// Set the object to the attribute depending on the attribute type. If it is a list,
 222 /// the values are appended if they are not in the list yet.
 223 /// \param theAttribute an attribute where the object and shape are set
 224 /// \param theObject an object
 225 /// \param theShape a shape
 226 /// \param theWorkshop to find an attribute for the given shape for attribute reference
 227 /// \param theTemporarily if it is true, do not store and name the added in the data framework
 228 /// \param theCheckIfAttributeHasObject if it is true, the check isInList is called
 229 ///        It is useful for attribute selection
 230 /// \return true if the attribute is filled with the given parameters
 231 MODULEBASE_EXPORT bool setObject(const AttributePtr& theAttribute, const ObjectPtr& theObject,
 232                                  const std::shared_ptr<GeomAPI_Shape>& theShape,
 233                                  ModuleBase_IWorkshop* theWorkshop,
 234                                  const bool theTemporarily,
 235                                  const bool theCheckIfAttributeHasObject);
 236
 237 /// Returns the shape of the attribute. If the attribute is AttributeRefAttrPtr, the shape is found
 238 /// using current module of the given workshop.
 239 /// \param theAttribute an attribute where the shape is set
 240 /// \param theWorkshop to find a shape for the given attribute
 241 MODULEBASE_EXPORT std::shared_ptr<GeomAPI_Shape> getShape(const AttributePtr& theAttribute,
 242                                                           ModuleBase_IWorkshop* theWorkshop);
 243
 244 /// Flush updated signal for the object. The viewer update is blocked in the process
 245 /// \param theObject parameter of the signal
 246 MODULEBASE_EXPORT void flushUpdated(ObjectPtr theObject);
 247
 248 /// Sends a message about block/unblock viewer updating
 249 /// \param theValue a boolean value
 250 MODULEBASE_EXPORT void blockUpdateViewer(const bool theValue);
 251
 252 /// Generates a wrapped string to be less than value with '\n' separators
 253 /// \param theValue a boolean value
 254 /// \param theWidget a widget to know the font
 255 /// \param theMaxLineInPixels a maximum line width in pixels
 256 MODULEBASE_EXPORT QString wrapTextByWords(const QString& theValue, QWidget* theWidget,
 257                                              int theMaxLineInPixels = 150);
 258
 259 /// Generates a locale to disable thousands separator for spin box
 260 /// (to avoid inconsistency of double-2-string and string-2-double conversion)
 261 /// \return locale
 262 MODULEBASE_EXPORT QLocale doubleLocale();
 263
 264 /// Returns a container of referenced feature to the current object in the object document.
 265 /// \param theObject an object, which will be casted to a feature type
 266 /// \param theRefFeatures an output container
 267 void MODULEBASE_EXPORT refsToFeatureInFeatureDocument(const ObjectPtr& theObject,
 268                                                       std::set<FeaturePtr>& theRefFeatures);
 269
 270
 271 /// Returns true if the object if a sub child of the feature. The feature is casted to the
 272 /// composite one. If it is possible, the sub object check happens. The method is applyed
 273 /// recursively to the feature subs.
 274 /// \param theObject a candidate to be a sub object
 275 /// \param theFeature a candidate to be a composite feature
 276 /// \return a boolean value
 277 //bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject, const FeaturePtr& theFeature);
 278
 279
 280 /// Returns true if the result is a sub object of some composite object
 281 /// \param theObject a result object
 282 /// \returns boolean value
 283 //bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject);
 284
 285
 286 /// Returns first result of the feature: the object itself if it is a result of
 287 /// first result of the object's feature
 288 /// \param theObject an object
 289 /// \return first result or NULL
 290 std::shared_ptr<ModelAPI_Result> MODULEBASE_EXPORT firstResult(const ObjectPtr& theObject);
 291
 292 /// Returns true if the list contains at least one feature from the module document(PartSet)
 293 /// The Part features are skipped.
 294 /// \param theFeatures a list of features
 295 /// \bool true if it is found
 296 bool MODULEBASE_EXPORT hasModuleDocumentFeature(const std::set<FeaturePtr>& theFeatures);
 297
 298 /// Shows a dialog box about references. Ask whether they should be also removed.
 299 /// \param theFeatures a list of features
 300 /// \param theReferences a map of all references to the features
 301 /// \param theParent a parent widget for the question message box
 302 /// \param theReferencesToDelete an out set for references features to be removed
 303 /// \return true if in message box answer is Yes
 304 bool MODULEBASE_EXPORT askToDelete(const std::set<FeaturePtr> aFeatures,
 305                                    const std::map<FeaturePtr,
 306                                    std::set<FeaturePtr> >& theReferences,
 307                                    QWidget* theParent,
 308                                    std::set<FeaturePtr>& theReferencesToDelete,
 309                                    const std::string& thePrefixInfo = "");
 310
 311 /// Converts a list of objects to set of corresponded features. If object is result, it is ingored
 312 /// because the feauture only might be removed. But if result is in a parameter group, the feature
 313 /// of this parameter is to be removed
 314 /// \param theObjects a list of objects
 315 /// \param theFeatures an out conteiner of features
 316 void MODULEBASE_EXPORT convertToFeatures(const QObjectPtrList& theObjects,
 317                                          std::set<FeaturePtr>& theFeatures);
 318
 319
 320 /// Returns translation from the given data.
 321 /// If translation is not exists then it returns a string
 322 /// from the info data without translation
 323 /// \param theMessage a message which dave to be translated
 324 QString MODULEBASE_EXPORT translate(const Events_InfoMessage& theMessage);
 325
 326 /// Returns translation from the given data.
 327 /// If translation is not exists then it returns a string
 328 /// from the info data without translation
 329 /// \param theContext context of the message (Feature Id)
 330 /// \param theMessage a message which dave to be translated
 331 QString MODULEBASE_EXPORT translate(const std::string& theContext, const std::string& theMessage);
 332
 333 /// Set Highlighting of points as a Ball shape
 334 /// \param theAIS - the presentation
 335 void MODULEBASE_EXPORT setPointBallHighlighting(AIS_Shape* theAIS);
 336
 337 }
 338
 339 #endif