1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_WidgetSelector.h
4 // Created: 19 June 2015
5 // Author: Natalia ERMOLAEVA
7 #ifndef ModuleBase_WidgetSelector_H
8 #define ModuleBase_WidgetSelector_H
10 #include "ModuleBase.h"
11 #include "ModuleBase_WidgetValidated.h"
12 #include <ModuleBase_ViewerPrs.h>
13 #include "ModuleBase_Definitions.h"
15 #include <ModelAPI_Object.h>
16 #include <ModelAPI_Attribute.h>
17 #include <GeomAPI_Shape.h>
19 class Config_WidgetAPI;
21 class ModuleBase_IWorkshop;
25 * Implementation of widget for selection.
26 * This abstract interface is designed to be used for shape/multi shape selector widgets.
28 class MODULEBASE_EXPORT ModuleBase_WidgetSelector : public ModuleBase_WidgetValidated
34 /// \param theParent the parent object
35 /// \param theWorkshop instance of workshop interface
36 /// \param theData the widget configuation. The attribute of the model widget is obtained from
37 /// \param theParentId is Id of a parent of the current attribute
38 ModuleBase_WidgetSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
39 const Config_WidgetAPI* theData, const std::string& theParentId);
41 virtual ~ModuleBase_WidgetSelector();
43 /// Defines if it is supposed that the widget should interact with the viewer.
44 virtual bool isViewerSelector() { return true; }
46 /// Activate or deactivate selection and selection filters
47 void activateSelectionAndFilters(bool toActivate);
49 /// Checks the widget validity. By default, it returns true.
50 /// \param thePrs a selected presentation in the view
51 /// \return a boolean value
52 virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
54 /// The methiod called when widget is deactivated
55 virtual void deactivate();
58 /// Slot which is called on selection event
59 void onSelectionChanged();
62 /// Set an empty value to attribute
63 virtual void clearAttribute() = 0;
65 /// Update focus after the attribute value change
66 virtual void updateFocus() = 0;
68 /// Return the attribute values wrapped in a list of viewer presentations
69 /// \return a list of viewer presentations, which contains an attribute result and
70 /// a shape. If the attribute do not uses the shape, it is empty
71 virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const = 0;
73 /// Retunrs a list of possible shape types
74 /// \return a list of shapes
75 virtual QIntList getShapeTypes() const = 0;
77 /// Computes and updates name of selected object in the widget
78 virtual void updateSelectionName() = 0;
80 /// Store the values to the model attribute of the widget. It casts this attribute to
81 /// the specific type and set the given values
82 /// \param theSelectedObject an object
83 /// \param theShape a selected shape, which is used in the selection attribute
84 /// \return true if it is succeed
85 virtual void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape) = 0;
87 /// The methiod called when widget is activated
88 virtual void activateCustom();
90 /// Returns true if selected shape corresponds to requested shape types.
91 /// If the widget type of shapes contains the faces item, the result is converted
92 /// to construction result and the method returns true if there is at least one face
93 /// in the construction.
94 /// \param theShape a shape
95 /// \param theResult a selected result
96 bool acceptSubShape(const GeomShapePtr& theShape, const ResultPtr& theResult) const;
98 /// Return an object and geom shape by the viewer presentation
99 /// \param thePrs a selection
100 /// \param theObject an output object
101 /// \param theShape a shape of the selection
102 virtual void getGeomSelection(const ModuleBase_ViewerPrs& thePrs,
103 ObjectPtr& theObject,
104 GeomShapePtr& theShape);
106 //----------- Class members -------------
107 /// Returns a name in the next form: attribute_feature_name/attribute_id
108 /// \param theAttribute a model attribute
109 /// \return string value
110 static std::string generateName(const AttributePtr& theAttribite);