1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_WidgetSketchCreator.h
4 // Created: 08 June 2015
5 // Author: Vitaly SMETANNIKOV
7 #ifndef PartSet_WidgetSketchCreator_H
8 #define PartSet_WidgetSketchCreator_H
12 #include <ModuleBase_WidgetSelector.h>
18 class ModuleBase_Operation;
19 class ModuleBase_IWorkshop;
20 class PartSet_PreviewPlanes;
24 * A widget which allow creation of a sketch in another operation.
25 * It creates sketch on aqctivation of this widget. If sketch object is already created then
26 * it will transfer a focus to next widget. It is supposed that the widget will be placed as
27 * a first widget in property panel
29 class PARTSET_EXPORT PartSet_WidgetSketchCreator : public ModuleBase_WidgetSelector
35 /// \param theParent the parent object
36 /// \param theModule a reference to a module object
37 /// \param theData the widget configuation. The attribute of the model widget is obtained from
38 PartSet_WidgetSketchCreator(QWidget* theParent, PartSet_Module* theModule,
39 const Config_WidgetAPI* theData);
41 virtual ~PartSet_WidgetSketchCreator();
43 /// Returns list of widget controls
44 /// \return a control list
45 virtual QList<QWidget*> getControls() const;
47 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
48 /// If the widget has the NonFocus focus policy, it is skipped.
49 /// \return the state whether the widget can accept the focus
50 virtual bool focusTo();
52 /// The methiod called when widget is deactivated
53 virtual void deactivate();
55 /// Set the given wrapped value to the current widget
56 /// This value should be processed in the widget according to the needs
57 /// \param theValues the wrapped selection values
58 /// \param theToValidate a validation of the values flag
59 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
60 const bool theToValidate);
62 /// Editing mode depends on mode of current operation. This value is defined by it.
63 virtual void setEditingMode(bool isEditing);
65 /// Checks all widget validator if the owner is valid. Firstly it checks custom widget validating,
66 /// next, the attribute's validating. It trying on the give selection to current attribute by
67 /// setting the value inside and calling validators. After this, the previous attribute value is
68 /// restored.The valid/invalid value is cashed.
69 /// \param theValue a selected presentation in the view
70 /// \return a boolean value
71 virtual bool isValidSelection(const ModuleBase_ViewerPrs& theValue);
73 /// Check if the current and the parent operations are a composite. If the parent operation contains
74 /// attribute selection list, the method returns false if it is invalid in this attibute validator
75 /// \param theWorkshop a current workshop
76 /// \return boolean value
77 static bool canCommitCurrentSketch(ModuleBase_IWorkshop* theWorkshop);
80 /// Checks whether the selection presentation contains preview planes
81 /// \param theValue a selection information
82 /// \return a boolean value
83 virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& theValue);
85 /// Saves the internal parameters to the given feature
86 /// \return True in success
87 virtual bool storeValueCustom() const;
89 virtual bool restoreValueCustom();
91 /// Retunrs attribute, which should be validated. In default implementation,
92 /// this is an attribute of ID
93 /// \return an attribute
94 virtual AttributePtr attribute() const;
96 /// Sets the selection control visible and set the current widget as active in property panel
97 /// It leads to connect to onSelectionChanged slot
98 void activateSelectionControl();
100 /// Visualization of the current control or others in PP
101 /// \param theSelectionControl state whether the control should be shown/hidden
102 void setVisibleSelectionControl(const bool theSelectionControl);
104 /// Retunrs a list of possible shape types
105 /// \return a list of shapes
106 virtual QIntList getShapeTypes() const;
108 /// Emits model changed info, updates the current control by selection change
109 /// \param theDone a state whether the selection is set
110 void updateOnSelectionChanged(const bool theDone);
113 /// Slot which is called on selection event
114 virtual void onSelectionChanged();
117 /// Returns true if the selection mode is active. This is when composition feature has no
118 /// a sub-object and the attribute list is empty
119 /// \return boolean value
120 bool isSelectionMode() const;
123 void onResumed(ModuleBase_Operation* theOp);
126 /// Append new Sketch, set the selected plane for the sketch and start Edit operation.
127 /// \param theValues a selection list
128 /// \return true if the sketch is started
129 bool startSketchOperation(const QList<ModuleBase_ViewerPrs>& theValues);
132 std::string myAttributeListID;
134 PartSet_Module* myModule;
136 /// Flag if the attribute() should return the attribute list ID or XML attribute
137 /// to store selection and check validation
138 bool myIsCustomAttribute;
140 /// Label of the widget
143 /// Input control of the widget
144 QLineEdit* myTextLine;
146 /// List of accepting shapes types
147 QStringList myShapeTypes;
149 /// class to show/hide preview planes
150 PartSet_PreviewPlanes* myPreviewPlanes;