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);
79 /// Sets the sub-object to list of base.
80 static void setSketchObjectToList(const CompositeFeaturePtr& theFeature,
81 const AttributePtr& theAttribute);
84 /// If there is no operation in current session, start operation for modify parameters
85 void openTransaction();
87 /// Checks whether the selection presentation contains preview planes
88 /// \param theValue a selection information
89 /// \return a boolean value
90 virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& theValue);
92 /// Saves the internal parameters to the given feature
93 /// \return True in success
94 virtual bool storeValueCustom() const;
96 virtual bool restoreValueCustom();
98 /// Retunrs attribute, which should be validated. In default implementation,
99 /// this is an attribute of ID
100 /// \return an attribute
101 virtual AttributePtr attribute() const;
103 /// Sets the selection control visible and set the current widget as active in property panel
104 /// It leads to connect to onSelectionChanged slot
105 void activateSelectionControl();
107 /// Visualization of the current control or others in PP
108 /// \param theSelectionControl state whether the control should be shown/hidden
109 void setVisibleSelectionControl(const bool theSelectionControl);
111 /// Retunrs a list of possible shape types
112 /// \return a list of shapes
113 virtual QIntList getShapeTypes() const;
115 /// Emits model changed info, updates the current control by selection change
116 /// \param theDone a state whether the selection is set
117 void updateOnSelectionChanged(const bool theDone);
120 /// Slot which is called on selection event
121 virtual void onSelectionChanged();
124 /// Returns true if the selection mode is active. This is when composition feature has no
125 /// a sub-object and the attribute list is empty
126 /// \return boolean value
127 bool isSelectionMode() const;
130 void onResumed(ModuleBase_Operation* theOp);
133 /// Append new Sketch, set the selected plane for the sketch and start Edit operation.
134 /// \param theValues a selection list
135 /// \return true if the sketch is started
136 bool startSketchOperation(const QList<ModuleBase_ViewerPrs>& theValues);
139 std::string myAttributeListID;
141 PartSet_Module* myModule;
143 /// Flag if the attribute() should return the attribute list ID or XML attribute
144 /// to store selection and check validation
145 bool myIsCustomAttribute;
147 /// Label of the widget
150 /// Input control of the widget
151 QLineEdit* myTextLine;
153 /// List of accepting shapes types
154 QStringList myShapeTypes;
156 /// class to show/hide preview planes
157 PartSet_PreviewPlanes* myPreviewPlanes;