1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_WidgetShapeSelector.h
4 // Created: 2 June 2014
5 // Author: Vitaly Smetannikov
7 #ifndef ModuleBase_WidgetShapeSelector_H
8 #define ModuleBase_WidgetShapeSelector_H
10 #include "ModuleBase.h"
11 #include "ModuleBase_WidgetValidated.h"
12 #include "ModuleBase_ViewerFilters.h"
13 #include <ModuleBase_ViewerPrs.h>
15 #include <ModelAPI_Object.h>
16 #include <ModelAPI_Attribute.h>
17 #include <GeomAPI_Shape.h>
19 #include <TopAbs_ShapeEnum.hxx>
21 #include <QStringList>
23 class Config_WidgetAPI;
28 class ModuleBase_IWorkshop;
29 class ModelAPI_Validator;
30 class GeomValidators_ShapeType;
34 * Implementation of widget for shapes selection.
35 * This type of widget can be defined in XML file with 'shape_selector' keyword.
38 * <shape_selector id="main_object"
40 * icon=":icons/cut_shape.png"
41 * tooltip="Select an object solid"
42 * shape_types="solid shell"
46 * It can use following parameters:
47 * - id - name of object attribute
48 * - label - content of widget's label
49 * - icon - icon which can be used instead label
50 * - tooltip - the witget's tooltip text
51 * - shape_types - list of shape types for selection.
52 * Possible values: face, vertex, wire, edge, shell, solid
53 * - object_types - types of selectable objects.
54 * For today it supports only one type "construction"
55 * which corresponds to ModelAPI_ResultConstruction object type
56 * - concealment - hide or not hide selected object after operation
58 class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetValidated
64 /// \param theParent the parent object
65 /// \param theWorkshop instance of workshop interface
66 /// \param theData the widget configuation. The attribute of the model widget is obtained from
67 /// \param theParentId is Id of a parent of the current attribute
68 ModuleBase_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
69 const Config_WidgetAPI* theData, const std::string& theParentId);
71 virtual ~ModuleBase_WidgetShapeSelector();
73 virtual bool restoreValue();
75 /// Defines if it is supposed that the widget should interact with the viewer.
76 virtual bool isViewerSelector() { return true; }
78 /// Returns list of widget controls
79 /// \return a control list
80 virtual QList<QWidget*> getControls() const;
82 /// Fills the attribute with the value of the selected owner
83 /// \param theOwner a selected owner
84 virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
86 /// The methiod called when widget is deactivated
87 virtual void deactivate();
91 /// Activate or deactivate selection
92 void activateSelection(bool toActivate);
95 /// Slot which is called on selection event
96 void onSelectionChanged();
99 /// Saves the internal parameters to the given feature
100 /// \return True in success
101 virtual bool storeValueCustom() const;
103 /// The methiod called when widget is activated
104 virtual void activateCustom();
106 /// Creates a backup of the current values of the attribute
107 /// It should be realized in the specific widget because of different
108 /// parameters of the current attribute
109 virtual void storeAttributeValue();
111 /// Creates a backup of the current values of the attribute
112 /// It should be realized in the specific widget because of different
113 /// parameters of the current attribute
114 /// \param theValid a boolean flag, if restore happens for valid parameters
115 virtual void restoreAttributeValue(const bool theValid);
117 /// Puts additional validators to the given list. A separate validator is created for each of the
118 /// "type_choice" value
119 /// \param theValidators a list of validators
120 /// \param theArguments a list of validators arguments
121 virtual void customValidators(std::list<ModelAPI_Validator*>& theValidators,
122 std::list<std::list<std::string> >& theArguments) const;
124 /// Computes and updates name of selected object in the widget
125 void updateSelectionName();
127 /// Raise panel which contains this widget
128 void raisePanel() const;
130 /// Returns true if selected shape corresponds to requested shape types
131 /// \param theShape a shape
132 bool acceptSubShape(const TopoDS_Shape& theShape) const;
135 void clearAttribute();
137 /// Store the values to the model attribute of the widget. It casts this attribute to
138 /// the specific type and set the given values
139 /// \param theSelectedObject an object
140 /// \param theShape a selected shape, which is used in the selection attribute
141 /// \return true if it is succeed
142 virtual bool setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
144 /// Get the shape from the attribute if the attribute contains a shape, e.g. selection attribute
146 virtual GeomShapePtr getShape() const;
148 /// Return the attribute values wrapped in a list of viewer presentations
149 /// \return a list of viewer presentations, which contains an attribute result and
150 /// a shape. If the attribute do not uses the shape, it is empty
151 QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
153 //----------- Class members -------------
155 /// Label of the widget
158 /// Input control of the widget
159 QLineEdit* myTextLine;
161 /// Reference to workshop
162 ModuleBase_IWorkshop* myWorkshop;
164 /// List of accepting shapes types
165 QStringList myShapeTypes;
167 /// backup parameters of the model attribute. The class processes three types of attribute:
168 /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
169 /// values are reserved in the backup
170 /// An attribute object
172 /// An attribute shape
173 GeomShapePtr myShape;
174 /// A reference of the attribute
175 AttributePtr myRefAttribute;
176 /// A boolean value whether refAttr uses reference of object
179 /// An instance of the "shape_type" validator. It is returns on validating in customValidator()
180 GeomValidators_ShapeType* myShapeValidator;