Salome HOME
Migration to OCCT 7.0
[modules/geom.git] / src / GEOMBase / GEOMBase_Helper.h
1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
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 <TColStd_MapOfInteger.hxx>
39
40 #include <QString>
41 #include <QMap>
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 SALOME_Prs;
51 class GEOM_Operation;
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   static SUIT_ViewWindow* getActiveView();
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   display,
78                                 const bool   activate = false,
79                                 const bool   update = true,
80                                 const bool   toRemoveFromEngine = true,
81                                 const double lineWidth = -1,
82                                 const int    displayMode = -1,
83                                 const int    color  = -1,
84                                 const bool   append = false );
85   // This is the easiest way to show preview. It is based on execute() method.
86   // It removes temporary GEOM::GEOM_Objects automatically.
87
88   virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj,
89                                  const bool   append = false,
90                                  const bool   activate = false,
91                                  const bool   update = true,
92                                  const double lineWidth = -1,
93                                  const int    displayMode = -1,
94                                  const int    color  = -1 );
95   void displayPreview  ( const SALOME_Prs* prs,
96                          const bool append = false,
97                          const bool = true );
98   void erasePreview    ( const bool = true );
99
100   void localSelection( const ObjectList&, const std::list<int> );
101   void localSelection( const ObjectList&, const int );
102   void localSelection( GEOM::GEOM_Object_ptr, const std::list<int> );
103   void localSelection( GEOM::GEOM_Object_ptr, const int );
104   void localSelection( const std::list<int> );
105   void localSelection( const int );
106   void activate( const int );
107   void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
108   void globalSelection( const TColStd_MapOfInteger&, const bool = false );
109   void globalSelection( const TColStd_MapOfInteger&, const QList<int>& ,const bool = false );
110   void updateViewer    ();
111
112   void prepareSelection( const ObjectList&, const int );
113   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
114
115   QString addInStudy   ( GEOM::GEOM_Object_ptr, const char* theName );
116
117   bool openCommand     ();
118   bool abortCommand    ();
119   bool commitCommand   ( const char* = 0 );
120   bool hasCommand      () const;
121
122   void updateObjBrowser() const;
123   int  getStudyId      () const;
124   SalomeApp_Study* getStudy  () const;
125   bool checkViewWindow ();
126
127   bool onAccept( const bool publish = true, const bool useTransaction = true, bool erasePreviewFlag = true);
128   // This method should be called from "OK" button handler.
129   // <publish> == true means that objects returned by execute()
130   // should be published in a study.
131
132   void showError();
133   // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
134   void showError( const QString& msg );
135   // Shows a error message followed by <msg>
136
137   GEOM::GEOM_IOperations_ptr getOperation();
138   // If <myOperation> is nil --> calls createOperation() and put the result
139   // into <myOperation> and returns it;
140   // otherwise, simply returns <myOperation>
141
142   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
143   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
144
145   bool selectObjects( ObjectList& objects );
146   // Selects list of 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 void restoreSubShapes( SALOMEDS::Study_ptr theStudy, SALOMEDS::SObject_ptr theSObject );
166   // This method is called by addInStudy().
167
168   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
169   // This method is called by addInStudy(). It should return a father object
170   // for <theObj> or a nil reference if <theObj> should be published
171   // as a top-level object.
172
173   virtual QString getNewObjectName (int CurrObj = -1) const;
174   virtual QString getObjectName(GEOM::GEOM_Object_ptr object) const;
175   virtual bool extractPrefix() const;
176   virtual void addSubshapesToStudy();
177   virtual QList<GEOM::GeomObjPtr> getSourceObjects();
178
179   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const QString& theName );
180   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, int theIndex );
181   // These methods are used to find published sub-object (sub-shape) in the parent object (main shape)
182
183   GEOM::GeomObjPtr        getSelected( TopAbs_ShapeEnum type );
184   GEOM::GeomObjPtr        getSelected( const QList<TopAbs_ShapeEnum>& types );
185   QList<GEOM::GeomObjPtr> getSelected( TopAbs_ShapeEnum type, int count, bool strict = true );
186   QList<GEOM::GeomObjPtr> getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict = true );
187
188   void hideSourceObjects( QList<GEOM::GeomObjPtr> theObjectList );
189   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
190   bool IsPreview() {return isPreview;}
191
192   GEOM_Displayer*             getDisplayer();
193   SUIT_Desktop*               getDesktop() const;
194
195   virtual void                setIsApplyAndClose( const bool theFlag );
196   virtual bool                isApplyAndClose() const;
197
198   virtual void                setIsOptimizedBrowsing( const bool theFlag );
199   virtual bool                isOptimizedBrowsing() const;
200
201   virtual void                setIsWaitCursorEnabled( const bool theFlag ) {myIsWaitCursorEnabled = theFlag;}
202   virtual bool                isWaitCursorEnabled() const {return myIsWaitCursorEnabled ;}
203   virtual void                setIsDisableBrowsing( const bool theFlag ) { myIsDisableBrowsing = theFlag; }
204   virtual bool                isDisableBrowsing() const { return myIsDisableBrowsing; }
205   virtual void                setIsDisplayResult( const bool theFlag ) {myIsDisplayResult = theFlag; }
206   virtual bool                isDisplayResult() const { return myIsDisplayResult; }
207
208 private:
209   QString                     getEntry( GEOM::GEOM_Object_ptr ) const;
210   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
211
212 private:
213   typedef std::list<SALOME_Prs*> PrsList;
214
215   PrsList                     myPreview;
216   GEOM_Displayer*             myDisplayer;
217   GEOM_Operation*             myCommand;
218   GEOM::GEOM_IOperations_var  myOperation;
219   SUIT_ViewWindow*            myViewWindow;
220   QString                     myPrefix;
221   bool                        isPreview;
222   SALOME_ListIO               mySelected;
223   SUIT_Desktop*               myDesktop;
224   bool                        myIsApplyAndClose;
225   bool                        myIsOptimizedBrowsing;
226   bool                        myIsWaitCursorEnabled;
227   bool                        myIsDisableBrowsing;  //This flag enable/disable selection
228                                                     //in the Object Browser newly created objects.
229   bool                        myIsDisplayResult;    //This flag display/hide newly created objects.
230 };
231
232 #endif // GEOMBASE_HELPER_H