1 // Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
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)
27 #ifndef GEOMBASE_HELPER_H
28 #define GEOMBASE_HELPER_H
30 #include "GEOM_GEOMBase.hxx"
31 #include "GEOM_GenericObjPtr.h"
33 #include <GEOM_Displayer.h>
34 #include <SALOME_ListIO.hxx>
35 #include <SALOMEconfig.h>
36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
43 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
45 class SalomeApp_Study;
47 class SUIT_ViewWindow;
50 class TColStd_MapOfInteger;
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
62 GEOMBase_Helper( SUIT_Desktop* );
63 virtual ~GEOMBase_Helper();
64 static SUIT_ViewWindow* getActiveView();
67 static GEOM::GEOM_Gen_ptr getGeomEngine();
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 );
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,
83 const bool append = false );
84 // This is the easiest way to show preview. It is based on execute() method.
85 // It removes temporary GEOM::GEOM_Objects automatically.
87 virtual void displayPreview ( GEOM::GEOM_Object_ptr obj,
88 const bool append = false,
89 const bool activate = false,
90 const bool update = true,
91 const double lineWidth = -1,
92 const int displayMode = -1,
93 const int color = -1 );
94 void displayPreview ( const SALOME_Prs* prs,
95 const bool append = false,
97 void erasePreview ( const bool = true );
99 void localSelection( const ObjectList&, const std::list<int> );
100 void localSelection( const ObjectList&, const int );
101 void localSelection( GEOM::GEOM_Object_ptr, const std::list<int> );
102 void localSelection( GEOM::GEOM_Object_ptr, const int );
103 void activate( const int );
104 void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false );
105 void globalSelection( const TColStd_MapOfInteger&, const bool = false );
106 void globalSelection( const TColStd_MapOfInteger&, const QList<int>& ,const bool = false );
107 void updateViewer ();
109 void prepareSelection( const ObjectList&, const int );
110 void prepareSelection( GEOM::GEOM_Object_ptr, const int );
112 QString addInStudy ( GEOM::GEOM_Object_ptr, const char* theName );
115 bool abortCommand ();
116 bool commitCommand ( const char* = 0 );
117 bool hasCommand () const;
119 void updateObjBrowser() const;
120 int getStudyId () const;
121 SalomeApp_Study* getStudy () const;
122 bool checkViewWindow ();
124 bool onAccept( const bool publish = true, const bool useTransaction = true, bool erasePreviewFlag = true);
125 // This method should be called from "OK" button handler.
126 // <publish> == true means that objects returned by execute()
127 // should be published in a study.
130 // Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
131 void showError( const QString& msg );
132 // Shows a error message followed by <msg>
134 GEOM::GEOM_IOperations_ptr getOperation();
135 // If <myOperation> is nil --> calls createOperation() and put the result
136 // into <myOperation> and returns it;
137 // otherwise, simply returns <myOperation>
139 inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
140 QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
142 bool selectObjects( ObjectList& objects );
143 // Selects list of objects
145 ////////////////////////////////////////////////////////////////////////////
146 // Virtual methods, to be redefined in dialog classes
147 ////////////////////////////////////////////////////////////////////////////
149 virtual GEOM::GEOM_IOperations_ptr createOperation();
150 // This method should be redefined in dialog boxes so as to return
151 // proper GEOM_IOperation interface.
152 // Returns nil reference by default
154 virtual bool isValid( QString& msg );
155 // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
157 virtual bool execute( ObjectList& objects );
158 // This method is called by onAccept().
159 // It should perform the required operation and put all new or modified objects into
160 // <objects> argument.Should return <false> if some error occurs during its execution.
162 virtual void restoreSubShapes( SALOMEDS::Study_ptr theStudy, SALOMEDS::SObject_ptr theSObject );
163 // This method is called by addInStudy().
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.
170 virtual QString getNewObjectName (int CurrObj = -1) const;
171 virtual QString getObjectName(GEOM::GEOM_Object_ptr object) const;
172 virtual bool extractPrefix() const;
173 virtual void addSubshapesToStudy();
175 GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const QString& theName );
176 GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, int theIndex );
177 // These methods are used to find published sub-object (sub-shape) in the parent object (main shape)
179 GEOM::GeomObjPtr getSelected( TopAbs_ShapeEnum type );
180 GEOM::GeomObjPtr getSelected( const QList<TopAbs_ShapeEnum>& types );
181 QList<GEOM::GeomObjPtr> getSelected( TopAbs_ShapeEnum type, int count, bool strict = true );
182 QList<GEOM::GeomObjPtr> getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict = true );
184 void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
185 bool IsPreview() {return isPreview;}
187 GEOM_Displayer* getDisplayer();
188 SUIT_Desktop* getDesktop() const;
190 virtual void setIsApplyAndClose( const bool theFlag );
191 virtual bool isApplyAndClose() const;
193 virtual void setIsOptimizedBrowsing( const bool theFlag );
194 virtual bool isOptimizedBrowsing() const;
196 virtual void setIsWaitCursorEnabled( const bool theFlag ) {myIsWaitCursorEnabled = theFlag;}
197 virtual bool isWaitCursorEnabled() const {return myIsWaitCursorEnabled ;}
198 virtual void setIsDisableBrowsing( const bool theFlag ) { myIsDisableBrowsing = theFlag; }
199 virtual bool isDisableBrowsing() const { return myIsDisableBrowsing; }
200 virtual void setIsDisplayResult( const bool theFlag ) {myIsDisplayResult = theFlag; }
201 virtual bool isDisplayResult() const { return myIsDisplayResult; }
204 QString getEntry( GEOM::GEOM_Object_ptr ) const;
205 void clearShapeBuffer( GEOM::GEOM_Object_ptr );
208 typedef std::list<SALOME_Prs*> PrsList;
211 GEOM_Displayer* myDisplayer;
212 GEOM_Operation* myCommand;
213 GEOM::GEOM_IOperations_var myOperation;
214 SUIT_ViewWindow* myViewWindow;
217 SALOME_ListIO mySelected;
218 SUIT_Desktop* myDesktop;
219 bool myIsApplyAndClose;
220 bool myIsOptimizedBrowsing;
221 bool myIsWaitCursorEnabled;
222 bool myIsDisableBrowsing; //This flag enable/disable selection
223 //in the Object Browser newly created objects.
224 bool myIsDisplayResult; //This flag display/hide newly created objects.
227 #endif // GEOMBASE_HELPER_H