]> SALOME platform Git repositories - modules/geom.git/blob - src/GEOMBase/GEOMBase_Helper.h
Salome HOME
Additional fix for bug NPAL19028 (see remarks from Olivier Giorgis).
[modules/geom.git] / 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 #include <qmap.h>
42
43 #include <list>
44
45 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
46
47 class SalomeApp_Study;
48 class SUIT_Desktop;
49 class SUIT_ViewWindow;
50 class GEOM_Operation;
51 class TopoDS_Shape;
52 class TColStd_MapOfInteger;
53
54 //================================================================
55 // Class       : GEOMBase_Helper
56 // Description : Helper class for dialog box development, can be used as 
57 //               the second base class for dialog boxes. Contains convenient methods
58 //               performing common operations (display/erase, selection activation,
59 //               publication in a study, transaction management)
60 //================================================================
61 class GEOMBASE_EXPORT GEOMBase_Helper
62 {
63 public:
64   GEOMBase_Helper( SUIT_Desktop* );
65   virtual ~GEOMBase_Helper();
66
67 protected:
68   static GEOM::GEOM_Gen_ptr getGeomEngine();
69
70   void display         ( const ObjectList&, const bool = true );
71   void display         ( GEOM::GEOM_Object_ptr, const bool = true );
72   void erase           ( const ObjectList&, const bool = true );
73   void erase           ( GEOM::GEOM_Object_ptr, const bool = true );
74   void redisplay       ( const ObjectList&, const bool = true, const bool = true );
75   void redisplay       ( GEOM::GEOM_Object_ptr, const bool = true, const bool = true );
76
77   virtual void displayPreview ( const bool   activate = false, 
78                                 const bool   update = true,
79                                 const bool   toRemoveFromEngine = true,
80                                 const double lineWidth = -1, 
81                                 const int    displayMode = -1,
82                                 const int    color  = -1 );
83   // This is the easiest way to show preview. It is based on execute() method.
84   // It removes temporary GEOM::GEOM_Objects automatically.
85
86   virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj, 
87                                  const bool   append = false, 
88                                  const bool   activate = false, 
89                                  const bool   update = true,
90                                  const double lineWidth = -1, 
91                                  const int    displayMode = -1,
92                                  const int    color  = -1 );
93   void displayPreview  ( const SALOME_Prs* prs, 
94                          const bool append = false, 
95                          const bool = true );
96   void erasePreview    ( const bool = true );
97
98   void localSelection( const ObjectList&, const int );
99   void localSelection( GEOM::GEOM_Object_ptr, const int );
100   void activate( const int );
101   void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
102   void globalSelection( const TColStd_MapOfInteger&, const bool = false );
103   void globalSelection( const TColStd_MapOfInteger&, const QValueList<int>& ,const bool = false );
104   void updateViewer    ();
105
106   void prepareSelection( const ObjectList&, const int );
107   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
108
109   void addInStudy      ( GEOM::GEOM_Object_ptr, const char* theName );
110
111   bool openCommand     ();
112   bool abortCommand    ();
113   bool commitCommand   ( const char* = 0 );
114   bool hasCommand      () const;
115
116   void updateObjBrowser() const;
117   int  getStudyId      () const;
118   SalomeApp_Study* getStudy  () const;
119   bool checkViewWindow ();
120
121   bool onAccept( const bool publish = true, const bool useTransaction = true );
122   // This method should be called from "OK" button handler.
123   // <publish> == true means that objects returned by execute() 
124   // should be published in a study.
125
126   void showError();
127   // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
128   void showError( const QString& msg );
129   // Shows a error message followed by <msg>
130
131   GEOM::GEOM_IOperations_ptr getOperation();
132   // If <myOperation> is nil --> calls createOperation() and put the result
133   // into <myOperation> and returns it;
134   // otherwise, simply returns <myOperation>
135
136   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
137   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
138
139   const SALOME_ListIO& selectedIO();
140   // Function returns a list of SALOME_InteractiveObject's from
141   // selection manager in GUI
142
143   int   IObjectCount() ;
144   // Function returns the number of selected objects
145   
146   Handle(SALOME_InteractiveObject) firstIObject() ;
147   // Function returns the first selected object in the list
148   // of selected objects
149
150   Handle(SALOME_InteractiveObject) lastIObject() ;
151   // Function returns the last selected object in the list
152   // of selected objects
153   
154   bool selectObjects( ObjectList& objects );
155   // Selects list of objects 
156
157   ////////////////////////////////////////////////////////////////////////////
158   // Virtual methods, to be redefined in dialog classes
159   ////////////////////////////////////////////////////////////////////////////
160
161   virtual GEOM::GEOM_IOperations_ptr createOperation();
162   // This method should be redefined in dialog boxes so as to return 
163   // proper GEOM_IOperation interface.
164   // Returns nil reference by default
165
166   virtual bool isValid( QString& msg );
167   // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
168
169   virtual bool execute( ObjectList& objects );
170   // This method is called by onAccept(). 
171   // It should perform the required operation and put all new or modified objects into 
172   // <objects> argument.Should return <false> if some error occurs during its execution. 
173
174   virtual void restoreSubShapes (SALOMEDS::Study_ptr theStudy, SALOMEDS::SObject_ptr theSObject);
175   // This method is called by addInStudy().
176
177   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
178   // This method is called by addInStudy(). It should return a father object
179   // for <theObj> or a nil reference if <theObj> should be published
180   // as a top-level object.
181
182   virtual const char* getNewObjectName() const; 
183   virtual void addSubshapesToStudy();
184
185   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const char* theName );
186   //This Metod to find SubObject in theFather Object by Name (theName)
187
188   void addSubshapesToFather( QMap<QString, GEOM::GEOM_Object_var>& theMap );
189
190   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
191   bool IsPreview() {return isPreview;}
192
193   GEOM_Displayer*             getDisplayer();
194   SUIT_Desktop*               getDesktop() const;
195
196 private:
197   char* getEntry              ( GEOM::GEOM_Object_ptr ) const;
198   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
199
200 private:
201   typedef std::list<SALOME_Prs*> PrsList;
202
203   PrsList                     myPreview;
204   GEOM_Displayer*             myDisplayer;
205   GEOM_Operation*             myCommand;
206   GEOM::GEOM_IOperations_var  myOperation;
207   SUIT_ViewWindow*            myViewWindow;
208   QString                     myPrefix;
209   bool                        isPreview;
210   SALOME_ListIO               mySelected;
211   SUIT_Desktop*               myDesktop;
212
213 };
214
215 #endif