src/GEOMGUI/GEOM_Displayer.h

   1 // Copyright (C) 2007-2023  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   : GEOM_Displayer.h
  25 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  26 //
  27 #ifndef GEOM_DISPLAYER_H
  28 #define GEOM_DISPLAYER_H
  29
  30 #include "GEOM_GEOMGUI.hxx"
  31 #include <GEOM_AISShape.hxx>
  32
  33 #include <SALOME_InteractiveObject.hxx>
  34
  35 class GEOM_Actor;
  36 class SALOME_ListIO;
  37 class SALOME_View;
  38 class SALOME_Prs;
  39 class SALOME_OCCPrs;
  40 class SALOME_VTKPrs;
  41 class SALOME_PV3DPrs;
  42 class SALOME_OCCViewType;
  43
  44 #include <TopoDS_Shape.hxx>
  45 #include <Quantity_Color.hxx>
  46 #include <LightApp_Displayer.h>
  47 #include <LightApp_Study.h>
  48 #include <Aspect_TypeOfMarker.hxx>
  49 #include <TCollection_AsciiString.hxx>
  50 #include <TColStd_MapOfInteger.hxx>
  51 #include <QList>
  52
  53 #include <list>
  54
  55 #include <SALOMEconfig.h>
  56 #include CORBA_CLIENT_HEADER(GEOM_Gen)
  57
  58 #define GEOM_ALLOBJECTS -1 // Selection of all objects is activated
  59 #define GEOM_PREVIEW    -2 // Definition for preview selection
  60 #define GEOM_ALLSHAPES  -3 // Selection of all shapes is activated
  61 #define GEOM_ALLGEOM    -4 // Selection of all geom objects is activated
  62
  63 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
  64
  65 class LightApp_SelectionMgr;
  66 class SalomeApp_Study;
  67 class SalomeApp_Application;
  68 class SUIT_SelectionFilter;
  69 class gp_Ax3;
  70
  71 class GEOMGUI_EXPORT GEOM_Displayer : public LightApp_Displayer
  72 {
  73
  74 public:
  75   /* Constructor */
  76   GEOM_Displayer();
  77   /* Destructor */
  78   virtual ~GEOM_Displayer();
  79
  80   virtual bool canBeDisplayed( const QString& /*entry*/, const QString& /*viewer_type*/ ) const;
  81
  82   /* Display/Erase object methods */
  83   void          Display   ( const Handle(SALOME_InteractiveObject)& theIO,
  84                             const bool updateViewer = true,
  85                             SALOME_View* theViewFrame = 0 );
  86
  87   // This overloaded Display() method can be useful for operations
  88   // not using dialog boxes.
  89   void          Display   ( GEOM::GEOM_BaseObject_ptr theObj,
  90                             const bool updateViewer = true );
  91
  92   void          Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
  93                             const bool updateViewer = true,
  94                             const bool checkActiveViewer = true );
  95
  96   void          Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
  97                             const bool theUpdateViewer,
  98                             SALOME_View* theViewFrame );
  99
 100   void          Erase     ( const Handle(SALOME_InteractiveObject)& theIO,
 101                             const bool forced = false,
 102                             const bool updateViewer = true,
 103                             SALOME_View* theViewFrame = 0 );
 104
 105   void          Erase     ( GEOM::GEOM_BaseObject_ptr theObj,
 106                             const bool forced = false,
 107                             const bool updateViewer = true,
 108                             SALOME_View* theViewFrame = 0);
 109
 110   void          EraseWithChildren(const Handle(SALOME_InteractiveObject)& theIO,
 111                                   const bool eraseOnlyChildren = false);
 112
 113   /* Display/Erase list of objects methods */
 114
 115   void          Display   ( const SALOME_ListIO& theIOList,
 116                             const bool updateViewer = true );
 117
 118   void          Erase     ( const SALOME_ListIO& theIOList,
 119                             const bool forced = false,
 120                             const bool updateViewer = true );
 121
 122   void          Redisplay ( const SALOME_ListIO& theIOList,
 123                             const bool updateViewer = true,
 124                             const bool checkActiveViewer = true );
 125
 126   void          Redisplay ( const SALOME_ListIO& theIOList,
 127                             const bool theUpdateViewer,
 128                             SALOME_View* theViewFrame );
 129
 130   /* Update visibility state */
 131   void          UpdateVisibility( SALOME_View*, const SALOME_Prs*, bool );
 132
 133   /* build presentation according to the current viewer type*/
 134   SALOME_Prs*   BuildPrs  ( GEOM::GEOM_Object_ptr );
 135   SALOME_Prs*   BuildPrs  ( const TopoDS_Shape& );
 136
 137   /* Set color for shape displaying. If it is equal -1 then default color is used.
 138      Available values are from Quantity_NameOfColor enumeration */
 139   void          SetColor  ( const int );
 140   void          UnsetColor();
 141   int           GetColor  () const;
 142   bool          HasColor  () const;
 143
 144   double        SetTransparency  ( const double );
 145   double        UnsetTransparency();
 146   double        GetTransparency  () const;
 147   bool          HasTransparency  () const;
 148
 149   /* Set texture for shape displaying. */
 150   void          SetTexture  ( const std::string& );
 151   bool          HasTexture  () const;
 152   std::string   GetTexture  () const;
 153
 154   /* Set width for shape displaying. If it is equal -1 then default width is used. */
 155   void          SetWidth  ( const double );
 156   void          UnsetWidth();
 157   double        GetWidth  () const;
 158   bool          HasWidth  () const;
 159
 160   /* Set width for iso-lines displaying. If it is equal -1 then default width is used. */
 161   void          SetIsosWidth  ( const int );
 162   int           GetIsosWidth  () const;
 163   bool          HasIsosWidth  () const;
 164
 165   /* Set nb iso-libes for displaying. Use -1 to set default values. */
 166   int           SetNbIsos( const int );
 167   int           UnsetNbIsos();
 168   int           GetNbIsos() const;
 169   bool          HasNbIsos() const;
 170
 171   /* Set color for iso-lines displaying. If it is equal -1 then default color is used.
 172      Available values are from Quantity_NameOfColor enumeration */
 173   int           SetIsosColor  ( const int );
 174   int           UnsetIsosColor();
 175   int           GetIsosColor  () const;
 176   bool          HasIsosColor  () const;
 177
 178   /* Set display mode shape displaying. If it is equal -1 then display mode is used. */
 179   int           SetDisplayMode( const int );
 180   int           GetDisplayMode() const;
 181   int           UnsetDisplayMode();
 182   bool          HasDisplayMode() const;
 183
 184   /* Sets name - for temporary objects only */
 185   void          SetName( const char* theName );
 186   void          UnsetName();
 187
 188   /* Reimplemented from SALOME_Displayer */
 189   virtual void  Update( SALOME_OCCPrs* );
 190   virtual void  Update( SALOME_VTKPrs* );
 191   virtual void  Update( SALOME_PV3DPrs* );
 192   virtual void  BeforeDisplay( SALOME_View*, const SALOME_OCCPrs* );
 193   virtual void  AfterDisplay ( SALOME_View*, const SALOME_OCCPrs* );
 194   virtual void  BeforeErase  ( SALOME_View*, const SALOME_OCCPrs* );
 195   virtual void  AfterErase   ( SALOME_View*, const SALOME_OCCPrs* );
 196
 197   /* This methods is used for activisation/deactivisation of objects to be displayed*/
 198   void          SetToActivate( const bool );
 199   bool          ToActivate() const;
 200
 201   /* Activate/Deactivate selection*/
 202   void         LocalSelection( const Handle(SALOME_InteractiveObject)&, const std::list<int> );
 203   void         LocalSelection( const Handle(SALOME_InteractiveObject)&, const int );
 204   void         LocalSelection( const SALOME_ListIO& theIOList, const std::list<int> );
 205   void         LocalSelection( const SALOME_ListIO& theIOList, const int );
 206   void         GlobalSelection( const int = GEOM_ALLOBJECTS, const bool = false );
 207   void         GlobalSelection( const TColStd_MapOfInteger&, const bool = false, const QList<int>* = 0 );
 208
 209   SalomeApp_Study* getStudy() const;
 210
 211   static SALOMEDS::Color getUniqueColor( const QList<SALOMEDS::Color>& );
 212   static SALOMEDS::Color getPredefinedUniqueColor();
 213
 214   /*Get color of the geom object*/
 215   static SALOMEDS::Color getColor(GEOM::GEOM_Object_var aGeomObject, bool& hasColor);
 216
 217   /* Get minimum or maximum enclosed shape type */
 218   static int getMinMaxShapeType( const TopoDS_Shape& shape, bool ismin );
 219
 220   /* Check if the object is a vertex or a compound of vertices */
 221   static bool isCompoundOfVertices( const TopoDS_Shape& theShape );
 222
 223
 224   /* Builds presentation of not published object */
 225   virtual SALOME_Prs* buildSubshapePresentation(const TopoDS_Shape& aShape,
 226                                                 const QString&,
 227                                                 SALOME_View* = 0);
 228
 229   /* Update visibility and parameters of the currently selected field step's color scale */
 230   void UpdateColorScale();
 231   bool SetUpdateColorScale(bool);
 232
 233 protected:
 234   /* internal methods */
 235   /* Builds presentation according to the current viewer type */
 236   virtual SALOME_Prs* buildPresentation( const QString&, SALOME_View* = 0 );
 237
 238   /* Sets interactive object */
 239   void        setIO( const Handle(SALOME_InteractiveObject)& theIO );
 240
 241   /* Sets shape */
 242   void        setShape( const TopoDS_Shape& theShape );
 243
 244   /* Sets field step information */
 245   void        setFieldStepInfo( const GEOM::field_data_type theFieldDataType,
 246                                 const int theFieldDimension,
 247                                 const QList<QVariant>& theFieldStepData,
 248                                 const TCollection_AsciiString& theFieldStepName,
 249                                 const double theFieldStepRangeMin,
 250                                 const double theFieldStepRangeMax );
 251
 252   /* Resets internal data */
 253   void        internalReset();
 254
 255   void        clearTemporary( LightApp_SelectionMgr* theSelMgr );
 256
 257   SUIT_SelectionFilter* getFilter( const int theMode );
 258   SUIT_SelectionFilter* getComplexFilter( const QList<int>* );
 259
 260   Quantity_Color qColorFromResources( const QString&, const QColor& );
 261   QColor         colorFromResources( const QString&, const QColor& );
 262   void           updateShapeProperties( const Handle(GEOM_AISShape)&, bool );
 263   void           updateActorProperties( GEOM_Actor*, bool );
 264   void           updateDimensions( const Handle(SALOME_InteractiveObject)&, SALOME_OCCPrs*, const gp_Ax3& );
 265   void           updateShapeAnnotations( const Handle(SALOME_InteractiveObject)&, SALOME_OCCPrs*, const gp_Ax3& );
 266
 267   PropMap getObjectProperties( const QString&, SALOME_View* = 0 );
 268   PropMap getDefaultPropertyMap();
 269
 270   /* Methods for reading the field step information */
 271   void            readFieldStepInfo( GEOM::GEOM_FieldStep_var theGeomFieldStep );
 272   QList<QVariant> groupFieldData( const QList<QVariant>& theFieldStepData,
 273                                   const int theFieldNbComponents,
 274                                   const bool theIsString,
 275                                   double& theFieldStepRangeMin,
 276                                   double& theFieldStepRangeMax );
 277
 278 protected:
 279   Handle(SALOME_InteractiveObject) myIO;
 280   TopoDS_Shape                     myShape;
 281   GEOM::field_data_type            myFieldDataType;
 282   int                              myFieldDimension;
 283   QList<QVariant>                  myFieldStepData;
 284   TCollection_AsciiString          myFieldStepName;
 285   double                           myFieldStepRangeMin;
 286   double                           myFieldStepRangeMax;
 287   std::string                      myNameInObjBrowser;
 288   std::string                      myName;
 289   std::string                      myTexture;
 290   int                              myType;
 291   SALOME_View*                     myViewFrame;
 292   bool                             myUpdateColorScale; // IPAL54049
 293
 294   // Attributes
 295   Quantity_Color                   myShadingColor;
 296   int                              myColor;
 297   double                           myWidth;
 298   int                              myIsosWidth;
 299   int                              myNbIsos;
 300   int                              myIsosColor;
 301   bool                             myToActivate;
 302   int                              myDisplayMode;
 303   bool                             myHasDisplayMode;
 304   Aspect_TypeOfMarker              myTypeOfMarker;
 305   double                           myScaleOfMarker;
 306   double                           myTransparency;
 307   bool                             myIsRedisplayed;
 308
 309 private:
 310   SalomeApp_Application* myApp;
 311   friend class GEOM_Swig;
 312 };
 313
 314 #endif // GEOM_DISPLAYER_H
 315