src/GEOMBase/GEOMBase_Helper.h

   1 //  GEOM GEOMGUI : GUI for Geometry component
   2 //
   3 //  Copyright (C) 2004  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 //
  24 //  File   : GEOMBase_Helper.h
  25 //  Author : Sergey ANIKIN
  26 //  Module : GEOM
  27 //  $Header$
  28
  29 #ifndef GEOMBASE_HELPER_H
  30 #define GEOMBASE_HELPER_H
  31
  32 #include "GEOM_GEOMBase.hxx"
  33
  34 #include "GEOM_Displayer.h"
  35 #include "SALOME_Prs.h"
  36 #include "SALOME_ListIO.hxx"
  37 #include <SALOMEconfig.h>
  38 #include CORBA_CLIENT_HEADER(GEOM_Gen)
  39
  40 #include <qstring.h>
  41
  42 #include <list>
  43
  44 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
  45
  46 class SalomeApp_Study;
  47 class SUIT_Desktop;
  48 class SUIT_ViewWindow;
  49 class GEOM_Operation;
  50 class TopoDS_Shape;
  51 class TColStd_MapOfInteger;
  52
  53 //================================================================
  54 // Class       : GEOMBase_Helper
  55 // Description : Helper class for dialog box development, can be used as
  56 //               the second base class for dialog boxes. Contains convenient methods
  57 //               performing common operations (display/erase, selection activation,
  58 //               publication in a study, transaction management)
  59 //================================================================
  60 class GEOMBASE_EXPORT GEOMBase_Helper
  61 {
  62 public:
  63   GEOMBase_Helper( SUIT_Desktop* );
  64   virtual ~GEOMBase_Helper();
  65
  66 protected:
  67   static GEOM::GEOM_Gen_ptr getGeomEngine();
  68
  69   void display         ( const ObjectList&, const bool = true );
  70   void display         ( GEOM::GEOM_Object_ptr, const bool = true );
  71   void erase           ( const ObjectList&, const bool = true );
  72   void erase           ( GEOM::GEOM_Object_ptr, const bool = true );
  73   void redisplay       ( const ObjectList&, const bool = true, const bool = true );
  74   void redisplay       ( GEOM::GEOM_Object_ptr, const bool = true, const bool = true );
  75
  76   virtual void displayPreview ( const bool   activate = false,
  77                                 const bool   update = true,
  78                                 const bool   toRemoveFromEngine = true,
  79                                 const double lineWidth = -1 );
  80   // This is the easiest way to show preview. It is based on execute() method.
  81   // It removes temporary GEOM::GEOM_Objects automatically.
  82
  83   virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj,
  84                                  const bool   append = false,
  85                                  const bool   activate = false,
  86                                  const bool   update = true,
  87                                  const double lineWidth = -1 );
  88   void displayPreview  ( const SALOME_Prs* prs,
  89                          const bool append = false,
  90                          const bool = true );
  91   void erasePreview    ( const bool = true );
  92
  93   void localSelection( const ObjectList&, const int );
  94   void localSelection( GEOM::GEOM_Object_ptr, const int );
  95   void activate( const int );
  96   void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
  97   void globalSelection( const TColStd_MapOfInteger&, const bool = false );
  98   void updateViewer    ();
  99
 100   void prepareSelection( const ObjectList&, const int );
 101   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
 102
 103   void addInStudy      ( GEOM::GEOM_Object_ptr, const char* theName );
 104
 105   bool openCommand     ();
 106   bool abortCommand    ();
 107   bool commitCommand   ( const char* = 0 );
 108   bool hasCommand      () const;
 109
 110   void updateObjBrowser() const;
 111   int  getStudyId      () const;
 112   SalomeApp_Study* getStudy  () const;
 113   bool checkViewWindow ();
 114
 115   bool onAccept( const bool publish = true, const bool useTransaction = true );
 116   // This method should be called from "OK" button handler.
 117   // <publish> == true means that objects returned by execute()
 118   // should be published in a study.
 119
 120   void showError();
 121   // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
 122   void showError( const QString& msg );
 123   // Shows a error message followed by <msg>
 124
 125   GEOM::GEOM_IOperations_ptr getOperation();
 126   // If <myOperation> is nil --> calls createOperation() and put the result
 127   // into <myOperation> and returns it;
 128   // otherwise, simply returns <myOperation>
 129
 130   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
 131   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
 132
 133   const SALOME_ListIO& selectedIO();
 134   // Function returns a list of SALOME_InteractiveObject's from
 135   // selection manager in GUI
 136
 137   int   IObjectCount() ;
 138   // Function returns the number of selected objects
 139
 140   Handle(SALOME_InteractiveObject) firstIObject() ;
 141   // Function returns the first selected object in the list
 142   // of selected objects
 143
 144   Handle(SALOME_InteractiveObject) lastIObject() ;
 145   // Function returns the last selected object in the list
 146   // of selected objects
 147
 148   ////////////////////////////////////////////////////////////////////////////
 149   // Virtual methods, to be redefined in dialog classes
 150   ////////////////////////////////////////////////////////////////////////////
 151
 152   virtual GEOM::GEOM_IOperations_ptr createOperation();
 153   // This method should be redefined in dialog boxes so as to return
 154   // proper GEOM_IOperation interface.
 155   // Returns nil reference by default
 156
 157   virtual bool isValid( QString& msg );
 158   // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
 159
 160   virtual bool execute( ObjectList& objects );
 161   // This method is called by onAccept().
 162   // It should perform the required operation and put all new or modified objects into
 163   // <objects> argument.Should return <false> if some error occurs during its execution.
 164
 165   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
 166   // This method is called by addInStudy(). It should return a father object
 167   // for <theObj> or a nil reference if <theObj> should be published
 168   // as a top-level object.
 169
 170   virtual const char* getNewObjectName() const;
 171
 172   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
 173   bool IsPreview() {return isPreview;}
 174
 175   GEOM_Displayer*             getDisplayer();
 176   SUIT_Desktop*               getDesktop() const;
 177
 178 private:
 179   char* getEntry              ( GEOM::GEOM_Object_ptr ) const;
 180   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
 181
 182 private:
 183   typedef std::list<SALOME_Prs*> PrsList;
 184
 185   PrsList                     myPreview;
 186   GEOM_Displayer*             myDisplayer;
 187   GEOM_Operation*             myCommand;
 188   GEOM::GEOM_IOperations_var  myOperation;
 189   SUIT_ViewWindow*            myViewWindow;
 190   QString                     myPrefix;
 191   bool                        isPreview;
 192   SALOME_ListIO               mySelected;
 193   SUIT_Desktop*               myDesktop;
 194
 195 };
 196
 197 #endif