Salome HOME
0021672: [CEA 565] Dump Study from script
[modules/geom.git] / src / GEOMBase / GEOMBase.h
index b6de381c5f7a1f41451be93982c0d7cdc252502a..84ab6ee14f8383ecd317bc83c78f9d747e49df7e 100644 (file)
-//  GEOM GEOMGUI : GUI for Geometry component
+// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
 //
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
-//  File   : GEOMBase.h
-//  Author : Damien COQUERET
-//  Module : GEOM
-//  $Header: 
 
+// GEOM GEOMGUI : GUI for Geometry component
+// File   : GEOMBase.h
+// Author : Damien COQUERET, Open CASCADE S.A.S.
+//
 #ifndef GEOMBASE_H
 #define GEOMBASE_H
 
-#include "GEOMContext.h"
+#include "GEOM_GEOMBase.hxx"
 
 // SALOME Includes
-#include "QAD_Config.h"
-#include "SALOME_Selection.h"
-#include "GEOM_Actor.h"
-#include "GEOM_AISShape.hxx"
-#include "GEOM_InteractiveObject.hxx"
-
-// Open CASCADE Includes
-#include <Quantity_Color.hxx>
+#include <GEOM_AISShape.hxx>
 
 // IDL Headers
 #include <SALOMEconfig.h>
 #include CORBA_SERVER_HEADER(SALOMEDS)
 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
+#include CORBA_SERVER_HEADER(GEOM_Gen)
+
+// QT Includes
+#include <QString>
+
+class GEOM_Actor;
+class SALOME_ListIO;
+
+class QWidget;
 
 //=================================================================================
 // class    : GEOMBase
 // purpose  :
 //=================================================================================
-class GEOMBase : public QObject
+class GEOMBASE_EXPORT GEOMBase
 {
-  Q_OBJECT /* for QT compatibility */
-    
 public :
-  GEOMBase();
-  ~GEOMBase();
+  /* Selection and objects management */
+  static int          GetIndex( const TopoDS_Shape& subshape, const TopoDS_Shape& shape );
+  static TopoDS_Shape GetShapeFromIOR( const QString& IOR );
+  static bool         GetShape( GEOM::GEOM_Object_ptr object,
+                               TopoDS_Shape& shape,
+                               const TopAbs_ShapeEnum type = TopAbs_SHAPE );
+  static TopoDS_Shape GetTopoFromSelection( const SALOME_ListIO& IObjects );
+  static int          GetNameOfSelectedIObjects( const SALOME_ListIO& IObjects,
+                                                QString& name,
+                                                const bool shapesOnly = false );
+  static QString      GetShapeTypeString( const TopoDS_Shape& shape );
 
-  static bool CustomPopup(QAD_Desktop* parent, QPopupMenu* popup, const QString& theContext,
-                         const QString& theParent, const QString& theObject);
+  /* Convertions */
+  static Handle(GEOM_AISShape)
+                      ConvertIOinGEOMAISShape( const Handle(SALOME_InteractiveObject)& IO,
+                                              bool onlyInActiveView = false );
 
-  bool Display(GEOM::GEOM_Shape_ptr aShape, Standard_CString name = "");
-  bool AddInStudy(bool selection = false, const Handle(SALOME_InteractiveObject)& anIO = 0);
+  static Handle(AIS_InteractiveObject)
+                      GetAIS( const Handle(SALOME_InteractiveObject)& IO,
+                             bool onlyInActiveView = false,
+                             bool onlyGeom = false ); 
+  static QStringList  ConvertListOfIOInListOfIOR( const SALOME_ListIO& IObjects ); 
 
-  /* Selection and objects management */
-  int GetIndex(const TopoDS_Shape& subshape, const TopoDS_Shape& shape, int ShapeType);
-  TopoDS_Shape GetShapeFromIOR(QString IOR);
-  bool GetTopoFromSelection(SALOME_Selection *Sel, TopoDS_Shape& tds);
-  int GetNameOfSelectedIObjects(SALOME_Selection* Sel, QString& aName); 
-  bool GetShapeTypeString(const TopoDS_Shape& aShape, Standard_CString& aTypeString);
+  static Handle(GEOM_AISShape) 
+                      ConvertIORinGEOMAISShape( const QString& IOR,
+                                               bool onlyInActiveView = false );
+  static GEOM_Actor*  ConvertIORinGEOMActor( const QString& IOR,
+                                            bool onlyInActiveView = false );
 
-  /* Convertions */
-  GEOM::GEOM_Shape_ptr ConvertIOinGEOMShape(const Handle(SALOME_InteractiveObject)& IO, 
-                                           Standard_Boolean& testResult);
-  Handle(GEOM_AISShape) ConvertIOinGEOMAISShape(const Handle(SALOME_InteractiveObject)& IO,
-                                               Standard_Boolean& testResult,
-                                               bool onlyInActiveView = false); 
-  void ConvertListOfIOInListOfIOR(const SALOME_ListIO& aList,
-                                 GEOM::GEOM_Gen::ListOfIOR& listIOR); 
-
-  Handle(GEOM_AISShape) ConvertIORinGEOMAISShape(const char * IOR,
-                                                Standard_Boolean& testResult,
-                                                bool onlyInActiveView = false);
-  GEOM_Actor* ConvertIORinGEOMActor(const char * IOR, Standard_Boolean& testResult,
-                                   bool onlyInActiveView = false);
+  static GEOM::GEOM_Object_ptr
+                      ConvertIOinGEOMObject( const Handle(SALOME_InteractiveObject)& IO );
 
-  /* Geometry */
-  bool VertexToPoint(const TopoDS_Shape& S, gp_Pnt& P);
+  static void         ConvertListOfIOInListOfGO( const SALOME_ListIO& IObjects,
+                                                GEOM::ListOfGO& geomObjects,
+                                                bool shapesOnly = false ); 
 
-  /* Used just by Plane and Prism */
-  bool LinearEdgeExtremities(const TopoDS_Shape& S, gp_Pnt& P1, gp_Pnt& P2);
-  void GetBipointDxDyDz(gp_Pnt P1, gp_Pnt P2, double& dx, double& dy, double& dz);
+  static GEOM::GEOM_Object_ptr
+                      GetObjectFromIOR( const QString& IOR );
 
-  /* User dialog 1 parameter returned */
-  double Parameter(Standard_Boolean& res,
-                  const char* aValue1 = 0, const char* aTitle1 = 0,
-                  const char* aTitle = 0, const double bottom = -1E6,
-                  const double top = +1E6, const int decimals = 6);
+  static QString      GetIORFromObject( GEOM::GEOM_Object_ptr object );
 
-  //void SetDisplayedObjectList();
+  /* Geometry */
+  static bool         VertexToPoint( const TopoDS_Shape& shape, gp_Pnt& point );
+
+  /* Used just by Plane and Prism */
+  static bool         LinearEdgeExtremities( const TopoDS_Shape& shape,
+                                            gp_Pnt& point1, gp_Pnt& point2 );
+  static void         GetBipointDxDyDz( const gp_Pnt& point1, const gp_Pnt& point2,
+                                       double& dx, double& dy, double& dz );
 
   /* Simulation management */
-  bool CreateArrowForLinearEdge(const TopoDS_Shape& tds, TopoDS_Shape& ArrowCone);
-  void DisplaySimulationShape(const TopoDS_Shape& S); 
-  void EraseSimulationShape();
+  static TopoDS_Shape CreateArrowForLinearEdge( const TopoDS_Shape& tds );
 
-  /* Method used by dialog boxes called when used has entered a name of object in a LineEdit */
-  bool SelectionByNameInDialogs(QWidget* aWidget, const QString& userObjectName, SALOME_Selection *Sel);
-  bool DefineDlgPosition(QWidget* aDlg, int& x, int& y);
+  /*  Generates default names */
+  static bool         SelectionByNameInDialogs( QWidget* widget,
+                                               const QString& userObjectName,
+                                               const SALOME_ListIO& IObjects );
+  /* Shows message box with error code */
+  static void         DefineDlgPosition( QWidget* dlg, int& x, int& y );
 
   /* This method generates default names for results of geometrical operations */
-  static QString GetDefaultName(const QString& theOperation);   
+  static QString      GetDefaultName( const QString& operation, bool extractPrefix = false );
 
-  GEOMContext* myGeomGUI;
-  GEOM::GEOM_Gen_var myGeom;   /* Current Geom Component */
+  /* Shows message box with error code and comment */
+  static void         ShowErrorMessage( const QString& errorCode, const QString& comment = QString() );
 
-  Quantity_Color myShadingColor;
-  Handle(AIS_Shape) mySimulationShape; /* AIS shape used only during topo/geom simulations */
-  bool mySettings_AddInStudy;
+  /* Gets name of object */
+  static QString      GetName( GEOM::GEOM_Object_ptr object );
 
-};
+  /* Check if object has shape */
+  static bool         IsShape( GEOM::GEOM_Object_ptr object );
 
-#endif
+  /* Get string representation of shape type */
+  static QString      TypeName( TopAbs_ShapeEnum type );
+  
+  /* Get study entry for the given object  */
+  static QString      GetEntry( GEOM::GEOM_Object_ptr object );
+
+  /* Publish sub-shape under the main object */
+  static void         PublishSubObject( GEOM::GEOM_Object_ptr object );
+};
 
+#endif // GEOMBASE_H