Salome HOME
731b63d06a8db714d1ca95f7ff91d26cd11d82fb
[modules/geom.git] / src / GEOMBase / GEOMBase_Helper.h
1 // Copyright (C) 2007-2014  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 <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   static SUIT_ViewWindow* getActiveView();
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   display,
77                                 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 std::list<int> );
99   void localSelection( const ObjectList&, const int );
100   void localSelection( GEOM::GEOM_Object_ptr, const std::list<int> );
101   void localSelection( GEOM::GEOM_Object_ptr, const int );
102   void activate( const int );
103   void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
104   void globalSelection( const TColStd_MapOfInteger&, const bool = false );
105   void globalSelection( const TColStd_MapOfInteger&, const QList<int>& ,const bool = false );
106   void updateViewer    ();
107
108   void prepareSelection( const ObjectList&, const int );
109   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
110
111   QString addInStudy   ( GEOM::GEOM_Object_ptr, const char* theName );
112
113   bool openCommand     ();
114   bool abortCommand    ();
115   bool commitCommand   ( const char* = 0 );
116   bool hasCommand      () const;
117
118   void updateObjBrowser() const;
119   int  getStudyId      () const;
120   SalomeApp_Study* getStudy  () const;
121   bool checkViewWindow ();
122
123   bool onAccept( const bool publish = true, const bool useTransaction = true, bool erasePreviewFlag = true);
124   // This method should be called from "OK" button handler.
125   // <publish> == true means that objects returned by execute()
126   // should be published in a study.
127
128   void showError();
129   // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
130   void showError( const QString& msg );
131   // Shows a error message followed by <msg>
132
133   GEOM::GEOM_IOperations_ptr getOperation();
134   // If <myOperation> is nil --> calls createOperation() and put the result
135   // into <myOperation> and returns it;
136   // otherwise, simply returns <myOperation>
137
138   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
139   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
140
141   bool selectObjects( ObjectList& objects );
142   // Selects list of objects
143
144   ////////////////////////////////////////////////////////////////////////////
145   // Virtual methods, to be redefined in dialog classes
146   ////////////////////////////////////////////////////////////////////////////
147
148   virtual GEOM::GEOM_IOperations_ptr createOperation();
149   // This method should be redefined in dialog boxes so as to return
150   // proper GEOM_IOperation interface.
151   // Returns nil reference by default
152
153   virtual bool isValid( QString& msg );
154   // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
155
156   virtual bool execute( ObjectList& objects );
157   // This method is called by onAccept().
158   // It should perform the required operation and put all new or modified objects into
159   // <objects> argument.Should return <false> if some error occurs during its execution.
160
161   virtual void restoreSubShapes( SALOMEDS::Study_ptr theStudy, SALOMEDS::SObject_ptr theSObject );
162   // This method is called by addInStudy().
163
164   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
165   // This method is called by addInStudy(). It should return a father object
166   // for <theObj> or a nil reference if <theObj> should be published
167   // as a top-level object.
168
169   virtual QString getNewObjectName (int CurrObj = -1) const;
170   virtual QString getObjectName(GEOM::GEOM_Object_ptr object) const;
171   virtual bool extractPrefix() const;
172   virtual void addSubshapesToStudy();
173
174   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const QString& theName );
175   GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, int theIndex );
176   // These methods are used to find published sub-object (sub-shape) in the parent object (main shape)
177
178   GEOM::GeomObjPtr        getSelected( TopAbs_ShapeEnum type );
179   GEOM::GeomObjPtr        getSelected( const QList<TopAbs_ShapeEnum>& types );
180   QList<GEOM::GeomObjPtr> getSelected( TopAbs_ShapeEnum type, int count, bool strict = true );
181   QList<GEOM::GeomObjPtr> getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict = true );
182
183   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
184   bool IsPreview() {return isPreview;}
185
186   GEOM_Displayer*             getDisplayer();
187   SUIT_Desktop*               getDesktop() const;
188
189   virtual void                setIsApplyAndClose( const bool theFlag );
190   virtual bool                isApplyAndClose() const;
191
192   virtual void                setIsOptimizedBrowsing( const bool theFlag );
193   virtual bool                isOptimizedBrowsing() const;
194
195   virtual void                setIsWaitCursorEnabled( const bool theFlag ) {myIsWaitCursorEnabled = theFlag;}
196   virtual bool                isWaitCursorEnabled() const {return myIsWaitCursorEnabled ;}
197   virtual void                setIsDisableBrowsing( const bool theFlag ) { myIsDisableBrowsing = theFlag; }
198   virtual bool                isDisableBrowsing() const { return myIsDisableBrowsing; }
199   virtual void                setIsDisplayResult( const bool theFlag ) {myIsDisplayResult = theFlag; }
200   virtual bool                isDisplayResult() const { return myIsDisplayResult; }
201
202 private:
203   QString                     getEntry( GEOM::GEOM_Object_ptr ) const;
204   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
205
206 private:
207   typedef std::list<SALOME_Prs*> PrsList;
208
209   PrsList                     myPreview;
210   GEOM_Displayer*             myDisplayer;
211   GEOM_Operation*             myCommand;
212   GEOM::GEOM_IOperations_var  myOperation;
213   SUIT_ViewWindow*            myViewWindow;
214   QString                     myPrefix;
215   bool                        isPreview;
216   SALOME_ListIO               mySelected;
217   SUIT_Desktop*               myDesktop;
218   bool                        myIsApplyAndClose;
219   bool                        myIsOptimizedBrowsing;
220   bool                        myIsWaitCursorEnabled;
221   bool                        myIsDisableBrowsing;  //This flag enable/disable selection
222                                                     //in the Object Browser newly created objects.
223   bool                        myIsDisplayResult;    //This flag display/hide newly created objects.
224 };
225
226 #endif // GEOMBASE_HELPER_H