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_WidgetSelector.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_WidgetSelector
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 /// Returns list of widget controls
74 /// \return a control list
75 virtual QList<QWidget*> getControls() const;
78 /// Saves the internal parameters to the given feature
79 /// \return True in success
80 virtual bool storeValueCustom() const;
82 virtual bool restoreValueCustom();
84 /// Creates a backup of the current values of the attribute
85 /// It should be realized in the specific widget because of different
86 /// parameters of the current attribute
87 virtual void storeAttributeValue();
89 /// Creates a backup of the current values of the attribute
90 /// It should be realized in the specific widget because of different
91 /// parameters of the current attribute
92 /// \param theValid a boolean flag, if restore happens for valid parameters
93 virtual void restoreAttributeValue(const bool theValid);
95 /// Computes and updates name of selected object in the widget
96 virtual void updateSelectionName();
99 virtual void clearAttribute();
101 // Update focus after the attribute value change
102 virtual void updateFocus();
104 /// Retunrs a list of possible shape types
105 /// \return a list of shapes
106 virtual QIntList getShapeTypes() const;
108 /// Store the values to the model attribute of the widget. It casts this attribute to
109 /// the specific type and set the given values
110 /// \param theSelectedObject an object
111 /// \param theShape a selected shape, which is used in the selection attribute
112 /// \return true if it is succeed
113 virtual void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
115 /// Get the shape from the attribute if the attribute contains a shape, e.g. selection attribute
117 virtual GeomShapePtr getShape() const;
119 /// Return the attribute values wrapped in a list of viewer presentations
120 /// \return a list of viewer presentations, which contains an attribute result and
121 /// a shape. If the attribute do not uses the shape, it is empty
122 virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
124 //----------- Class members -------------
126 /// Label of the widget
129 /// Input control of the widget
130 QLineEdit* myTextLine;
132 /// List of accepting shapes types
133 QStringList myShapeTypes;
135 /// backup parameters of the model attribute. The class processes three types of attribute:
136 /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
137 /// values are reserved in the backup
138 /// An attribute object
140 /// An attribute shape
141 GeomShapePtr myShape;
142 /// A reference of the attribute
143 AttributePtr myRefAttribute;
144 /// A boolean value whether refAttr uses reference of object