ModuleBase_WidgetValidated.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef MODULEBASE_WIDGETVALIDATED_H_
#define MODULEBASE_WIDGETVALIDATED_H_
 
#include <ModuleBase.h>
#include <ModuleBase_ModelWidget.h>
 
#include <GeomAPI_Shape.h>
#include <GeomAPI_AISObject.h>
#include <ModelAPI_Object.h>
#include <ModelAPI_Attribute.h>
#include <ModelAPI_ResultBody.h>
 
#include <SelectMgr_ListOfFilter.hxx>
#include <NCollection_DataMap.hxx>
#include <TopoDS_Shape.hxx>
#include <AIS_NListOfEntityOwner.hxx>
 
#include <QList>
#include <QMap>
 
class QWidget;
class ModuleBase_IWorkshop;
class ModuleBase_ISelection;
class ModuleBase_WidgetSelectorStore;
class ModelAPI_Validator;
class Config_WidgetAPI;
 
//#define LIST_OF_VALID_PRS
 
class MODULEBASE_EXPORT ModuleBase_WidgetValidated : public ModuleBase_ModelWidget
{
  Q_OBJECT
 public:
  ModuleBase_WidgetValidated(QWidget* theParent,
                             ModuleBase_IWorkshop* theWorkshop,
                             const Config_WidgetAPI* theData);
  virtual ~ModuleBase_WidgetValidated();
 
  virtual bool isValidSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue);
 
  ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
 
  virtual void deactivate();
 
  void clearValidatedCash();
 
  bool isFilterActivated() const;
 
  virtual void selectionFilters(QIntList& theModuleSelectionFilters,
                                SelectMgr_ListOfFilter& theSelectionFilters);
 
  static void blockFeatureAttribute(const AttributePtr& theAttribute,
                                    const FeaturePtr& theFeature,
                                    const bool& theToBlock,
                                    bool& isFlushesActived,
                                    bool& isAttributeSetInitializedBlocked,
                                    bool& isAttributeSendUpdatedBlocked);
 
  static bool isValidAttribute(const AttributePtr& theAttribute);
 
protected:
  virtual bool isValidInFilters(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
  bool isValidSelectionForAttribute(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue,
                                    const AttributePtr& theAttribute);
 
  virtual AttributePtr attribute() const;
 
  virtual void storeAttributeValue(const AttributePtr& theAttribute);
 
  virtual void restoreAttributeValue(const AttributePtr& theAttribute, const bool theValid);
 
  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
  virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs) = 0;
 
  QList<std::shared_ptr<ModuleBase_ViewerPrs>> getFilteredSelected();
 
  virtual void blockAttribute(const AttributePtr& theAttribute, const bool& theToBlock,
                              bool& isFlushesActived, bool& isAttributeSetInitializedBlocked,
                              bool& isAttributeSendUpdatedBlocked);
 
protected:
  bool getValidState(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue, bool& theValid);
 
  void storeValidState(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue, const bool theValid);
 
private:
  void filterPresentations(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 
  void filterCompSolids(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 
  void collectSubBodies(const ResultBodyPtr& theBody, AIS_NListOfEntityOwner& theList);
 
protected:
  ModuleBase_IWorkshop* myWorkshop;
  bool myIsInValidate;
 
private:
  ObjectPtr myPresentedObject; 
#ifdef LIST_OF_VALID_PRS
  QList<std::shared_ptr<ModuleBase_ViewerPrs>> myValidPrs;
 
  QList<std::shared_ptr<ModuleBase_ViewerPrs>> myInvalidPrs;
#else
  // assume that one presentation selection presentation corresponds only one shape
  NCollection_DataMap<TopoDS_Shape, std::shared_ptr<ModuleBase_ViewerPrs> > myValidPrs;
  NCollection_DataMap<TopoDS_Shape, std::shared_ptr<ModuleBase_ViewerPrs> > myInvalidPrs;
#endif
 
  ModuleBase_WidgetSelectorStore* myAttributeStore;
};
 
#endif /* MODULEBASE_WIDGETVALIDATED_H_ */