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                                 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 updateViewer    ();
 103
 104   void prepareSelection( const ObjectList&, const int );
 105   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
 106
 107   void addInStudy      ( GEOM::GEOM_Object_ptr, const char* theName );
 108
 109   bool openCommand     ();
 110   bool abortCommand    ();
 111   bool commitCommand   ( const char* = 0 );
 112   bool hasCommand      () const;
 113
 114   void updateObjBrowser() const;
 115   int  getStudyId      () const;
 116   SalomeApp_Study* getStudy  () const;
 117   bool checkViewWindow ();
 118
 119   bool onAccept( const bool publish = true, const bool useTransaction = true );
 120   // This method should be called from "OK" button handler.
 121   // <publish> == true means that objects returned by execute()
 122   // should be published in a study.
 123
 124   void showError();
 125   // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
 126   void showError( const QString& msg );
 127   // Shows a error message followed by <msg>
 128
 129   GEOM::GEOM_IOperations_ptr getOperation();
 130   // If <myOperation> is nil --> calls createOperation() and put the result
 131   // into <myOperation> and returns it;
 132   // otherwise, simply returns <myOperation>
 133
 134   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
 135   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
 136
 137   const SALOME_ListIO& selectedIO();
 138   // Function returns a list of SALOME_InteractiveObject's from
 139   // selection manager in GUI
 140
 141   int   IObjectCount() ;
 142   // Function returns the number of selected objects
 143
 144   Handle(SALOME_InteractiveObject) firstIObject() ;
 145   // Function returns the first selected object in the list
 146   // of selected objects
 147
 148   Handle(SALOME_InteractiveObject) lastIObject() ;
 149   // Function returns the last selected object in the list
 150   // of selected objects
 151
 152   bool selectObjects( ObjectList& objects );
 153   // Selects list of objects
 154
 155   ////////////////////////////////////////////////////////////////////////////
 156   // Virtual methods, to be redefined in dialog classes
 157   ////////////////////////////////////////////////////////////////////////////
 158
 159   virtual GEOM::GEOM_IOperations_ptr createOperation();
 160   // This method should be redefined in dialog boxes so as to return
 161   // proper GEOM_IOperation interface.
 162   // Returns nil reference by default
 163
 164   virtual bool isValid( QString& msg );
 165   // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
 166
 167   virtual bool execute( ObjectList& objects );
 168   // This method is called by onAccept().
 169   // It should perform the required operation and put all new or modified objects into
 170   // <objects> argument.Should return <false> if some error occurs during its execution.
 171
 172   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
 173   // This method is called by addInStudy(). It should return a father object
 174   // for <theObj> or a nil reference if <theObj> should be published
 175   // as a top-level object.
 176
 177   virtual const char* getNewObjectName() const;
 178
 179   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
 180   bool IsPreview() {return isPreview;}
 181
 182   GEOM_Displayer*             getDisplayer();
 183   SUIT_Desktop*               getDesktop() const;
 184
 185 private:
 186   char* getEntry              ( GEOM::GEOM_Object_ptr ) const;
 187   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
 188
 189 private:
 190   typedef std::list<SALOME_Prs*> PrsList;
 191
 192   PrsList                     myPreview;
 193   GEOM_Displayer*             myDisplayer;
 194   GEOM_Operation*             myCommand;
 195   GEOM::GEOM_IOperations_var  myOperation;
 196   SUIT_ViewWindow*            myViewWindow;
 197   QString                     myPrefix;
 198   bool                        isPreview;
 199   SALOME_ListIO               mySelected;
 200   SUIT_Desktop*               myDesktop;
 201
 202 };
 203
 204 #endif