Salome HOME
Merge branch 'V9_9_BR'
[modules/smesh.git] / src / SMESHGUI / SMESHGUI_Hypotheses.h
index 431ca2294c04d15c743108f7608644971ac8c26f..fb41e7adbdea80368e04ad0617c063be3bc82453 100644 (file)
-//  SMESH SMESHGUI : GUI for SMESH component
+// Copyright (C) 2007-2022  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003  CEA
-// 
-//  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. 
-// 
-//  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.org
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
+// 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.
 //
-//  File   : SMESHGUI_Hypotheses.h
-//  Author : Julia DOROVSKIKH
-//  Module : SMESH
-//  $Header$
+// 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
+//
+
+// SMESH SMESHGUI : GUI for SMESH component
+// File   : SMESHGUI_Hypotheses.h
+// Author : Julia DOROVSKIKH, Open CASCADE S.A.S.
+//
+#ifndef SMESHGUI_HYPOTHESES_H
+#define SMESHGUI_HYPOTHESES_H
+
+// SMESH includes
+#include "SMESH_SMESHGUI.hxx"
+#include "SMESHGUI_HypothesesUtils.h"
 
-#ifndef SMESHGUI_Hypotheses_HeaderFile
-#define SMESHGUI_Hypotheses_HeaderFile
+// Qt includes
+#include <QtxDialog.h>
+#include <QVariant>
 
+// IDL includes
 #include <SALOMEconfig.h>
 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
 
-// QT Includes
-#include <qstring.h>
-#include <qwidget.h>
-#include <qvaluevector.h>
-#include <qstringlist.h>
+class QEventLoop;
 
 /*!
  * \brief Auxiliary class for creation of hypotheses
 */
-class SMESHGUI_GenericHypothesisCreator
+class SMESHGUI_EXPORT SMESHGUI_GenericHypothesisCreator : public QObject
+{
+  Q_OBJECT
+
+public:
+  SMESHGUI_GenericHypothesisCreator( const QString& );
+  virtual ~SMESHGUI_GenericHypothesisCreator();
+
+  void                         create( SMESH::SMESH_Hypothesis_ptr,
+                                       const QString&, QWidget*, QObject*, const QString& );
+  void                         create( bool, const QString&, QWidget*, QObject*, const QString& );
+  void                         edit( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*, QObject*, const QString& );
+  void                         setInitParamsHypothesis(SMESH::SMESH_Hypothesis_ptr);
+
+  virtual bool                 checkParams( QString& ) const;
+  virtual void                 onReject();
+  virtual QString              helpPage() const;
+
+  QString                      hypType() const;
+  QString                      hypName() const;
+  bool                         isCreation() const;
+  
+  QString                      getShapeEntry() const { return myShapeEntry; }
+  void                         setShapeEntry( const QString& theEntry );
+
+  QString                      getMainShapeEntry() const { return myMainShapeEntry; }
+  void                         setMainShapeEntry( const QString& theEntry ) { myMainShapeEntry = theEntry; }
+
+  void                         setNoGeomMesh( const bool noGeom ) { myNoGeomMesh = noGeom; }
+  bool                         getNoGeomMesh() const { return myNoGeomMesh; }
+
+signals:
+  void                         finished( int );
+
+protected:
+  struct StdParam
+  {
+    QString    myName;
+    QVariant   myValue;
+    bool       isVariable;
+    QString    myText;
+    QByteArray myTextAsBytes;
+    StdParam() {
+      isVariable = false;
+    }
+    const char* text() const {
+      ((QByteArray&) myTextAsBytes) = myText.toUtf8(); return myTextAsBytes.constData();
+    }
+    void setNoName() { myName.clear(); } // ==> widget occupies both columns
+    bool hasName() const { return !myName.isEmpty(); }
+  };
+
+  typedef QList<StdParam>      ListOfStdParams;
+  typedef QList<QWidget*>      ListOfWidgets;
+
+  SMESH::SMESH_Hypothesis_var  hypothesis() const;
+  SMESH::SMESH_Hypothesis_var  initParamsHypothesis(const bool strict=false) const;
+  bool                         hasInitParamsHypothesis() const;
+  const ListOfWidgets&         widgets() const;
+  ListOfWidgets&               changeWidgets();
+  QLabel*                      getLabel(int i) const;
+  QtxDialog*                   dlg() const;
+  QString                      getVariableName(const char* methodName) const;
+
+  virtual QFrame*              buildFrame() = 0;
+          QFrame*              buildStdFrame();
+  virtual void                 retrieveParams() const = 0;
+  virtual QString              storeParams() const = 0;
+  virtual bool                 stdParams( ListOfStdParams& ) const;
+  bool                         getStdParamFromDlg( ListOfStdParams& ) const;
+  virtual QStringList          getVariablesFromDlg() const;
+  static  QString              stdParamValues( const ListOfStdParams& );
+  virtual void                 attuneStdWidget( QWidget*, const int ) const;
+  virtual QWidget*             getCustomWidget( const StdParam&, 
+                                                QWidget*, const int ) const;
+  virtual QWidget*             getHelperWidget() const;
+  virtual bool                 getParamFromCustomWidget( StdParam&, QWidget* ) const;
+  virtual void                 valueChanged( QWidget* );
+  virtual QString              caption() const;
+  virtual QPixmap              icon() const;
+  virtual QString              type() const;
+
+protected slots:
+  virtual void                 onValueChanged();
+
+private slots:
+  virtual void                 onDialogFinished( int );
+
+private:
+  void                         editHypothesis( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*, QObject* obj, const QString& );
+
+private:
+  SMESH::SMESH_Hypothesis_var  myHypo, myInitParamsHypo;
+  bool                         myToDeleteInitParamsHypo;
+  QString                      myHypName;
+  QString                      myHypType;
+  ListOfWidgets                myParamWidgets;
+  ListOfWidgets                myParamLabels;
+  bool                         myIsCreate;
+  bool                         myNoGeomMesh; //!< true for a mesh not based on geometry
+  QtxDialog*                   myDlg;
+  QString                      myShapeEntry;
+  QString                      myMainShapeEntry;
+};
+
+class SMESHGUI_HypothesisDlg : public QtxDialog
 {
-  public:
-  virtual void CreateHypothesis (const bool isAlgo, QWidget* parent) = 0;
-  virtual void EditHypothesis (SMESH::SMESH_Hypothesis_ptr theHyp) = 0;
+  Q_OBJECT
+
+public:
+  SMESHGUI_HypothesisDlg( SMESHGUI_GenericHypothesisCreator*, QWidget* );
+  virtual ~SMESHGUI_HypothesisDlg();
+
+  void setHIcon( const QPixmap& );
+  void setCustomFrame( QFrame* );
+  void setType( const QString& );
+  void showEvent(QShowEvent *event);
+
+protected slots:
+  virtual void accept();
+  virtual void reject();
+  void onHelp();
+
+ private:
+  SMESHGUI_GenericHypothesisCreator* myCreator;
+  QLabel *myIconLabel, *myTypeLabel;
+  QString myHelpFileName;
 };
 
 /*!
- * \brief Class containing information about hypothesis
-*/
-class HypothesisData
+ * \brief Information about a hypothesis
+ */
+struct HypothesisData
 {
- public:
-  HypothesisData( const QString& thePluginName,
-                  const QString& theServerLibName,
-                  const QString& theClientLibName,
-                  const QString& theLabel,
-                  const QString& theIconId,
-                  const QValueList<int>& theDim,
-                  const bool theIsAux ) 
-: PluginName( thePluginName ),
-  ServerLibName( theServerLibName ),
-  ClientLibName( theClientLibName ),
-  Label( theLabel ),
-  IconId( theIconId ),
-  Dim( theDim ),
-  IsAux( theIsAux )
- {};
-
- QString PluginName;      //!< plugin name
- QString ServerLibName;   //!< server library name
- QString ClientLibName;   //!< client library name
- QString Label;           //!< label
- QString IconId;          //!< icon identifier
- QValueList<int> Dim;     //!< list of supported dimensions (see SMESH::Dimension enumeration)
- bool IsAux;              //!< TRUE if given hypothesis is auxiliary one, FALSE otherwise
+  HypothesisData( const QString&, const QString&, const QString&,
+                  const QString&, const QString&, const QString&,
+                  const QString&, const int, const int,
+                  const QList<int>&, const bool,
+                  const QStringList&, const QStringList&,
+                  const QStringList&, const QStringList&,
+                  const int, const bool supportSub );
+
+  QString TypeName;        //!< hypothesis type name
+  QString PluginName;      //!< plugin name
+  QString ServerLibName;   //!< server library name
+  QString ClientLibName;   //!< client library name
+  QString Label;           //!< label
+  QString IconId;          //!< icon identifier
+  QString Context;         //!< ["GLOBAL","LOCAL","ANY"(default)]
+  int     GroupID;         //!< group ID (staring from zero)
+  int     Priority;        //!< integer, priority within the group
+  QList<int> Dim;          //!< list of supported dimensions (see SMESH::Dimension enumeration)
+  bool IsAuxOrNeedHyp;     //!< TRUE if given HYPOTHESIS is auxiliary one, FALSE otherwise
+  //!<                          TRUE if given ALGORITHM can't work w/o hypotheses
+  int  IsNeedGeometry;     //!< 1 if the algorithm works with shapes only,
+  //!<                         -1 if the algorithm works without shapes only,
+  //!<                          0 if the algorithm works in both cases
+  bool IsSupportSubmeshes; //!< TRUE if the algorithm building all-dim elems supports sub-meshes
+
+  // for algorithm only: dependencies algo <-> algo and algo -> hypos
+  QStringList BasicHypos;   //!< list of basic hypotheses
+  QStringList OptionalHypos;//!< list of optional hypotheses
+  QStringList InputTypes;   //!< list of element types required as a prerequisite
+  QStringList OutputTypes;  //!< list of types of generated elements
 };
 
 /*!
@@ -85,14 +217,57 @@ class HypothesisData
  */
 class HypothesesSet
 {
- public:
-  HypothesesSet( const QString& theSetName ) 
-    : HypoSetName( theSetName ) {};
-  HypothesesSet( const QString&     theSetName,
-                 const QStringList& theHypoList,
-                 const QStringList& theAlgoList )
-    : HypoSetName( theSetName ), HypoList(theHypoList), AlgoList(theAlgoList) {};
-  QString     HypoSetName;
-  QStringList HypoList, AlgoList;
+public:
+
+  enum SetType { MAIN, ALT, INTERN, NB_HYP_TYPES }; //!< hypos/algos type: main, alternative, internal-edges
+
+  //HypothesesSet( const QString& );
+  HypothesesSet( const QString& name,
+                 bool useCommonSize, bool isQuadDominated,
+                 const QStringList& mainHypos, const QStringList& mainAlgos,
+                 const QStringList& altHypos, const QStringList&  altAlgos,
+                 const QStringList& intHypos, const QStringList&  intAlgos );
+
+  QString name() const;
+  bool toUseCommonSize() const { return myUseCommonSize; }
+  bool isQuadDominated() const { return myQuadDominated; }
+  bool hasAlgo( SetType type ) const { return !myAlgoList[ type ].isEmpty(); }
+  //int count( bool, SetType ) const;
+
+  int maxDim() const;
+
+  void setIsCustom( bool );
+  bool getIsCustom() const;
+
+  void setAlgoAvailable( SetType type, bool isAvailable );
+  bool getAlgoAvailable( SetType type );
+
+  static SetType getPreferredHypType();
+  static const char* getCommonHypoSetHypoType();
+
+  //bool isAlgo() const;
+
+  // CASCADE-like iteration
+  void init( bool, SetType );
+  bool more() const;
+  void next();
+  QString current() const;
+
+private:
+  QStringList* list(bool,SetType) const;
+  QStringList* list() const;
+
+private:
+  bool        myUseCommonSize; // Average size is asked only and used to create default hypotheses
+  bool        myQuadDominated;
+  QString     myHypoSetName;
+  QStringList myHypoList[3], myAlgoList[3]; // per SetType
+  bool        myIsAlgoAvailable[3]; // current state depending on geometry etc
+
+  // iteration
+  SetType myHypType;
+  bool myIsAlgo, myIsCustom;
+  int myIndex;
 };
-#endif
+
+#endif // SMESHGUI_HYPOTHESES_H