+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModuleBase_WidgetShapeSelector.h
// Created: 2 June 2014
// Author: Vitaly Smetannikov
#define ModuleBase_WidgetShapeSelector_H
#include "ModuleBase.h"
-#include "ModuleBase_ModelWidget.h"
+#include "ModuleBase_WidgetValidated.h"
#include "ModuleBase_ViewerFilters.h"
+#include <ModuleBase_ViewerPrs.h>
#include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
#include <GeomAPI_Shape.h>
#include <TopAbs_ShapeEnum.hxx>
class QToolButton;
class ModuleBase_IWorkshop;
-class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_ModelWidget
+/**
+* \ingroup GUI
+* Implementation of widget for shapes selection.
+* This type of widget can be defined in XML file with 'shape_selector' keyword.
+* For example:
+* \code
+* <shape_selector id="main_object"
+* label="Main object"
+* icon=":icons/cut_shape.png"
+* tooltip="Select an object solid"
+* shape_types="solid shell"
+* concealment="true"
+* />
+* \endcode
+* It can use following parameters:
+* - id - name of object attribute
+* - label - content of widget's label
+* - icon - icon which can be used instead label
+* - tooltip - the witget's tooltip text
+* - shape_types - list of shape types for selection.
+* Possible values: face, vertex, wire, edge, shell, solid
+* - object_types - types of selectable objects.
+* For today it supports only one type "construction"
+* which corresponds to ModelAPI_ResultConstruction object type
+* - concealment - hide or not hide selected object after operation
+*/
+class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetValidated
{
Q_OBJECT
public:
+
+ /// Converts string value (name of shape type) to shape enum value
+ /// \param theType - string with shape type name
+ /// \return TopAbs_ShapeEnum value
static TopAbs_ShapeEnum shapeType(const QString& theType);
+ /// Constructor
+ /// \param theParent the parent object
+ /// \param theWorkshop instance of workshop interface
+ /// \param theData the widget configuation. The attribute of the model widget is obtained from
+ /// \param theParentId is Id of a parent of the current attribute
ModuleBase_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
const Config_WidgetAPI* theData, const std::string& theParentId);
virtual ~ModuleBase_WidgetShapeSelector();
- /// Saves the internal parameters to the given feature
- virtual bool storeValue() const;
-
virtual bool restoreValue();
- /// Returns the internal parent wiget control, that can be shown anywhere
- /// \returns the widget
- QWidget* getControl() const
- {
- return myContainer;
- }
+ /// Defines if it is supposed that the widget should interact with the viewer.
+ virtual bool isViewerSelector() { return true; }
/// Returns list of widget controls
/// \return a control list
virtual QList<QWidget*> getControls() const;
- ObjectPtr selectedFeature() const
- {
- return mySelectedObject;
- }
-
- /// Set the given wrapped value to the current widget
- /// This value should be processed in the widget according to the needs
- /// \param theValue the wrapped widget value
- virtual bool setSelection(ModuleBase_ViewerPrs theValue);
-
-
- /// The methiod called when widget is activated
- virtual void activate();
+ /// Fills the attribute with the value of the selected owner
+ /// \param theOwner a selected owner
+ virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
/// The methiod called when widget is deactivated
virtual void deactivate();
-
public slots:
/// Activate or deactivate selection
void activateSelection(bool toActivate);
private slots:
+ /// Slot which is called on selection event
void onSelectionChanged();
protected:
- void updateSelectionName();
- void raisePanel() const;
+ /// Saves the internal parameters to the given feature
+ /// \return True in success
+ virtual bool storeValueCustom() const;
- /// Returns true if shape of given object corresponds to requested shape type
- /// This method is called only in non sub-shapes selection mode
- virtual bool acceptObjectShape(const ObjectPtr theObject) const;
+ /// The methiod called when widget is activated
+ virtual void activateCustom();
- /// Returns true if selected shape corresponds to requested shape types
- /// This method is called only in sub-shapes selection mode
- virtual bool acceptSubShape(std::shared_ptr<GeomAPI_Shape> theShape) const;
+ /// Creates a backup of the current values of the attribute
+ /// It should be realized in the specific widget because of different
+ /// parameters of the current attribute
+ virtual void storeAttributeValue();
+
+ /// Creates a backup of the current values of the attribute
+ /// It should be realized in the specific widget because of different
+ /// parameters of the current attribute
+ /// \param theValid a boolean flag, if restore happens for valid parameters
+ virtual void restoreAttributeValue(const bool theValid);
- /// Returns true if selected object corresponds to requested Object type
- /// Thid method is used in any selection mode
- virtual bool acceptObjectType(const ObjectPtr theObject) const;
+ /// Computes and updates name of selected object in the widget
+ void updateSelectionName();
+ /// Raise panel which contains this widget
+ void raisePanel() const;
- // Set the given object as a value of the widget
- void setObject(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape = std::shared_ptr<GeomAPI_Shape>());
+ /// Returns true if selected shape corresponds to requested shape types
+ /// \param theShape a shape
+ virtual bool acceptSubShape(std::shared_ptr<GeomAPI_Shape> theShape) const;
- /// Check the selected with validators if installed
- virtual bool isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape);
+ // Get the shape from the attribute it the attribute contain a shape, e.g. selection attribute
+ /// \return a shape
+ GeomShapePtr getShape() const;
/// Clear attribute
void clearAttribute();
+ /// Store the values to the model attribute of the widget. It casts this attribute to
+ /// the specific type and set the given values
+ /// \param theSelectedObject an object
+ /// \param theShape a selected shape, which is used in the selection attribute
+ /// \return true if it is succeed
+ virtual bool setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
+
//----------- Class members -------------
- protected:
- QWidget* myContainer;
+ protected:
+ /// Label of the widget
QLabel* myLabel;
+
+ /// Input control of the widget
QLineEdit* myTextLine;
+ /// Reference to workshop
ModuleBase_IWorkshop* myWorkshop;
- ObjectPtr mySelectedObject;
- std::shared_ptr<GeomAPI_Shape> myShape;
-
+ /// List of accepting shapes types
QStringList myShapeTypes;
- QStringList myObjectTypes;
-
- /// If true then local selector has to be activated in context
- bool myUseSubShapes;
+ /// Active/inactive flag
bool myIsActive;
- Handle(ModuleBase_ObjectTypesFilter) myObjTypeFilter;
+ /// backup parameters of the model attribute. The class processes three types of attribute:
+ /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
+ /// values are reserved in the backup
+ /// An attribute object
+ ObjectPtr myObject;
+ /// An attribute shape
+ GeomShapePtr myShape;
+ /// A reference of the attribute
+ AttributePtr myRefAttribute;
+ /// A boolean value whether refAttr uses reference of object
+ bool myIsObject;
};
#endif
