src/GEOMBase/GEOMBase_Helper.h

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 // GEOM GEOMGUI : GUI for Geometry component
  24 // File   : GEOMBase_Helper.h
  25 // Author : Sergey ANIKIN, Open CASCADE S.A.S. (sergey.anikin@opencascade.com)
  26
  27 #ifndef GEOMBASE_HELPER_H
  28 #define GEOMBASE_HELPER_H
  29
  30 #include "GEOM_GEOMBase.hxx"
  31 #include "GEOM_GenericObjPtr.h"
  32
  33 #include <GEOM_Displayer.h>
  34 #include <SALOME_ListIO.hxx>
  35 #include <SALOMEconfig.h>
  36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
  37
  38 #include <QString>
  39 #include <QMap>
  40
  41 #include <list>
  42
  43 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
  44
  45 class SalomeApp_Study;
  46 class SUIT_Desktop;
  47 class SUIT_ViewWindow;
  48 class SALOME_Prs;
  49 class GEOM_Operation;
  50 class TColStd_MapOfInteger;
  51
  52 //================================================================
  53 // Class       : GEOMBase_Helper
  54 // Description : Helper class for dialog box development, can be used as
  55 //               the second base class for dialog boxes. Contains convenient methods
  56 //               performing common operations (display/erase, selection activation,
  57 //               publication in a study, transaction management)
  58 //================================================================
  59 class GEOMBASE_EXPORT GEOMBase_Helper
  60 {
  61 public:
  62   GEOMBase_Helper( SUIT_Desktop* );
  63   virtual ~GEOMBase_Helper();
  64
  65 protected:
  66   static GEOM::GEOM_Gen_ptr getGeomEngine();
  67
  68   void display         ( const ObjectList&, const bool = true );
  69   void display         ( GEOM::GEOM_Object_ptr, const bool = true );
  70   void erase           ( const ObjectList&, const bool = true );
  71   void erase           ( GEOM::GEOM_Object_ptr, const bool = true );
  72   void redisplay       ( const ObjectList&, const bool = true, const bool = true );
  73   void redisplay       ( GEOM::GEOM_Object_ptr, const bool = true, const bool = true );
  74
  75   virtual void displayPreview ( const bool   display,
  76                                 const bool   activate = false,
  77                                 const bool   update = true,
  78                                 const bool   toRemoveFromEngine = true,
  79                                 const double lineWidth = -1,
  80                                 const int    displayMode = -1,
  81                                 const int    color  = -1 );
  82   // This is the easiest way to show preview. It is based on execute() method.
  83   // It removes temporary GEOM::GEOM_Objects automatically.
  84
  85   virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj,
  86                                  const bool   append = false,
  87                                  const bool   activate = false,
  88                                  const bool   update = true,
  89                                  const double lineWidth = -1,
  90                                  const int    displayMode = -1,
  91                                  const int    color  = -1 );
  92   void displayPreview  ( const SALOME_Prs* prs,
  93                          const bool append = false,
  94                          const bool = true );
  95   void erasePreview    ( const bool = true );
  96
  97   void localSelection( const ObjectList&, const int );
  98   void localSelection( GEOM::GEOM_Object_ptr, const int );
  99   void activate( const int );
 100   void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
 101   void globalSelection( const TColStd_MapOfInteger&, const bool = false );
 102   void globalSelection( const TColStd_MapOfInteger&, const QList<int>& ,const bool = false );
 103   void updateViewer    ();
 104
 105   void prepareSelection( const ObjectList&, const int );
 106   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
 107
 108   QString addInStudy   ( GEOM::GEOM_Object_ptr, const char* theName );
 109
 110   bool openCommand     ();
 111   bool abortCommand    ();
 112   bool commitCommand   ( const char* = 0 );
 113   bool hasCommand      () const;
 114
 115   void updateObjBrowser() const;
 116   int  getStudyId      () const;
 117   SalomeApp_Study* getStudy  () const;
 118   bool checkViewWindow ();
 119
 120   bool onAccept( const bool publish = true, const bool useTransaction = true, bool erasePreviewFlag = true);
 121   // This method should be called from "OK" button handler.
 122   // <publish> == true means that objects returned by execute()
 123   // should be published in a study.
 124
 125   void showError();
 126   // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
 127   void showError( const QString& msg );
 128   // Shows a error message followed by <msg>
 129
 130   GEOM::GEOM_IOperations_ptr getOperation();
 131   // If <myOperation> is nil --> calls createOperation() and put the result
 132   // into <myOperation> and returns it;
 133   // otherwise, simply returns <myOperation>
 134
 135   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
 136   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
 137
 138   bool selectObjects( ObjectList& objects );
 139   // Selects list of objects
 140
 141   ////////////////////////////////////////////////////////////////////////////
 142   // Virtual methods, to be redefined in dialog classes
 143   ////////////////////////////////////////////////////////////////////////////
 144
 145   virtual GEOM::GEOM_IOperations_ptr createOperation();
 146   // This method should be redefined in dialog boxes so as to return
 147   // proper GEOM_IOperation interface.
 148   // Returns nil reference by default
 149
 150   virtual bool isValid( QString& msg );
 151   // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
 152
 153   virtual bool execute( ObjectList& objects );
 154   // This method is called by onAccept().
 155   // It should perform the required operation and put all new or modified objects into
 156   // <objects> argument.Should return <false> if some error occurs during its execution.
 157
 158   virtual void restoreSubShapes( SALOMEDS::Study_ptr theStudy, SALOMEDS::SObject_ptr theSObject );
 159   // This method is called by addInStudy().
 160
 161   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
 162   // This method is called by addInStudy(). It should return a father object
 163   // for <theObj> or a nil reference if <theObj> should be published
 164   // as a top-level object.
 165
 166   virtual QString getNewObjectName (int CurrObj = -1) const;
 167   virtual QString getObjectName(GEOM::GEOM_Object_ptr object) const;
 168   virtual bool extractPrefix() const;
 169   virtual void addSubshapesToStudy();
 170
 171   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const QString& theName );
 172   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, int theIndex );
 173   // These methods are used to find published sub-object (sub-shape) in the parent object (main shape)
 174
 175   GEOM::GeomObjPtr        getSelected( TopAbs_ShapeEnum type );
 176   GEOM::GeomObjPtr        getSelected( const QList<TopAbs_ShapeEnum>& types );
 177   QList<GEOM::GeomObjPtr> getSelected( TopAbs_ShapeEnum type, int count, bool strict = true );
 178   QList<GEOM::GeomObjPtr> getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict = true );
 179
 180   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
 181   bool IsPreview() {return isPreview;}
 182
 183   GEOM_Displayer*             getDisplayer();
 184   SUIT_Desktop*               getDesktop() const;
 185
 186   virtual void                setIsApplyAndClose( const bool theFlag );
 187   virtual bool                isApplyAndClose() const;
 188
 189   virtual void                setIsOptimizedBrowsing( const bool theFlag );
 190   virtual bool                isOptimizedBrowsing() const;
 191
 192   virtual void                setIsWaitCursorEnabled( const bool theFlag ) {myIsWaitCursorEnabled = theFlag;}
 193   virtual bool                isWaitCursorEnabled() const {return myIsWaitCursorEnabled ;}
 194   virtual void                setIsDisableBrowsing( const bool theFlag ) { myIsDisableBrowsing = theFlag; }
 195   virtual bool                isDisableBrowsing() const { return myIsDisableBrowsing; }
 196   virtual void                setIsDisplayResult( const bool theFlag ) {myIsDisplayResult = theFlag; }
 197   virtual bool                isDisplayResult() const { return myIsDisplayResult; }
 198
 199 private:
 200   QString                     getEntry( GEOM::GEOM_Object_ptr ) const;
 201   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
 202
 203 private:
 204   typedef std::list<SALOME_Prs*> PrsList;
 205
 206   PrsList                     myPreview;
 207   GEOM_Displayer*             myDisplayer;
 208   GEOM_Operation*             myCommand;
 209   GEOM::GEOM_IOperations_var  myOperation;
 210   SUIT_ViewWindow*            myViewWindow;
 211   QString                     myPrefix;
 212   bool                        isPreview;
 213   SALOME_ListIO               mySelected;
 214   SUIT_Desktop*               myDesktop;
 215   bool                        myIsApplyAndClose;
 216   bool                        myIsOptimizedBrowsing;
 217   bool                        myIsWaitCursorEnabled;
 218   bool                        myIsDisableBrowsing;  //This flag enable/disable selection
 219                                                     //in the Object Browser newly created objects.
 220   bool                        myIsDisplayResult;    //This flag display/hide newly created objects.
 221 };
 222
 223 #endif // GEOMBASE_HELPER_H